Documentation fixes for Scroller.
[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 which hold the widgets.
33
34 @section license License
35
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
38
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
44 */
45
46
47 /**
48  * @defgroup Start Getting Started
49  *
50  * To write an Elementary app, you can get started with the following:
51  *
52 @code
53 #include <Elementary.h>
54 EAPI_MAIN int
55 elm_main(int argc, char **argv)
56 {
57    // create window(s) here and do any application init
58    elm_run(); // run main loop
59    elm_shutdown(); // after mainloop finishes running, shutdown
60    return 0; // exit 0 for exit code
61 }
62 ELM_MAIN()
63 @endcode
64  *
65  * To use autotools (which helps in many ways in the long run, like being able
66  * to immediately create releases of your software directly from your tree
67  * and ensure everything needed to build it is there) you will need a
68  * configure.ac, Makefile.am and autogen.sh file.
69  *
70  * configure.ac:
71  *
72 @verbatim
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
74 AC_PREREQ(2.52)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
77 AC_PROG_CC
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
80 AC_OUTPUT(Makefile)
81 @endverbatim
82  *
83  * Makefile.am:
84  *
85 @verbatim
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
88
89 INCLUDES = -I$(top_srcdir)
90
91 bin_PROGRAMS = myapp
92
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
96 @endverbatim
97  *
98  * autogen.sh:
99  *
100 @verbatim
101 #!/bin/sh
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
106 ./configure "$@"
107 @endverbatim
108  *
109  * To generate all the things needed to bootstrap just run:
110  *
111 @verbatim
112 ./autogen.sh
113 @endverbatim
114  *
115  * This will generate Makefile.in's, the confgure script and everything else.
116  * After this it works like all normal autotools projects:
117 @verbatim
118 ./configure
119 make
120 sudo make install
121 @endverbatim
122  *
123  * Note sudo was assumed to get root permissions, as this would install in
124  * /usr/local which is system-owned. Use any way you like to gain root, or
125  * specify a different prefix with configure:
126  *
127 @verbatim
128 ./confiugre --prefix=$HOME/mysoftware
129 @endverbatim
130  *
131  * Also remember that autotools buys you some useful commands like:
132 @verbatim
133 make uninstall
134 @endverbatim
135  *
136  * This uninstalls the software after it was installed with "make install".
137  * It is very useful to clear up what you built if you wish to clean the
138  * system.
139  *
140 @verbatim
141 make distcheck
142 @endverbatim
143  *
144  * This firstly checks if your build tree is "clean" and ready for
145  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146  * ready to upload and distribute to the world, that contains the generated
147  * Makefile.in's and configure script. The users do not need to run
148  * autogen.sh - just configure and on. They don't need autotools installed.
149  * This tarball also builds cleanly, has all the sources it needs to build
150  * included (that is sources for your application, not libraries it depends
151  * on like Elementary). It builds cleanly in a buildroot and does not
152  * contain any files that are temporarily generated like binaries and other
153  * build-generated files, so the tarball is clean, and no need to worry
154  * about cleaning up your tree before packaging.
155  *
156 @verbatim
157 make clean
158 @endverbatim
159  *
160  * This cleans up all build files (binaries, objects etc.) from the tree.
161  *
162 @verbatim
163 make distclean
164 @endverbatim
165  *
166  * This cleans out all files from the build and from configure's output too.
167  *
168 @verbatim
169 make maintainer-clean
170 @endverbatim
171  *
172  * This deletes all the files autogen.sh will produce so the tree is clean
173  * to be put into a revision-control system (like CVS, SVN or GIT for example).
174  *
175  * There is a more advanced way of making use of the quicklaunch infrastructure
176  * in Elementary (which will not be covered here due to its more advanced
177  * nature).
178  *
179  * Now let's actually create an interactive "Hello World" gui that you can
180  * click the ok button to exit. It's more code because this now does something
181  * much more significant, but it's still very simple:
182  *
183 @code
184 #include <Elementary.h>
185
186 static void
187 on_done(void *data, Evas_Object *obj, void *event_info)
188 {
189    // quit the mainloop (elm_run function will return)
190    elm_exit();
191 }
192
193 EAPI_MAIN int
194 elm_main(int argc, char **argv)
195 {
196    Evas_Object *win, *bg, *box, *lab, *btn;
197
198    // new window - do the usual and give it a name, title and delete handler
199    win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
200    elm_win_title_set(win, "Hello");
201    // when the user clicks "close" on a window there is a request to delete
202    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203
204    // add a standard bg
205    bg = elm_bg_add(win);
206    // add object as a resize object for the window (controls window minimum
207    // size as well as gets resized if window is resized)
208    elm_win_resize_object_add(win, bg);
209    evas_object_show(bg);
210
211    // add a box object - default is vertical. a box holds children in a row,
212    // either horizontally or vertically. nothing more.
213    box = elm_box_add(win);
214    // make the box hotizontal
215    elm_box_horizontal_set(box, EINA_TRUE);
216    // add object as a resize object for the window (controls window minimum
217    // size as well as gets resized if window is resized)
218    elm_win_resize_object_add(win, box);
219    evas_object_show(box);
220
221    // add a label widget, set the text and put it in the pad frame
222    lab = elm_label_add(win);
223    // set default text of the label
224    elm_object_text_set(lab, "Hello out there world!");
225    // pack the label at the end of the box
226    elm_box_pack_end(box, lab);
227    evas_object_show(lab);
228
229    // add an ok button
230    btn = elm_button_add(win);
231    // set default text of button to "OK"
232    elm_object_text_set(btn, "OK");
233    // pack the button at the end of the box
234    elm_box_pack_end(box, btn);
235    evas_object_show(btn);
236    // call on_done when button is clicked
237    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
238
239    // now we are done, show the window
240    evas_object_show(win);
241
242    // run the mainloop and process events and callbacks
243    elm_run();
244    return 0;
245 }
246 ELM_MAIN()
247 @endcode
248    *
249    */
250
251 /**
252 @page authors Authors
253 @author Carsten Haitzler <raster@@rasterman.com>
254 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
255 @author Cedric Bail <cedric.bail@@free.fr>
256 @author Vincent Torri <vtorri@@univ-evry.fr>
257 @author Daniel Kolesa <quaker66@@gmail.com>
258 @author Jaime Thomas <avi.thomas@@gmail.com>
259 @author Swisscom - http://www.swisscom.ch/
260 @author Christopher Michael <devilhorns@@comcast.net>
261 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
262 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
263 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
264 @author Brian Wang <brian.wang.0721@@gmail.com>
265 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
266 @author Samsung Electronics <tbd>
267 @author Samsung SAIT <tbd>
268 @author Brett Nash <nash@@nash.id.au>
269 @author Bruno Dilly <bdilly@@profusion.mobi>
270 @author Rafael Fonseca <rfonseca@@profusion.mobi>
271 @author Chuneon Park <hermet@@hermet.pe.kr>
272 @author Woohyun Jung <wh0705.jung@@samsung.com>
273 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
274 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
275 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
276 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
277 @author Gustavo Lima Chaves <glima@@profusion.mobi>
278 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
279 @author Tiago Falcão <tiago@@profusion.mobi>
280 @author Otavio Pontes <otavio@@profusion.mobi>
281 @author Viktor Kojouharov <vkojouharov@@gmail.com>
282 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
283 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
284 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
285 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
286 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
287 @author Jihoon Kim <jihoon48.kim@@samsung.com>
288 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
289 @author Tom Hacohen <tom@@stosb.com>
290 @author Aharon Hillel <a.hillel@@partner.samsung.com>
291 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
292 @author Shinwoo Kim <kimcinoo@@gmail.com>
293 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
294 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
295 @author Sung W. Park <sungwoo@gmail.com>
296 @author Thierry el Borgi <thierry@substantiel.fr>
297 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
298 @author Chanwook Jung <joey.jung@samsung.com>
299 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
300 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
301 @author Kim Yunhan <spbear@gmail.com>
302
303 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
304 contact with the developers and maintainers.
305  */
306
307 #ifndef ELEMENTARY_H
308 #define ELEMENTARY_H
309
310 /**
311  * @file Elementary.h
312  * @brief Elementary's API
313  *
314  * Elementary API.
315  */
316
317 @ELM_UNIX_DEF@ ELM_UNIX
318 @ELM_WIN32_DEF@ ELM_WIN32
319 @ELM_WINCE_DEF@ ELM_WINCE
320 @ELM_EDBUS_DEF@ ELM_EDBUS
321 @ELM_EFREET_DEF@ ELM_EFREET
322 @ELM_ETHUMB_DEF@ ELM_ETHUMB
323 @ELM_WEB_DEF@ ELM_WEB
324 @ELM_EMAP_DEF@ ELM_EMAP
325 @ELM_DEBUG_DEF@ ELM_DEBUG
326 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
327 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
328
329 /* Standard headers for standard system calls etc. */
330 #include <stdio.h>
331 #include <stdlib.h>
332 #include <unistd.h>
333 #include <string.h>
334 #include <sys/types.h>
335 #include <sys/stat.h>
336 #include <sys/time.h>
337 #include <sys/param.h>
338 #include <dlfcn.h>
339 #include <math.h>
340 #include <fnmatch.h>
341 #include <limits.h>
342 #include <ctype.h>
343 #include <time.h>
344 #include <dirent.h>
345 #include <pwd.h>
346 #include <errno.h>
347
348 #ifdef ELM_UNIX
349 # include <locale.h>
350 # ifdef ELM_LIBINTL_H
351 #  include <libintl.h>
352 # endif
353 # include <signal.h>
354 # include <grp.h>
355 # include <glob.h>
356 #endif
357
358 #ifdef ELM_ALLOCA_H
359 # include <alloca.h>
360 #endif
361
362 #if defined (ELM_WIN32) || defined (ELM_WINCE)
363 # include <malloc.h>
364 # ifndef alloca
365 #  define alloca _alloca
366 # endif
367 #endif
368
369
370 /* EFL headers */
371 #include <Eina.h>
372 #include <Eet.h>
373 #include <Evas.h>
374 #include <Evas_GL.h>
375 #include <Ecore.h>
376 #include <Ecore_Evas.h>
377 #include <Ecore_File.h>
378 #include <Ecore_IMF.h>
379 #include <Ecore_Con.h>
380 #include <Edje.h>
381
382 #ifdef ELM_EDBUS
383 # include <E_DBus.h>
384 #endif
385
386 #ifdef ELM_EFREET
387 # include <Efreet.h>
388 # include <Efreet_Mime.h>
389 # include <Efreet_Trash.h>
390 #endif
391
392 #ifdef ELM_ETHUMB
393 # include <Ethumb_Client.h>
394 #endif
395
396 #ifdef ELM_EMAP
397 # include <EMap.h>
398 #endif
399
400 #ifdef EAPI
401 # undef EAPI
402 #endif
403
404 #ifdef _WIN32
405 # ifdef ELEMENTARY_BUILD
406 #  ifdef DLL_EXPORT
407 #   define EAPI __declspec(dllexport)
408 #  else
409 #   define EAPI
410 #  endif /* ! DLL_EXPORT */
411 # else
412 #  define EAPI __declspec(dllimport)
413 # endif /* ! EFL_EVAS_BUILD */
414 #else
415 # ifdef __GNUC__
416 #  if __GNUC__ >= 4
417 #   define EAPI __attribute__ ((visibility("default")))
418 #  else
419 #   define EAPI
420 #  endif
421 # else
422 #  define EAPI
423 # endif
424 #endif /* ! _WIN32 */
425
426 #ifdef _WIN32
427 # define EAPI_MAIN
428 #else
429 # define EAPI_MAIN EAPI
430 #endif
431
432 /* allow usage from c++ */
433 #ifdef __cplusplus
434 extern "C" {
435 #endif
436
437 #define ELM_VERSION_MAJOR @VMAJ@
438 #define ELM_VERSION_MINOR @VMIN@
439
440    typedef struct _Elm_Version
441      {
442         int major;
443         int minor;
444         int micro;
445         int revision;
446      } Elm_Version;
447
448    EAPI extern Elm_Version *elm_version;
449
450 /* handy macros */
451 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
452 #define ELM_PI 3.14159265358979323846
453
454    /**
455     * @defgroup General General
456     *
457     * @brief General Elementary API. Functions that don't relate to
458     * Elementary objects specifically.
459     *
460     * Here are documented functions which init/shutdown the library,
461     * that apply to generic Elementary objects, that deal with
462     * configuration, et cetera.
463     *
464     * @ref general_functions_example_page "This" example contemplates
465     * some of these functions.
466     */
467
468    /**
469     * @addtogroup General
470     * @{
471     */
472
473   /**
474    * Defines couple of standard Evas_Object layers to be used
475    * with evas_object_layer_set().
476    *
477    * @note whenever extending with new values, try to keep some padding
478    *       to siblings so there is room for further extensions.
479    */
480   typedef enum _Elm_Object_Layer
481     {
482        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
483        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
484        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
485        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
486        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
487        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
488     } Elm_Object_Layer;
489
490 /**************************************************************************/
491    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
492
493    /**
494     * Emitted when the application has reconfigured elementary settings due
495     * to an external configuration tool asking it to.
496     */
497    EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
498
499    /**
500     * Emitted when any Elementary's policy value is changed.
501     */
502    EAPI extern int ELM_EVENT_POLICY_CHANGED;
503
504    /**
505     * @typedef Elm_Event_Policy_Changed
506     *
507     * Data on the event when an Elementary policy has changed
508     */
509     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
510
511    /**
512     * @struct _Elm_Event_Policy_Changed
513     *
514     * Data on the event when an Elementary policy has changed
515     */
516     struct _Elm_Event_Policy_Changed
517      {
518         unsigned int policy; /**< the policy identifier */
519         int          new_value; /**< value the policy had before the change */
520         int          old_value; /**< new value the policy got */
521     };
522
523    /**
524     * Policy identifiers.
525     */
526     typedef enum _Elm_Policy
527     {
528         ELM_POLICY_QUIT, /**< under which circumstances the application
529                           * should quit automatically. @see
530                           * Elm_Policy_Quit.
531                           */
532         ELM_POLICY_LAST
533     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
534  */
535
536    typedef enum _Elm_Policy_Quit
537      {
538         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
539                                    * automatically */
540         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
541                                             * application's last
542                                             * window is closed */
543      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
544
545    typedef enum _Elm_Focus_Direction
546      {
547         ELM_FOCUS_PREVIOUS,
548         ELM_FOCUS_NEXT
549      } Elm_Focus_Direction;
550
551    typedef enum _Elm_Text_Format
552      {
553         ELM_TEXT_FORMAT_PLAIN_UTF8,
554         ELM_TEXT_FORMAT_MARKUP_UTF8
555      } Elm_Text_Format;
556
557    /**
558     * Line wrapping types.
559     */
560    typedef enum _Elm_Wrap_Type
561      {
562         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
563         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
564         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
565         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
566         ELM_WRAP_LAST
567      } Elm_Wrap_Type;
568
569    typedef enum
570      {
571         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
572         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
573         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
574         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
575         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
576         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
577         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
578         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
579         ELM_INPUT_PANEL_LAYOUT_INVALID
580      } Elm_Input_Panel_Layout;
581
582    /**
583     * @typedef Elm_Object_Item
584     * An Elementary Object item handle.
585     * @ingroup General
586     */
587    typedef struct _Elm_Object_Item Elm_Object_Item;
588
589
590    /**
591     * Called back when a widget's tooltip is activated and needs content.
592     * @param data user-data given to elm_object_tooltip_content_cb_set()
593     * @param obj owner widget.
594     * @param tooltip The tooltip object (affix content to this!)
595     */
596    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
597
598    /**
599     * Called back when a widget's item tooltip is activated and needs content.
600     * @param data user-data given to elm_object_tooltip_content_cb_set()
601     * @param obj owner widget.
602     * @param tooltip The tooltip object (affix content to this!)
603     * @param item context dependent item. As an example, if tooltip was
604     *        set on Elm_List_Item, then it is of this type.
605     */
606    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
607
608    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
609
610 #ifndef ELM_LIB_QUICKLAUNCH
611 #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 */
612 #else
613 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
614 #endif
615
616 /**************************************************************************/
617    /* General calls */
618
619    /**
620     * Initialize Elementary
621     *
622     * @param[in] argc System's argument count value
623     * @param[in] argv System's pointer to array of argument strings
624     * @return The init counter value.
625     *
626     * This function initializes Elementary and increments a counter of
627     * the number of calls to it. It returns the new counter's value.
628     *
629     * @warning This call is exported only for use by the @c ELM_MAIN()
630     * macro. There is no need to use this if you use this macro (which
631     * is highly advisable). An elm_main() should contain the entry
632     * point code for your application, having the same prototype as
633     * elm_init(), and @b not being static (putting the @c EAPI symbol
634     * in front of its type declaration is advisable). The @c
635     * ELM_MAIN() call should be placed just after it.
636     *
637     * Example:
638     * @dontinclude bg_example_01.c
639     * @skip static void
640     * @until ELM_MAIN
641     *
642     * See the full @ref bg_example_01_c "example".
643     *
644     * @see elm_shutdown().
645     * @ingroup General
646     */
647    EAPI int          elm_init(int argc, char **argv);
648
649    /**
650     * Shut down Elementary
651     *
652     * @return The init counter value.
653     *
654     * This should be called at the end of your application, just
655     * before it ceases to do any more processing. This will clean up
656     * any permanent resources your application may have allocated via
657     * Elementary that would otherwise persist.
658     *
659     * @see elm_init() for an example
660     *
661     * @ingroup General
662     */
663    EAPI int          elm_shutdown(void);
664
665    /**
666     * Run Elementary's main loop
667     *
668     * This call should be issued just after all initialization is
669     * completed. This function will not return until elm_exit() is
670     * called. It will keep looping, running the main
671     * (event/processing) loop for Elementary.
672     *
673     * @see elm_init() for an example
674     *
675     * @ingroup General
676     */
677    EAPI void         elm_run(void);
678
679    /**
680     * Exit Elementary's main loop
681     *
682     * If this call is issued, it will flag the main loop to cease
683     * processing and return back to its parent function (usually your
684     * elm_main() function).
685     *
686     * @see elm_init() for an example. There, just after a request to
687     * close the window comes, the main loop will be left.
688     *
689     * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
690     * applications, you'll be able to get this function called automatically for you.
691     *
692     * @ingroup General
693     */
694    EAPI void         elm_exit(void);
695
696    /**
697     * Provide information in order to make Elementary determine the @b
698     * run time location of the software in question, so other data files
699     * such as images, sound files, executable utilities, libraries,
700     * modules and locale files can be found.
701     *
702     * @param mainfunc This is your application's main function name,
703     *        whose binary's location is to be found. Providing @c NULL
704     *        will make Elementary not to use it
705     * @param dom This will be used as the application's "domain", in the
706     *        form of a prefix to any environment variables that may
707     *        override prefix detection and the directory name, inside the
708     *        standard share or data directories, where the software's
709     *        data files will be looked for.
710     * @param checkfile This is an (optional) magic file's path to check
711     *        for existence (and it must be located in the data directory,
712     *        under the share directory provided above). Its presence will
713     *        help determine the prefix found was correct. Pass @c NULL if
714     *        the check is not to be done.
715     *
716     * This function allows one to re-locate the application somewhere
717     * else after compilation, if the developer wishes for easier
718     * distribution of pre-compiled binaries.
719     *
720     * The prefix system is designed to locate where the given software is
721     * installed (under a common path prefix) at run time and then report
722     * specific locations of this prefix and common directories inside
723     * this prefix like the binary, library, data and locale directories,
724     * through the @c elm_app_*_get() family of functions.
725     *
726     * Call elm_app_info_set() early on before you change working
727     * directory or anything about @c argv[0], so it gets accurate
728     * information.
729     *
730     * It will then try and trace back which file @p mainfunc comes from,
731     * if provided, to determine the application's prefix directory.
732     *
733     * The @p dom parameter provides a string prefix to prepend before
734     * environment variables, allowing a fallback to @b specific
735     * environment variables to locate the software. You would most
736     * probably provide a lowercase string there, because it will also
737     * serve as directory domain, explained next. For environment
738     * variables purposes, this string is made uppercase. For example if
739     * @c "myapp" is provided as the prefix, then the program would expect
740     * @c "MYAPP_PREFIX" as a master environment variable to specify the
741     * exact install prefix for the software, or more specific environment
742     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
743     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
744     * the user or scripts before launching. If not provided (@c NULL),
745     * environment variables will not be used to override compiled-in
746     * defaults or auto detections.
747     *
748     * The @p dom string also provides a subdirectory inside the system
749     * shared data directory for data files. For example, if the system
750     * directory is @c /usr/local/share, then this directory name is
751     * appended, creating @c /usr/local/share/myapp, if it @p was @c
752     * "myapp". It is expected that the application installs data files in
753     * this directory.
754     *
755     * The @p checkfile is a file name or path of something inside the
756     * share or data directory to be used to test that the prefix
757     * detection worked. For example, your app will install a wallpaper
758     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
759     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
760     * checkfile string.
761     *
762     * @see elm_app_compile_bin_dir_set()
763     * @see elm_app_compile_lib_dir_set()
764     * @see elm_app_compile_data_dir_set()
765     * @see elm_app_compile_locale_set()
766     * @see elm_app_prefix_dir_get()
767     * @see elm_app_bin_dir_get()
768     * @see elm_app_lib_dir_get()
769     * @see elm_app_data_dir_get()
770     * @see elm_app_locale_dir_get()
771     */
772    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
773
774    /**
775     * Provide information on the @b fallback application's binaries
776     * directory, in scenarios where they get overriden by
777     * elm_app_info_set().
778     *
779     * @param dir The path to the default binaries directory (compile time
780     * one)
781     *
782     * @note Elementary will as well use this path to determine actual
783     * names of binaries' directory paths, maybe changing it to be @c
784     * something/local/bin instead of @c something/bin, only, for
785     * example.
786     *
787     * @warning You should call this function @b before
788     * elm_app_info_set().
789     */
790    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
791
792    /**
793     * Provide information on the @b fallback application's libraries
794     * directory, on scenarios where they get overriden by
795     * elm_app_info_set().
796     *
797     * @param dir The path to the default libraries directory (compile
798     * time one)
799     *
800     * @note Elementary will as well use this path to determine actual
801     * names of libraries' directory paths, maybe changing it to be @c
802     * something/lib32 or @c something/lib64 instead of @c something/lib,
803     * only, for example.
804     *
805     * @warning You should call this function @b before
806     * elm_app_info_set().
807     */
808    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
809
810    /**
811     * Provide information on the @b fallback application's data
812     * directory, on scenarios where they get overriden by
813     * elm_app_info_set().
814     *
815     * @param dir The path to the default data directory (compile time
816     * one)
817     *
818     * @note Elementary will as well use this path to determine actual
819     * names of data directory paths, maybe changing it to be @c
820     * something/local/share instead of @c something/share, only, for
821     * example.
822     *
823     * @warning You should call this function @b before
824     * elm_app_info_set().
825     */
826    EAPI void         elm_app_compile_data_dir_set(const char *dir);
827
828    /**
829     * Provide information on the @b fallback application's locale
830     * directory, on scenarios where they get overriden by
831     * elm_app_info_set().
832     *
833     * @param dir The path to the default locale directory (compile time
834     * one)
835     *
836     * @warning You should call this function @b before
837     * elm_app_info_set().
838     */
839    EAPI void         elm_app_compile_locale_set(const char *dir);
840
841    /**
842     * Retrieve the application's run time prefix directory, as set by
843     * elm_app_info_set() and the way (environment) the application was
844     * run from.
845     *
846     * @return The directory prefix the application is actually using.
847     */
848    EAPI const char  *elm_app_prefix_dir_get(void);
849
850    /**
851     * Retrieve the application's run time binaries prefix directory, as
852     * set by elm_app_info_set() and the way (environment) the application
853     * was run from.
854     *
855     * @return The binaries directory prefix the application is actually
856     * using.
857     */
858    EAPI const char  *elm_app_bin_dir_get(void);
859
860    /**
861     * Retrieve the application's run time libraries prefix directory, as
862     * set by elm_app_info_set() and the way (environment) the application
863     * was run from.
864     *
865     * @return The libraries directory prefix the application is actually
866     * using.
867     */
868    EAPI const char  *elm_app_lib_dir_get(void);
869
870    /**
871     * Retrieve the application's run time data prefix directory, as
872     * set by elm_app_info_set() and the way (environment) the application
873     * was run from.
874     *
875     * @return The data directory prefix the application is actually
876     * using.
877     */
878    EAPI const char  *elm_app_data_dir_get(void);
879
880    /**
881     * Retrieve the application's run time locale prefix directory, as
882     * set by elm_app_info_set() and the way (environment) the application
883     * was run from.
884     *
885     * @return The locale directory prefix the application is actually
886     * using.
887     */
888    EAPI const char  *elm_app_locale_dir_get(void);
889
890    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
891    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
892    EAPI int          elm_quicklaunch_init(int argc, char **argv);
893    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
894    EAPI int          elm_quicklaunch_sub_shutdown(void);
895    EAPI int          elm_quicklaunch_shutdown(void);
896    EAPI void         elm_quicklaunch_seed(void);
897    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
898    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
899    EAPI void         elm_quicklaunch_cleanup(void);
900    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
901    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
902
903    EAPI Eina_Bool    elm_need_efreet(void);
904    EAPI Eina_Bool    elm_need_e_dbus(void);
905
906    /**
907     * This must be called before any other function that deals with
908     * elm_thumb objects or ethumb_client instances.
909     *
910     * @ingroup Thumb
911     */
912    EAPI Eina_Bool    elm_need_ethumb(void);
913
914    /**
915     * This must be called before any other function that deals with
916     * elm_web objects or ewk_view instances.
917     *
918     * @ingroup Web
919     */
920    EAPI Eina_Bool    elm_need_web(void);
921
922    /**
923     * Set a new policy's value (for a given policy group/identifier).
924     *
925     * @param policy policy identifier, as in @ref Elm_Policy.
926     * @param value policy value, which depends on the identifier
927     *
928     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
929     *
930     * Elementary policies define applications' behavior,
931     * somehow. These behaviors are divided in policy groups (see
932     * #Elm_Policy enumeration). This call will emit the Ecore event
933     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
934     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
935     * then.
936     *
937     * @note Currently, we have only one policy identifier/group
938     * (#ELM_POLICY_QUIT), which has two possible values.
939     *
940     * @ingroup General
941     */
942    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
943
944    /**
945     * Gets the policy value for given policy identifier.
946     *
947     * @param policy policy identifier, as in #Elm_Policy.
948     * @return The currently set policy value, for that
949     * identifier. Will be @c 0 if @p policy passed is invalid.
950     *
951     * @ingroup General
952     */
953    EAPI int          elm_policy_get(unsigned int policy);
954
955    /**
956     * Change the language of the current application
957     *
958     * The @p lang passed must be the full name of the locale to use, for
959     * example "en_US.utf8" or "es_ES@euro".
960     *
961     * Changing language with this function will make Elementary run through
962     * all its widgets, translating strings set with
963     * elm_object_domain_translatable_text_part_set(). This way, an entire
964     * UI can have its language changed without having to restart the program.
965     *
966     * For more complex cases, like having formatted strings that need
967     * translation, widgets will also emit a "language,changed" signal that
968     * the user can listen to to manually translate the text.
969     *
970     * @param lang Language to set, must be the full name of the locale
971     *
972     * @ingroup General
973     */
974    EAPI void         elm_language_set(const char *lang);
975
976    /**
977     * Set a label of an object
978     *
979     * @param obj The Elementary object
980     * @param part The text part name to set (NULL for the default label)
981     * @param label The new text of the label
982     *
983     * @note Elementary objects may have many labels (e.g. Action Slider)
984     *
985     * @ingroup General
986     */
987    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
988
989 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
990
991    /**
992     * Get a label of an object
993     *
994     * @param obj The Elementary object
995     * @param part The text part name to get (NULL for the default label)
996     * @return text of the label or NULL for any error
997     *
998     * @note Elementary objects may have many labels (e.g. Action Slider)
999     *
1000     * @ingroup General
1001     */
1002    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1003
1004 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
1005
1006    /**
1007     * Set the text for an objects' part, marking it as translatable.
1008     *
1009     * The string to set as @p text must be the original one. Do not pass the
1010     * return of @c gettext() here. Elementary will translate the string
1011     * internally and set it on the object using elm_object_text_part_set(),
1012     * also storing the original string so that it can be automatically
1013     * translated when the language is changed with elm_language_set().
1014     *
1015     * The @p domain will be stored along to find the translation in the
1016     * correct catalog. It can be NULL, in which case it will use whatever
1017     * domain was set by the application with @c textdomain(). This is useful
1018     * in case you are building a library on top of Elementary that will have
1019     * its own translatable strings, that should not be mixed with those of
1020     * programs using the library.
1021     *
1022     * @param obj The object containing the text part
1023     * @param part The name of the part to set
1024     * @param domain The translation domain to use
1025     * @param text The original, non-translated text to set
1026     *
1027     * @ingroup General
1028     */
1029    EAPI void         elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1030
1031 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1032
1033 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1034
1035    /**
1036     * Gets the original string set as translatable for an object
1037     *
1038     * When setting translated strings, the function elm_object_text_part_get()
1039     * will return the translation returned by @c gettext(). To get the
1040     * original string use this function.
1041     *
1042     * @param obj The object
1043     * @param part The name of the part that was set
1044     *
1045     * @return The original, untranslated string
1046     *
1047     * @ingroup General
1048     */
1049    EAPI const char  *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1050
1051 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1052
1053    /**
1054     * Set a content of an object
1055     *
1056     * @param obj The Elementary object
1057     * @param part The content part name to set (NULL for the default content)
1058     * @param content The new content of the object
1059     *
1060     * @note Elementary objects may have many contents
1061     *
1062     * @ingroup General
1063     */
1064    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1065
1066 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
1067
1068    /**
1069     * Get a content of an object
1070     *
1071     * @param obj The Elementary object
1072     * @param item The content part name to get (NULL for the default content)
1073     * @return content of the object or NULL for any error
1074     *
1075     * @note Elementary objects may have many contents
1076     *
1077     * @ingroup General
1078     */
1079    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1080
1081 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1082
1083    /**
1084     * Unset a content of an object
1085     *
1086     * @param obj The Elementary object
1087     * @param item The content part name to unset (NULL for the default content)
1088     *
1089     * @note Elementary objects may have many contents
1090     *
1091     * @ingroup General
1092     */
1093    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1094
1095 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1096
1097    /**
1098     * Get the widget object's handle which contains a given item
1099     *
1100     * @param item The Elementary object item
1101     * @return The widget object
1102     *
1103     * @note This returns the widget object itself that an item belongs to.
1104     *
1105     * @ingroup General
1106     */
1107    EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1108
1109    /**
1110     * Set a content of an object item
1111     *
1112     * @param it The Elementary object item
1113     * @param part The content part name to set (NULL for the default content)
1114     * @param content The new content of the object item
1115     *
1116     * @note Elementary object items may have many contents
1117     *
1118     * @ingroup General
1119     */
1120    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1121
1122 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1123
1124    /**
1125     * Get a content of an object item
1126     *
1127     * @param it The Elementary object item
1128     * @param part The content part name to unset (NULL for the default content)
1129     * @return content of the object item or NULL for any error
1130     *
1131     * @note Elementary object items may have many contents
1132     *
1133     * @ingroup General
1134     */
1135    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1136
1137 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1138
1139    /**
1140     * Unset a content of an object item
1141     *
1142     * @param it The Elementary object item
1143     * @param part The content part name to unset (NULL for the default content)
1144     *
1145     * @note Elementary object items may have many contents
1146     *
1147     * @ingroup General
1148     */
1149    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1150
1151 #define elm_object_item_content_unset(it) elm_object_item_content_part_unset((it), NULL)
1152
1153    /**
1154     * Set a label of an object item
1155     *
1156     * @param it The Elementary object item
1157     * @param part The text part name to set (NULL for the default label)
1158     * @param label The new text of the label
1159     *
1160     * @note Elementary object items may have many labels
1161     *
1162     * @ingroup General
1163     */
1164    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1165
1166 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1167
1168    /**
1169     * Get a label of an object item
1170     *
1171     * @param it The Elementary object item
1172     * @param part The text part name to get (NULL for the default label)
1173     * @return text of the label or NULL for any error
1174     *
1175     * @note Elementary object items may have many labels
1176     *
1177     * @ingroup General
1178     */
1179    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1180
1181 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1182
1183    /**
1184     * Set the text to read out when in accessibility mode
1185     *
1186     * @param obj The object which is to be described
1187     * @param txt The text that describes the widget to people with poor or no vision
1188     *
1189     * @ingroup General
1190     */
1191    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1192
1193    /**
1194     * Set the text to read out when in accessibility mode
1195     *
1196     * @param it The object item which is to be described
1197     * @param txt The text that describes the widget to people with poor or no vision
1198     *
1199     * @ingroup General
1200     */
1201    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1202
1203    /**
1204     * Get the data associated with an object item
1205     * @param it The object item
1206     * @return The data associated with @p it
1207     *
1208     * @ingroup General
1209     */
1210    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1211
1212    /**
1213     * Set the data associated with an object item
1214     * @param it The object item
1215     * @param data The data to be associated with @p it
1216     *
1217     * @ingroup General
1218     */
1219    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1220
1221    /**
1222     * Send a signal to the edje object of the widget item.
1223     *
1224     * This function sends a signal to the edje object of the obj item. An
1225     * edje program can respond to a signal by specifying matching
1226     * 'signal' and 'source' fields.
1227     *
1228     * @param it The Elementary object item
1229     * @param emission The signal's name.
1230     * @param source The signal's source.
1231     * @ingroup General
1232     */
1233    EAPI void             elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1234
1235    /**
1236     * @}
1237     */
1238
1239    /**
1240     * @defgroup Caches Caches
1241     *
1242     * These are functions which let one fine-tune some cache values for
1243     * Elementary applications, thus allowing for performance adjustments.
1244     *
1245     * @{
1246     */
1247
1248    /**
1249     * @brief Flush all caches.
1250     *
1251     * Frees all data that was in cache and is not currently being used to reduce
1252     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1253     * to calling all of the following functions:
1254     * @li edje_file_cache_flush()
1255     * @li edje_collection_cache_flush()
1256     * @li eet_clearcache()
1257     * @li evas_image_cache_flush()
1258     * @li evas_font_cache_flush()
1259     * @li evas_render_dump()
1260     * @note Evas caches are flushed for every canvas associated with a window.
1261     *
1262     * @ingroup Caches
1263     */
1264    EAPI void         elm_all_flush(void);
1265
1266    /**
1267     * Get the configured cache flush interval time
1268     *
1269     * This gets the globally configured cache flush interval time, in
1270     * ticks
1271     *
1272     * @return The cache flush interval time
1273     * @ingroup Caches
1274     *
1275     * @see elm_all_flush()
1276     */
1277    EAPI int          elm_cache_flush_interval_get(void);
1278
1279    /**
1280     * Set the configured cache flush interval time
1281     *
1282     * This sets the globally configured cache flush interval time, in ticks
1283     *
1284     * @param size The cache flush interval time
1285     * @ingroup Caches
1286     *
1287     * @see elm_all_flush()
1288     */
1289    EAPI void         elm_cache_flush_interval_set(int size);
1290
1291    /**
1292     * Set the configured cache flush interval time for all applications on the
1293     * display
1294     *
1295     * This sets the globally configured cache flush interval time -- in ticks
1296     * -- for all applications on the display.
1297     *
1298     * @param size The cache flush interval time
1299     * @ingroup Caches
1300     */
1301    EAPI void         elm_cache_flush_interval_all_set(int size);
1302
1303    /**
1304     * Get the configured cache flush enabled state
1305     *
1306     * This gets the globally configured cache flush state - if it is enabled
1307     * or not. When cache flushing is enabled, elementary will regularly
1308     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1309     * memory and allow usage to re-seed caches and data in memory where it
1310     * can do so. An idle application will thus minimise its memory usage as
1311     * data will be freed from memory and not be re-loaded as it is idle and
1312     * not rendering or doing anything graphically right now.
1313     *
1314     * @return The cache flush state
1315     * @ingroup Caches
1316     *
1317     * @see elm_all_flush()
1318     */
1319    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1320
1321    /**
1322     * Set the configured cache flush enabled state
1323     *
1324     * This sets the globally configured cache flush enabled state.
1325     *
1326     * @param size The cache flush enabled state
1327     * @ingroup Caches
1328     *
1329     * @see elm_all_flush()
1330     */
1331    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1332
1333    /**
1334     * Set the configured cache flush enabled state for all applications on the
1335     * display
1336     *
1337     * This sets the globally configured cache flush enabled state for all
1338     * applications on the display.
1339     *
1340     * @param size The cache flush enabled state
1341     * @ingroup Caches
1342     */
1343    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1344
1345    /**
1346     * Get the configured font cache size
1347     *
1348     * This gets the globally configured font cache size, in bytes.
1349     *
1350     * @return The font cache size
1351     * @ingroup Caches
1352     */
1353    EAPI int          elm_font_cache_get(void);
1354
1355    /**
1356     * Set the configured font cache size
1357     *
1358     * This sets the globally configured font cache size, in bytes
1359     *
1360     * @param size The font cache size
1361     * @ingroup Caches
1362     */
1363    EAPI void         elm_font_cache_set(int size);
1364
1365    /**
1366     * Set the configured font cache size for all applications on the
1367     * display
1368     *
1369     * This sets the globally configured font cache size -- in bytes
1370     * -- for all applications on the display.
1371     *
1372     * @param size The font cache size
1373     * @ingroup Caches
1374     */
1375    EAPI void         elm_font_cache_all_set(int size);
1376
1377    /**
1378     * Get the configured image cache size
1379     *
1380     * This gets the globally configured image cache size, in bytes
1381     *
1382     * @return The image cache size
1383     * @ingroup Caches
1384     */
1385    EAPI int          elm_image_cache_get(void);
1386
1387    /**
1388     * Set the configured image cache size
1389     *
1390     * This sets the globally configured image cache size, in bytes
1391     *
1392     * @param size The image cache size
1393     * @ingroup Caches
1394     */
1395    EAPI void         elm_image_cache_set(int size);
1396
1397    /**
1398     * Set the configured image cache size for all applications on the
1399     * display
1400     *
1401     * This sets the globally configured image cache size -- in bytes
1402     * -- for all applications on the display.
1403     *
1404     * @param size The image cache size
1405     * @ingroup Caches
1406     */
1407    EAPI void         elm_image_cache_all_set(int size);
1408
1409    /**
1410     * Get the configured edje file cache size.
1411     *
1412     * This gets the globally configured edje file cache size, in number
1413     * of files.
1414     *
1415     * @return The edje file cache size
1416     * @ingroup Caches
1417     */
1418    EAPI int          elm_edje_file_cache_get(void);
1419
1420    /**
1421     * Set the configured edje file cache size
1422     *
1423     * This sets the globally configured edje file cache size, in number
1424     * of files.
1425     *
1426     * @param size The edje file cache size
1427     * @ingroup Caches
1428     */
1429    EAPI void         elm_edje_file_cache_set(int size);
1430
1431    /**
1432     * Set the configured edje file cache size for all applications on the
1433     * display
1434     *
1435     * This sets the globally configured edje file cache size -- in number
1436     * of files -- for all applications on the display.
1437     *
1438     * @param size The edje file cache size
1439     * @ingroup Caches
1440     */
1441    EAPI void         elm_edje_file_cache_all_set(int size);
1442
1443    /**
1444     * Get the configured edje collections (groups) cache size.
1445     *
1446     * This gets the globally configured edje collections cache size, in
1447     * number of collections.
1448     *
1449     * @return The edje collections cache size
1450     * @ingroup Caches
1451     */
1452    EAPI int          elm_edje_collection_cache_get(void);
1453
1454    /**
1455     * Set the configured edje collections (groups) cache size
1456     *
1457     * This sets the globally configured edje collections cache size, in
1458     * number of collections.
1459     *
1460     * @param size The edje collections cache size
1461     * @ingroup Caches
1462     */
1463    EAPI void         elm_edje_collection_cache_set(int size);
1464
1465    /**
1466     * Set the configured edje collections (groups) cache size for all
1467     * applications on the display
1468     *
1469     * This sets the globally configured edje collections cache size -- in
1470     * number of collections -- for all applications on the display.
1471     *
1472     * @param size The edje collections cache size
1473     * @ingroup Caches
1474     */
1475    EAPI void         elm_edje_collection_cache_all_set(int size);
1476
1477    /**
1478     * @}
1479     */
1480
1481    /**
1482     * @defgroup Scaling Widget Scaling
1483     *
1484     * Different widgets can be scaled independently. These functions
1485     * allow you to manipulate this scaling on a per-widget basis. The
1486     * object and all its children get their scaling factors multiplied
1487     * by the scale factor set. This is multiplicative, in that if a
1488     * child also has a scale size set it is in turn multiplied by its
1489     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1490     * double size, @c 0.5 is half, etc.
1491     *
1492     * @ref general_functions_example_page "This" example contemplates
1493     * some of these functions.
1494     */
1495
1496    /**
1497     * Get the global scaling factor
1498     *
1499     * This gets the globally configured scaling factor that is applied to all
1500     * objects.
1501     *
1502     * @return The scaling factor
1503     * @ingroup Scaling
1504     */
1505    EAPI double       elm_scale_get(void);
1506
1507    /**
1508     * Set the global scaling factor
1509     *
1510     * This sets the globally configured scaling factor that is applied to all
1511     * objects.
1512     *
1513     * @param scale The scaling factor to set
1514     * @ingroup Scaling
1515     */
1516    EAPI void         elm_scale_set(double scale);
1517
1518    /**
1519     * Set the global scaling factor for all applications on the display
1520     *
1521     * This sets the globally configured scaling factor that is applied to all
1522     * objects for all applications.
1523     * @param scale The scaling factor to set
1524     * @ingroup Scaling
1525     */
1526    EAPI void         elm_scale_all_set(double scale);
1527
1528    /**
1529     * Set the scaling factor for a given Elementary object
1530     *
1531     * @param obj The Elementary to operate on
1532     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1533     * no scaling)
1534     *
1535     * @ingroup Scaling
1536     */
1537    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1538
1539    /**
1540     * Get the scaling factor for a given Elementary object
1541     *
1542     * @param obj The object
1543     * @return The scaling factor set by elm_object_scale_set()
1544     *
1545     * @ingroup Scaling
1546     */
1547    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1548
1549    /**
1550     * @defgroup Password_last_show Password last input show
1551     *
1552     * Last show feature of password mode enables user to view
1553     * the last input entered for few seconds before masking it.
1554     * These functions allow to set this feature in password mode
1555     * of entry widget and also allow to manipulate the duration
1556     * for which the input has to be visible.
1557     *
1558     * @{
1559     */
1560
1561    /**
1562     * Get show last setting of password mode.
1563     *
1564     * This gets the show last input setting of password mode which might be
1565     * enabled or disabled.
1566     *
1567     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1568     *            if it's disabled.
1569     * @ingroup Password_last_show
1570     */
1571    EAPI Eina_Bool elm_password_show_last_get(void);
1572
1573    /**
1574     * Set show last setting in password mode.
1575     *
1576     * This enables or disables show last setting of password mode.
1577     *
1578     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1579     * @see elm_password_show_last_timeout_set()
1580     * @ingroup Password_last_show
1581     */
1582    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1583
1584    /**
1585     * Get's the timeout value in last show password mode.
1586     *
1587     * This gets the time out value for which the last input entered in password
1588     * mode will be visible.
1589     *
1590     * @return The timeout value of last show password mode.
1591     * @ingroup Password_last_show
1592     */
1593    EAPI double elm_password_show_last_timeout_get(void);
1594
1595    /**
1596     * Set's the timeout value in last show password mode.
1597     *
1598     * This sets the time out value for which the last input entered in password
1599     * mode will be visible.
1600     *
1601     * @param password_show_last_timeout The timeout value.
1602     * @see elm_password_show_last_set()
1603     * @ingroup Password_last_show
1604     */
1605    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1606
1607    /**
1608     * @}
1609     */
1610
1611    /**
1612     * @defgroup UI-Mirroring Selective Widget mirroring
1613     *
1614     * These functions allow you to set ui-mirroring on specific
1615     * widgets or the whole interface. Widgets can be in one of two
1616     * modes, automatic and manual.  Automatic means they'll be changed
1617     * according to the system mirroring mode and manual means only
1618     * explicit changes will matter. You are not supposed to change
1619     * mirroring state of a widget set to automatic, will mostly work,
1620     * but the behavior is not really defined.
1621     *
1622     * @{
1623     */
1624
1625    EAPI Eina_Bool    elm_mirrored_get(void);
1626    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1627
1628    /**
1629     * Get the system mirrored mode. This determines the default mirrored mode
1630     * of widgets.
1631     *
1632     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1633     */
1634    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1635
1636    /**
1637     * Set the system mirrored mode. This determines the default mirrored mode
1638     * of widgets.
1639     *
1640     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1641     */
1642    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1643
1644    /**
1645     * Returns the widget's mirrored mode setting.
1646     *
1647     * @param obj The widget.
1648     * @return mirrored mode setting of the object.
1649     *
1650     **/
1651    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1652
1653    /**
1654     * Sets the widget's mirrored mode setting.
1655     * When widget in automatic mode, it follows the system mirrored mode set by
1656     * elm_mirrored_set().
1657     * @param obj The widget.
1658     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1659     */
1660    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1661
1662    /**
1663     * @}
1664     */
1665
1666    /**
1667     * Set the style to use by a widget
1668     *
1669     * Sets the style name that will define the appearance of a widget. Styles
1670     * vary from widget to widget and may also be defined by other themes
1671     * by means of extensions and overlays.
1672     *
1673     * @param obj The Elementary widget to style
1674     * @param style The style name to use
1675     *
1676     * @see elm_theme_extension_add()
1677     * @see elm_theme_extension_del()
1678     * @see elm_theme_overlay_add()
1679     * @see elm_theme_overlay_del()
1680     *
1681     * @ingroup Styles
1682     */
1683    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1684    /**
1685     * Get the style used by the widget
1686     *
1687     * This gets the style being used for that widget. Note that the string
1688     * pointer is only valid as longas the object is valid and the style doesn't
1689     * change.
1690     *
1691     * @param obj The Elementary widget to query for its style
1692     * @return The style name used
1693     *
1694     * @see elm_object_style_set()
1695     *
1696     * @ingroup Styles
1697     */
1698    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1699
1700    /**
1701     * @defgroup Styles Styles
1702     *
1703     * Widgets can have different styles of look. These generic API's
1704     * set styles of widgets, if they support them (and if the theme(s)
1705     * do).
1706     *
1707     * @ref general_functions_example_page "This" example contemplates
1708     * some of these functions.
1709     */
1710
1711    /**
1712     * Set the disabled state of an Elementary object.
1713     *
1714     * @param obj The Elementary object to operate on
1715     * @param disabled The state to put in in: @c EINA_TRUE for
1716     *        disabled, @c EINA_FALSE for enabled
1717     *
1718     * Elementary objects can be @b disabled, in which state they won't
1719     * receive input and, in general, will be themed differently from
1720     * their normal state, usually greyed out. Useful for contexts
1721     * where you don't want your users to interact with some of the
1722     * parts of you interface.
1723     *
1724     * This sets the state for the widget, either disabling it or
1725     * enabling it back.
1726     *
1727     * @ingroup Styles
1728     */
1729    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1730
1731    /**
1732     * Get the disabled state of an Elementary object.
1733     *
1734     * @param obj The Elementary object to operate on
1735     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1736     *            if it's enabled (or on errors)
1737     *
1738     * This gets the state of the widget, which might be enabled or disabled.
1739     *
1740     * @ingroup Styles
1741     */
1742    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1743
1744    /**
1745     * @defgroup WidgetNavigation Widget Tree Navigation.
1746     *
1747     * How to check if an Evas Object is an Elementary widget? How to
1748     * get the first elementary widget that is parent of the given
1749     * object?  These are all covered in widget tree navigation.
1750     *
1751     * @ref general_functions_example_page "This" example contemplates
1752     * some of these functions.
1753     */
1754
1755    /**
1756     * Check if the given Evas Object is an Elementary widget.
1757     *
1758     * @param obj the object to query.
1759     * @return @c EINA_TRUE if it is an elementary widget variant,
1760     *         @c EINA_FALSE otherwise
1761     * @ingroup WidgetNavigation
1762     */
1763    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1764
1765    /**
1766     * Get the first parent of the given object that is an Elementary
1767     * widget.
1768     *
1769     * @param obj the Elementary object to query parent from.
1770     * @return the parent object that is an Elementary widget, or @c
1771     *         NULL, if it was not found.
1772     *
1773     * Use this to query for an object's parent widget.
1774     *
1775     * @note Most of Elementary users wouldn't be mixing non-Elementary
1776     * smart objects in the objects tree of an application, as this is
1777     * an advanced usage of Elementary with Evas. So, except for the
1778     * application's window, which is the root of that tree, all other
1779     * objects would have valid Elementary widget parents.
1780     *
1781     * @ingroup WidgetNavigation
1782     */
1783    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1784
1785    /**
1786     * Get the top level parent of an Elementary widget.
1787     *
1788     * @param obj The object to query.
1789     * @return The top level Elementary widget, or @c NULL if parent cannot be
1790     * found.
1791     * @ingroup WidgetNavigation
1792     */
1793    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1794
1795    /**
1796     * Get the string that represents this Elementary widget.
1797     *
1798     * @note Elementary is weird and exposes itself as a single
1799     *       Evas_Object_Smart_Class of type "elm_widget", so
1800     *       evas_object_type_get() always return that, making debug and
1801     *       language bindings hard. This function tries to mitigate this
1802     *       problem, but the solution is to change Elementary to use
1803     *       proper inheritance.
1804     *
1805     * @param obj the object to query.
1806     * @return Elementary widget name, or @c NULL if not a valid widget.
1807     * @ingroup WidgetNavigation
1808     */
1809    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1810
1811    /**
1812     * @defgroup Config Elementary Config
1813     *
1814     * Elementary configuration is formed by a set options bounded to a
1815     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1816     * "finger size", etc. These are functions with which one syncronizes
1817     * changes made to those values to the configuration storing files, de
1818     * facto. You most probably don't want to use the functions in this
1819     * group unlees you're writing an elementary configuration manager.
1820     *
1821     * @{
1822     */
1823
1824    /**
1825     * Save back Elementary's configuration, so that it will persist on
1826     * future sessions.
1827     *
1828     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1829     * @ingroup Config
1830     *
1831     * This function will take effect -- thus, do I/O -- immediately. Use
1832     * it when you want to apply all configuration changes at once. The
1833     * current configuration set will get saved onto the current profile
1834     * configuration file.
1835     *
1836     */
1837    EAPI Eina_Bool    elm_config_save(void);
1838
1839    /**
1840     * Reload Elementary's configuration, bounded to current selected
1841     * profile.
1842     *
1843     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1844     * @ingroup Config
1845     *
1846     * Useful when you want to force reloading of configuration values for
1847     * a profile. If one removes user custom configuration directories,
1848     * for example, it will force a reload with system values insted.
1849     *
1850     */
1851    EAPI void         elm_config_reload(void);
1852
1853    /**
1854     * @}
1855     */
1856
1857    /**
1858     * @defgroup Profile Elementary Profile
1859     *
1860     * Profiles are pre-set options that affect the whole look-and-feel of
1861     * Elementary-based applications. There are, for example, profiles
1862     * aimed at desktop computer applications and others aimed at mobile,
1863     * touchscreen-based ones. You most probably don't want to use the
1864     * functions in this group unlees you're writing an elementary
1865     * configuration manager.
1866     *
1867     * @{
1868     */
1869
1870    /**
1871     * Get Elementary's profile in use.
1872     *
1873     * This gets the global profile that is applied to all Elementary
1874     * applications.
1875     *
1876     * @return The profile's name
1877     * @ingroup Profile
1878     */
1879    EAPI const char  *elm_profile_current_get(void);
1880
1881    /**
1882     * Get an Elementary's profile directory path in the filesystem. One
1883     * may want to fetch a system profile's dir or an user one (fetched
1884     * inside $HOME).
1885     *
1886     * @param profile The profile's name
1887     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1888     *                or a system one (@c EINA_FALSE)
1889     * @return The profile's directory path.
1890     * @ingroup Profile
1891     *
1892     * @note You must free it with elm_profile_dir_free().
1893     */
1894    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1895
1896    /**
1897     * Free an Elementary's profile directory path, as returned by
1898     * elm_profile_dir_get().
1899     *
1900     * @param p_dir The profile's path
1901     * @ingroup Profile
1902     *
1903     */
1904    EAPI void         elm_profile_dir_free(const char *p_dir);
1905
1906    /**
1907     * Get Elementary's list of available profiles.
1908     *
1909     * @return The profiles list. List node data are the profile name
1910     *         strings.
1911     * @ingroup Profile
1912     *
1913     * @note One must free this list, after usage, with the function
1914     *       elm_profile_list_free().
1915     */
1916    EAPI Eina_List   *elm_profile_list_get(void);
1917
1918    /**
1919     * Free Elementary's list of available profiles.
1920     *
1921     * @param l The profiles list, as returned by elm_profile_list_get().
1922     * @ingroup Profile
1923     *
1924     */
1925    EAPI void         elm_profile_list_free(Eina_List *l);
1926
1927    /**
1928     * Set Elementary's profile.
1929     *
1930     * This sets the global profile that is applied to Elementary
1931     * applications. Just the process the call comes from will be
1932     * affected.
1933     *
1934     * @param profile The profile's name
1935     * @ingroup Profile
1936     *
1937     */
1938    EAPI void         elm_profile_set(const char *profile);
1939
1940    /**
1941     * Set Elementary's profile.
1942     *
1943     * This sets the global profile that is applied to all Elementary
1944     * applications. All running Elementary windows will be affected.
1945     *
1946     * @param profile The profile's name
1947     * @ingroup Profile
1948     *
1949     */
1950    EAPI void         elm_profile_all_set(const char *profile);
1951
1952    /**
1953     * @}
1954     */
1955
1956    /**
1957     * @defgroup Engine Elementary Engine
1958     *
1959     * These are functions setting and querying which rendering engine
1960     * Elementary will use for drawing its windows' pixels.
1961     *
1962     * The following are the available engines:
1963     * @li "software_x11"
1964     * @li "fb"
1965     * @li "directfb"
1966     * @li "software_16_x11"
1967     * @li "software_8_x11"
1968     * @li "xrender_x11"
1969     * @li "opengl_x11"
1970     * @li "software_gdi"
1971     * @li "software_16_wince_gdi"
1972     * @li "sdl"
1973     * @li "software_16_sdl"
1974     * @li "opengl_sdl"
1975     * @li "buffer"
1976     * @li "ews"
1977     *
1978     * @{
1979     */
1980
1981    /**
1982     * @brief Get Elementary's rendering engine in use.
1983     *
1984     * @return The rendering engine's name
1985     * @note there's no need to free the returned string, here.
1986     *
1987     * This gets the global rendering engine that is applied to all Elementary
1988     * applications.
1989     *
1990     * @see elm_engine_set()
1991     */
1992    EAPI const char  *elm_engine_current_get(void);
1993
1994    /**
1995     * @brief Set Elementary's rendering engine for use.
1996     *
1997     * @param engine The rendering engine's name
1998     *
1999     * This sets global rendering engine that is applied to all Elementary
2000     * applications. Note that it will take effect only to Elementary windows
2001     * created after this is called.
2002     *
2003     * @see elm_win_add()
2004     */
2005    EAPI void         elm_engine_set(const char *engine);
2006
2007    /**
2008     * @}
2009     */
2010
2011    /**
2012     * @defgroup Fonts Elementary Fonts
2013     *
2014     * These are functions dealing with font rendering, selection and the
2015     * like for Elementary applications. One might fetch which system
2016     * fonts are there to use and set custom fonts for individual classes
2017     * of UI items containing text (text classes).
2018     *
2019     * @{
2020     */
2021
2022   typedef struct _Elm_Text_Class
2023     {
2024        const char *name;
2025        const char *desc;
2026     } Elm_Text_Class;
2027
2028   typedef struct _Elm_Font_Overlay
2029     {
2030        const char     *text_class;
2031        const char     *font;
2032        Evas_Font_Size  size;
2033     } Elm_Font_Overlay;
2034
2035   typedef struct _Elm_Font_Properties
2036     {
2037        const char *name;
2038        Eina_List  *styles;
2039     } Elm_Font_Properties;
2040
2041    /**
2042     * Get Elementary's list of supported text classes.
2043     *
2044     * @return The text classes list, with @c Elm_Text_Class blobs as data.
2045     * @ingroup Fonts
2046     *
2047     * Release the list with elm_text_classes_list_free().
2048     */
2049    EAPI const Eina_List     *elm_text_classes_list_get(void);
2050
2051    /**
2052     * Free Elementary's list of supported text classes.
2053     *
2054     * @ingroup Fonts
2055     *
2056     * @see elm_text_classes_list_get().
2057     */
2058    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
2059
2060    /**
2061     * Get Elementary's list of font overlays, set with
2062     * elm_font_overlay_set().
2063     *
2064     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2065     * data.
2066     *
2067     * @ingroup Fonts
2068     *
2069     * For each text class, one can set a <b>font overlay</b> for it,
2070     * overriding the default font properties for that class coming from
2071     * the theme in use. There is no need to free this list.
2072     *
2073     * @see elm_font_overlay_set() and elm_font_overlay_unset().
2074     */
2075    EAPI const Eina_List     *elm_font_overlay_list_get(void);
2076
2077    /**
2078     * Set a font overlay for a given Elementary text class.
2079     *
2080     * @param text_class Text class name
2081     * @param font Font name and style string
2082     * @param size Font size
2083     *
2084     * @ingroup Fonts
2085     *
2086     * @p font has to be in the format returned by
2087     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2088     * and elm_font_overlay_unset().
2089     */
2090    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2091
2092    /**
2093     * Unset a font overlay for a given Elementary text class.
2094     *
2095     * @param text_class Text class name
2096     *
2097     * @ingroup Fonts
2098     *
2099     * This will bring back text elements belonging to text class
2100     * @p text_class back to their default font settings.
2101     */
2102    EAPI void                 elm_font_overlay_unset(const char *text_class);
2103
2104    /**
2105     * Apply the changes made with elm_font_overlay_set() and
2106     * elm_font_overlay_unset() on the current Elementary window.
2107     *
2108     * @ingroup Fonts
2109     *
2110     * This applies all font overlays set to all objects in the UI.
2111     */
2112    EAPI void                 elm_font_overlay_apply(void);
2113
2114    /**
2115     * Apply the changes made with elm_font_overlay_set() and
2116     * elm_font_overlay_unset() on all Elementary application windows.
2117     *
2118     * @ingroup Fonts
2119     *
2120     * This applies all font overlays set to all objects in the UI.
2121     */
2122    EAPI void                 elm_font_overlay_all_apply(void);
2123
2124    /**
2125     * Translate a font (family) name string in fontconfig's font names
2126     * syntax into an @c Elm_Font_Properties struct.
2127     *
2128     * @param font The font name and styles string
2129     * @return the font properties struct
2130     *
2131     * @ingroup Fonts
2132     *
2133     * @note The reverse translation can be achived with
2134     * elm_font_fontconfig_name_get(), for one style only (single font
2135     * instance, not family).
2136     */
2137    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2138
2139    /**
2140     * Free font properties return by elm_font_properties_get().
2141     *
2142     * @param efp the font properties struct
2143     *
2144     * @ingroup Fonts
2145     */
2146    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2147
2148    /**
2149     * Translate a font name, bound to a style, into fontconfig's font names
2150     * syntax.
2151     *
2152     * @param name The font (family) name
2153     * @param style The given style (may be @c NULL)
2154     *
2155     * @return the font name and style string
2156     *
2157     * @ingroup Fonts
2158     *
2159     * @note The reverse translation can be achived with
2160     * elm_font_properties_get(), for one style only (single font
2161     * instance, not family).
2162     */
2163    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2164
2165    /**
2166     * Free the font string return by elm_font_fontconfig_name_get().
2167     *
2168     * @param efp the font properties struct
2169     *
2170     * @ingroup Fonts
2171     */
2172    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2173
2174    /**
2175     * Create a font hash table of available system fonts.
2176     *
2177     * One must call it with @p list being the return value of
2178     * evas_font_available_list(). The hash will be indexed by font
2179     * (family) names, being its values @c Elm_Font_Properties blobs.
2180     *
2181     * @param list The list of available system fonts, as returned by
2182     * evas_font_available_list().
2183     * @return the font hash.
2184     *
2185     * @ingroup Fonts
2186     *
2187     * @note The user is supposed to get it populated at least with 3
2188     * default font families (Sans, Serif, Monospace), which should be
2189     * present on most systems.
2190     */
2191    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2192
2193    /**
2194     * Free the hash return by elm_font_available_hash_add().
2195     *
2196     * @param hash the hash to be freed.
2197     *
2198     * @ingroup Fonts
2199     */
2200    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2201
2202    /**
2203     * @}
2204     */
2205
2206    /**
2207     * @defgroup Fingers Fingers
2208     *
2209     * Elementary is designed to be finger-friendly for touchscreens,
2210     * and so in addition to scaling for display resolution, it can
2211     * also scale based on finger "resolution" (or size). You can then
2212     * customize the granularity of the areas meant to receive clicks
2213     * on touchscreens.
2214     *
2215     * Different profiles may have pre-set values for finger sizes.
2216     *
2217     * @ref general_functions_example_page "This" example contemplates
2218     * some of these functions.
2219     *
2220     * @{
2221     */
2222
2223    /**
2224     * Get the configured "finger size"
2225     *
2226     * @return The finger size
2227     *
2228     * This gets the globally configured finger size, <b>in pixels</b>
2229     *
2230     * @ingroup Fingers
2231     */
2232    EAPI Evas_Coord       elm_finger_size_get(void);
2233
2234    /**
2235     * Set the configured finger size
2236     *
2237     * This sets the globally configured finger size in pixels
2238     *
2239     * @param size The finger size
2240     * @ingroup Fingers
2241     */
2242    EAPI void             elm_finger_size_set(Evas_Coord size);
2243
2244    /**
2245     * Set the configured finger size for all applications on the display
2246     *
2247     * This sets the globally configured finger size in pixels for all
2248     * applications on the display
2249     *
2250     * @param size The finger size
2251     * @ingroup Fingers
2252     */
2253    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2254
2255    /**
2256     * @}
2257     */
2258
2259    /**
2260     * @defgroup Focus Focus
2261     *
2262     * An Elementary application has, at all times, one (and only one)
2263     * @b focused object. This is what determines where the input
2264     * events go to within the application's window. Also, focused
2265     * objects can be decorated differently, in order to signal to the
2266     * user where the input is, at a given moment.
2267     *
2268     * Elementary applications also have the concept of <b>focus
2269     * chain</b>: one can cycle through all the windows' focusable
2270     * objects by input (tab key) or programmatically. The default
2271     * focus chain for an application is the one define by the order in
2272     * which the widgets where added in code. One will cycle through
2273     * top level widgets, and, for each one containg sub-objects, cycle
2274     * through them all, before returning to the level
2275     * above. Elementary also allows one to set @b custom focus chains
2276     * for their applications.
2277     *
2278     * Besides the focused decoration a widget may exhibit, when it
2279     * gets focus, Elementary has a @b global focus highlight object
2280     * that can be enabled for a window. If one chooses to do so, this
2281     * extra highlight effect will surround the current focused object,
2282     * too.
2283     *
2284     * @note Some Elementary widgets are @b unfocusable, after
2285     * creation, by their very nature: they are not meant to be
2286     * interacted with input events, but are there just for visual
2287     * purposes.
2288     *
2289     * @ref general_functions_example_page "This" example contemplates
2290     * some of these functions.
2291     */
2292
2293    /**
2294     * Get the enable status of the focus highlight
2295     *
2296     * This gets whether the highlight on focused objects is enabled or not
2297     * @ingroup Focus
2298     */
2299    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2300
2301    /**
2302     * Set the enable status of the focus highlight
2303     *
2304     * Set whether to show or not the highlight on focused objects
2305     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2306     * @ingroup Focus
2307     */
2308    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2309
2310    /**
2311     * Get the enable status of the highlight animation
2312     *
2313     * Get whether the focus highlight, if enabled, will animate its switch from
2314     * one object to the next
2315     * @ingroup Focus
2316     */
2317    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2318
2319    /**
2320     * Set the enable status of the highlight animation
2321     *
2322     * Set whether the focus highlight, if enabled, will animate its switch from
2323     * one object to the next
2324     * @param animate Enable animation if EINA_TRUE, disable otherwise
2325     * @ingroup Focus
2326     */
2327    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2328
2329    /**
2330     * Get the whether an Elementary object has the focus or not.
2331     *
2332     * @param obj The Elementary object to get the information from
2333     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2334     *            not (and on errors).
2335     *
2336     * @see elm_object_focus_set()
2337     *
2338     * @ingroup Focus
2339     */
2340    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2341
2342    /**
2343     * Set/unset focus to a given Elementary object.
2344     *
2345     * @param obj The Elementary object to operate on.
2346     * @param enable @c EINA_TRUE Set focus to a given object,
2347     *               @c EINA_FALSE Unset focus to a given object.
2348     *
2349     * @note When you set focus to this object, if it can handle focus, will
2350     * take the focus away from the one who had it previously and will, for
2351     * now on, be the one receiving input events. Unsetting focus will remove
2352     * the focus from @p obj, passing it back to the previous element in the
2353     * focus chain list.
2354     *
2355     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2356     *
2357     * @ingroup Focus
2358     */
2359    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2360
2361    /**
2362     * Make a given Elementary object the focused one.
2363     *
2364     * @param obj The Elementary object to make focused.
2365     *
2366     * @note This object, if it can handle focus, will take the focus
2367     * away from the one who had it previously and will, for now on, be
2368     * the one receiving input events.
2369     *
2370     * @see elm_object_focus_get()
2371     * @deprecated use elm_object_focus_set() instead.
2372     *
2373     * @ingroup Focus
2374     */
2375    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2376
2377    /**
2378     * Remove the focus from an Elementary object
2379     *
2380     * @param obj The Elementary to take focus from
2381     *
2382     * This removes the focus from @p obj, passing it back to the
2383     * previous element in the focus chain list.
2384     *
2385     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2386     * @deprecated use elm_object_focus_set() instead.
2387     *
2388     * @ingroup Focus
2389     */
2390    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2391
2392    /**
2393     * Set the ability for an Element object to be focused
2394     *
2395     * @param obj The Elementary object to operate on
2396     * @param enable @c EINA_TRUE if the object can be focused, @c
2397     *        EINA_FALSE if not (and on errors)
2398     *
2399     * This sets whether the object @p obj is able to take focus or
2400     * not. Unfocusable objects do nothing when programmatically
2401     * focused, being the nearest focusable parent object the one
2402     * really getting focus. Also, when they receive mouse input, they
2403     * will get the event, but not take away the focus from where it
2404     * was previously.
2405     *
2406     * @ingroup Focus
2407     */
2408    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2409
2410    /**
2411     * Get whether an Elementary object is focusable or not
2412     *
2413     * @param obj The Elementary object to operate on
2414     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2415     *             EINA_FALSE if not (and on errors)
2416     *
2417     * @note Objects which are meant to be interacted with by input
2418     * events are created able to be focused, by default. All the
2419     * others are not.
2420     *
2421     * @ingroup Focus
2422     */
2423    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2424
2425    /**
2426     * Set custom focus chain.
2427     *
2428     * This function overwrites any previous custom focus chain within
2429     * the list of objects. The previous list will be deleted and this list
2430     * will be managed by elementary. After it is set, don't modify it.
2431     *
2432     * @note On focus cycle, only will be evaluated children of this container.
2433     *
2434     * @param obj The container object
2435     * @param objs Chain of objects to pass focus
2436     * @ingroup Focus
2437     */
2438    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2439
2440    /**
2441     * Unset a custom focus chain on a given Elementary widget
2442     *
2443     * @param obj The container object to remove focus chain from
2444     *
2445     * Any focus chain previously set on @p obj (for its child objects)
2446     * is removed entirely after this call.
2447     *
2448     * @ingroup Focus
2449     */
2450    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2451
2452    /**
2453     * Get custom focus chain
2454     *
2455     * @param obj The container object
2456     * @ingroup Focus
2457     */
2458    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2459
2460    /**
2461     * Append object to custom focus chain.
2462     *
2463     * @note If relative_child equal to NULL or not in custom chain, the object
2464     * will be added in end.
2465     *
2466     * @note On focus cycle, only will be evaluated children of this container.
2467     *
2468     * @param obj The container object
2469     * @param child The child to be added in custom chain
2470     * @param relative_child The relative object to position the child
2471     * @ingroup Focus
2472     */
2473    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2474
2475    /**
2476     * Prepend object to custom focus chain.
2477     *
2478     * @note If relative_child equal to NULL or not in custom chain, the object
2479     * will be added in begin.
2480     *
2481     * @note On focus cycle, only will be evaluated children of this container.
2482     *
2483     * @param obj The container object
2484     * @param child The child to be added in custom chain
2485     * @param relative_child The relative object to position the child
2486     * @ingroup Focus
2487     */
2488    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2489
2490    /**
2491     * Give focus to next object in object tree.
2492     *
2493     * Give focus to next object in focus chain of one object sub-tree.
2494     * If the last object of chain already have focus, the focus will go to the
2495     * first object of chain.
2496     *
2497     * @param obj The object root of sub-tree
2498     * @param dir Direction to cycle the focus
2499     *
2500     * @ingroup Focus
2501     */
2502    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2503
2504    /**
2505     * Give focus to near object in one direction.
2506     *
2507     * Give focus to near object in direction of one object.
2508     * If none focusable object in given direction, the focus will not change.
2509     *
2510     * @param obj The reference object
2511     * @param x Horizontal component of direction to focus
2512     * @param y Vertical component of direction to focus
2513     *
2514     * @ingroup Focus
2515     */
2516    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2517
2518    /**
2519     * Make the elementary object and its children to be unfocusable
2520     * (or focusable).
2521     *
2522     * @param obj The Elementary object to operate on
2523     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2524     *        @c EINA_FALSE for focusable.
2525     *
2526     * This sets whether the object @p obj and its children objects
2527     * are able to take focus or not. If the tree is set as unfocusable,
2528     * newest focused object which is not in this tree will get focus.
2529     * This API can be helpful for an object to be deleted.
2530     * When an object will be deleted soon, it and its children may not
2531     * want to get focus (by focus reverting or by other focus controls).
2532     * Then, just use this API before deleting.
2533     *
2534     * @see elm_object_tree_unfocusable_get()
2535     *
2536     * @ingroup Focus
2537     */
2538    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2539
2540    /**
2541     * Get whether an Elementary object and its children are unfocusable or not.
2542     *
2543     * @param obj The Elementary object to get the information from
2544     * @return @c EINA_TRUE, if the tree is unfocussable,
2545     *         @c EINA_FALSE if not (and on errors).
2546     *
2547     * @see elm_object_tree_unfocusable_set()
2548     *
2549     * @ingroup Focus
2550     */
2551    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2552
2553    /**
2554     * @defgroup Scrolling Scrolling
2555     *
2556     * These are functions setting how scrollable views in Elementary
2557     * widgets should behave on user interaction.
2558     *
2559     * @{
2560     */
2561
2562    /**
2563     * Get whether scrollers should bounce when they reach their
2564     * viewport's edge during a scroll.
2565     *
2566     * @return the thumb scroll bouncing state
2567     *
2568     * This is the default behavior for touch screens, in general.
2569     * @ingroup Scrolling
2570     */
2571    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2572
2573    /**
2574     * Set whether scrollers should bounce when they reach their
2575     * viewport's edge during a scroll.
2576     *
2577     * @param enabled the thumb scroll bouncing state
2578     *
2579     * @see elm_thumbscroll_bounce_enabled_get()
2580     * @ingroup Scrolling
2581     */
2582    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2583
2584    /**
2585     * Set whether scrollers should bounce when they reach their
2586     * viewport's edge during a scroll, for all Elementary application
2587     * windows.
2588     *
2589     * @param enabled the thumb scroll bouncing state
2590     *
2591     * @see elm_thumbscroll_bounce_enabled_get()
2592     * @ingroup Scrolling
2593     */
2594    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2595
2596    /**
2597     * Get the amount of inertia a scroller will impose at bounce
2598     * animations.
2599     *
2600     * @return the thumb scroll bounce friction
2601     *
2602     * @ingroup Scrolling
2603     */
2604    EAPI double           elm_scroll_bounce_friction_get(void);
2605
2606    /**
2607     * Set the amount of inertia a scroller will impose at bounce
2608     * animations.
2609     *
2610     * @param friction the thumb scroll bounce friction
2611     *
2612     * @see elm_thumbscroll_bounce_friction_get()
2613     * @ingroup Scrolling
2614     */
2615    EAPI void             elm_scroll_bounce_friction_set(double friction);
2616
2617    /**
2618     * Set the amount of inertia a scroller will impose at bounce
2619     * animations, for all Elementary application windows.
2620     *
2621     * @param friction the thumb scroll bounce friction
2622     *
2623     * @see elm_thumbscroll_bounce_friction_get()
2624     * @ingroup Scrolling
2625     */
2626    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2627
2628    /**
2629     * Get the amount of inertia a <b>paged</b> scroller will impose at
2630     * page fitting animations.
2631     *
2632     * @return the page scroll friction
2633     *
2634     * @ingroup Scrolling
2635     */
2636    EAPI double           elm_scroll_page_scroll_friction_get(void);
2637
2638    /**
2639     * Set the amount of inertia a <b>paged</b> scroller will impose at
2640     * page fitting animations.
2641     *
2642     * @param friction the page scroll friction
2643     *
2644     * @see elm_thumbscroll_page_scroll_friction_get()
2645     * @ingroup Scrolling
2646     */
2647    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2648
2649    /**
2650     * Set the amount of inertia a <b>paged</b> scroller will impose at
2651     * page fitting animations, for all Elementary application windows.
2652     *
2653     * @param friction the page scroll friction
2654     *
2655     * @see elm_thumbscroll_page_scroll_friction_get()
2656     * @ingroup Scrolling
2657     */
2658    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2659
2660    /**
2661     * Get the amount of inertia a scroller will impose at region bring
2662     * animations.
2663     *
2664     * @return the bring in scroll friction
2665     *
2666     * @ingroup Scrolling
2667     */
2668    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2669
2670    /**
2671     * Set the amount of inertia a scroller will impose at region bring
2672     * animations.
2673     *
2674     * @param friction the bring in scroll friction
2675     *
2676     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2677     * @ingroup Scrolling
2678     */
2679    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2680
2681    /**
2682     * Set the amount of inertia a scroller will impose at region bring
2683     * animations, for all Elementary application windows.
2684     *
2685     * @param friction the bring in scroll friction
2686     *
2687     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2688     * @ingroup Scrolling
2689     */
2690    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2691
2692    /**
2693     * Get the amount of inertia scrollers will impose at animations
2694     * triggered by Elementary widgets' zooming API.
2695     *
2696     * @return the zoom friction
2697     *
2698     * @ingroup Scrolling
2699     */
2700    EAPI double           elm_scroll_zoom_friction_get(void);
2701
2702    /**
2703     * Set the amount of inertia scrollers will impose at animations
2704     * triggered by Elementary widgets' zooming API.
2705     *
2706     * @param friction the zoom friction
2707     *
2708     * @see elm_thumbscroll_zoom_friction_get()
2709     * @ingroup Scrolling
2710     */
2711    EAPI void             elm_scroll_zoom_friction_set(double friction);
2712
2713    /**
2714     * Set the amount of inertia scrollers will impose at animations
2715     * triggered by Elementary widgets' zooming API, for all Elementary
2716     * application windows.
2717     *
2718     * @param friction the zoom friction
2719     *
2720     * @see elm_thumbscroll_zoom_friction_get()
2721     * @ingroup Scrolling
2722     */
2723    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2724
2725    /**
2726     * Get whether scrollers should be draggable from any point in their
2727     * views.
2728     *
2729     * @return the thumb scroll state
2730     *
2731     * @note This is the default behavior for touch screens, in general.
2732     * @note All other functions namespaced with "thumbscroll" will only
2733     *       have effect if this mode is enabled.
2734     *
2735     * @ingroup Scrolling
2736     */
2737    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2738
2739    /**
2740     * Set whether scrollers should be draggable from any point in their
2741     * views.
2742     *
2743     * @param enabled the thumb scroll state
2744     *
2745     * @see elm_thumbscroll_enabled_get()
2746     * @ingroup Scrolling
2747     */
2748    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2749
2750    /**
2751     * Set whether scrollers should be draggable from any point in their
2752     * views, for all Elementary application windows.
2753     *
2754     * @param enabled the thumb scroll state
2755     *
2756     * @see elm_thumbscroll_enabled_get()
2757     * @ingroup Scrolling
2758     */
2759    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2760
2761    /**
2762     * Get the number of pixels one should travel while dragging a
2763     * scroller's view to actually trigger scrolling.
2764     *
2765     * @return the thumb scroll threshould
2766     *
2767     * One would use higher values for touch screens, in general, because
2768     * of their inherent imprecision.
2769     * @ingroup Scrolling
2770     */
2771    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2772
2773    /**
2774     * Set the number of pixels one should travel while dragging a
2775     * scroller's view to actually trigger scrolling.
2776     *
2777     * @param threshold the thumb scroll threshould
2778     *
2779     * @see elm_thumbscroll_threshould_get()
2780     * @ingroup Scrolling
2781     */
2782    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2783
2784    /**
2785     * Set the number of pixels one should travel while dragging a
2786     * scroller's view to actually trigger scrolling, for all Elementary
2787     * application windows.
2788     *
2789     * @param threshold the thumb scroll threshould
2790     *
2791     * @see elm_thumbscroll_threshould_get()
2792     * @ingroup Scrolling
2793     */
2794    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2795
2796    /**
2797     * Get the minimum speed of mouse cursor movement which will trigger
2798     * list self scrolling animation after a mouse up event
2799     * (pixels/second).
2800     *
2801     * @return the thumb scroll momentum threshould
2802     *
2803     * @ingroup Scrolling
2804     */
2805    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2806
2807    /**
2808     * Set the minimum speed of mouse cursor movement which will trigger
2809     * list self scrolling animation after a mouse up event
2810     * (pixels/second).
2811     *
2812     * @param threshold the thumb scroll momentum threshould
2813     *
2814     * @see elm_thumbscroll_momentum_threshould_get()
2815     * @ingroup Scrolling
2816     */
2817    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2818
2819    /**
2820     * Set the minimum speed of mouse cursor movement which will trigger
2821     * list self scrolling animation after a mouse up event
2822     * (pixels/second), for all Elementary application windows.
2823     *
2824     * @param threshold the thumb scroll momentum threshould
2825     *
2826     * @see elm_thumbscroll_momentum_threshould_get()
2827     * @ingroup Scrolling
2828     */
2829    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2830
2831    /**
2832     * Get the amount of inertia a scroller will impose at self scrolling
2833     * animations.
2834     *
2835     * @return the thumb scroll friction
2836     *
2837     * @ingroup Scrolling
2838     */
2839    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2840
2841    /**
2842     * Set the amount of inertia a scroller will impose at self scrolling
2843     * animations.
2844     *
2845     * @param friction the thumb scroll friction
2846     *
2847     * @see elm_thumbscroll_friction_get()
2848     * @ingroup Scrolling
2849     */
2850    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2851
2852    /**
2853     * Set the amount of inertia a scroller will impose at self scrolling
2854     * animations, for all Elementary application windows.
2855     *
2856     * @param friction the thumb scroll friction
2857     *
2858     * @see elm_thumbscroll_friction_get()
2859     * @ingroup Scrolling
2860     */
2861    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2862
2863    /**
2864     * Get the amount of lag between your actual mouse cursor dragging
2865     * movement and a scroller's view movement itself, while pushing it
2866     * into bounce state manually.
2867     *
2868     * @return the thumb scroll border friction
2869     *
2870     * @ingroup Scrolling
2871     */
2872    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2873
2874    /**
2875     * Set the amount of lag between your actual mouse cursor dragging
2876     * movement and a scroller's view movement itself, while pushing it
2877     * into bounce state manually.
2878     *
2879     * @param friction the thumb scroll border friction. @c 0.0 for
2880     *        perfect synchrony between two movements, @c 1.0 for maximum
2881     *        lag.
2882     *
2883     * @see elm_thumbscroll_border_friction_get()
2884     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2885     *
2886     * @ingroup Scrolling
2887     */
2888    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2889
2890    /**
2891     * Set the amount of lag between your actual mouse cursor dragging
2892     * movement and a scroller's view movement itself, while pushing it
2893     * into bounce state manually, for all Elementary application windows.
2894     *
2895     * @param friction the thumb scroll border friction. @c 0.0 for
2896     *        perfect synchrony between two movements, @c 1.0 for maximum
2897     *        lag.
2898     *
2899     * @see elm_thumbscroll_border_friction_get()
2900     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2901     *
2902     * @ingroup Scrolling
2903     */
2904    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2905
2906    /**
2907     * Get the sensitivity amount which is be multiplied by the length of
2908     * mouse dragging.
2909     *
2910     * @return the thumb scroll sensitivity friction
2911     *
2912     * @ingroup Scrolling
2913     */
2914    EAPI double           elm_scroll_thumbscroll_sensitivity_friction_get(void);
2915
2916    /**
2917     * Set the sensitivity amount which is be multiplied by the length of
2918     * mouse dragging.
2919     *
2920     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2921     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2922     *        is proper.
2923     *
2924     * @see elm_thumbscroll_sensitivity_friction_get()
2925     * @note parameter value will get bound to 0.1 - 1.0 interval, always
2926     *
2927     * @ingroup Scrolling
2928     */
2929    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2930
2931    /**
2932     * Set the sensitivity amount which is be multiplied by the length of
2933     * mouse dragging, for all Elementary application windows.
2934     *
2935     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2936     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2937     *        is proper.
2938     *
2939     * @see elm_thumbscroll_sensitivity_friction_get()
2940     * @note parameter value will get bound to 0.1 - 1.0 interval, always
2941     *
2942     * @ingroup Scrolling
2943     */
2944    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2945
2946    /**
2947     * @}
2948     */
2949
2950    /**
2951     * @defgroup Scrollhints Scrollhints
2952     *
2953     * Objects when inside a scroller can scroll, but this may not always be
2954     * desirable in certain situations. This allows an object to hint to itself
2955     * and parents to "not scroll" in one of 2 ways. If any child object of a
2956     * scroller has pushed a scroll freeze or hold then it affects all parent
2957     * scrollers until all children have released them.
2958     *
2959     * 1. To hold on scrolling. This means just flicking and dragging may no
2960     * longer scroll, but pressing/dragging near an edge of the scroller will
2961     * still scroll. This is automatically used by the entry object when
2962     * selecting text.
2963     *
2964     * 2. To totally freeze scrolling. This means it stops. until
2965     * popped/released.
2966     *
2967     * @{
2968     */
2969
2970    /**
2971     * Push the scroll hold by 1
2972     *
2973     * This increments the scroll hold count by one. If it is more than 0 it will
2974     * take effect on the parents of the indicated object.
2975     *
2976     * @param obj The object
2977     * @ingroup Scrollhints
2978     */
2979    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2980
2981    /**
2982     * Pop the scroll hold by 1
2983     *
2984     * This decrements the scroll hold count by one. If it is more than 0 it will
2985     * take effect on the parents of the indicated object.
2986     *
2987     * @param obj The object
2988     * @ingroup Scrollhints
2989     */
2990    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2991
2992    /**
2993     * Push the scroll freeze by 1
2994     *
2995     * This increments the scroll freeze count by one. If it is more
2996     * than 0 it will take effect on the parents of the indicated
2997     * object.
2998     *
2999     * @param obj The object
3000     * @ingroup Scrollhints
3001     */
3002    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3003
3004    /**
3005     * Pop the scroll freeze by 1
3006     *
3007     * This decrements the scroll freeze count by one. If it is more
3008     * than 0 it will take effect on the parents of the indicated
3009     * object.
3010     *
3011     * @param obj The object
3012     * @ingroup Scrollhints
3013     */
3014    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3015
3016    /**
3017     * Lock the scrolling of the given widget (and thus all parents)
3018     *
3019     * This locks the given object from scrolling in the X axis (and implicitly
3020     * also locks all parent scrollers too from doing the same).
3021     *
3022     * @param obj The object
3023     * @param lock The lock state (1 == locked, 0 == unlocked)
3024     * @ingroup Scrollhints
3025     */
3026    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3027
3028    /**
3029     * Lock the scrolling of the given widget (and thus all parents)
3030     *
3031     * This locks the given object from scrolling in the Y axis (and implicitly
3032     * also locks all parent scrollers too from doing the same).
3033     *
3034     * @param obj The object
3035     * @param lock The lock state (1 == locked, 0 == unlocked)
3036     * @ingroup Scrollhints
3037     */
3038    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3039
3040    /**
3041     * Get the scrolling lock of the given widget
3042     *
3043     * This gets the lock for X axis scrolling.
3044     *
3045     * @param obj The object
3046     * @ingroup Scrollhints
3047     */
3048    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3049
3050    /**
3051     * Get the scrolling lock of the given widget
3052     *
3053     * This gets the lock for X axis scrolling.
3054     *
3055     * @param obj The object
3056     * @ingroup Scrollhints
3057     */
3058    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3059
3060    /**
3061     * @}
3062     */
3063
3064    /**
3065     * Send a signal to the widget edje object.
3066     *
3067     * This function sends a signal to the edje object of the obj. An
3068     * edje program can respond to a signal by specifying matching
3069     * 'signal' and 'source' fields.
3070     *
3071     * @param obj The object
3072     * @param emission The signal's name.
3073     * @param source The signal's source.
3074     * @ingroup General
3075     */
3076    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3077
3078    /**
3079     * Add a callback for a signal emitted by widget edje object.
3080     *
3081     * This function connects a callback function to a signal emitted by the
3082     * edje object of the obj.
3083     * Globs can occur in either the emission or source name.
3084     *
3085     * @param obj The object
3086     * @param emission The signal's name.
3087     * @param source The signal's source.
3088     * @param func The callback function to be executed when the signal is
3089     * emitted.
3090     * @param data A pointer to data to pass in to the callback function.
3091     * @ingroup General
3092     */
3093    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);
3094
3095    /**
3096     * Remove a signal-triggered callback from a widget edje object.
3097     *
3098     * This function removes a callback, previoulsy attached to a
3099     * signal emitted by the edje object of the obj.  The parameters
3100     * emission, source and func must match exactly those passed to a
3101     * previous call to elm_object_signal_callback_add(). The data
3102     * pointer that was passed to this call will be returned.
3103     *
3104     * @param obj The object
3105     * @param emission The signal's name.
3106     * @param source The signal's source.
3107     * @param func The callback function to be executed when the signal is
3108     * emitted.
3109     * @return The data pointer
3110     * @ingroup General
3111     */
3112    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);
3113
3114    /**
3115     * Add a callback for input events (key up, key down, mouse wheel)
3116     * on a given Elementary widget
3117     *
3118     * @param obj The widget to add an event callback on
3119     * @param func The callback function to be executed when the event
3120     * happens
3121     * @param data Data to pass in to @p func
3122     *
3123     * Every widget in an Elementary interface set to receive focus,
3124     * with elm_object_focus_allow_set(), will propagate @b all of its
3125     * key up, key down and mouse wheel input events up to its parent
3126     * object, and so on. All of the focusable ones in this chain which
3127     * had an event callback set, with this call, will be able to treat
3128     * those events. There are two ways of making the propagation of
3129     * these event upwards in the tree of widgets to @b cease:
3130     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3131     *   the event was @b not processed, so the propagation will go on.
3132     * - The @c event_info pointer passed to @p func will contain the
3133     *   event's structure and, if you OR its @c event_flags inner
3134     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3135     *   one has already handled it, thus killing the event's
3136     *   propagation, too.
3137     *
3138     * @note Your event callback will be issued on those events taking
3139     * place only if no other child widget of @obj has consumed the
3140     * event already.
3141     *
3142     * @note Not to be confused with @c
3143     * evas_object_event_callback_add(), which will add event callbacks
3144     * per type on general Evas objects (no event propagation
3145     * infrastructure taken in account).
3146     *
3147     * @note Not to be confused with @c
3148     * elm_object_signal_callback_add(), which will add callbacks to @b
3149     * signals coming from a widget's theme, not input events.
3150     *
3151     * @note Not to be confused with @c
3152     * edje_object_signal_callback_add(), which does the same as
3153     * elm_object_signal_callback_add(), but directly on an Edje
3154     * object.
3155     *
3156     * @note Not to be confused with @c
3157     * evas_object_smart_callback_add(), which adds callbacks to smart
3158     * objects' <b>smart events</b>, and not input events.
3159     *
3160     * @see elm_object_event_callback_del()
3161     *
3162     * @ingroup General
3163     */
3164    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3165
3166    /**
3167     * Remove an event callback from a widget.
3168     *
3169     * This function removes a callback, previoulsy attached to event emission
3170     * by the @p obj.
3171     * The parameters func and data must match exactly those passed to
3172     * a previous call to elm_object_event_callback_add(). The data pointer that
3173     * was passed to this call will be returned.
3174     *
3175     * @param obj The object
3176     * @param func The callback function to be executed when the event is
3177     * emitted.
3178     * @param data Data to pass in to the callback function.
3179     * @return The data pointer
3180     * @ingroup General
3181     */
3182    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3183
3184    /**
3185     * Adjust size of an element for finger usage.
3186     *
3187     * @param times_w How many fingers should fit horizontally
3188     * @param w Pointer to the width size to adjust
3189     * @param times_h How many fingers should fit vertically
3190     * @param h Pointer to the height size to adjust
3191     *
3192     * This takes width and height sizes (in pixels) as input and a
3193     * size multiple (which is how many fingers you want to place
3194     * within the area, being "finger" the size set by
3195     * elm_finger_size_set()), and adjusts the size to be large enough
3196     * to accommodate the resulting size -- if it doesn't already
3197     * accommodate it. On return the @p w and @p h sizes pointed to by
3198     * these parameters will be modified, on those conditions.
3199     *
3200     * @note This is kind of a low level Elementary call, most useful
3201     * on size evaluation times for widgets. An external user wouldn't
3202     * be calling, most of the time.
3203     *
3204     * @ingroup Fingers
3205     */
3206    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3207
3208    /**
3209     * Get the duration for occuring long press event.
3210     *
3211     * @return Timeout for long press event
3212     * @ingroup Longpress
3213     */
3214    EAPI double           elm_longpress_timeout_get(void);
3215
3216    /**
3217     * Set the duration for occuring long press event.
3218     *
3219     * @param lonpress_timeout Timeout for long press event
3220     * @ingroup Longpress
3221     */
3222    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3223
3224    /**
3225     * @defgroup Debug Debug
3226     * don't use it unless you are sure
3227     *
3228     * @{
3229     */
3230
3231    /**
3232     * Print Tree object hierarchy in stdout
3233     *
3234     * @param obj The root object
3235     * @ingroup Debug
3236     */
3237    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3238
3239    /**
3240     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3241     *
3242     * @param obj The root object
3243     * @param file The path of output file
3244     * @ingroup Debug
3245     */
3246    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3247
3248    /**
3249     * @}
3250     */
3251
3252    /**
3253     * @defgroup Theme Theme
3254     *
3255     * Elementary uses Edje to theme its widgets, naturally. But for the most
3256     * part this is hidden behind a simpler interface that lets the user set
3257     * extensions and choose the style of widgets in a much easier way.
3258     *
3259     * Instead of thinking in terms of paths to Edje files and their groups
3260     * each time you want to change the appearance of a widget, Elementary
3261     * works so you can add any theme file with extensions or replace the
3262     * main theme at one point in the application, and then just set the style
3263     * of widgets with elm_object_style_set() and related functions. Elementary
3264     * will then look in its list of themes for a matching group and apply it,
3265     * and when the theme changes midway through the application, all widgets
3266     * will be updated accordingly.
3267     *
3268     * There are three concepts you need to know to understand how Elementary
3269     * theming works: default theme, extensions and overlays.
3270     *
3271     * Default theme, obviously enough, is the one that provides the default
3272     * look of all widgets. End users can change the theme used by Elementary
3273     * by setting the @c ELM_THEME environment variable before running an
3274     * application, or globally for all programs using the @c elementary_config
3275     * utility. Applications can change the default theme using elm_theme_set(),
3276     * but this can go against the user wishes, so it's not an adviced practice.
3277     *
3278     * Ideally, applications should find everything they need in the already
3279     * provided theme, but there may be occasions when that's not enough and
3280     * custom styles are required to correctly express the idea. For this
3281     * cases, Elementary has extensions.
3282     *
3283     * Extensions allow the application developer to write styles of its own
3284     * to apply to some widgets. This requires knowledge of how each widget
3285     * is themed, as extensions will always replace the entire group used by
3286     * the widget, so important signals and parts need to be there for the
3287     * object to behave properly (see documentation of Edje for details).
3288     * Once the theme for the extension is done, the application needs to add
3289     * it to the list of themes Elementary will look into, using
3290     * elm_theme_extension_add(), and set the style of the desired widgets as
3291     * he would normally with elm_object_style_set().
3292     *
3293     * Overlays, on the other hand, can replace the look of all widgets by
3294     * overriding the default style. Like extensions, it's up to the application
3295     * developer to write the theme for the widgets it wants, the difference
3296     * being that when looking for the theme, Elementary will check first the
3297     * list of overlays, then the set theme and lastly the list of extensions,
3298     * so with overlays it's possible to replace the default view and every
3299     * widget will be affected. This is very much alike to setting the whole
3300     * theme for the application and will probably clash with the end user
3301     * options, not to mention the risk of ending up with not matching styles
3302     * across the program. Unless there's a very special reason to use them,
3303     * overlays should be avoided for the resons exposed before.
3304     *
3305     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3306     * keeps one default internally and every function that receives one of
3307     * these can be called with NULL to refer to this default (except for
3308     * elm_theme_free()). It's possible to create a new instance of a
3309     * ::Elm_Theme to set other theme for a specific widget (and all of its
3310     * children), but this is as discouraged, if not even more so, than using
3311     * overlays. Don't use this unless you really know what you are doing.
3312     *
3313     * But to be less negative about things, you can look at the following
3314     * examples:
3315     * @li @ref theme_example_01 "Using extensions"
3316     * @li @ref theme_example_02 "Using overlays"
3317     *
3318     * @{
3319     */
3320    /**
3321     * @typedef Elm_Theme
3322     *
3323     * Opaque handler for the list of themes Elementary looks for when
3324     * rendering widgets.
3325     *
3326     * Stay out of this unless you really know what you are doing. For most
3327     * cases, sticking to the default is all a developer needs.
3328     */
3329    typedef struct _Elm_Theme Elm_Theme;
3330
3331    /**
3332     * Create a new specific theme
3333     *
3334     * This creates an empty specific theme that only uses the default theme. A
3335     * specific theme has its own private set of extensions and overlays too
3336     * (which are empty by default). Specific themes do not fall back to themes
3337     * of parent objects. They are not intended for this use. Use styles, overlays
3338     * and extensions when needed, but avoid specific themes unless there is no
3339     * other way (example: you want to have a preview of a new theme you are
3340     * selecting in a "theme selector" window. The preview is inside a scroller
3341     * and should display what the theme you selected will look like, but not
3342     * actually apply it yet. The child of the scroller will have a specific
3343     * theme set to show this preview before the user decides to apply it to all
3344     * applications).
3345     */
3346    EAPI Elm_Theme       *elm_theme_new(void);
3347    /**
3348     * Free a specific theme
3349     *
3350     * @param th The theme to free
3351     *
3352     * This frees a theme created with elm_theme_new().
3353     */
3354    EAPI void             elm_theme_free(Elm_Theme *th);
3355    /**
3356     * Copy the theme fom the source to the destination theme
3357     *
3358     * @param th The source theme to copy from
3359     * @param thdst The destination theme to copy data to
3360     *
3361     * This makes a one-time static copy of all the theme config, extensions
3362     * and overlays from @p th to @p thdst. If @p th references a theme, then
3363     * @p thdst is also set to reference it, with all the theme settings,
3364     * overlays and extensions that @p th had.
3365     */
3366    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3367    /**
3368     * Tell the source theme to reference the ref theme
3369     *
3370     * @param th The theme that will do the referencing
3371     * @param thref The theme that is the reference source
3372     *
3373     * This clears @p th to be empty and then sets it to refer to @p thref
3374     * so @p th acts as an override to @p thref, but where its overrides
3375     * don't apply, it will fall through to @p thref for configuration.
3376     */
3377    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3378    /**
3379     * Return the theme referred to
3380     *
3381     * @param th The theme to get the reference from
3382     * @return The referenced theme handle
3383     *
3384     * This gets the theme set as the reference theme by elm_theme_ref_set().
3385     * If no theme is set as a reference, NULL is returned.
3386     */
3387    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3388    /**
3389     * Return the default theme
3390     *
3391     * @return The default theme handle
3392     *
3393     * This returns the internal default theme setup handle that all widgets
3394     * use implicitly unless a specific theme is set. This is also often use
3395     * as a shorthand of NULL.
3396     */
3397    EAPI Elm_Theme       *elm_theme_default_get(void);
3398    /**
3399     * Prepends a theme overlay to the list of overlays
3400     *
3401     * @param th The theme to add to, or if NULL, the default theme
3402     * @param item The Edje file path to be used
3403     *
3404     * Use this if your application needs to provide some custom overlay theme
3405     * (An Edje file that replaces some default styles of widgets) where adding
3406     * new styles, or changing system theme configuration is not possible. Do
3407     * NOT use this instead of a proper system theme configuration. Use proper
3408     * configuration files, profiles, environment variables etc. to set a theme
3409     * so that the theme can be altered by simple confiugration by a user. Using
3410     * this call to achieve that effect is abusing the API and will create lots
3411     * of trouble.
3412     *
3413     * @see elm_theme_extension_add()
3414     */
3415    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3416    /**
3417     * Delete a theme overlay from the list of overlays
3418     *
3419     * @param th The theme to delete from, or if NULL, the default theme
3420     * @param item The name of the theme overlay
3421     *
3422     * @see elm_theme_overlay_add()
3423     */
3424    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3425    /**
3426     * Appends a theme extension to the list of extensions.
3427     *
3428     * @param th The theme to add to, or if NULL, the default theme
3429     * @param item The Edje file path to be used
3430     *
3431     * This is intended when an application needs more styles of widgets or new
3432     * widget themes that the default does not provide (or may not provide). The
3433     * application has "extended" usage by coming up with new custom style names
3434     * for widgets for specific uses, but as these are not "standard", they are
3435     * not guaranteed to be provided by a default theme. This means the
3436     * application is required to provide these extra elements itself in specific
3437     * Edje files. This call adds one of those Edje files to the theme search
3438     * path to be search after the default theme. The use of this call is
3439     * encouraged when default styles do not meet the needs of the application.
3440     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3441     *
3442     * @see elm_object_style_set()
3443     */
3444    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3445    /**
3446     * Deletes a theme extension from the list of extensions.
3447     *
3448     * @param th The theme to delete from, or if NULL, the default theme
3449     * @param item The name of the theme extension
3450     *
3451     * @see elm_theme_extension_add()
3452     */
3453    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3454    /**
3455     * Set the theme search order for the given theme
3456     *
3457     * @param th The theme to set the search order, or if NULL, the default theme
3458     * @param theme Theme search string
3459     *
3460     * This sets the search string for the theme in path-notation from first
3461     * theme to search, to last, delimited by the : character. Example:
3462     *
3463     * "shiny:/path/to/file.edj:default"
3464     *
3465     * See the ELM_THEME environment variable for more information.
3466     *
3467     * @see elm_theme_get()
3468     * @see elm_theme_list_get()
3469     */
3470    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3471    /**
3472     * Return the theme search order
3473     *
3474     * @param th The theme to get the search order, or if NULL, the default theme
3475     * @return The internal search order path
3476     *
3477     * This function returns a colon separated string of theme elements as
3478     * returned by elm_theme_list_get().
3479     *
3480     * @see elm_theme_set()
3481     * @see elm_theme_list_get()
3482     */
3483    EAPI const char      *elm_theme_get(Elm_Theme *th);
3484    /**
3485     * Return a list of theme elements to be used in a theme.
3486     *
3487     * @param th Theme to get the list of theme elements from.
3488     * @return The internal list of theme elements
3489     *
3490     * This returns the internal list of theme elements (will only be valid as
3491     * long as the theme is not modified by elm_theme_set() or theme is not
3492     * freed by elm_theme_free(). This is a list of strings which must not be
3493     * altered as they are also internal. If @p th is NULL, then the default
3494     * theme element list is returned.
3495     *
3496     * A theme element can consist of a full or relative path to a .edj file,
3497     * or a name, without extension, for a theme to be searched in the known
3498     * theme paths for Elemementary.
3499     *
3500     * @see elm_theme_set()
3501     * @see elm_theme_get()
3502     */
3503    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3504    /**
3505     * Return the full patrh for a theme element
3506     *
3507     * @param f The theme element name
3508     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3509     * @return The full path to the file found.
3510     *
3511     * This returns a string you should free with free() on success, NULL on
3512     * failure. This will search for the given theme element, and if it is a
3513     * full or relative path element or a simple searchable name. The returned
3514     * path is the full path to the file, if searched, and the file exists, or it
3515     * is simply the full path given in the element or a resolved path if
3516     * relative to home. The @p in_search_path boolean pointed to is set to
3517     * EINA_TRUE if the file was a searchable file andis in the search path,
3518     * and EINA_FALSE otherwise.
3519     */
3520    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3521    /**
3522     * Flush the current theme.
3523     *
3524     * @param th Theme to flush
3525     *
3526     * This flushes caches that let elementary know where to find theme elements
3527     * in the given theme. If @p th is NULL, then the default theme is flushed.
3528     * Call this function if source theme data has changed in such a way as to
3529     * make any caches Elementary kept invalid.
3530     */
3531    EAPI void             elm_theme_flush(Elm_Theme *th);
3532    /**
3533     * This flushes all themes (default and specific ones).
3534     *
3535     * This will flush all themes in the current application context, by calling
3536     * elm_theme_flush() on each of them.
3537     */
3538    EAPI void             elm_theme_full_flush(void);
3539    /**
3540     * Set the theme for all elementary using applications on the current display
3541     *
3542     * @param theme The name of the theme to use. Format same as the ELM_THEME
3543     * environment variable.
3544     */
3545    EAPI void             elm_theme_all_set(const char *theme);
3546    /**
3547     * Return a list of theme elements in the theme search path
3548     *
3549     * @return A list of strings that are the theme element names.
3550     *
3551     * This lists all available theme files in the standard Elementary search path
3552     * for theme elements, and returns them in alphabetical order as theme
3553     * element names in a list of strings. Free this with
3554     * elm_theme_name_available_list_free() when you are done with the list.
3555     */
3556    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3557    /**
3558     * Free the list returned by elm_theme_name_available_list_new()
3559     *
3560     * This frees the list of themes returned by
3561     * elm_theme_name_available_list_new(). Once freed the list should no longer
3562     * be used. a new list mys be created.
3563     */
3564    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3565    /**
3566     * Set a specific theme to be used for this object and its children
3567     *
3568     * @param obj The object to set the theme on
3569     * @param th The theme to set
3570     *
3571     * This sets a specific theme that will be used for the given object and any
3572     * child objects it has. If @p th is NULL then the theme to be used is
3573     * cleared and the object will inherit its theme from its parent (which
3574     * ultimately will use the default theme if no specific themes are set).
3575     *
3576     * Use special themes with great care as this will annoy users and make
3577     * configuration difficult. Avoid any custom themes at all if it can be
3578     * helped.
3579     */
3580    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3581    /**
3582     * Get the specific theme to be used
3583     *
3584     * @param obj The object to get the specific theme from
3585     * @return The specifc theme set.
3586     *
3587     * This will return a specific theme set, or NULL if no specific theme is
3588     * set on that object. It will not return inherited themes from parents, only
3589     * the specific theme set for that specific object. See elm_object_theme_set()
3590     * for more information.
3591     */
3592    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3593
3594    /**
3595     * Get a data item from a theme
3596     *
3597     * @param th The theme, or NULL for default theme
3598     * @param key The data key to search with
3599     * @return The data value, or NULL on failure
3600     *
3601     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3602     * It works the same way as edje_file_data_get() except that the return is stringshared.
3603     */
3604    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3605    /**
3606     * @}
3607     */
3608
3609    /* win */
3610    /** @defgroup Win Win
3611     *
3612     * @image html img/widget/win/preview-00.png
3613     * @image latex img/widget/win/preview-00.eps
3614     *
3615     * The window class of Elementary.  Contains functions to manipulate
3616     * windows. The Evas engine used to render the window contents is specified
3617     * in the system or user elementary config files (whichever is found last),
3618     * and can be overridden with the ELM_ENGINE environment variable for
3619     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3620     * compilation setup and modules actually installed at runtime) are (listed
3621     * in order of best supported and most likely to be complete and work to
3622     * lowest quality).
3623     *
3624     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3625     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3626     * rendering in X11)
3627     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3628     * exits)
3629     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3630     * rendering)
3631     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3632     * buffer)
3633     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3634     * rendering using SDL as the buffer)
3635     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3636     * GDI with software)
3637     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3638     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3639     * grayscale using dedicated 8bit software engine in X11)
3640     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3641     * X11 using 16bit software engine)
3642     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3643     * (Windows CE rendering via GDI with 16bit software renderer)
3644     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3645     * buffer with 16bit software renderer)
3646     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3647     *
3648     * All engines use a simple string to select the engine to render, EXCEPT
3649     * the "shot" engine. This actually encodes the output of the virtual
3650     * screenshot and how long to delay in the engine string. The engine string
3651     * is encoded in the following way:
3652     *
3653     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3654     *
3655     * Where options are separated by a ":" char if more than one option is
3656     * given, with delay, if provided being the first option and file the last
3657     * (order is important). The delay specifies how long to wait after the
3658     * window is shown before doing the virtual "in memory" rendering and then
3659     * save the output to the file specified by the file option (and then exit).
3660     * If no delay is given, the default is 0.5 seconds. If no file is given the
3661     * default output file is "out.png". Repeat option is for continous
3662     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3663     * fixed to "out001.png" Some examples of using the shot engine:
3664     *
3665     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3666     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3667     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3668     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3669     *   ELM_ENGINE="shot:" elementary_test
3670     *
3671     * Signals that you can add callbacks for are:
3672     *
3673     * @li "delete,request": the user requested to close the window. See
3674     * elm_win_autodel_set().
3675     * @li "focus,in": window got focus
3676     * @li "focus,out": window lost focus
3677     * @li "moved": window that holds the canvas was moved
3678     *
3679     * Examples:
3680     * @li @ref win_example_01
3681     *
3682     * @{
3683     */
3684    /**
3685     * Defines the types of window that can be created
3686     *
3687     * These are hints set on the window so that a running Window Manager knows
3688     * how the window should be handled and/or what kind of decorations it
3689     * should have.
3690     *
3691     * Currently, only the X11 backed engines use them.
3692     */
3693    typedef enum _Elm_Win_Type
3694      {
3695         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3696                          window. Almost every window will be created with this
3697                          type. */
3698         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3699         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3700                            window holding desktop icons. */
3701         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3702                         be kept on top of any other window by the Window
3703                         Manager. */
3704         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3705                            similar. */
3706         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3707         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3708                            pallete. */
3709         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3710         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3711                                  entry in a menubar is clicked. Typically used
3712                                  with elm_win_override_set(). This hint exists
3713                                  for completion only, as the EFL way of
3714                                  implementing a menu would not normally use a
3715                                  separate window for its contents. */
3716         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3717                               triggered by right-clicking an object. */
3718         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3719                            explanatory text that typically appear after the
3720                            mouse cursor hovers over an object for a while.
3721                            Typically used with elm_win_override_set() and also
3722                            not very commonly used in the EFL. */
3723         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3724                                 battery life or a new E-Mail received. */
3725         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3726                          usually used in the EFL. */
3727         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3728                        object being dragged across different windows, or even
3729                        applications. Typically used with
3730                        elm_win_override_set(). */
3731         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3732                                  buffer. No actual window is created for this
3733                                  type, instead the window and all of its
3734                                  contents will be rendered to an image buffer.
3735                                  This allows to have children window inside a
3736                                  parent one just like any other object would
3737                                  be, and do other things like applying @c
3738                                  Evas_Map effects to it. This is the only type
3739                                  of window that requires the @c parent
3740                                  parameter of elm_win_add() to be a valid @c
3741                                  Evas_Object. */
3742      } Elm_Win_Type;
3743
3744    /**
3745     * The differents layouts that can be requested for the virtual keyboard.
3746     *
3747     * When the application window is being managed by Illume, it may request
3748     * any of the following layouts for the virtual keyboard.
3749     */
3750    typedef enum _Elm_Win_Keyboard_Mode
3751      {
3752         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3753         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3754         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3755         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3756         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3757         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3758         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3759         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3760         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3761         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3762         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3763         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3764         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3765         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3766         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3767         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3768      } Elm_Win_Keyboard_Mode;
3769
3770    /**
3771     * Available commands that can be sent to the Illume manager.
3772     *
3773     * When running under an Illume session, a window may send commands to the
3774     * Illume manager to perform different actions.
3775     */
3776    typedef enum _Elm_Illume_Command
3777      {
3778         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3779                                          window */
3780         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3781                                             in the list */
3782         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3783                                          screen */
3784         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3785      } Elm_Illume_Command;
3786
3787    /**
3788     * Adds a window object. If this is the first window created, pass NULL as
3789     * @p parent.
3790     *
3791     * @param parent Parent object to add the window to, or NULL
3792     * @param name The name of the window
3793     * @param type The window type, one of #Elm_Win_Type.
3794     *
3795     * The @p parent paramter can be @c NULL for every window @p type except
3796     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3797     * which the image object will be created.
3798     *
3799     * @return The created object, or NULL on failure
3800     */
3801    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3802    /**
3803     * Add @p subobj as a resize object of window @p obj.
3804     *
3805     *
3806     * Setting an object as a resize object of the window means that the
3807     * @p subobj child's size and position will be controlled by the window
3808     * directly. That is, the object will be resized to match the window size
3809     * and should never be moved or resized manually by the developer.
3810     *
3811     * In addition, resize objects of the window control what the minimum size
3812     * of it will be, as well as whether it can or not be resized by the user.
3813     *
3814     * For the end user to be able to resize a window by dragging the handles
3815     * or borders provided by the Window Manager, or using any other similar
3816     * mechanism, all of the resize objects in the window should have their
3817     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3818     *
3819     * @param obj The window object
3820     * @param subobj The resize object to add
3821     */
3822    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3823    /**
3824     * Delete @p subobj as a resize object of window @p obj.
3825     *
3826     * This function removes the object @p subobj from the resize objects of
3827     * the window @p obj. It will not delete the object itself, which will be
3828     * left unmanaged and should be deleted by the developer, manually handled
3829     * or set as child of some other container.
3830     *
3831     * @param obj The window object
3832     * @param subobj The resize object to add
3833     */
3834    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3835    /**
3836     * Set the title of the window
3837     *
3838     * @param obj The window object
3839     * @param title The title to set
3840     */
3841    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3842    /**
3843     * Get the title of the window
3844     *
3845     * The returned string is an internal one and should not be freed or
3846     * modified. It will also be rendered invalid if a new title is set or if
3847     * the window is destroyed.
3848     *
3849     * @param obj The window object
3850     * @return The title
3851     */
3852    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3853    /**
3854     * Set the window's autodel state.
3855     *
3856     * When closing the window in any way outside of the program control, like
3857     * pressing the X button in the titlebar or using a command from the
3858     * Window Manager, a "delete,request" signal is emitted to indicate that
3859     * this event occurred and the developer can take any action, which may
3860     * include, or not, destroying the window object.
3861     *
3862     * When the @p autodel parameter is set, the window will be automatically
3863     * destroyed when this event occurs, after the signal is emitted.
3864     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3865     * and is up to the program to do so when it's required.
3866     *
3867     * @param obj The window object
3868     * @param autodel If true, the window will automatically delete itself when
3869     * closed
3870     */
3871    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3872    /**
3873     * Get the window's autodel state.
3874     *
3875     * @param obj The window object
3876     * @return If the window will automatically delete itself when closed
3877     *
3878     * @see elm_win_autodel_set()
3879     */
3880    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3881    /**
3882     * Activate a window object.
3883     *
3884     * This function sends a request to the Window Manager to activate the
3885     * window pointed by @p obj. If honored by the WM, the window will receive
3886     * the keyboard focus.
3887     *
3888     * @note This is just a request that a Window Manager may ignore, so calling
3889     * this function does not ensure in any way that the window will be the
3890     * active one after it.
3891     *
3892     * @param obj The window object
3893     */
3894    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3895    /**
3896     * Lower a window object.
3897     *
3898     * Places the window pointed by @p obj at the bottom of the stack, so that
3899     * no other window is covered by it.
3900     *
3901     * If elm_win_override_set() is not set, the Window Manager may ignore this
3902     * request.
3903     *
3904     * @param obj The window object
3905     */
3906    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3907    /**
3908     * Raise a window object.
3909     *
3910     * Places the window pointed by @p obj at the top of the stack, so that it's
3911     * not covered by any other window.
3912     *
3913     * If elm_win_override_set() is not set, the Window Manager may ignore this
3914     * request.
3915     *
3916     * @param obj The window object
3917     */
3918    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3919    /**
3920     * Set the borderless state of a window.
3921     *
3922     * This function requests the Window Manager to not draw any decoration
3923     * around the window.
3924     *
3925     * @param obj The window object
3926     * @param borderless If true, the window is borderless
3927     */
3928    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3929    /**
3930     * Get the borderless state of a window.
3931     *
3932     * @param obj The window object
3933     * @return If true, the window is borderless
3934     */
3935    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3936    /**
3937     * Set the shaped state of a window.
3938     *
3939     * Shaped windows, when supported, will render the parts of the window that
3940     * has no content, transparent.
3941     *
3942     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3943     * background object or cover the entire window in any other way, or the
3944     * parts of the canvas that have no data will show framebuffer artifacts.
3945     *
3946     * @param obj The window object
3947     * @param shaped If true, the window is shaped
3948     *
3949     * @see elm_win_alpha_set()
3950     */
3951    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3952    /**
3953     * Get the shaped state of a window.
3954     *
3955     * @param obj The window object
3956     * @return If true, the window is shaped
3957     *
3958     * @see elm_win_shaped_set()
3959     */
3960    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3961    /**
3962     * Set the alpha channel state of a window.
3963     *
3964     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3965     * possibly making parts of the window completely or partially transparent.
3966     * This is also subject to the underlying system supporting it, like for
3967     * example, running under a compositing manager. If no compositing is
3968     * available, enabling this option will instead fallback to using shaped
3969     * windows, with elm_win_shaped_set().
3970     *
3971     * @param obj The window object
3972     * @param alpha If true, the window has an alpha channel
3973     *
3974     * @see elm_win_alpha_set()
3975     */
3976    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3977    /**
3978     * Get the transparency state of a window.
3979     *
3980     * @param obj The window object
3981     * @return If true, the window is transparent
3982     *
3983     * @see elm_win_transparent_set()
3984     */
3985    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3986    /**
3987     * Set the transparency state of a window.
3988     *
3989     * Use elm_win_alpha_set() instead.
3990     *
3991     * @param obj The window object
3992     * @param transparent If true, the window is transparent
3993     *
3994     * @see elm_win_alpha_set()
3995     */
3996    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3997    /**
3998     * Get the alpha channel state of a window.
3999     *
4000     * @param obj The window object
4001     * @return If true, the window has an alpha channel
4002     */
4003    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4004    /**
4005     * Set the override state of a window.
4006     *
4007     * A window with @p override set to EINA_TRUE will not be managed by the
4008     * Window Manager. This means that no decorations of any kind will be shown
4009     * for it, moving and resizing must be handled by the application, as well
4010     * as the window visibility.
4011     *
4012     * This should not be used for normal windows, and even for not so normal
4013     * ones, it should only be used when there's a good reason and with a lot
4014     * of care. Mishandling override windows may result situations that
4015     * disrupt the normal workflow of the end user.
4016     *
4017     * @param obj The window object
4018     * @param override If true, the window is overridden
4019     */
4020    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4021    /**
4022     * Get the override state of a window.
4023     *
4024     * @param obj The window object
4025     * @return If true, the window is overridden
4026     *
4027     * @see elm_win_override_set()
4028     */
4029    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4030    /**
4031     * Set the fullscreen state of a window.
4032     *
4033     * @param obj The window object
4034     * @param fullscreen If true, the window is fullscreen
4035     */
4036    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4037    /**
4038     * Get the fullscreen state of a window.
4039     *
4040     * @param obj The window object
4041     * @return If true, the window is fullscreen
4042     */
4043    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4044    /**
4045     * Set the maximized state of a window.
4046     *
4047     * @param obj The window object
4048     * @param maximized If true, the window is maximized
4049     */
4050    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4051    /**
4052     * Get the maximized state of a window.
4053     *
4054     * @param obj The window object
4055     * @return If true, the window is maximized
4056     */
4057    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4058    /**
4059     * Set the iconified state of a window.
4060     *
4061     * @param obj The window object
4062     * @param iconified If true, the window is iconified
4063     */
4064    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4065    /**
4066     * Get the iconified state of a window.
4067     *
4068     * @param obj The window object
4069     * @return If true, the window is iconified
4070     */
4071    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4072    /**
4073     * Set the layer of the window.
4074     *
4075     * What this means exactly will depend on the underlying engine used.
4076     *
4077     * In the case of X11 backed engines, the value in @p layer has the
4078     * following meanings:
4079     * @li < 3: The window will be placed below all others.
4080     * @li > 5: The window will be placed above all others.
4081     * @li other: The window will be placed in the default layer.
4082     *
4083     * @param obj The window object
4084     * @param layer The layer of the window
4085     */
4086    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4087    /**
4088     * Get the layer of the window.
4089     *
4090     * @param obj The window object
4091     * @return The layer of the window
4092     *
4093     * @see elm_win_layer_set()
4094     */
4095    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4096    /**
4097     * Set the rotation of the window.
4098     *
4099     * Most engines only work with multiples of 90.
4100     *
4101     * This function is used to set the orientation of the window @p obj to
4102     * match that of the screen. The window itself will be resized to adjust
4103     * to the new geometry of its contents. If you want to keep the window size,
4104     * see elm_win_rotation_with_resize_set().
4105     *
4106     * @param obj The window object
4107     * @param rotation The rotation of the window, in degrees (0-360),
4108     * counter-clockwise.
4109     */
4110    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4111    /**
4112     * Rotates the window and resizes it.
4113     *
4114     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4115     * that they fit inside the current window geometry.
4116     *
4117     * @param obj The window object
4118     * @param layer The rotation of the window in degrees (0-360),
4119     * counter-clockwise.
4120     */
4121    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4122    /**
4123     * Get the rotation of the window.
4124     *
4125     * @param obj The window object
4126     * @return The rotation of the window in degrees (0-360)
4127     *
4128     * @see elm_win_rotation_set()
4129     * @see elm_win_rotation_with_resize_set()
4130     */
4131    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4132    /**
4133     * Set the sticky state of the window.
4134     *
4135     * Hints the Window Manager that the window in @p obj should be left fixed
4136     * at its position even when the virtual desktop it's on moves or changes.
4137     *
4138     * @param obj The window object
4139     * @param sticky If true, the window's sticky state is enabled
4140     */
4141    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4142    /**
4143     * Get the sticky state of the window.
4144     *
4145     * @param obj The window object
4146     * @return If true, the window's sticky state is enabled
4147     *
4148     * @see elm_win_sticky_set()
4149     */
4150    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4151    /**
4152     * Set if this window is an illume conformant window
4153     *
4154     * @param obj The window object
4155     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4156     */
4157    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4158    /**
4159     * Get if this window is an illume conformant window
4160     *
4161     * @param obj The window object
4162     * @return A boolean if this window is illume conformant or not
4163     */
4164    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4165    /**
4166     * Set a window to be an illume quickpanel window
4167     *
4168     * By default window objects are not quickpanel windows.
4169     *
4170     * @param obj The window object
4171     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4172     */
4173    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4174    /**
4175     * Get if this window is a quickpanel or not
4176     *
4177     * @param obj The window object
4178     * @return A boolean if this window is a quickpanel or not
4179     */
4180    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4181    /**
4182     * Set the major priority of a quickpanel window
4183     *
4184     * @param obj The window object
4185     * @param priority The major priority for this quickpanel
4186     */
4187    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4188    /**
4189     * Get the major priority of a quickpanel window
4190     *
4191     * @param obj The window object
4192     * @return The major priority of this quickpanel
4193     */
4194    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4195    /**
4196     * Set the minor priority of a quickpanel window
4197     *
4198     * @param obj The window object
4199     * @param priority The minor priority for this quickpanel
4200     */
4201    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4202    /**
4203     * Get the minor priority of a quickpanel window
4204     *
4205     * @param obj The window object
4206     * @return The minor priority of this quickpanel
4207     */
4208    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4209    /**
4210     * Set which zone this quickpanel should appear in
4211     *
4212     * @param obj The window object
4213     * @param zone The requested zone for this quickpanel
4214     */
4215    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4216    /**
4217     * Get which zone this quickpanel should appear in
4218     *
4219     * @param obj The window object
4220     * @return The requested zone for this quickpanel
4221     */
4222    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4223    /**
4224     * Set the window to be skipped by keyboard focus
4225     *
4226     * This sets the window to be skipped by normal keyboard input. This means
4227     * a window manager will be asked to not focus this window as well as omit
4228     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4229     *
4230     * Call this and enable it on a window BEFORE you show it for the first time,
4231     * otherwise it may have no effect.
4232     *
4233     * Use this for windows that have only output information or might only be
4234     * interacted with by the mouse or fingers, and never for typing input.
4235     * Be careful that this may have side-effects like making the window
4236     * non-accessible in some cases unless the window is specially handled. Use
4237     * this with care.
4238     *
4239     * @param obj The window object
4240     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4241     */
4242    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4243    /**
4244     * Send a command to the windowing environment
4245     *
4246     * This is intended to work in touchscreen or small screen device
4247     * environments where there is a more simplistic window management policy in
4248     * place. This uses the window object indicated to select which part of the
4249     * environment to control (the part that this window lives in), and provides
4250     * a command and an optional parameter structure (use NULL for this if not
4251     * needed).
4252     *
4253     * @param obj The window object that lives in the environment to control
4254     * @param command The command to send
4255     * @param params Optional parameters for the command
4256     */
4257    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4258    /**
4259     * Get the inlined image object handle
4260     *
4261     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4262     * then the window is in fact an evas image object inlined in the parent
4263     * canvas. You can get this object (be careful to not manipulate it as it
4264     * is under control of elementary), and use it to do things like get pixel
4265     * data, save the image to a file, etc.
4266     *
4267     * @param obj The window object to get the inlined image from
4268     * @return The inlined image object, or NULL if none exists
4269     */
4270    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4271    /**
4272     * Set the enabled status for the focus highlight in a window
4273     *
4274     * This function will enable or disable the focus highlight only for the
4275     * given window, regardless of the global setting for it
4276     *
4277     * @param obj The window where to enable the highlight
4278     * @param enabled The enabled value for the highlight
4279     */
4280    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4281    /**
4282     * Get the enabled value of the focus highlight for this window
4283     *
4284     * @param obj The window in which to check if the focus highlight is enabled
4285     *
4286     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4287     */
4288    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4289    /**
4290     * Set the style for the focus highlight on this window
4291     *
4292     * Sets the style to use for theming the highlight of focused objects on
4293     * the given window. If @p style is NULL, the default will be used.
4294     *
4295     * @param obj The window where to set the style
4296     * @param style The style to set
4297     */
4298    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4299    /**
4300     * Get the style set for the focus highlight object
4301     *
4302     * Gets the style set for this windows highilght object, or NULL if none
4303     * is set.
4304     *
4305     * @param obj The window to retrieve the highlights style from
4306     *
4307     * @return The style set or NULL if none was. Default is used in that case.
4308     */
4309    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4310    /*...
4311     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4312     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4313     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4314     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4315     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4316     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4317     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4318     *
4319     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4320     * (blank mouse, private mouse obj, defaultmouse)
4321     *
4322     */
4323    /**
4324     * Sets the keyboard mode of the window.
4325     *
4326     * @param obj The window object
4327     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4328     */
4329    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4330    /**
4331     * Gets the keyboard mode of the window.
4332     *
4333     * @param obj The window object
4334     * @return The mode, one of #Elm_Win_Keyboard_Mode
4335     */
4336    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4337    /**
4338     * Sets whether the window is a keyboard.
4339     *
4340     * @param obj The window object
4341     * @param is_keyboard If true, the window is a virtual keyboard
4342     */
4343    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4344    /**
4345     * Gets whether the window is a keyboard.
4346     *
4347     * @param obj The window object
4348     * @return If the window is a virtual keyboard
4349     */
4350    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4351
4352    /**
4353     * Get the screen position of a window.
4354     *
4355     * @param obj The window object
4356     * @param x The int to store the x coordinate to
4357     * @param y The int to store the y coordinate to
4358     */
4359    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4360    /**
4361     * @}
4362     */
4363
4364    /**
4365     * @defgroup Inwin Inwin
4366     *
4367     * @image html img/widget/inwin/preview-00.png
4368     * @image latex img/widget/inwin/preview-00.eps
4369     * @image html img/widget/inwin/preview-01.png
4370     * @image latex img/widget/inwin/preview-01.eps
4371     * @image html img/widget/inwin/preview-02.png
4372     * @image latex img/widget/inwin/preview-02.eps
4373     *
4374     * An inwin is a window inside a window that is useful for a quick popup.
4375     * It does not hover.
4376     *
4377     * It works by creating an object that will occupy the entire window, so it
4378     * must be created using an @ref Win "elm_win" as parent only. The inwin
4379     * object can be hidden or restacked below every other object if it's
4380     * needed to show what's behind it without destroying it. If this is done,
4381     * the elm_win_inwin_activate() function can be used to bring it back to
4382     * full visibility again.
4383     *
4384     * There are three styles available in the default theme. These are:
4385     * @li default: The inwin is sized to take over most of the window it's
4386     * placed in.
4387     * @li minimal: The size of the inwin will be the minimum necessary to show
4388     * its contents.
4389     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4390     * possible, but it's sized vertically the most it needs to fit its\
4391     * contents.
4392     *
4393     * Some examples of Inwin can be found in the following:
4394     * @li @ref inwin_example_01
4395     *
4396     * @{
4397     */
4398    /**
4399     * Adds an inwin to the current window
4400     *
4401     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4402     * Never call this function with anything other than the top-most window
4403     * as its parameter, unless you are fond of undefined behavior.
4404     *
4405     * After creating the object, the widget will set itself as resize object
4406     * for the window with elm_win_resize_object_add(), so when shown it will
4407     * appear to cover almost the entire window (how much of it depends on its
4408     * content and the style used). It must not be added into other container
4409     * objects and it needs not be moved or resized manually.
4410     *
4411     * @param parent The parent object
4412     * @return The new object or NULL if it cannot be created
4413     */
4414    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4415    /**
4416     * Activates an inwin object, ensuring its visibility
4417     *
4418     * This function will make sure that the inwin @p obj is completely visible
4419     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4420     * to the front. It also sets the keyboard focus to it, which will be passed
4421     * onto its content.
4422     *
4423     * The object's theme will also receive the signal "elm,action,show" with
4424     * source "elm".
4425     *
4426     * @param obj The inwin to activate
4427     */
4428    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4429    /**
4430     * Set the content of an inwin object.
4431     *
4432     * Once the content object is set, a previously set one will be deleted.
4433     * If you want to keep that old content object, use the
4434     * elm_win_inwin_content_unset() function.
4435     *
4436     * @param obj The inwin object
4437     * @param content The object to set as content
4438     */
4439    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4440    /**
4441     * Get the content of an inwin object.
4442     *
4443     * Return the content object which is set for this widget.
4444     *
4445     * The returned object is valid as long as the inwin is still alive and no
4446     * other content is set on it. Deleting the object will notify the inwin
4447     * about it and this one will be left empty.
4448     *
4449     * If you need to remove an inwin's content to be reused somewhere else,
4450     * see elm_win_inwin_content_unset().
4451     *
4452     * @param obj The inwin object
4453     * @return The content that is being used
4454     */
4455    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4456    /**
4457     * Unset the content of an inwin object.
4458     *
4459     * Unparent and return the content object which was set for this widget.
4460     *
4461     * @param obj The inwin object
4462     * @return The content that was being used
4463     */
4464    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4465    /**
4466     * @}
4467     */
4468    /* X specific calls - won't work on non-x engines (return 0) */
4469
4470    /**
4471     * Get the Ecore_X_Window of an Evas_Object
4472     *
4473     * @param obj The object
4474     *
4475     * @return The Ecore_X_Window of @p obj
4476     *
4477     * @ingroup Win
4478     */
4479    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4480
4481    /* smart callbacks called:
4482     * "delete,request" - the user requested to delete the window
4483     * "focus,in" - window got focus
4484     * "focus,out" - window lost focus
4485     * "moved" - window that holds the canvas was moved
4486     */
4487
4488    /**
4489     * @defgroup Bg Bg
4490     *
4491     * @image html img/widget/bg/preview-00.png
4492     * @image latex img/widget/bg/preview-00.eps
4493     *
4494     * @brief Background object, used for setting a solid color, image or Edje
4495     * group as background to a window or any container object.
4496     *
4497     * The bg object is used for setting a solid background to a window or
4498     * packing into any container object. It works just like an image, but has
4499     * some properties useful to a background, like setting it to tiled,
4500     * centered, scaled or stretched.
4501     *
4502     * Here is some sample code using it:
4503     * @li @ref bg_01_example_page
4504     * @li @ref bg_02_example_page
4505     * @li @ref bg_03_example_page
4506     */
4507
4508    /* bg */
4509    typedef enum _Elm_Bg_Option
4510      {
4511         ELM_BG_OPTION_CENTER,  /**< center the background */
4512         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4513         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4514         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4515      } Elm_Bg_Option;
4516
4517    /**
4518     * Add a new background to the parent
4519     *
4520     * @param parent The parent object
4521     * @return The new object or NULL if it cannot be created
4522     *
4523     * @ingroup Bg
4524     */
4525    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4526
4527    /**
4528     * Set the file (image or edje) used for the background
4529     *
4530     * @param obj The bg object
4531     * @param file The file path
4532     * @param group Optional key (group in Edje) within the file
4533     *
4534     * This sets the image file used in the background object. The image (or edje)
4535     * will be stretched (retaining aspect if its an image file) to completely fill
4536     * the bg object. This may mean some parts are not visible.
4537     *
4538     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4539     * even if @p file is NULL.
4540     *
4541     * @ingroup Bg
4542     */
4543    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4544
4545    /**
4546     * Get the file (image or edje) used for the background
4547     *
4548     * @param obj The bg object
4549     * @param file The file path
4550     * @param group Optional key (group in Edje) within the file
4551     *
4552     * @ingroup Bg
4553     */
4554    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4555
4556    /**
4557     * Set the option used for the background image
4558     *
4559     * @param obj The bg object
4560     * @param option The desired background option (TILE, SCALE)
4561     *
4562     * This sets the option used for manipulating the display of the background
4563     * image. The image can be tiled or scaled.
4564     *
4565     * @ingroup Bg
4566     */
4567    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4568
4569    /**
4570     * Get the option used for the background image
4571     *
4572     * @param obj The bg object
4573     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4574     *
4575     * @ingroup Bg
4576     */
4577    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4578    /**
4579     * Set the option used for the background color
4580     *
4581     * @param obj The bg object
4582     * @param r
4583     * @param g
4584     * @param b
4585     *
4586     * This sets the color used for the background rectangle. Its range goes
4587     * from 0 to 255.
4588     *
4589     * @ingroup Bg
4590     */
4591    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4592    /**
4593     * Get the option used for the background color
4594     *
4595     * @param obj The bg object
4596     * @param r
4597     * @param g
4598     * @param b
4599     *
4600     * @ingroup Bg
4601     */
4602    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4603
4604    /**
4605     * Set the overlay object used for the background object.
4606     *
4607     * @param obj The bg object
4608     * @param overlay The overlay object
4609     *
4610     * This provides a way for elm_bg to have an 'overlay' that will be on top
4611     * of the bg. Once the over object is set, a previously set one will be
4612     * deleted, even if you set the new one to NULL. If you want to keep that
4613     * old content object, use the elm_bg_overlay_unset() function.
4614     *
4615     * @ingroup Bg
4616     */
4617
4618    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4619
4620    /**
4621     * Get the overlay object used for the background object.
4622     *
4623     * @param obj The bg object
4624     * @return The content that is being used
4625     *
4626     * Return the content object which is set for this widget
4627     *
4628     * @ingroup Bg
4629     */
4630    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4631
4632    /**
4633     * Get the overlay object used for the background object.
4634     *
4635     * @param obj The bg object
4636     * @return The content that was being used
4637     *
4638     * Unparent and return the overlay object which was set for this widget
4639     *
4640     * @ingroup Bg
4641     */
4642    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4643
4644    /**
4645     * Set the size of the pixmap representation of the image.
4646     *
4647     * This option just makes sense if an image is going to be set in the bg.
4648     *
4649     * @param obj The bg object
4650     * @param w The new width of the image pixmap representation.
4651     * @param h The new height of the image pixmap representation.
4652     *
4653     * This function sets a new size for pixmap representation of the given bg
4654     * image. It allows the image to be loaded already in the specified size,
4655     * reducing the memory usage and load time when loading a big image with load
4656     * size set to a smaller size.
4657     *
4658     * NOTE: this is just a hint, the real size of the pixmap may differ
4659     * depending on the type of image being loaded, being bigger than requested.
4660     *
4661     * @ingroup Bg
4662     */
4663    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4664    /* smart callbacks called:
4665     */
4666
4667    /**
4668     * @defgroup Icon Icon
4669     *
4670     * @image html img/widget/icon/preview-00.png
4671     * @image latex img/widget/icon/preview-00.eps
4672     *
4673     * An object that provides standard icon images (delete, edit, arrows, etc.)
4674     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4675     *
4676     * The icon image requested can be in the elementary theme, or in the
4677     * freedesktop.org paths. It's possible to set the order of preference from
4678     * where the image will be used.
4679     *
4680     * This API is very similar to @ref Image, but with ready to use images.
4681     *
4682     * Default images provided by the theme are described below.
4683     *
4684     * The first list contains icons that were first intended to be used in
4685     * toolbars, but can be used in many other places too:
4686     * @li home
4687     * @li close
4688     * @li apps
4689     * @li arrow_up
4690     * @li arrow_down
4691     * @li arrow_left
4692     * @li arrow_right
4693     * @li chat
4694     * @li clock
4695     * @li delete
4696     * @li edit
4697     * @li refresh
4698     * @li folder
4699     * @li file
4700     *
4701     * Now some icons that were designed to be used in menus (but again, you can
4702     * use them anywhere else):
4703     * @li menu/home
4704     * @li menu/close
4705     * @li menu/apps
4706     * @li menu/arrow_up
4707     * @li menu/arrow_down
4708     * @li menu/arrow_left
4709     * @li menu/arrow_right
4710     * @li menu/chat
4711     * @li menu/clock
4712     * @li menu/delete
4713     * @li menu/edit
4714     * @li menu/refresh
4715     * @li menu/folder
4716     * @li menu/file
4717     *
4718     * And here we have some media player specific icons:
4719     * @li media_player/forward
4720     * @li media_player/info
4721     * @li media_player/next
4722     * @li media_player/pause
4723     * @li media_player/play
4724     * @li media_player/prev
4725     * @li media_player/rewind
4726     * @li media_player/stop
4727     *
4728     * Signals that you can add callbacks for are:
4729     *
4730     * "clicked" - This is called when a user has clicked the icon
4731     *
4732     * An example of usage for this API follows:
4733     * @li @ref tutorial_icon
4734     */
4735
4736    /**
4737     * @addtogroup Icon
4738     * @{
4739     */
4740
4741    typedef enum _Elm_Icon_Type
4742      {
4743         ELM_ICON_NONE,
4744         ELM_ICON_FILE,
4745         ELM_ICON_STANDARD
4746      } Elm_Icon_Type;
4747    /**
4748     * @enum _Elm_Icon_Lookup_Order
4749     * @typedef Elm_Icon_Lookup_Order
4750     *
4751     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4752     * theme, FDO paths, or both?
4753     *
4754     * @ingroup Icon
4755     */
4756    typedef enum _Elm_Icon_Lookup_Order
4757      {
4758         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4759         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4760         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4761         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4762      } Elm_Icon_Lookup_Order;
4763
4764    /**
4765     * Add a new icon object to the parent.
4766     *
4767     * @param parent The parent object
4768     * @return The new object or NULL if it cannot be created
4769     *
4770     * @see elm_icon_file_set()
4771     *
4772     * @ingroup Icon
4773     */
4774    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4775    /**
4776     * Set the file that will be used as icon.
4777     *
4778     * @param obj The icon object
4779     * @param file The path to file that will be used as icon image
4780     * @param group The group that the icon belongs to an edje file
4781     *
4782     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4783     *
4784     * @note The icon image set by this function can be changed by
4785     * elm_icon_standard_set().
4786     *
4787     * @see elm_icon_file_get()
4788     *
4789     * @ingroup Icon
4790     */
4791    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4792    /**
4793     * Set a location in memory to be used as an icon
4794     *
4795     * @param obj The icon object
4796     * @param img The binary data that will be used as an image
4797     * @param size The size of binary data @p img
4798     * @param format Optional format of @p img to pass to the image loader
4799     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4800     *
4801     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4802     *
4803     * @note The icon image set by this function can be changed by
4804     * elm_icon_standard_set().
4805     *
4806     * @ingroup Icon
4807     */
4808    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);
4809    /**
4810     * Get the file that will be used as icon.
4811     *
4812     * @param obj The icon object
4813     * @param file The path to file that will be used as the icon image
4814     * @param group The group that the icon belongs to, in edje file
4815     *
4816     * @see elm_icon_file_set()
4817     *
4818     * @ingroup Icon
4819     */
4820    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4821    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4822    /**
4823     * Set the icon by icon standards names.
4824     *
4825     * @param obj The icon object
4826     * @param name The icon name
4827     *
4828     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4829     *
4830     * For example, freedesktop.org defines standard icon names such as "home",
4831     * "network", etc. There can be different icon sets to match those icon
4832     * keys. The @p name given as parameter is one of these "keys", and will be
4833     * used to look in the freedesktop.org paths and elementary theme. One can
4834     * change the lookup order with elm_icon_order_lookup_set().
4835     *
4836     * If name is not found in any of the expected locations and it is the
4837     * absolute path of an image file, this image will be used.
4838     *
4839     * @note The icon image set by this function can be changed by
4840     * elm_icon_file_set().
4841     *
4842     * @see elm_icon_standard_get()
4843     * @see elm_icon_file_set()
4844     *
4845     * @ingroup Icon
4846     */
4847    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4848    /**
4849     * Get the icon name set by icon standard names.
4850     *
4851     * @param obj The icon object
4852     * @return The icon name
4853     *
4854     * If the icon image was set using elm_icon_file_set() instead of
4855     * elm_icon_standard_set(), then this function will return @c NULL.
4856     *
4857     * @see elm_icon_standard_set()
4858     *
4859     * @ingroup Icon
4860     */
4861    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4862    /**
4863     * Set the smooth scaling for an icon object.
4864     *
4865     * @param obj The icon object
4866     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4867     * otherwise. Default is @c EINA_TRUE.
4868     *
4869     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4870     * scaling provides a better resulting image, but is slower.
4871     *
4872     * The smooth scaling should be disabled when making animations that change
4873     * the icon size, since they will be faster. Animations that don't require
4874     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4875     * is already scaled, since the scaled icon image will be cached).
4876     *
4877     * @see elm_icon_smooth_get()
4878     *
4879     * @ingroup Icon
4880     */
4881    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4882    /**
4883     * Get whether smooth scaling is enabled for an icon object.
4884     *
4885     * @param obj The icon object
4886     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4887     *
4888     * @see elm_icon_smooth_set()
4889     *
4890     * @ingroup Icon
4891     */
4892    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4893    /**
4894     * Disable scaling of this object.
4895     *
4896     * @param obj The icon object.
4897     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4898     * otherwise. Default is @c EINA_FALSE.
4899     *
4900     * This function disables scaling of the icon object through the function
4901     * elm_object_scale_set(). However, this does not affect the object
4902     * size/resize in any way. For that effect, take a look at
4903     * elm_icon_scale_set().
4904     *
4905     * @see elm_icon_no_scale_get()
4906     * @see elm_icon_scale_set()
4907     * @see elm_object_scale_set()
4908     *
4909     * @ingroup Icon
4910     */
4911    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4912    /**
4913     * Get whether scaling is disabled on the object.
4914     *
4915     * @param obj The icon object
4916     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4917     *
4918     * @see elm_icon_no_scale_set()
4919     *
4920     * @ingroup Icon
4921     */
4922    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4923    /**
4924     * Set if the object is (up/down) resizable.
4925     *
4926     * @param obj The icon object
4927     * @param scale_up A bool to set if the object is resizable up. Default is
4928     * @c EINA_TRUE.
4929     * @param scale_down A bool to set if the object is resizable down. Default
4930     * is @c EINA_TRUE.
4931     *
4932     * This function limits the icon object resize ability. If @p scale_up is set to
4933     * @c EINA_FALSE, the object can't have its height or width resized to a value
4934     * higher than the original icon size. Same is valid for @p scale_down.
4935     *
4936     * @see elm_icon_scale_get()
4937     *
4938     * @ingroup Icon
4939     */
4940    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4941    /**
4942     * Get if the object is (up/down) resizable.
4943     *
4944     * @param obj The icon object
4945     * @param scale_up A bool to set if the object is resizable up
4946     * @param scale_down A bool to set if the object is resizable down
4947     *
4948     * @see elm_icon_scale_set()
4949     *
4950     * @ingroup Icon
4951     */
4952    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4953    /**
4954     * Get the object's image size
4955     *
4956     * @param obj The icon object
4957     * @param w A pointer to store the width in
4958     * @param h A pointer to store the height in
4959     *
4960     * @ingroup Icon
4961     */
4962    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4963    /**
4964     * Set if the icon fill the entire object area.
4965     *
4966     * @param obj The icon object
4967     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4968     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4969     *
4970     * When the icon object is resized to a different aspect ratio from the
4971     * original icon image, the icon image will still keep its aspect. This flag
4972     * tells how the image should fill the object's area. They are: keep the
4973     * entire icon inside the limits of height and width of the object (@p
4974     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4975     * of the object, and the icon will fill the entire object (@p fill_outside
4976     * is @c EINA_TRUE).
4977     *
4978     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4979     * retain property to false. Thus, the icon image will always keep its
4980     * original aspect ratio.
4981     *
4982     * @see elm_icon_fill_outside_get()
4983     * @see elm_image_fill_outside_set()
4984     *
4985     * @ingroup Icon
4986     */
4987    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4988    /**
4989     * Get if the object is filled outside.
4990     *
4991     * @param obj The icon object
4992     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4993     *
4994     * @see elm_icon_fill_outside_set()
4995     *
4996     * @ingroup Icon
4997     */
4998    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4999    /**
5000     * Set the prescale size for the icon.
5001     *
5002     * @param obj The icon object
5003     * @param size The prescale size. This value is used for both width and
5004     * height.
5005     *
5006     * This function sets a new size for pixmap representation of the given
5007     * icon. It allows the icon to be loaded already in the specified size,
5008     * reducing the memory usage and load time when loading a big icon with load
5009     * size set to a smaller size.
5010     *
5011     * It's equivalent to the elm_bg_load_size_set() function for bg.
5012     *
5013     * @note this is just a hint, the real size of the pixmap may differ
5014     * depending on the type of icon being loaded, being bigger than requested.
5015     *
5016     * @see elm_icon_prescale_get()
5017     * @see elm_bg_load_size_set()
5018     *
5019     * @ingroup Icon
5020     */
5021    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5022    /**
5023     * Get the prescale size for the icon.
5024     *
5025     * @param obj The icon object
5026     * @return The prescale size
5027     *
5028     * @see elm_icon_prescale_set()
5029     *
5030     * @ingroup Icon
5031     */
5032    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5033    /**
5034     * Sets the icon lookup order used by elm_icon_standard_set().
5035     *
5036     * @param obj The icon object
5037     * @param order The icon lookup order (can be one of
5038     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5039     * or ELM_ICON_LOOKUP_THEME)
5040     *
5041     * @see elm_icon_order_lookup_get()
5042     * @see Elm_Icon_Lookup_Order
5043     *
5044     * @ingroup Icon
5045     */
5046    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5047    /**
5048     * Gets the icon lookup order.
5049     *
5050     * @param obj The icon object
5051     * @return The icon lookup order
5052     *
5053     * @see elm_icon_order_lookup_set()
5054     * @see Elm_Icon_Lookup_Order
5055     *
5056     * @ingroup Icon
5057     */
5058    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5059    /**
5060     * Get if the icon supports animation or not.
5061     *
5062     * @param obj The icon object
5063     * @return @c EINA_TRUE if the icon supports animation,
5064     *         @c EINA_FALSE otherwise.
5065     *
5066     * Return if this elm icon's image can be animated. Currently Evas only
5067     * supports gif animation. If the return value is EINA_FALSE, other
5068     * elm_icon_animated_XXX APIs won't work.
5069     * @ingroup Icon
5070     */
5071    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5072    /**
5073     * Set animation mode of the icon.
5074     *
5075     * @param obj The icon object
5076     * @param anim @c EINA_TRUE if the object do animation job,
5077     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5078     *
5079     * Since the default animation mode is set to EINA_FALSE, 
5080     * the icon is shown without animation.
5081     * This might be desirable when the application developer wants to show
5082     * a snapshot of the animated icon.
5083     * Set it to EINA_TRUE when the icon needs to be animated.
5084     * @ingroup Icon
5085     */
5086    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5087    /**
5088     * Get animation mode of the icon.
5089     *
5090     * @param obj The icon object
5091     * @return The animation mode of the icon object
5092     * @see elm_icon_animated_set
5093     * @ingroup Icon
5094     */
5095    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5096    /**
5097     * Set animation play mode of the icon.
5098     *
5099     * @param obj The icon object
5100     * @param play @c EINA_TRUE the object play animation images,
5101     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5102     *
5103     * To play elm icon's animation, set play to EINA_TURE.
5104     * For example, you make gif player using this set/get API and click event.
5105     *
5106     * 1. Click event occurs
5107     * 2. Check play flag using elm_icon_animaged_play_get
5108     * 3. If elm icon was playing, set play to EINA_FALSE.
5109     *    Then animation will be stopped and vice versa
5110     * @ingroup Icon
5111     */
5112    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5113    /**
5114     * Get animation play mode of the icon.
5115     *
5116     * @param obj The icon object
5117     * @return The play mode of the icon object
5118     *
5119     * @see elm_icon_animated_play_get
5120     * @ingroup Icon
5121     */
5122    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5123
5124    /**
5125     * @}
5126     */
5127
5128    /**
5129     * @defgroup Image Image
5130     *
5131     * @image html img/widget/image/preview-00.png
5132     * @image latex img/widget/image/preview-00.eps
5133
5134     *
5135     * An object that allows one to load an image file to it. It can be used
5136     * anywhere like any other elementary widget.
5137     *
5138     * This widget provides most of the functionality provided from @ref Bg or @ref
5139     * Icon, but with a slightly different API (use the one that fits better your
5140     * needs).
5141     *
5142     * The features not provided by those two other image widgets are:
5143     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5144     * @li change the object orientation with elm_image_orient_set();
5145     * @li and turning the image editable with elm_image_editable_set().
5146     *
5147     * Signals that you can add callbacks for are:
5148     *
5149     * @li @c "clicked" - This is called when a user has clicked the image
5150     *
5151     * An example of usage for this API follows:
5152     * @li @ref tutorial_image
5153     */
5154
5155    /**
5156     * @addtogroup Image
5157     * @{
5158     */
5159
5160    /**
5161     * @enum _Elm_Image_Orient
5162     * @typedef Elm_Image_Orient
5163     *
5164     * Possible orientation options for elm_image_orient_set().
5165     *
5166     * @image html elm_image_orient_set.png
5167     * @image latex elm_image_orient_set.eps width=\textwidth
5168     *
5169     * @ingroup Image
5170     */
5171    typedef enum _Elm_Image_Orient
5172      {
5173         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5174         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5175         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5176         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5177         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5178         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5179         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5180         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5181      } Elm_Image_Orient;
5182
5183    /**
5184     * Add a new image to the parent.
5185     *
5186     * @param parent The parent object
5187     * @return The new object or NULL if it cannot be created
5188     *
5189     * @see elm_image_file_set()
5190     *
5191     * @ingroup Image
5192     */
5193    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5194    /**
5195     * Set the file that will be used as image.
5196     *
5197     * @param obj The image object
5198     * @param file The path to file that will be used as image
5199     * @param group The group that the image belongs in edje file (if it's an
5200     * edje image)
5201     *
5202     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5203     *
5204     * @see elm_image_file_get()
5205     *
5206     * @ingroup Image
5207     */
5208    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5209    /**
5210     * Get the file that will be used as image.
5211     *
5212     * @param obj The image object
5213     * @param file The path to file
5214     * @param group The group that the image belongs in edje file
5215     *
5216     * @see elm_image_file_set()
5217     *
5218     * @ingroup Image
5219     */
5220    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5221    /**
5222     * Set the smooth effect for an image.
5223     *
5224     * @param obj The image object
5225     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5226     * otherwise. Default is @c EINA_TRUE.
5227     *
5228     * Set the scaling algorithm to be used when scaling the image. Smooth
5229     * scaling provides a better resulting image, but is slower.
5230     *
5231     * The smooth scaling should be disabled when making animations that change
5232     * the image size, since it will be faster. Animations that don't require
5233     * resizing of the image can keep the smooth scaling enabled (even if the
5234     * image is already scaled, since the scaled image will be cached).
5235     *
5236     * @see elm_image_smooth_get()
5237     *
5238     * @ingroup Image
5239     */
5240    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5241    /**
5242     * Get the smooth effect for an image.
5243     *
5244     * @param obj The image object
5245     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5246     *
5247     * @see elm_image_smooth_get()
5248     *
5249     * @ingroup Image
5250     */
5251    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5252
5253    /**
5254     * Gets the current size of the image.
5255     *
5256     * @param obj The image object.
5257     * @param w Pointer to store width, or NULL.
5258     * @param h Pointer to store height, or NULL.
5259     *
5260     * This is the real size of the image, not the size of the object.
5261     *
5262     * On error, neither w or h will be written.
5263     *
5264     * @ingroup Image
5265     */
5266    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5267    /**
5268     * Disable scaling of this object.
5269     *
5270     * @param obj The image object.
5271     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5272     * otherwise. Default is @c EINA_FALSE.
5273     *
5274     * This function disables scaling of the elm_image widget through the
5275     * function elm_object_scale_set(). However, this does not affect the widget
5276     * size/resize in any way. For that effect, take a look at
5277     * elm_image_scale_set().
5278     *
5279     * @see elm_image_no_scale_get()
5280     * @see elm_image_scale_set()
5281     * @see elm_object_scale_set()
5282     *
5283     * @ingroup Image
5284     */
5285    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5286    /**
5287     * Get whether scaling is disabled on the object.
5288     *
5289     * @param obj The image object
5290     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5291     *
5292     * @see elm_image_no_scale_set()
5293     *
5294     * @ingroup Image
5295     */
5296    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5297    /**
5298     * Set if the object is (up/down) resizable.
5299     *
5300     * @param obj The image object
5301     * @param scale_up A bool to set if the object is resizable up. Default is
5302     * @c EINA_TRUE.
5303     * @param scale_down A bool to set if the object is resizable down. Default
5304     * is @c EINA_TRUE.
5305     *
5306     * This function limits the image resize ability. If @p scale_up is set to
5307     * @c EINA_FALSE, the object can't have its height or width resized to a value
5308     * higher than the original image size. Same is valid for @p scale_down.
5309     *
5310     * @see elm_image_scale_get()
5311     *
5312     * @ingroup Image
5313     */
5314    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5315    /**
5316     * Get if the object is (up/down) resizable.
5317     *
5318     * @param obj The image object
5319     * @param scale_up A bool to set if the object is resizable up
5320     * @param scale_down A bool to set if the object is resizable down
5321     *
5322     * @see elm_image_scale_set()
5323     *
5324     * @ingroup Image
5325     */
5326    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5327    /**
5328     * Set if the image fills the entire object area, when keeping the aspect ratio.
5329     *
5330     * @param obj The image object
5331     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5332     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5333     *
5334     * When the image should keep its aspect ratio even if resized to another
5335     * aspect ratio, there are two possibilities to resize it: keep the entire
5336     * image inside the limits of height and width of the object (@p fill_outside
5337     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5338     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5339     *
5340     * @note This option will have no effect if
5341     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5342     *
5343     * @see elm_image_fill_outside_get()
5344     * @see elm_image_aspect_ratio_retained_set()
5345     *
5346     * @ingroup Image
5347     */
5348    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5349    /**
5350     * Get if the object is filled outside
5351     *
5352     * @param obj The image object
5353     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5354     *
5355     * @see elm_image_fill_outside_set()
5356     *
5357     * @ingroup Image
5358     */
5359    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5360    /**
5361     * Set the prescale size for the image
5362     *
5363     * @param obj The image object
5364     * @param size The prescale size. This value is used for both width and
5365     * height.
5366     *
5367     * This function sets a new size for pixmap representation of the given
5368     * image. It allows the image to be loaded already in the specified size,
5369     * reducing the memory usage and load time when loading a big image with load
5370     * size set to a smaller size.
5371     *
5372     * It's equivalent to the elm_bg_load_size_set() function for bg.
5373     *
5374     * @note this is just a hint, the real size of the pixmap may differ
5375     * depending on the type of image being loaded, being bigger than requested.
5376     *
5377     * @see elm_image_prescale_get()
5378     * @see elm_bg_load_size_set()
5379     *
5380     * @ingroup Image
5381     */
5382    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5383    /**
5384     * Get the prescale size for the image
5385     *
5386     * @param obj The image object
5387     * @return The prescale size
5388     *
5389     * @see elm_image_prescale_set()
5390     *
5391     * @ingroup Image
5392     */
5393    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5394    /**
5395     * Set the image orientation.
5396     *
5397     * @param obj The image object
5398     * @param orient The image orientation @ref Elm_Image_Orient
5399     *  Default is #ELM_IMAGE_ORIENT_NONE.
5400     *
5401     * This function allows to rotate or flip the given image.
5402     *
5403     * @see elm_image_orient_get()
5404     * @see @ref Elm_Image_Orient
5405     *
5406     * @ingroup Image
5407     */
5408    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5409    /**
5410     * Get the image orientation.
5411     *
5412     * @param obj The image object
5413     * @return The image orientation @ref Elm_Image_Orient
5414     *
5415     * @see elm_image_orient_set()
5416     * @see @ref Elm_Image_Orient
5417     *
5418     * @ingroup Image
5419     */
5420    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5421    /**
5422     * Make the image 'editable'.
5423     *
5424     * @param obj Image object.
5425     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5426     *
5427     * This means the image is a valid drag target for drag and drop, and can be
5428     * cut or pasted too.
5429     *
5430     * @ingroup Image
5431     */
5432    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5433    /**
5434     * Check if the image 'editable'.
5435     *
5436     * @param obj Image object.
5437     * @return Editability.
5438     *
5439     * A return value of EINA_TRUE means the image is a valid drag target
5440     * for drag and drop, and can be cut or pasted too.
5441     *
5442     * @ingroup Image
5443     */
5444    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5445    /**
5446     * Get the basic Evas_Image object from this object (widget).
5447     *
5448     * @param obj The image object to get the inlined image from
5449     * @return The inlined image object, or NULL if none exists
5450     *
5451     * This function allows one to get the underlying @c Evas_Object of type
5452     * Image from this elementary widget. It can be useful to do things like get
5453     * the pixel data, save the image to a file, etc.
5454     *
5455     * @note Be careful to not manipulate it, as it is under control of
5456     * elementary.
5457     *
5458     * @ingroup Image
5459     */
5460    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5461    /**
5462     * Set whether the original aspect ratio of the image should be kept on resize.
5463     *
5464     * @param obj The image object.
5465     * @param retained @c EINA_TRUE if the image should retain the aspect,
5466     * @c EINA_FALSE otherwise.
5467     *
5468     * The original aspect ratio (width / height) of the image is usually
5469     * distorted to match the object's size. Enabling this option will retain
5470     * this original aspect, and the way that the image is fit into the object's
5471     * area depends on the option set by elm_image_fill_outside_set().
5472     *
5473     * @see elm_image_aspect_ratio_retained_get()
5474     * @see elm_image_fill_outside_set()
5475     *
5476     * @ingroup Image
5477     */
5478    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5479    /**
5480     * Get if the object retains the original aspect ratio.
5481     *
5482     * @param obj The image object.
5483     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5484     * otherwise.
5485     *
5486     * @ingroup Image
5487     */
5488    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5489
5490    /**
5491     * @}
5492     */
5493
5494    /* glview */
5495    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5496
5497    typedef enum _Elm_GLView_Mode
5498      {
5499         ELM_GLVIEW_ALPHA   = 1,
5500         ELM_GLVIEW_DEPTH   = 2,
5501         ELM_GLVIEW_STENCIL = 4
5502      } Elm_GLView_Mode;
5503
5504    /**
5505     * Defines a policy for the glview resizing.
5506     *
5507     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5508     */
5509    typedef enum _Elm_GLView_Resize_Policy
5510      {
5511         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5512         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5513      } Elm_GLView_Resize_Policy;
5514
5515    typedef enum _Elm_GLView_Render_Policy
5516      {
5517         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5518         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5519      } Elm_GLView_Render_Policy;
5520
5521    /**
5522     * @defgroup GLView
5523     *
5524     * A simple GLView widget that allows GL rendering.
5525     *
5526     * Signals that you can add callbacks for are:
5527     *
5528     * @{
5529     */
5530
5531    /**
5532     * Add a new glview to the parent
5533     *
5534     * @param parent The parent object
5535     * @return The new object or NULL if it cannot be created
5536     *
5537     * @ingroup GLView
5538     */
5539    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5540
5541    /**
5542     * Sets the size of the glview
5543     *
5544     * @param obj The glview object
5545     * @param width width of the glview object
5546     * @param height height of the glview object
5547     *
5548     * @ingroup GLView
5549     */
5550    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5551
5552    /**
5553     * Gets the size of the glview.
5554     *
5555     * @param obj The glview object
5556     * @param width width of the glview object
5557     * @param height height of the glview object
5558     *
5559     * Note that this function returns the actual image size of the
5560     * glview.  This means that when the scale policy is set to
5561     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5562     * size.
5563     *
5564     * @ingroup GLView
5565     */
5566    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5567
5568    /**
5569     * Gets the gl api struct for gl rendering
5570     *
5571     * @param obj The glview object
5572     * @return The api object or NULL if it cannot be created
5573     *
5574     * @ingroup GLView
5575     */
5576    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5577
5578    /**
5579     * Set the mode of the GLView. Supports Three simple modes.
5580     *
5581     * @param obj The glview object
5582     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5583     * @return True if set properly.
5584     *
5585     * @ingroup GLView
5586     */
5587    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5588
5589    /**
5590     * Set the resize policy for the glview object.
5591     *
5592     * @param obj The glview object.
5593     * @param policy The scaling policy.
5594     *
5595     * By default, the resize policy is set to
5596     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5597     * destroys the previous surface and recreates the newly specified
5598     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5599     * however, glview only scales the image object and not the underlying
5600     * GL Surface.
5601     *
5602     * @ingroup GLView
5603     */
5604    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5605
5606    /**
5607     * Set the render policy for the glview object.
5608     *
5609     * @param obj The glview object.
5610     * @param policy The render policy.
5611     *
5612     * By default, the render policy is set to
5613     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5614     * that during the render loop, glview is only redrawn if it needs
5615     * to be redrawn. (i.e. When it is visible) If the policy is set to
5616     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5617     * whether it is visible/need redrawing or not.
5618     *
5619     * @ingroup GLView
5620     */
5621    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5622
5623    /**
5624     * Set the init function that runs once in the main loop.
5625     *
5626     * @param obj The glview object.
5627     * @param func The init function to be registered.
5628     *
5629     * The registered init function gets called once during the render loop.
5630     *
5631     * @ingroup GLView
5632     */
5633    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5634
5635    /**
5636     * Set the render function that runs in the main loop.
5637     *
5638     * @param obj The glview object.
5639     * @param func The delete function to be registered.
5640     *
5641     * The registered del function gets called when GLView object is deleted.
5642     *
5643     * @ingroup GLView
5644     */
5645    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5646
5647    /**
5648     * Set the resize function that gets called when resize happens.
5649     *
5650     * @param obj The glview object.
5651     * @param func The resize function to be registered.
5652     *
5653     * @ingroup GLView
5654     */
5655    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5656
5657    /**
5658     * Set the render function that runs in the main loop.
5659     *
5660     * @param obj The glview object.
5661     * @param func The render function to be registered.
5662     *
5663     * @ingroup GLView
5664     */
5665    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5666
5667    /**
5668     * Notifies that there has been changes in the GLView.
5669     *
5670     * @param obj The glview object.
5671     *
5672     * @ingroup GLView
5673     */
5674    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5675
5676    /**
5677     * @}
5678     */
5679
5680    /* box */
5681    /**
5682     * @defgroup Box Box
5683     *
5684     * @image html img/widget/box/preview-00.png
5685     * @image latex img/widget/box/preview-00.eps width=\textwidth
5686     *
5687     * @image html img/box.png
5688     * @image latex img/box.eps width=\textwidth
5689     *
5690     * A box arranges objects in a linear fashion, governed by a layout function
5691     * that defines the details of this arrangement.
5692     *
5693     * By default, the box will use an internal function to set the layout to
5694     * a single row, either vertical or horizontal. This layout is affected
5695     * by a number of parameters, such as the homogeneous flag set by
5696     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5697     * elm_box_align_set() and the hints set to each object in the box.
5698     *
5699     * For this default layout, it's possible to change the orientation with
5700     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5701     * placing its elements ordered from top to bottom. When horizontal is set,
5702     * the order will go from left to right. If the box is set to be
5703     * homogeneous, every object in it will be assigned the same space, that
5704     * of the largest object. Padding can be used to set some spacing between
5705     * the cell given to each object. The alignment of the box, set with
5706     * elm_box_align_set(), determines how the bounding box of all the elements
5707     * will be placed within the space given to the box widget itself.
5708     *
5709     * The size hints of each object also affect how they are placed and sized
5710     * within the box. evas_object_size_hint_min_set() will give the minimum
5711     * size the object can have, and the box will use it as the basis for all
5712     * latter calculations. Elementary widgets set their own minimum size as
5713     * needed, so there's rarely any need to use it manually.
5714     *
5715     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5716     * used to tell whether the object will be allocated the minimum size it
5717     * needs or if the space given to it should be expanded. It's important
5718     * to realize that expanding the size given to the object is not the same
5719     * thing as resizing the object. It could very well end being a small
5720     * widget floating in a much larger empty space. If not set, the weight
5721     * for objects will normally be 0.0 for both axis, meaning the widget will
5722     * not be expanded. To take as much space possible, set the weight to
5723     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5724     *
5725     * Besides how much space each object is allocated, it's possible to control
5726     * how the widget will be placed within that space using
5727     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5728     * for both axis, meaning the object will be centered, but any value from
5729     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5730     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5731     * is -1.0, means the object will be resized to fill the entire space it
5732     * was allocated.
5733     *
5734     * In addition, customized functions to define the layout can be set, which
5735     * allow the application developer to organize the objects within the box
5736     * in any number of ways.
5737     *
5738     * The special elm_box_layout_transition() function can be used
5739     * to switch from one layout to another, animating the motion of the
5740     * children of the box.
5741     *
5742     * @note Objects should not be added to box objects using _add() calls.
5743     *
5744     * Some examples on how to use boxes follow:
5745     * @li @ref box_example_01
5746     * @li @ref box_example_02
5747     *
5748     * @{
5749     */
5750    /**
5751     * @typedef Elm_Box_Transition
5752     *
5753     * Opaque handler containing the parameters to perform an animated
5754     * transition of the layout the box uses.
5755     *
5756     * @see elm_box_transition_new()
5757     * @see elm_box_layout_set()
5758     * @see elm_box_layout_transition()
5759     */
5760    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5761
5762    /**
5763     * Add a new box to the parent
5764     *
5765     * By default, the box will be in vertical mode and non-homogeneous.
5766     *
5767     * @param parent The parent object
5768     * @return The new object or NULL if it cannot be created
5769     */
5770    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5771    /**
5772     * Set the horizontal orientation
5773     *
5774     * By default, box object arranges their contents vertically from top to
5775     * bottom.
5776     * By calling this function with @p horizontal as EINA_TRUE, the box will
5777     * become horizontal, arranging contents from left to right.
5778     *
5779     * @note This flag is ignored if a custom layout function is set.
5780     *
5781     * @param obj The box object
5782     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5783     * EINA_FALSE = vertical)
5784     */
5785    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5786    /**
5787     * Get the horizontal orientation
5788     *
5789     * @param obj The box object
5790     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5791     */
5792    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5793    /**
5794     * Set the box to arrange its children homogeneously
5795     *
5796     * If enabled, homogeneous layout makes all items the same size, according
5797     * to the size of the largest of its children.
5798     *
5799     * @note This flag is ignored if a custom layout function is set.
5800     *
5801     * @param obj The box object
5802     * @param homogeneous The homogeneous flag
5803     */
5804    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5805    /**
5806     * Get whether the box is using homogeneous mode or not
5807     *
5808     * @param obj The box object
5809     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5810     */
5811    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5812    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5813    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5814    /**
5815     * Add an object to the beginning of the pack list
5816     *
5817     * Pack @p subobj into the box @p obj, placing it first in the list of
5818     * children objects. The actual position the object will get on screen
5819     * depends on the layout used. If no custom layout is set, it will be at
5820     * the top or left, depending if the box is vertical or horizontal,
5821     * respectively.
5822     *
5823     * @param obj The box object
5824     * @param subobj The object to add to the box
5825     *
5826     * @see elm_box_pack_end()
5827     * @see elm_box_pack_before()
5828     * @see elm_box_pack_after()
5829     * @see elm_box_unpack()
5830     * @see elm_box_unpack_all()
5831     * @see elm_box_clear()
5832     */
5833    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5834    /**
5835     * Add an object at the end of the pack list
5836     *
5837     * Pack @p subobj into the box @p obj, placing it last in the list of
5838     * children objects. The actual position the object will get on screen
5839     * depends on the layout used. If no custom layout is set, it will be at
5840     * the bottom or right, depending if the box is vertical or horizontal,
5841     * respectively.
5842     *
5843     * @param obj The box object
5844     * @param subobj The object to add to the box
5845     *
5846     * @see elm_box_pack_start()
5847     * @see elm_box_pack_before()
5848     * @see elm_box_pack_after()
5849     * @see elm_box_unpack()
5850     * @see elm_box_unpack_all()
5851     * @see elm_box_clear()
5852     */
5853    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5854    /**
5855     * Adds an object to the box before the indicated object
5856     *
5857     * This will add the @p subobj to the box indicated before the object
5858     * indicated with @p before. If @p before is not already in the box, results
5859     * are undefined. Before means either to the left of the indicated object or
5860     * above it depending on orientation.
5861     *
5862     * @param obj The box object
5863     * @param subobj The object to add to the box
5864     * @param before The object before which to add it
5865     *
5866     * @see elm_box_pack_start()
5867     * @see elm_box_pack_end()
5868     * @see elm_box_pack_after()
5869     * @see elm_box_unpack()
5870     * @see elm_box_unpack_all()
5871     * @see elm_box_clear()
5872     */
5873    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5874    /**
5875     * Adds an object to the box after the indicated object
5876     *
5877     * This will add the @p subobj to the box indicated after the object
5878     * indicated with @p after. If @p after is not already in the box, results
5879     * are undefined. After means either to the right of the indicated object or
5880     * below it depending on orientation.
5881     *
5882     * @param obj The box object
5883     * @param subobj The object to add to the box
5884     * @param after The object after which to add it
5885     *
5886     * @see elm_box_pack_start()
5887     * @see elm_box_pack_end()
5888     * @see elm_box_pack_before()
5889     * @see elm_box_unpack()
5890     * @see elm_box_unpack_all()
5891     * @see elm_box_clear()
5892     */
5893    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5894    /**
5895     * Clear the box of all children
5896     *
5897     * Remove all the elements contained by the box, deleting the respective
5898     * objects.
5899     *
5900     * @param obj The box object
5901     *
5902     * @see elm_box_unpack()
5903     * @see elm_box_unpack_all()
5904     */
5905    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5906    /**
5907     * Unpack a box item
5908     *
5909     * Remove the object given by @p subobj from the box @p obj without
5910     * deleting it.
5911     *
5912     * @param obj The box object
5913     *
5914     * @see elm_box_unpack_all()
5915     * @see elm_box_clear()
5916     */
5917    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5918    /**
5919     * Remove all items from the box, without deleting them
5920     *
5921     * Clear the box from all children, but don't delete the respective objects.
5922     * If no other references of the box children exist, the objects will never
5923     * be deleted, and thus the application will leak the memory. Make sure
5924     * when using this function that you hold a reference to all the objects
5925     * in the box @p obj.
5926     *
5927     * @param obj The box object
5928     *
5929     * @see elm_box_clear()
5930     * @see elm_box_unpack()
5931     */
5932    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5933    /**
5934     * Retrieve a list of the objects packed into the box
5935     *
5936     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5937     * The order of the list corresponds to the packing order the box uses.
5938     *
5939     * You must free this list with eina_list_free() once you are done with it.
5940     *
5941     * @param obj The box object
5942     */
5943    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5944    /**
5945     * Set the space (padding) between the box's elements.
5946     *
5947     * Extra space in pixels that will be added between a box child and its
5948     * neighbors after its containing cell has been calculated. This padding
5949     * is set for all elements in the box, besides any possible padding that
5950     * individual elements may have through their size hints.
5951     *
5952     * @param obj The box object
5953     * @param horizontal The horizontal space between elements
5954     * @param vertical The vertical space between elements
5955     */
5956    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5957    /**
5958     * Get the space (padding) between the box's elements.
5959     *
5960     * @param obj The box object
5961     * @param horizontal The horizontal space between elements
5962     * @param vertical The vertical space between elements
5963     *
5964     * @see elm_box_padding_set()
5965     */
5966    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5967    /**
5968     * Set the alignment of the whole bouding box of contents.
5969     *
5970     * Sets how the bounding box containing all the elements of the box, after
5971     * their sizes and position has been calculated, will be aligned within
5972     * the space given for the whole box widget.
5973     *
5974     * @param obj The box object
5975     * @param horizontal The horizontal alignment of elements
5976     * @param vertical The vertical alignment of elements
5977     */
5978    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5979    /**
5980     * Get the alignment of the whole bouding box of contents.
5981     *
5982     * @param obj The box object
5983     * @param horizontal The horizontal alignment of elements
5984     * @param vertical The vertical alignment of elements
5985     *
5986     * @see elm_box_align_set()
5987     */
5988    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5989
5990    /**
5991     * Force the box to recalculate its children packing.
5992     *
5993     * If any children was added or removed, box will not calculate the
5994     * values immediately rather leaving it to the next main loop
5995     * iteration. While this is great as it would save lots of
5996     * recalculation, whenever you need to get the position of a just
5997     * added item you must force recalculate before doing so.
5998     *
5999     * @param obj The box object.
6000     */
6001    EAPI void                 elm_box_recalculate(Evas_Object *obj);
6002
6003    /**
6004     * Set the layout defining function to be used by the box
6005     *
6006     * Whenever anything changes that requires the box in @p obj to recalculate
6007     * the size and position of its elements, the function @p cb will be called
6008     * to determine what the layout of the children will be.
6009     *
6010     * Once a custom function is set, everything about the children layout
6011     * is defined by it. The flags set by elm_box_horizontal_set() and
6012     * elm_box_homogeneous_set() no longer have any meaning, and the values
6013     * given by elm_box_padding_set() and elm_box_align_set() are up to this
6014     * layout function to decide if they are used and how. These last two
6015     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6016     * passed to @p cb. The @c Evas_Object the function receives is not the
6017     * Elementary widget, but the internal Evas Box it uses, so none of the
6018     * functions described here can be used on it.
6019     *
6020     * Any of the layout functions in @c Evas can be used here, as well as the
6021     * special elm_box_layout_transition().
6022     *
6023     * The final @p data argument received by @p cb is the same @p data passed
6024     * here, and the @p free_data function will be called to free it
6025     * whenever the box is destroyed or another layout function is set.
6026     *
6027     * Setting @p cb to NULL will revert back to the default layout function.
6028     *
6029     * @param obj The box object
6030     * @param cb The callback function used for layout
6031     * @param data Data that will be passed to layout function
6032     * @param free_data Function called to free @p data
6033     *
6034     * @see elm_box_layout_transition()
6035     */
6036    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);
6037    /**
6038     * Special layout function that animates the transition from one layout to another
6039     *
6040     * Normally, when switching the layout function for a box, this will be
6041     * reflected immediately on screen on the next render, but it's also
6042     * possible to do this through an animated transition.
6043     *
6044     * This is done by creating an ::Elm_Box_Transition and setting the box
6045     * layout to this function.
6046     *
6047     * For example:
6048     * @code
6049     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6050     *                            evas_object_box_layout_vertical, // start
6051     *                            NULL, // data for initial layout
6052     *                            NULL, // free function for initial data
6053     *                            evas_object_box_layout_horizontal, // end
6054     *                            NULL, // data for final layout
6055     *                            NULL, // free function for final data
6056     *                            anim_end, // will be called when animation ends
6057     *                            NULL); // data for anim_end function\
6058     * elm_box_layout_set(box, elm_box_layout_transition, t,
6059     *                    elm_box_transition_free);
6060     * @endcode
6061     *
6062     * @note This function can only be used with elm_box_layout_set(). Calling
6063     * it directly will not have the expected results.
6064     *
6065     * @see elm_box_transition_new
6066     * @see elm_box_transition_free
6067     * @see elm_box_layout_set
6068     */
6069    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6070    /**
6071     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6072     *
6073     * If you want to animate the change from one layout to another, you need
6074     * to set the layout function of the box to elm_box_layout_transition(),
6075     * passing as user data to it an instance of ::Elm_Box_Transition with the
6076     * necessary information to perform this animation. The free function to
6077     * set for the layout is elm_box_transition_free().
6078     *
6079     * The parameters to create an ::Elm_Box_Transition sum up to how long
6080     * will it be, in seconds, a layout function to describe the initial point,
6081     * another for the final position of the children and one function to be
6082     * called when the whole animation ends. This last function is useful to
6083     * set the definitive layout for the box, usually the same as the end
6084     * layout for the animation, but could be used to start another transition.
6085     *
6086     * @param start_layout The layout function that will be used to start the animation
6087     * @param start_layout_data The data to be passed the @p start_layout function
6088     * @param start_layout_free_data Function to free @p start_layout_data
6089     * @param end_layout The layout function that will be used to end the animation
6090     * @param end_layout_free_data The data to be passed the @p end_layout function
6091     * @param end_layout_free_data Function to free @p end_layout_data
6092     * @param transition_end_cb Callback function called when animation ends
6093     * @param transition_end_data Data to be passed to @p transition_end_cb
6094     * @return An instance of ::Elm_Box_Transition
6095     *
6096     * @see elm_box_transition_new
6097     * @see elm_box_layout_transition
6098     */
6099    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);
6100    /**
6101     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6102     *
6103     * This function is mostly useful as the @c free_data parameter in
6104     * elm_box_layout_set() when elm_box_layout_transition().
6105     *
6106     * @param data The Elm_Box_Transition instance to be freed.
6107     *
6108     * @see elm_box_transition_new
6109     * @see elm_box_layout_transition
6110     */
6111    EAPI void                elm_box_transition_free(void *data);
6112    /**
6113     * @}
6114     */
6115
6116    /* button */
6117    /**
6118     * @defgroup Button Button
6119     *
6120     * @image html img/widget/button/preview-00.png
6121     * @image latex img/widget/button/preview-00.eps
6122     * @image html img/widget/button/preview-01.png
6123     * @image latex img/widget/button/preview-01.eps
6124     * @image html img/widget/button/preview-02.png
6125     * @image latex img/widget/button/preview-02.eps
6126     *
6127     * This is a push-button. Press it and run some function. It can contain
6128     * a simple label and icon object and it also has an autorepeat feature.
6129     *
6130     * This widgets emits the following signals:
6131     * @li "clicked": the user clicked the button (press/release).
6132     * @li "repeated": the user pressed the button without releasing it.
6133     * @li "pressed": button was pressed.
6134     * @li "unpressed": button was released after being pressed.
6135     * In all three cases, the @c event parameter of the callback will be
6136     * @c NULL.
6137     *
6138     * Also, defined in the default theme, the button has the following styles
6139     * available:
6140     * @li default: a normal button.
6141     * @li anchor: Like default, but the button fades away when the mouse is not
6142     * over it, leaving only the text or icon.
6143     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6144     * continuous look across its options.
6145     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6146     *
6147     * Follow through a complete example @ref button_example_01 "here".
6148     * @{
6149     */
6150    /**
6151     * Add a new button to the parent's canvas
6152     *
6153     * @param parent The parent object
6154     * @return The new object or NULL if it cannot be created
6155     */
6156    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6157    /**
6158     * Set the label used in the button
6159     *
6160     * The passed @p label can be NULL to clean any existing text in it and
6161     * leave the button as an icon only object.
6162     *
6163     * @param obj The button object
6164     * @param label The text will be written on the button
6165     * @deprecated use elm_object_text_set() instead.
6166     */
6167    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6168    /**
6169     * Get the label set for the button
6170     *
6171     * The string returned is an internal pointer and should not be freed or
6172     * altered. It will also become invalid when the button is destroyed.
6173     * The string returned, if not NULL, is a stringshare, so if you need to
6174     * keep it around even after the button is destroyed, you can use
6175     * eina_stringshare_ref().
6176     *
6177     * @param obj The button object
6178     * @return The text set to the label, or NULL if nothing is set
6179     * @deprecated use elm_object_text_set() instead.
6180     */
6181    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6182    /**
6183     * Set the icon used for the button
6184     *
6185     * Setting a new icon will delete any other that was previously set, making
6186     * any reference to them invalid. If you need to maintain the previous
6187     * object alive, unset it first with elm_button_icon_unset().
6188     *
6189     * @param obj The button object
6190     * @param icon The icon object for the button
6191     */
6192    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6193    /**
6194     * Get the icon used for the button
6195     *
6196     * Return the icon object which is set for this widget. If the button is
6197     * destroyed or another icon is set, the returned object will be deleted
6198     * and any reference to it will be invalid.
6199     *
6200     * @param obj The button object
6201     * @return The icon object that is being used
6202     *
6203     * @see elm_button_icon_unset()
6204     */
6205    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6206    /**
6207     * Remove the icon set without deleting it and return the object
6208     *
6209     * This function drops the reference the button holds of the icon object
6210     * and returns this last object. It is used in case you want to remove any
6211     * icon, or set another one, without deleting the actual object. The button
6212     * will be left without an icon set.
6213     *
6214     * @param obj The button object
6215     * @return The icon object that was being used
6216     */
6217    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6218    /**
6219     * Turn on/off the autorepeat event generated when the button is kept pressed
6220     *
6221     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6222     * signal when they are clicked.
6223     *
6224     * When on, keeping a button pressed will continuously emit a @c repeated
6225     * signal until the button is released. The time it takes until it starts
6226     * emitting the signal is given by
6227     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6228     * new emission by elm_button_autorepeat_gap_timeout_set().
6229     *
6230     * @param obj The button object
6231     * @param on  A bool to turn on/off the event
6232     */
6233    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6234    /**
6235     * Get whether the autorepeat feature is enabled
6236     *
6237     * @param obj The button object
6238     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6239     *
6240     * @see elm_button_autorepeat_set()
6241     */
6242    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6243    /**
6244     * Set the initial timeout before the autorepeat event is generated
6245     *
6246     * Sets the timeout, in seconds, since the button is pressed until the
6247     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6248     * won't be any delay and the even will be fired the moment the button is
6249     * pressed.
6250     *
6251     * @param obj The button object
6252     * @param t   Timeout in seconds
6253     *
6254     * @see elm_button_autorepeat_set()
6255     * @see elm_button_autorepeat_gap_timeout_set()
6256     */
6257    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6258    /**
6259     * Get the initial timeout before the autorepeat event is generated
6260     *
6261     * @param obj The button object
6262     * @return Timeout in seconds
6263     *
6264     * @see elm_button_autorepeat_initial_timeout_set()
6265     */
6266    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6267    /**
6268     * Set the interval between each generated autorepeat event
6269     *
6270     * After the first @c repeated event is fired, all subsequent ones will
6271     * follow after a delay of @p t seconds for each.
6272     *
6273     * @param obj The button object
6274     * @param t   Interval in seconds
6275     *
6276     * @see elm_button_autorepeat_initial_timeout_set()
6277     */
6278    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6279    /**
6280     * Get the interval between each generated autorepeat event
6281     *
6282     * @param obj The button object
6283     * @return Interval in seconds
6284     */
6285    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6286    /**
6287     * @}
6288     */
6289
6290    /**
6291     * @defgroup File_Selector_Button File Selector Button
6292     *
6293     * @image html img/widget/fileselector_button/preview-00.png
6294     * @image latex img/widget/fileselector_button/preview-00.eps
6295     * @image html img/widget/fileselector_button/preview-01.png
6296     * @image latex img/widget/fileselector_button/preview-01.eps
6297     * @image html img/widget/fileselector_button/preview-02.png
6298     * @image latex img/widget/fileselector_button/preview-02.eps
6299     *
6300     * This is a button that, when clicked, creates an Elementary
6301     * window (or inner window) <b> with a @ref Fileselector "file
6302     * selector widget" within</b>. When a file is chosen, the (inner)
6303     * window is closed and the button emits a signal having the
6304     * selected file as it's @c event_info.
6305     *
6306     * This widget encapsulates operations on its internal file
6307     * selector on its own API. There is less control over its file
6308     * selector than that one would have instatiating one directly.
6309     *
6310     * The following styles are available for this button:
6311     * @li @c "default"
6312     * @li @c "anchor"
6313     * @li @c "hoversel_vertical"
6314     * @li @c "hoversel_vertical_entry"
6315     *
6316     * Smart callbacks one can register to:
6317     * - @c "file,chosen" - the user has selected a path, whose string
6318     *   pointer comes as the @c event_info data (a stringshared
6319     *   string)
6320     *
6321     * Here is an example on its usage:
6322     * @li @ref fileselector_button_example
6323     *
6324     * @see @ref File_Selector_Entry for a similar widget.
6325     * @{
6326     */
6327
6328    /**
6329     * Add a new file selector button widget to the given parent
6330     * Elementary (container) object
6331     *
6332     * @param parent The parent object
6333     * @return a new file selector button widget handle or @c NULL, on
6334     * errors
6335     */
6336    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6337
6338    /**
6339     * Set the label for a given file selector button widget
6340     *
6341     * @param obj The file selector button widget
6342     * @param label The text label to be displayed on @p obj
6343     *
6344     * @deprecated use elm_object_text_set() instead.
6345     */
6346    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6347
6348    /**
6349     * Get the label set for a given file selector button widget
6350     *
6351     * @param obj The file selector button widget
6352     * @return The button label
6353     *
6354     * @deprecated use elm_object_text_set() instead.
6355     */
6356    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6357
6358    /**
6359     * Set the icon on a given file selector button widget
6360     *
6361     * @param obj The file selector button widget
6362     * @param icon The icon object for the button
6363     *
6364     * Once the icon object is set, a previously set one will be
6365     * deleted. If you want to keep the latter, use the
6366     * elm_fileselector_button_icon_unset() function.
6367     *
6368     * @see elm_fileselector_button_icon_get()
6369     */
6370    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6371
6372    /**
6373     * Get the icon set for a given file selector button widget
6374     *
6375     * @param obj The file selector button widget
6376     * @return The icon object currently set on @p obj or @c NULL, if
6377     * none is
6378     *
6379     * @see elm_fileselector_button_icon_set()
6380     */
6381    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6382
6383    /**
6384     * Unset the icon used in a given file selector button widget
6385     *
6386     * @param obj The file selector button widget
6387     * @return The icon object that was being used on @p obj or @c
6388     * NULL, on errors
6389     *
6390     * Unparent and return the icon object which was set for this
6391     * widget.
6392     *
6393     * @see elm_fileselector_button_icon_set()
6394     */
6395    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6396
6397    /**
6398     * Set the title for a given file selector button widget's window
6399     *
6400     * @param obj The file selector button widget
6401     * @param title The title string
6402     *
6403     * This will change the window's title, when the file selector pops
6404     * out after a click on the button. Those windows have the default
6405     * (unlocalized) value of @c "Select a file" as titles.
6406     *
6407     * @note It will only take any effect if the file selector
6408     * button widget is @b not under "inwin mode".
6409     *
6410     * @see elm_fileselector_button_window_title_get()
6411     */
6412    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6413
6414    /**
6415     * Get the title set for a given file selector button widget's
6416     * window
6417     *
6418     * @param obj The file selector button widget
6419     * @return Title of the file selector button's window
6420     *
6421     * @see elm_fileselector_button_window_title_get() for more details
6422     */
6423    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6424
6425    /**
6426     * Set the size of a given file selector button widget's window,
6427     * holding the file selector itself.
6428     *
6429     * @param obj The file selector button widget
6430     * @param width The window's width
6431     * @param height The window's height
6432     *
6433     * @note it will only take any effect if the file selector button
6434     * widget is @b not under "inwin mode". The default size for the
6435     * window (when applicable) is 400x400 pixels.
6436     *
6437     * @see elm_fileselector_button_window_size_get()
6438     */
6439    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6440
6441    /**
6442     * Get the size of a given file selector button widget's window,
6443     * holding the file selector itself.
6444     *
6445     * @param obj The file selector button widget
6446     * @param width Pointer into which to store the width value
6447     * @param height Pointer into which to store the height value
6448     *
6449     * @note Use @c NULL pointers on the size values you're not
6450     * interested in: they'll be ignored by the function.
6451     *
6452     * @see elm_fileselector_button_window_size_set(), for more details
6453     */
6454    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6455
6456    /**
6457     * Set the initial file system path for a given file selector
6458     * button widget
6459     *
6460     * @param obj The file selector button widget
6461     * @param path The path string
6462     *
6463     * It must be a <b>directory</b> path, which will have the contents
6464     * displayed initially in the file selector's view, when invoked
6465     * from @p obj. The default initial path is the @c "HOME"
6466     * environment variable's value.
6467     *
6468     * @see elm_fileselector_button_path_get()
6469     */
6470    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6471
6472    /**
6473     * Get the initial file system path set for a given file selector
6474     * button widget
6475     *
6476     * @param obj The file selector button widget
6477     * @return path The path string
6478     *
6479     * @see elm_fileselector_button_path_set() for more details
6480     */
6481    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6482
6483    /**
6484     * Enable/disable a tree view in the given file selector button
6485     * widget's internal file selector
6486     *
6487     * @param obj The file selector button widget
6488     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6489     * disable
6490     *
6491     * This has the same effect as elm_fileselector_expandable_set(),
6492     * but now applied to a file selector button's internal file
6493     * selector.
6494     *
6495     * @note There's no way to put a file selector button's internal
6496     * file selector in "grid mode", as one may do with "pure" file
6497     * selectors.
6498     *
6499     * @see elm_fileselector_expandable_get()
6500     */
6501    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6502
6503    /**
6504     * Get whether tree view is enabled for the given file selector
6505     * button widget's internal file selector
6506     *
6507     * @param obj The file selector button widget
6508     * @return @c EINA_TRUE if @p obj widget's internal file selector
6509     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6510     *
6511     * @see elm_fileselector_expandable_set() for more details
6512     */
6513    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6514
6515    /**
6516     * Set whether a given file selector button widget's internal file
6517     * selector is to display folders only or the directory contents,
6518     * as well.
6519     *
6520     * @param obj The file selector button widget
6521     * @param only @c EINA_TRUE to make @p obj widget's internal file
6522     * selector only display directories, @c EINA_FALSE to make files
6523     * to be displayed in it too
6524     *
6525     * This has the same effect as elm_fileselector_folder_only_set(),
6526     * but now applied to a file selector button's internal file
6527     * selector.
6528     *
6529     * @see elm_fileselector_folder_only_get()
6530     */
6531    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6532
6533    /**
6534     * Get whether a given file selector button widget's internal file
6535     * selector is displaying folders only or the directory contents,
6536     * as well.
6537     *
6538     * @param obj The file selector button widget
6539     * @return @c EINA_TRUE if @p obj widget's internal file
6540     * selector is only displaying directories, @c EINA_FALSE if files
6541     * are being displayed in it too (and on errors)
6542     *
6543     * @see elm_fileselector_button_folder_only_set() for more details
6544     */
6545    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6546
6547    /**
6548     * Enable/disable the file name entry box where the user can type
6549     * in a name for a file, in a given file selector button widget's
6550     * internal file selector.
6551     *
6552     * @param obj The file selector button widget
6553     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6554     * file selector a "saving dialog", @c EINA_FALSE otherwise
6555     *
6556     * This has the same effect as elm_fileselector_is_save_set(),
6557     * but now applied to a file selector button's internal file
6558     * selector.
6559     *
6560     * @see elm_fileselector_is_save_get()
6561     */
6562    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6563
6564    /**
6565     * Get whether the given file selector button widget's internal
6566     * file selector is in "saving dialog" mode
6567     *
6568     * @param obj The file selector button widget
6569     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6570     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6571     * errors)
6572     *
6573     * @see elm_fileselector_button_is_save_set() for more details
6574     */
6575    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6576
6577    /**
6578     * Set whether a given file selector button widget's internal file
6579     * selector will raise an Elementary "inner window", instead of a
6580     * dedicated Elementary window. By default, it won't.
6581     *
6582     * @param obj The file selector button widget
6583     * @param value @c EINA_TRUE to make it use an inner window, @c
6584     * EINA_TRUE to make it use a dedicated window
6585     *
6586     * @see elm_win_inwin_add() for more information on inner windows
6587     * @see elm_fileselector_button_inwin_mode_get()
6588     */
6589    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6590
6591    /**
6592     * Get whether a given file selector button widget's internal file
6593     * selector will raise an Elementary "inner window", instead of a
6594     * dedicated Elementary window.
6595     *
6596     * @param obj The file selector button widget
6597     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6598     * if it will use a dedicated window
6599     *
6600     * @see elm_fileselector_button_inwin_mode_set() for more details
6601     */
6602    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6603
6604    /**
6605     * @}
6606     */
6607
6608     /**
6609     * @defgroup File_Selector_Entry File Selector Entry
6610     *
6611     * @image html img/widget/fileselector_entry/preview-00.png
6612     * @image latex img/widget/fileselector_entry/preview-00.eps
6613     *
6614     * This is an entry made to be filled with or display a <b>file
6615     * system path string</b>. Besides the entry itself, the widget has
6616     * a @ref File_Selector_Button "file selector button" on its side,
6617     * which will raise an internal @ref Fileselector "file selector widget",
6618     * when clicked, for path selection aided by file system
6619     * navigation.
6620     *
6621     * This file selector may appear in an Elementary window or in an
6622     * inner window. When a file is chosen from it, the (inner) window
6623     * is closed and the selected file's path string is exposed both as
6624     * an smart event and as the new text on the entry.
6625     *
6626     * This widget encapsulates operations on its internal file
6627     * selector on its own API. There is less control over its file
6628     * selector than that one would have instatiating one directly.
6629     *
6630     * Smart callbacks one can register to:
6631     * - @c "changed" - The text within the entry was changed
6632     * - @c "activated" - The entry has had editing finished and
6633     *   changes are to be "committed"
6634     * - @c "press" - The entry has been clicked
6635     * - @c "longpressed" - The entry has been clicked (and held) for a
6636     *   couple seconds
6637     * - @c "clicked" - The entry has been clicked
6638     * - @c "clicked,double" - The entry has been double clicked
6639     * - @c "focused" - The entry has received focus
6640     * - @c "unfocused" - The entry has lost focus
6641     * - @c "selection,paste" - A paste action has occurred on the
6642     *   entry
6643     * - @c "selection,copy" - A copy action has occurred on the entry
6644     * - @c "selection,cut" - A cut action has occurred on the entry
6645     * - @c "unpressed" - The file selector entry's button was released
6646     *   after being pressed.
6647     * - @c "file,chosen" - The user has selected a path via the file
6648     *   selector entry's internal file selector, whose string pointer
6649     *   comes as the @c event_info data (a stringshared string)
6650     *
6651     * Here is an example on its usage:
6652     * @li @ref fileselector_entry_example
6653     *
6654     * @see @ref File_Selector_Button for a similar widget.
6655     * @{
6656     */
6657
6658    /**
6659     * Add a new file selector entry widget to the given parent
6660     * Elementary (container) object
6661     *
6662     * @param parent The parent object
6663     * @return a new file selector entry widget handle or @c NULL, on
6664     * errors
6665     */
6666    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6667
6668    /**
6669     * Set the label for a given file selector entry widget's button
6670     *
6671     * @param obj The file selector entry widget
6672     * @param label The text label to be displayed on @p obj widget's
6673     * button
6674     *
6675     * @deprecated use elm_object_text_set() instead.
6676     */
6677    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6678
6679    /**
6680     * Get the label set for a given file selector entry widget's button
6681     *
6682     * @param obj The file selector entry widget
6683     * @return The widget button's label
6684     *
6685     * @deprecated use elm_object_text_set() instead.
6686     */
6687    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6688
6689    /**
6690     * Set the icon on a given file selector entry widget's button
6691     *
6692     * @param obj The file selector entry widget
6693     * @param icon The icon object for the entry's button
6694     *
6695     * Once the icon object is set, a previously set one will be
6696     * deleted. If you want to keep the latter, use the
6697     * elm_fileselector_entry_button_icon_unset() function.
6698     *
6699     * @see elm_fileselector_entry_button_icon_get()
6700     */
6701    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6702
6703    /**
6704     * Get the icon set for a given file selector entry widget's button
6705     *
6706     * @param obj The file selector entry widget
6707     * @return The icon object currently set on @p obj widget's button
6708     * or @c NULL, if none is
6709     *
6710     * @see elm_fileselector_entry_button_icon_set()
6711     */
6712    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6713
6714    /**
6715     * Unset the icon used in a given file selector entry widget's
6716     * button
6717     *
6718     * @param obj The file selector entry widget
6719     * @return The icon object that was being used on @p obj widget's
6720     * button or @c NULL, on errors
6721     *
6722     * Unparent and return the icon object which was set for this
6723     * widget's button.
6724     *
6725     * @see elm_fileselector_entry_button_icon_set()
6726     */
6727    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6728
6729    /**
6730     * Set the title for a given file selector entry widget's window
6731     *
6732     * @param obj The file selector entry widget
6733     * @param title The title string
6734     *
6735     * This will change the window's title, when the file selector pops
6736     * out after a click on the entry's button. Those windows have the
6737     * default (unlocalized) value of @c "Select a file" as titles.
6738     *
6739     * @note It will only take any effect if the file selector
6740     * entry widget is @b not under "inwin mode".
6741     *
6742     * @see elm_fileselector_entry_window_title_get()
6743     */
6744    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6745
6746    /**
6747     * Get the title set for a given file selector entry widget's
6748     * window
6749     *
6750     * @param obj The file selector entry widget
6751     * @return Title of the file selector entry's window
6752     *
6753     * @see elm_fileselector_entry_window_title_get() for more details
6754     */
6755    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6756
6757    /**
6758     * Set the size of a given file selector entry widget's window,
6759     * holding the file selector itself.
6760     *
6761     * @param obj The file selector entry widget
6762     * @param width The window's width
6763     * @param height The window's height
6764     *
6765     * @note it will only take any effect if the file selector entry
6766     * widget is @b not under "inwin mode". The default size for the
6767     * window (when applicable) is 400x400 pixels.
6768     *
6769     * @see elm_fileselector_entry_window_size_get()
6770     */
6771    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6772
6773    /**
6774     * Get the size of a given file selector entry widget's window,
6775     * holding the file selector itself.
6776     *
6777     * @param obj The file selector entry widget
6778     * @param width Pointer into which to store the width value
6779     * @param height Pointer into which to store the height value
6780     *
6781     * @note Use @c NULL pointers on the size values you're not
6782     * interested in: they'll be ignored by the function.
6783     *
6784     * @see elm_fileselector_entry_window_size_set(), for more details
6785     */
6786    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6787
6788    /**
6789     * Set the initial file system path and the entry's path string for
6790     * a given file selector entry widget
6791     *
6792     * @param obj The file selector entry widget
6793     * @param path The path string
6794     *
6795     * It must be a <b>directory</b> path, which will have the contents
6796     * displayed initially in the file selector's view, when invoked
6797     * from @p obj. The default initial path is the @c "HOME"
6798     * environment variable's value.
6799     *
6800     * @see elm_fileselector_entry_path_get()
6801     */
6802    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6803
6804    /**
6805     * Get the entry's path string for a given file selector entry
6806     * widget
6807     *
6808     * @param obj The file selector entry widget
6809     * @return path The path string
6810     *
6811     * @see elm_fileselector_entry_path_set() for more details
6812     */
6813    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6814
6815    /**
6816     * Enable/disable a tree view in the given file selector entry
6817     * widget's internal file selector
6818     *
6819     * @param obj The file selector entry widget
6820     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6821     * disable
6822     *
6823     * This has the same effect as elm_fileselector_expandable_set(),
6824     * but now applied to a file selector entry's internal file
6825     * selector.
6826     *
6827     * @note There's no way to put a file selector entry's internal
6828     * file selector in "grid mode", as one may do with "pure" file
6829     * selectors.
6830     *
6831     * @see elm_fileselector_expandable_get()
6832     */
6833    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6834
6835    /**
6836     * Get whether tree view is enabled for the given file selector
6837     * entry widget's internal file selector
6838     *
6839     * @param obj The file selector entry widget
6840     * @return @c EINA_TRUE if @p obj widget's internal file selector
6841     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6842     *
6843     * @see elm_fileselector_expandable_set() for more details
6844     */
6845    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6846
6847    /**
6848     * Set whether a given file selector entry widget's internal file
6849     * selector is to display folders only or the directory contents,
6850     * as well.
6851     *
6852     * @param obj The file selector entry widget
6853     * @param only @c EINA_TRUE to make @p obj widget's internal file
6854     * selector only display directories, @c EINA_FALSE to make files
6855     * to be displayed in it too
6856     *
6857     * This has the same effect as elm_fileselector_folder_only_set(),
6858     * but now applied to a file selector entry's internal file
6859     * selector.
6860     *
6861     * @see elm_fileselector_folder_only_get()
6862     */
6863    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6864
6865    /**
6866     * Get whether a given file selector entry widget's internal file
6867     * selector is displaying folders only or the directory contents,
6868     * as well.
6869     *
6870     * @param obj The file selector entry widget
6871     * @return @c EINA_TRUE if @p obj widget's internal file
6872     * selector is only displaying directories, @c EINA_FALSE if files
6873     * are being displayed in it too (and on errors)
6874     *
6875     * @see elm_fileselector_entry_folder_only_set() for more details
6876     */
6877    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6878
6879    /**
6880     * Enable/disable the file name entry box where the user can type
6881     * in a name for a file, in a given file selector entry widget's
6882     * internal file selector.
6883     *
6884     * @param obj The file selector entry widget
6885     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6886     * file selector a "saving dialog", @c EINA_FALSE otherwise
6887     *
6888     * This has the same effect as elm_fileselector_is_save_set(),
6889     * but now applied to a file selector entry's internal file
6890     * selector.
6891     *
6892     * @see elm_fileselector_is_save_get()
6893     */
6894    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6895
6896    /**
6897     * Get whether the given file selector entry widget's internal
6898     * file selector is in "saving dialog" mode
6899     *
6900     * @param obj The file selector entry widget
6901     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6902     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6903     * errors)
6904     *
6905     * @see elm_fileselector_entry_is_save_set() for more details
6906     */
6907    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6908
6909    /**
6910     * Set whether a given file selector entry widget's internal file
6911     * selector will raise an Elementary "inner window", instead of a
6912     * dedicated Elementary window. By default, it won't.
6913     *
6914     * @param obj The file selector entry widget
6915     * @param value @c EINA_TRUE to make it use an inner window, @c
6916     * EINA_TRUE to make it use a dedicated window
6917     *
6918     * @see elm_win_inwin_add() for more information on inner windows
6919     * @see elm_fileselector_entry_inwin_mode_get()
6920     */
6921    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6922
6923    /**
6924     * Get whether a given file selector entry widget's internal file
6925     * selector will raise an Elementary "inner window", instead of a
6926     * dedicated Elementary window.
6927     *
6928     * @param obj The file selector entry widget
6929     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6930     * if it will use a dedicated window
6931     *
6932     * @see elm_fileselector_entry_inwin_mode_set() for more details
6933     */
6934    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6935
6936    /**
6937     * Set the initial file system path for a given file selector entry
6938     * widget
6939     *
6940     * @param obj The file selector entry widget
6941     * @param path The path string
6942     *
6943     * It must be a <b>directory</b> path, which will have the contents
6944     * displayed initially in the file selector's view, when invoked
6945     * from @p obj. The default initial path is the @c "HOME"
6946     * environment variable's value.
6947     *
6948     * @see elm_fileselector_entry_path_get()
6949     */
6950    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6951
6952    /**
6953     * Get the parent directory's path to the latest file selection on
6954     * a given filer selector entry widget
6955     *
6956     * @param obj The file selector object
6957     * @return The (full) path of the directory of the last selection
6958     * on @p obj widget, a @b stringshared string
6959     *
6960     * @see elm_fileselector_entry_path_set()
6961     */
6962    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6963
6964    /**
6965     * @}
6966     */
6967
6968    /**
6969     * @defgroup Scroller Scroller
6970     *
6971     * A scroller holds a single object and "scrolls it around". This means that
6972     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6973     * region around, allowing to move through a much larger object that is
6974     * contained in the scroller. The scroller will always have a small minimum
6975     * size by default as it won't be limited by the contents of the scroller.
6976     *
6977     * Signals that you can add callbacks for are:
6978     * @li "edge,left" - the left edge of the content has been reached
6979     * @li "edge,right" - the right edge of the content has been reached
6980     * @li "edge,top" - the top edge of the content has been reached
6981     * @li "edge,bottom" - the bottom edge of the content has been reached
6982     * @li "scroll" - the content has been scrolled (moved)
6983     * @li "scroll,anim,start" - scrolling animation has started
6984     * @li "scroll,anim,stop" - scrolling animation has stopped
6985     * @li "scroll,drag,start" - dragging the contents around has started
6986     * @li "scroll,drag,stop" - dragging the contents around has stopped
6987     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6988     * user intervetion.
6989     *
6990     * @note When Elemementary is in embedded mode the scrollbars will not be
6991     * dragable, they appear merely as indicators of how much has been scrolled.
6992     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6993     * fingerscroll) won't work.
6994     *
6995     * In @ref tutorial_scroller you'll find an example of how to use most of
6996     * this API.
6997     * @{
6998     */
6999    /**
7000     * @brief Type that controls when scrollbars should appear.
7001     *
7002     * @see elm_scroller_policy_set()
7003     */
7004    typedef enum _Elm_Scroller_Policy
7005      {
7006         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7007         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7008         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7009         ELM_SCROLLER_POLICY_LAST
7010      } Elm_Scroller_Policy;
7011    /**
7012     * @brief Add a new scroller to the parent
7013     *
7014     * @param parent The parent object
7015     * @return The new object or NULL if it cannot be created
7016     */
7017    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7018    /**
7019     * @brief Set the content of the scroller widget (the object to be scrolled around).
7020     *
7021     * @param obj The scroller object
7022     * @param content The new content object
7023     *
7024     * Once the content object is set, a previously set one will be deleted.
7025     * If you want to keep that old content object, use the
7026     * elm_scroller_content_unset() function.
7027     */
7028    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7029    /**
7030     * @brief Get the content of the scroller widget
7031     *
7032     * @param obj The slider object
7033     * @return The content that is being used
7034     *
7035     * Return the content object which is set for this widget
7036     *
7037     * @see elm_scroller_content_set()
7038     */
7039    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7040    /**
7041     * @brief Unset the content of the scroller widget
7042     *
7043     * @param obj The slider object
7044     * @return The content that was being used
7045     *
7046     * Unparent and return the content object which was set for this widget
7047     *
7048     * @see elm_scroller_content_set()
7049     */
7050    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7051    /**
7052     * @brief Set custom theme elements for the scroller
7053     *
7054     * @param obj The scroller object
7055     * @param widget The widget name to use (default is "scroller")
7056     * @param base The base name to use (default is "base")
7057     */
7058    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7059    /**
7060     * @brief Make the scroller minimum size limited to the minimum size of the content
7061     *
7062     * @param obj The scroller object
7063     * @param w Enable limiting minimum size horizontally
7064     * @param h Enable limiting minimum size vertically
7065     *
7066     * By default the scroller will be as small as its design allows,
7067     * irrespective of its content. This will make the scroller minimum size the
7068     * right size horizontally and/or vertically to perfectly fit its content in
7069     * that direction.
7070     */
7071    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7072    /**
7073     * @brief Show a specific virtual region within the scroller content object
7074     *
7075     * @param obj The scroller object
7076     * @param x X coordinate of the region
7077     * @param y Y coordinate of the region
7078     * @param w Width of the region
7079     * @param h Height of the region
7080     *
7081     * This will ensure all (or part if it does not fit) of the designated
7082     * region in the virtual content object (0, 0 starting at the top-left of the
7083     * virtual content object) is shown within the scroller.
7084     */
7085    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);
7086    /**
7087     * @brief Set the scrollbar visibility policy
7088     *
7089     * @param obj The scroller object
7090     * @param policy_h Horizontal scrollbar policy
7091     * @param policy_v Vertical scrollbar policy
7092     *
7093     * This sets the scrollbar visibility policy for the given scroller.
7094     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7095     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7096     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7097     * respectively for the horizontal and vertical scrollbars.
7098     */
7099    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7100    /**
7101     * @brief Gets scrollbar visibility policy
7102     *
7103     * @param obj The scroller object
7104     * @param policy_h Horizontal scrollbar policy
7105     * @param policy_v Vertical scrollbar policy
7106     *
7107     * @see elm_scroller_policy_set()
7108     */
7109    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7110    /**
7111     * @brief Get the currently visible content region
7112     *
7113     * @param obj The scroller object
7114     * @param x X coordinate of the region
7115     * @param y Y coordinate of the region
7116     * @param w Width of the region
7117     * @param h Height of the region
7118     *
7119     * This gets the current region in the content object that is visible through
7120     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7121     * w, @p h values pointed to.
7122     *
7123     * @note All coordinates are relative to the content.
7124     *
7125     * @see elm_scroller_region_show()
7126     */
7127    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);
7128    /**
7129     * @brief Get the size of the content object
7130     *
7131     * @param obj The scroller object
7132     * @param w Width of the content object.
7133     * @param h Height of the content object.
7134     *
7135     * This gets the size of the content object of the scroller.
7136     */
7137    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7138    /**
7139     * @brief Set bouncing behavior
7140     *
7141     * @param obj The scroller object
7142     * @param h_bounce Allow bounce horizontally
7143     * @param v_bounce Allow bounce vertically
7144     *
7145     * When scrolling, the scroller may "bounce" when reaching an edge of the
7146     * content object. This is a visual way to indicate the end has been reached.
7147     * This is enabled by default for both axis. This API will set if it is enabled
7148     * for the given axis with the boolean parameters for each axis.
7149     */
7150    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7151    /**
7152     * @brief Get the bounce behaviour
7153     *
7154     * @param obj The Scroller object
7155     * @param h_bounce Will the scroller bounce horizontally or not
7156     * @param v_bounce Will the scroller bounce vertically or not
7157     *
7158     * @see elm_scroller_bounce_set()
7159     */
7160    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7161    /**
7162     * @brief Set scroll page size relative to viewport size.
7163     *
7164     * @param obj The scroller object
7165     * @param h_pagerel The horizontal page relative size
7166     * @param v_pagerel The vertical page relative size
7167     *
7168     * The scroller is capable of limiting scrolling by the user to "pages". That
7169     * is to jump by and only show a "whole page" at a time as if the continuous
7170     * area of the scroller content is split into page sized pieces. This sets
7171     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7172     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7173     * axis. This is mutually exclusive with page size
7174     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7175     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7176     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7177     * the other axis.
7178     */
7179    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7180    /**
7181     * @brief Set scroll page size.
7182     *
7183     * @param obj The scroller object
7184     * @param h_pagesize The horizontal page size
7185     * @param v_pagesize The vertical page size
7186     *
7187     * This sets the page size to an absolute fixed value, with 0 turning it off
7188     * for that axis.
7189     *
7190     * @see elm_scroller_page_relative_set()
7191     */
7192    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7193    /**
7194     * @brief Get scroll current page number.
7195     *
7196     * @param obj The scroller object
7197     * @param h_pagenumber The horizontal page number
7198     * @param v_pagenumber The vertical page number
7199     *
7200     * The page number starts from 0. 0 is the first page.
7201     * Current page means the page which meet the top-left of the viewport.
7202     * If there are two or more pages in the viewport, it returns the number of page
7203     * which meet the top-left of the viewport.
7204     *
7205     * @see elm_scroller_last_page_get()
7206     * @see elm_scroller_page_show()
7207     * @see elm_scroller_page_brint_in()
7208     */
7209    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7210    /**
7211     * @brief Get scroll last page number.
7212     *
7213     * @param obj The scroller object
7214     * @param h_pagenumber The horizontal page number
7215     * @param v_pagenumber The vertical page number
7216     *
7217     * The page number starts from 0. 0 is the first page.
7218     * This returns the last page number among the pages.
7219     *
7220     * @see elm_scroller_current_page_get()
7221     * @see elm_scroller_page_show()
7222     * @see elm_scroller_page_brint_in()
7223     */
7224    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7225    /**
7226     * Show a specific virtual region within the scroller content object by page number.
7227     *
7228     * @param obj The scroller object
7229     * @param h_pagenumber The horizontal page number
7230     * @param v_pagenumber The vertical page number
7231     *
7232     * 0, 0 of the indicated page is located at the top-left of the viewport.
7233     * This will jump to the page directly without animation.
7234     *
7235     * Example of usage:
7236     *
7237     * @code
7238     * sc = elm_scroller_add(win);
7239     * elm_scroller_content_set(sc, content);
7240     * elm_scroller_page_relative_set(sc, 1, 0);
7241     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7242     * elm_scroller_page_show(sc, h_page + 1, v_page);
7243     * @endcode
7244     *
7245     * @see elm_scroller_page_bring_in()
7246     */
7247    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7248    /**
7249     * Show a specific virtual region within the scroller content object by page number.
7250     *
7251     * @param obj The scroller object
7252     * @param h_pagenumber The horizontal page number
7253     * @param v_pagenumber The vertical page number
7254     *
7255     * 0, 0 of the indicated page is located at the top-left of the viewport.
7256     * This will slide to the page with animation.
7257     *
7258     * Example of usage:
7259     *
7260     * @code
7261     * sc = elm_scroller_add(win);
7262     * elm_scroller_content_set(sc, content);
7263     * elm_scroller_page_relative_set(sc, 1, 0);
7264     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7265     * elm_scroller_page_bring_in(sc, h_page, v_page);
7266     * @endcode
7267     *
7268     * @see elm_scroller_page_show()
7269     */
7270    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7271    /**
7272     * @brief Show a specific virtual region within the scroller content object.
7273     *
7274     * @param obj The scroller object
7275     * @param x X coordinate of the region
7276     * @param y Y coordinate of the region
7277     * @param w Width of the region
7278     * @param h Height of the region
7279     *
7280     * This will ensure all (or part if it does not fit) of the designated
7281     * region in the virtual content object (0, 0 starting at the top-left of the
7282     * virtual content object) is shown within the scroller. Unlike
7283     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7284     * to this location (if configuration in general calls for transitions). It
7285     * may not jump immediately to the new location and make take a while and
7286     * show other content along the way.
7287     *
7288     * @see elm_scroller_region_show()
7289     */
7290    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);
7291    /**
7292     * @brief Set event propagation on a scroller
7293     *
7294     * @param obj The scroller object
7295     * @param propagation If propagation is enabled or not
7296     *
7297     * This enables or disabled event propagation from the scroller content to
7298     * the scroller and its parent. By default event propagation is disabled.
7299     */
7300    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7301    /**
7302     * @brief Get event propagation for a scroller
7303     *
7304     * @param obj The scroller object
7305     * @return The propagation state
7306     *
7307     * This gets the event propagation for a scroller.
7308     *
7309     * @see elm_scroller_propagate_events_set()
7310     */
7311    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7312    /**
7313     * @brief Set scrolling gravity on a scroller
7314     *
7315     * @param obj The scroller object
7316     * @param x The scrolling horizontal gravity
7317     * @param y The scrolling vertical gravity
7318     *
7319     * It set scrolling gravity. It adds scrolling weight values
7320     * to the scroller. Usually it uses for stopping the scroller.
7321     * To set y as 0.0 for lower growing child objects,
7322     * even though child objects are added to bottom, the scroller doesn't move.
7323     * To set y as 1.0 for upper growing child objects. And x is horizontal gravity.
7324     * By default 0.0 for x and y.
7325     */
7326    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7327    /**
7328     * @brief Get scrolling gravity values for a scroller
7329     *
7330     * @param obj The scroller object
7331     * @param x The scrolling horizontal gravity
7332     * @param y The scrolling vertical gravity
7333     *
7334     * This gets gravity values for a scroller.
7335     *
7336     * @see elm_scroller_gravity_set()
7337     *
7338     */
7339    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7340    /**
7341     * @}
7342     */
7343
7344    /**
7345     * @defgroup Label Label
7346     *
7347     * @image html img/widget/label/preview-00.png
7348     * @image latex img/widget/label/preview-00.eps
7349     *
7350     * @brief Widget to display text, with simple html-like markup.
7351     *
7352     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7353     * text doesn't fit the geometry of the label it will be ellipsized or be
7354     * cut. Elementary provides several themes for this widget:
7355     * @li default - No animation
7356     * @li marker - Centers the text in the label and make it bold by default
7357     * @li slide_long - The entire text appears from the right of the screen and
7358     * slides until it disappears in the left of the screen(reappering on the
7359     * right again).
7360     * @li slide_short - The text appears in the left of the label and slides to
7361     * the right to show the overflow. When all of the text has been shown the
7362     * position is reset.
7363     * @li slide_bounce - The text appears in the left of the label and slides to
7364     * the right to show the overflow. When all of the text has been shown the
7365     * animation reverses, moving the text to the left.
7366     *
7367     * Custom themes can of course invent new markup tags and style them any way
7368     * they like.
7369     *
7370     * The following signals may be emitted by the label widget:
7371     * @li "language,changed": The program's language changed.
7372     *
7373     * See @ref tutorial_label for a demonstration of how to use a label widget.
7374     * @{
7375     */
7376    /**
7377     * @brief Add a new label to the parent
7378     *
7379     * @param parent The parent object
7380     * @return The new object or NULL if it cannot be created
7381     */
7382    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7383    /**
7384     * @brief Set the label on the label object
7385     *
7386     * @param obj The label object
7387     * @param label The label will be used on the label object
7388     * @deprecated See elm_object_text_set()
7389     */
7390    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 */
7391    /**
7392     * @brief Get the label used on the label object
7393     *
7394     * @param obj The label object
7395     * @return The string inside the label
7396     * @deprecated See elm_object_text_get()
7397     */
7398    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7399    /**
7400     * @brief Set the wrapping behavior of the label
7401     *
7402     * @param obj The label object
7403     * @param wrap To wrap text or not
7404     *
7405     * By default no wrapping is done. Possible values for @p wrap are:
7406     * @li ELM_WRAP_NONE - No wrapping
7407     * @li ELM_WRAP_CHAR - wrap between characters
7408     * @li ELM_WRAP_WORD - wrap between words
7409     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7410     */
7411    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7412    /**
7413     * @brief Get the wrapping behavior of the label
7414     *
7415     * @param obj The label object
7416     * @return Wrap type
7417     *
7418     * @see elm_label_line_wrap_set()
7419     */
7420    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7421    /**
7422     * @brief Set wrap width of the label
7423     *
7424     * @param obj The label object
7425     * @param w The wrap width in pixels at a minimum where words need to wrap
7426     *
7427     * This function sets the maximum width size hint of the label.
7428     *
7429     * @warning This is only relevant if the label is inside a container.
7430     */
7431    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7432    /**
7433     * @brief Get wrap width of the label
7434     *
7435     * @param obj The label object
7436     * @return The wrap width in pixels at a minimum where words need to wrap
7437     *
7438     * @see elm_label_wrap_width_set()
7439     */
7440    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7441    /**
7442     * @brief Set wrap height of the label
7443     *
7444     * @param obj The label object
7445     * @param h The wrap height in pixels at a minimum where words need to wrap
7446     *
7447     * This function sets the maximum height size hint of the label.
7448     *
7449     * @warning This is only relevant if the label is inside a container.
7450     */
7451    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7452    /**
7453     * @brief get wrap width of the label
7454     *
7455     * @param obj The label object
7456     * @return The wrap height in pixels at a minimum where words need to wrap
7457     */
7458    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7459    /**
7460     * @brief Set the font size on the label object.
7461     *
7462     * @param obj The label object
7463     * @param size font size
7464     *
7465     * @warning NEVER use this. It is for hyper-special cases only. use styles
7466     * instead. e.g. "big", "medium", "small" - or better name them by use:
7467     * "title", "footnote", "quote" etc.
7468     */
7469    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7470    /**
7471     * @brief Set the text color on the label object
7472     *
7473     * @param obj The label object
7474     * @param r Red property background color of The label object
7475     * @param g Green property background color of The label object
7476     * @param b Blue property background color of The label object
7477     * @param a Alpha property background color of The label object
7478     *
7479     * @warning NEVER use this. It is for hyper-special cases only. use styles
7480     * instead. e.g. "big", "medium", "small" - or better name them by use:
7481     * "title", "footnote", "quote" etc.
7482     */
7483    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);
7484    /**
7485     * @brief Set the text align on the label object
7486     *
7487     * @param obj The label object
7488     * @param align align mode ("left", "center", "right")
7489     *
7490     * @warning NEVER use this. It is for hyper-special cases only. use styles
7491     * instead. e.g. "big", "medium", "small" - or better name them by use:
7492     * "title", "footnote", "quote" etc.
7493     */
7494    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7495    /**
7496     * @brief Set background color of the label
7497     *
7498     * @param obj The label object
7499     * @param r Red property background color of The label object
7500     * @param g Green property background color of The label object
7501     * @param b Blue property background color of The label object
7502     * @param a Alpha property background alpha of The label object
7503     *
7504     * @warning NEVER use this. It is for hyper-special cases only. use styles
7505     * instead. e.g. "big", "medium", "small" - or better name them by use:
7506     * "title", "footnote", "quote" etc.
7507     */
7508    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);
7509    /**
7510     * @brief Set the ellipsis behavior of the label
7511     *
7512     * @param obj The label object
7513     * @param ellipsis To ellipsis text or not
7514     *
7515     * If set to true and the text doesn't fit in the label an ellipsis("...")
7516     * will be shown at the end of the widget.
7517     *
7518     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7519     * choosen wrap method was ELM_WRAP_WORD.
7520     */
7521    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7522    /**
7523     * @brief Set the text slide of the label
7524     *
7525     * @param obj The label object
7526     * @param slide To start slide or stop
7527     *
7528     * If set to true the text of the label will slide throught the length of
7529     * label.
7530     *
7531     * @warning This only work with the themes "slide_short", "slide_long" and
7532     * "slide_bounce".
7533     */
7534    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7535    /**
7536     * @brief Get the text slide mode of the label
7537     *
7538     * @param obj The label object
7539     * @return slide slide mode value
7540     *
7541     * @see elm_label_slide_set()
7542     */
7543    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7544    /**
7545     * @brief Set the slide duration(speed) of the label
7546     *
7547     * @param obj The label object
7548     * @return The duration in seconds in moving text from slide begin position
7549     * to slide end position
7550     */
7551    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7552    /**
7553     * @brief Get the slide duration(speed) of the label
7554     *
7555     * @param obj The label object
7556     * @return The duration time in moving text from slide begin position to slide end position
7557     *
7558     * @see elm_label_slide_duration_set()
7559     */
7560    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7561    /**
7562     * @}
7563     */
7564
7565    /**
7566     * @defgroup Toggle Toggle
7567     *
7568     * @image html img/widget/toggle/preview-00.png
7569     * @image latex img/widget/toggle/preview-00.eps
7570     *
7571     * @brief A toggle is a slider which can be used to toggle between
7572     * two values.  It has two states: on and off.
7573     *
7574     * This widget is deprecated. Please use elm_check_add() instead using the
7575     * toggle style like:
7576     * 
7577     * @code
7578     * obj = elm_check_add(parent);
7579     * elm_object_style_set(obj, "toggle");
7580     * elm_check_states_labels_set(obj, "ON", "OFF");
7581     * @endcode
7582     * 
7583     * Signals that you can add callbacks for are:
7584     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7585     *                 until the toggle is released by the cursor (assuming it
7586     *                 has been triggered by the cursor in the first place).
7587     *
7588     * @ref tutorial_toggle show how to use a toggle.
7589     * @{
7590     */
7591    /**
7592     * @brief Add a toggle to @p parent.
7593     *
7594     * @param parent The parent object
7595     *
7596     * @return The toggle object
7597     */
7598    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7599    /**
7600     * @brief Sets the label to be displayed with the toggle.
7601     *
7602     * @param obj The toggle object
7603     * @param label The label to be displayed
7604     *
7605     * @deprecated use elm_object_text_set() instead.
7606     */
7607    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7608    /**
7609     * @brief Gets the label of the toggle
7610     *
7611     * @param obj  toggle object
7612     * @return The label of the toggle
7613     *
7614     * @deprecated use elm_object_text_get() instead.
7615     */
7616    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7617    /**
7618     * @brief Set the icon used for the toggle
7619     *
7620     * @param obj The toggle object
7621     * @param icon The icon object for the button
7622     *
7623     * Once the icon object is set, a previously set one will be deleted
7624     * If you want to keep that old content object, use the
7625     * elm_toggle_icon_unset() function.
7626     */
7627    EINA_DEPRECATED EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7628    /**
7629     * @brief Get the icon used for the toggle
7630     *
7631     * @param obj The toggle object
7632     * @return The icon object that is being used
7633     *
7634     * Return the icon object which is set for this widget.
7635     *
7636     * @see elm_toggle_icon_set()
7637     */
7638    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7639    /**
7640     * @brief Unset the icon used for the toggle
7641     *
7642     * @param obj The toggle object
7643     * @return The icon object that was being used
7644     *
7645     * Unparent and return the icon object which was set for this widget.
7646     *
7647     * @see elm_toggle_icon_set()
7648     */
7649    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7650    /**
7651     * @brief Sets the labels to be associated with the on and off states of the toggle.
7652     *
7653     * @param obj The toggle object
7654     * @param onlabel The label displayed when the toggle is in the "on" state
7655     * @param offlabel The label displayed when the toggle is in the "off" state
7656     */
7657    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7658    /**
7659     * @brief Gets the labels associated with the on and off states of the toggle.
7660     *
7661     * @param obj The toggle object
7662     * @param onlabel A char** to place the onlabel of @p obj into
7663     * @param offlabel A char** to place the offlabel of @p obj into
7664     */
7665    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7666    /**
7667     * @brief Sets the state of the toggle to @p state.
7668     *
7669     * @param obj The toggle object
7670     * @param state The state of @p obj
7671     */
7672    EINA_DEPRECATED EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7673    /**
7674     * @brief Gets the state of the toggle to @p state.
7675     *
7676     * @param obj The toggle object
7677     * @return The state of @p obj
7678     */
7679    EINA_DEPRECATED EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7680    /**
7681     * @brief Sets the state pointer of the toggle to @p statep.
7682     *
7683     * @param obj The toggle object
7684     * @param statep The state pointer of @p obj
7685     */
7686    EINA_DEPRECATED EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7687    /**
7688     * @}
7689     */
7690
7691    /**
7692     * @defgroup Frame Frame
7693     *
7694     * @image html img/widget/frame/preview-00.png
7695     * @image latex img/widget/frame/preview-00.eps
7696     *
7697     * @brief Frame is a widget that holds some content and has a title.
7698     *
7699     * The default look is a frame with a title, but Frame supports multple
7700     * styles:
7701     * @li default
7702     * @li pad_small
7703     * @li pad_medium
7704     * @li pad_large
7705     * @li pad_huge
7706     * @li outdent_top
7707     * @li outdent_bottom
7708     *
7709     * Of all this styles only default shows the title. Frame emits no signals.
7710     *
7711     * For a detailed example see the @ref tutorial_frame.
7712     *
7713     * @{
7714     */
7715    /**
7716     * @brief Add a new frame to the parent
7717     *
7718     * @param parent The parent object
7719     * @return The new object or NULL if it cannot be created
7720     */
7721    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7722    /**
7723     * @brief Set the frame label
7724     *
7725     * @param obj The frame object
7726     * @param label The label of this frame object
7727     *
7728     * @deprecated use elm_object_text_set() instead.
7729     */
7730    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7731    /**
7732     * @brief Get the frame label
7733     *
7734     * @param obj The frame object
7735     *
7736     * @return The label of this frame objet or NULL if unable to get frame
7737     *
7738     * @deprecated use elm_object_text_get() instead.
7739     */
7740    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7741    /**
7742     * @brief Set the content of the frame widget
7743     *
7744     * Once the content object is set, a previously set one will be deleted.
7745     * If you want to keep that old content object, use the
7746     * elm_frame_content_unset() function.
7747     *
7748     * @param obj The frame object
7749     * @param content The content will be filled in this frame object
7750     */
7751    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7752    /**
7753     * @brief Get the content of the frame widget
7754     *
7755     * Return the content object which is set for this widget
7756     *
7757     * @param obj The frame object
7758     * @return The content that is being used
7759     */
7760    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7761    /**
7762     * @brief Unset the content of the frame widget
7763     *
7764     * Unparent and return the content object which was set for this widget
7765     *
7766     * @param obj The frame object
7767     * @return The content that was being used
7768     */
7769    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7770    /**
7771     * @}
7772     */
7773
7774    /**
7775     * @defgroup Table Table
7776     *
7777     * A container widget to arrange other widgets in a table where items can
7778     * also span multiple columns or rows - even overlap (and then be raised or
7779     * lowered accordingly to adjust stacking if they do overlap).
7780     *
7781     * The followin are examples of how to use a table:
7782     * @li @ref tutorial_table_01
7783     * @li @ref tutorial_table_02
7784     *
7785     * @{
7786     */
7787    /**
7788     * @brief Add a new table to the parent
7789     *
7790     * @param parent The parent object
7791     * @return The new object or NULL if it cannot be created
7792     */
7793    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7794    /**
7795     * @brief Set the homogeneous layout in the table
7796     *
7797     * @param obj The layout object
7798     * @param homogeneous A boolean to set if the layout is homogeneous in the
7799     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7800     */
7801    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7802    /**
7803     * @brief Get the current table homogeneous mode.
7804     *
7805     * @param obj The table object
7806     * @return A boolean to indicating if the layout is homogeneous in the table
7807     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7808     */
7809    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7810    /**
7811     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7812     */
7813    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7814    /**
7815     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7816     */
7817    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7818    /**
7819     * @brief Set padding between cells.
7820     *
7821     * @param obj The layout object.
7822     * @param horizontal set the horizontal padding.
7823     * @param vertical set the vertical padding.
7824     *
7825     * Default value is 0.
7826     */
7827    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7828    /**
7829     * @brief Get padding between cells.
7830     *
7831     * @param obj The layout object.
7832     * @param horizontal set the horizontal padding.
7833     * @param vertical set the vertical padding.
7834     */
7835    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7836    /**
7837     * @brief Add a subobject on the table with the coordinates passed
7838     *
7839     * @param obj The table object
7840     * @param subobj The subobject to be added to the table
7841     * @param x Row number
7842     * @param y Column number
7843     * @param w rowspan
7844     * @param h colspan
7845     *
7846     * @note All positioning inside the table is relative to rows and columns, so
7847     * a value of 0 for x and y, means the top left cell of the table, and a
7848     * value of 1 for w and h means @p subobj only takes that 1 cell.
7849     */
7850    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7851    /**
7852     * @brief Remove child from table.
7853     *
7854     * @param obj The table object
7855     * @param subobj The subobject
7856     */
7857    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7858    /**
7859     * @brief Faster way to remove all child objects from a table object.
7860     *
7861     * @param obj The table object
7862     * @param clear If true, will delete children, else just remove from table.
7863     */
7864    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7865    /**
7866     * @brief Set the packing location of an existing child of the table
7867     *
7868     * @param subobj The subobject to be modified in the table
7869     * @param x Row number
7870     * @param y Column number
7871     * @param w rowspan
7872     * @param h colspan
7873     *
7874     * Modifies the position of an object already in the table.
7875     *
7876     * @note All positioning inside the table is relative to rows and columns, so
7877     * a value of 0 for x and y, means the top left cell of the table, and a
7878     * value of 1 for w and h means @p subobj only takes that 1 cell.
7879     */
7880    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7881    /**
7882     * @brief Get the packing location of an existing child of the table
7883     *
7884     * @param subobj The subobject to be modified in the table
7885     * @param x Row number
7886     * @param y Column number
7887     * @param w rowspan
7888     * @param h colspan
7889     *
7890     * @see elm_table_pack_set()
7891     */
7892    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7893    /**
7894     * @}
7895     */
7896
7897    /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
7898    typedef struct Elm_Gen_Item Elm_Gen_Item;
7899    typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
7900    typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
7901    typedef char        *(*Elm_Gen_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
7902    typedef Evas_Object *(*Elm_Gen_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Content(swallowed object) fetching class function for gen item classes. */
7903    typedef Eina_Bool    (*Elm_Gen_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gen item classes. */
7904    typedef void         (*Elm_Gen_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
7905    struct _Elm_Gen_Item_Class
7906      {
7907         const char             *item_style;
7908         struct _Elm_Gen_Item_Class_Func
7909           {
7910              Elm_Gen_Item_Label_Get_Cb label_get;
7911              Elm_Gen_Item_Content_Get_Cb  content_get;
7912              Elm_Gen_Item_State_Get_Cb state_get;
7913              Elm_Gen_Item_Del_Cb       del;
7914           } func;
7915      };
7916    EAPI void elm_gen_clear(Evas_Object *obj);
7917    EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
7918    EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
7919    EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
7920    EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
7921    EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
7922    EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
7923    EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
7924    EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
7925    EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
7926    EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
7927    EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
7928    EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
7929    EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
7930    EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
7931    EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
7932    EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
7933    EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
7934    EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
7935    EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
7936    EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
7937
7938    /**
7939     * @defgroup Gengrid Gengrid (Generic grid)
7940     *
7941     * This widget aims to position objects in a grid layout while
7942     * actually creating and rendering only the visible ones, using the
7943     * same idea as the @ref Genlist "genlist": the user defines a @b
7944     * class for each item, specifying functions that will be called at
7945     * object creation, deletion, etc. When those items are selected by
7946     * the user, a callback function is issued. Users may interact with
7947     * a gengrid via the mouse (by clicking on items to select them and
7948     * clicking on the grid's viewport and swiping to pan the whole
7949     * view) or via the keyboard, navigating through item with the
7950     * arrow keys.
7951     *
7952     * @section Gengrid_Layouts Gengrid layouts
7953     *
7954     * Gengrids may layout its items in one of two possible layouts:
7955     * - horizontal or
7956     * - vertical.
7957     *
7958     * When in "horizontal mode", items will be placed in @b columns,
7959     * from top to bottom and, when the space for a column is filled,
7960     * another one is started on the right, thus expanding the grid
7961     * horizontally, making for horizontal scrolling. When in "vertical
7962     * mode" , though, items will be placed in @b rows, from left to
7963     * right and, when the space for a row is filled, another one is
7964     * started below, thus expanding the grid vertically (and making
7965     * for vertical scrolling).
7966     *
7967     * @section Gengrid_Items Gengrid items
7968     *
7969     * An item in a gengrid can have 0 or more text labels (they can be
7970     * regular text or textblock Evas objects - that's up to the style
7971     * to determine), 0 or more icons (which are simply objects
7972     * swallowed into the gengrid item's theming Edje object) and 0 or
7973     * more <b>boolean states</b>, which have the behavior left to the
7974     * user to define. The Edje part names for each of these properties
7975     * will be looked up, in the theme file for the gengrid, under the
7976     * Edje (string) data items named @c "labels", @c "icons" and @c
7977     * "states", respectively. For each of those properties, if more
7978     * than one part is provided, they must have names listed separated
7979     * by spaces in the data fields. For the default gengrid item
7980     * theme, we have @b one label part (@c "elm.text"), @b two icon
7981     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7982     * no state parts.
7983     *
7984     * A gengrid item may be at one of several styles. Elementary
7985     * provides one by default - "default", but this can be extended by
7986     * system or application custom themes/overlays/extensions (see
7987     * @ref Theme "themes" for more details).
7988     *
7989     * @section Gengrid_Item_Class Gengrid item classes
7990     *
7991     * In order to have the ability to add and delete items on the fly,
7992     * gengrid implements a class (callback) system where the
7993     * application provides a structure with information about that
7994     * type of item (gengrid may contain multiple different items with
7995     * different classes, states and styles). Gengrid will call the
7996     * functions in this struct (methods) when an item is "realized"
7997     * (i.e., created dynamically, while the user is scrolling the
7998     * grid). All objects will simply be deleted when no longer needed
7999     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8000     * contains the following members:
8001     * - @c item_style - This is a constant string and simply defines
8002     * the name of the item style. It @b must be specified and the
8003     * default should be @c "default".
8004     * - @c func.label_get - This function is called when an item
8005     * object is actually created. The @c data parameter will point to
8006     * the same data passed to elm_gengrid_item_append() and related
8007     * item creation functions. The @c obj parameter is the gengrid
8008     * object itself, while the @c part one is the name string of one
8009     * of the existing text parts in the Edje group implementing the
8010     * item's theme. This function @b must return a strdup'()ed string,
8011     * as the caller will free() it when done. See
8012     * #Elm_Gengrid_Item_Label_Get_Cb.
8013     * - @c func.content_get - This function is called when an item object
8014     * is actually created. The @c data parameter will point to the
8015     * same data passed to elm_gengrid_item_append() and related item
8016     * creation functions. The @c obj parameter is the gengrid object
8017     * itself, while the @c part one is the name string of one of the
8018     * existing (content) swallow parts in the Edje group implementing the
8019     * item's theme. It must return @c NULL, when no content is desired,
8020     * or a valid object handle, otherwise. The object will be deleted
8021     * by the gengrid on its deletion or when the item is "unrealized".
8022     * See #Elm_Gengrid_Item_Content_Get_Cb.
8023     * - @c func.state_get - This function is called when an item
8024     * object is actually created. The @c data parameter will point to
8025     * the same data passed to elm_gengrid_item_append() and related
8026     * item creation functions. The @c obj parameter is the gengrid
8027     * object itself, while the @c part one is the name string of one
8028     * of the state parts in the Edje group implementing the item's
8029     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8030     * true/on. Gengrids will emit a signal to its theming Edje object
8031     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8032     * "source" arguments, respectively, when the state is true (the
8033     * default is false), where @c XXX is the name of the (state) part.
8034     * See #Elm_Gengrid_Item_State_Get_Cb.
8035     * - @c func.del - This is called when elm_gengrid_item_del() is
8036     * called on an item or elm_gengrid_clear() is called on the
8037     * gengrid. This is intended for use when gengrid items are
8038     * deleted, so any data attached to the item (e.g. its data
8039     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8040     *
8041     * @section Gengrid_Usage_Hints Usage hints
8042     *
8043     * If the user wants to have multiple items selected at the same
8044     * time, elm_gengrid_multi_select_set() will permit it. If the
8045     * gengrid is single-selection only (the default), then
8046     * elm_gengrid_select_item_get() will return the selected item or
8047     * @c NULL, if none is selected. If the gengrid is under
8048     * multi-selection, then elm_gengrid_selected_items_get() will
8049     * return a list (that is only valid as long as no items are
8050     * modified (added, deleted, selected or unselected) of child items
8051     * on a gengrid.
8052     *
8053     * If an item changes (internal (boolean) state, label or content 
8054     * changes), then use elm_gengrid_item_update() to have gengrid
8055     * update the item with the new state. A gengrid will re-"realize"
8056     * the item, thus calling the functions in the
8057     * #Elm_Gengrid_Item_Class set for that item.
8058     *
8059     * To programmatically (un)select an item, use
8060     * elm_gengrid_item_selected_set(). To get its selected state use
8061     * elm_gengrid_item_selected_get(). To make an item disabled
8062     * (unable to be selected and appear differently) use
8063     * elm_gengrid_item_disabled_set() to set this and
8064     * elm_gengrid_item_disabled_get() to get the disabled state.
8065     *
8066     * Grid cells will only have their selection smart callbacks called
8067     * when firstly getting selected. Any further clicks will do
8068     * nothing, unless you enable the "always select mode", with
8069     * elm_gengrid_always_select_mode_set(), thus making every click to
8070     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8071     * turn off the ability to select items entirely in the widget and
8072     * they will neither appear selected nor call the selection smart
8073     * callbacks.
8074     *
8075     * Remember that you can create new styles and add your own theme
8076     * augmentation per application with elm_theme_extension_add(). If
8077     * you absolutely must have a specific style that overrides any
8078     * theme the user or system sets up you can use
8079     * elm_theme_overlay_add() to add such a file.
8080     *
8081     * @section Gengrid_Smart_Events Gengrid smart events
8082     *
8083     * Smart events that you can add callbacks for are:
8084     * - @c "activated" - The user has double-clicked or pressed
8085     *   (enter|return|spacebar) on an item. The @c event_info parameter
8086     *   is the gengrid item that was activated.
8087     * - @c "clicked,double" - The user has double-clicked an item.
8088     *   The @c event_info parameter is the gengrid item that was double-clicked.
8089     * - @c "longpressed" - This is called when the item is pressed for a certain
8090     *   amount of time. By default it's 1 second.
8091     * - @c "selected" - The user has made an item selected. The
8092     *   @c event_info parameter is the gengrid item that was selected.
8093     * - @c "unselected" - The user has made an item unselected. The
8094     *   @c event_info parameter is the gengrid item that was unselected.
8095     * - @c "realized" - This is called when the item in the gengrid
8096     *   has its implementing Evas object instantiated, de facto. @c
8097     *   event_info is the gengrid item that was created. The object
8098     *   may be deleted at any time, so it is highly advised to the
8099     *   caller @b not to use the object pointer returned from
8100     *   elm_gengrid_item_object_get(), because it may point to freed
8101     *   objects.
8102     * - @c "unrealized" - This is called when the implementing Evas
8103     *   object for this item is deleted. @c event_info is the gengrid
8104     *   item that was deleted.
8105     * - @c "changed" - Called when an item is added, removed, resized
8106     *   or moved and when the gengrid is resized or gets "horizontal"
8107     *   property changes.
8108     * - @c "scroll,anim,start" - This is called when scrolling animation has
8109     *   started.
8110     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8111     *   stopped.
8112     * - @c "drag,start,up" - Called when the item in the gengrid has
8113     *   been dragged (not scrolled) up.
8114     * - @c "drag,start,down" - Called when the item in the gengrid has
8115     *   been dragged (not scrolled) down.
8116     * - @c "drag,start,left" - Called when the item in the gengrid has
8117     *   been dragged (not scrolled) left.
8118     * - @c "drag,start,right" - Called when the item in the gengrid has
8119     *   been dragged (not scrolled) right.
8120     * - @c "drag,stop" - Called when the item in the gengrid has
8121     *   stopped being dragged.
8122     * - @c "drag" - Called when the item in the gengrid is being
8123     *   dragged.
8124     * - @c "scroll" - called when the content has been scrolled
8125     *   (moved).
8126     * - @c "scroll,drag,start" - called when dragging the content has
8127     *   started.
8128     * - @c "scroll,drag,stop" - called when dragging the content has
8129     *   stopped.
8130     * - @c "edge,top" - This is called when the gengrid is scrolled until
8131     *   the top edge.
8132     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8133     *   until the bottom edge.
8134     * - @c "edge,left" - This is called when the gengrid is scrolled
8135     *   until the left edge.
8136     * - @c "edge,right" - This is called when the gengrid is scrolled
8137     *   until the right edge.
8138     *
8139     * List of gengrid examples:
8140     * @li @ref gengrid_example
8141     */
8142
8143    /**
8144     * @addtogroup Gengrid
8145     * @{
8146     */
8147
8148    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8149    #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8150    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8151    #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8152    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8153    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8154    typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for gengrid item classes. */
8155    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. */
8156    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8157
8158    /**
8159     * @struct _Elm_Gengrid_Item_Class
8160     *
8161     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8162     * field details.
8163     */
8164    struct _Elm_Gengrid_Item_Class
8165      {
8166         const char             *item_style;
8167         struct _Elm_Gengrid_Item_Class_Func
8168           {
8169              Elm_Gengrid_Item_Label_Get_Cb label_get;
8170              Elm_Gengrid_Item_Content_Get_Cb content_get;
8171              Elm_Gengrid_Item_State_Get_Cb state_get;
8172              Elm_Gengrid_Item_Del_Cb       del;
8173           } func;
8174      }; /**< #Elm_Gengrid_Item_Class member definitions */
8175    #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8176    /**
8177     * Add a new gengrid widget to the given parent Elementary
8178     * (container) object
8179     *
8180     * @param parent The parent object
8181     * @return a new gengrid widget handle or @c NULL, on errors
8182     *
8183     * This function inserts a new gengrid widget on the canvas.
8184     *
8185     * @see elm_gengrid_item_size_set()
8186     * @see elm_gengrid_group_item_size_set()
8187     * @see elm_gengrid_horizontal_set()
8188     * @see elm_gengrid_item_append()
8189     * @see elm_gengrid_item_del()
8190     * @see elm_gengrid_clear()
8191     *
8192     * @ingroup Gengrid
8193     */
8194    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8195
8196    /**
8197     * Set the size for the items of a given gengrid widget
8198     *
8199     * @param obj The gengrid object.
8200     * @param w The items' width.
8201     * @param h The items' height;
8202     *
8203     * A gengrid, after creation, has still no information on the size
8204     * to give to each of its cells. So, you most probably will end up
8205     * with squares one @ref Fingers "finger" wide, the default
8206     * size. Use this function to force a custom size for you items,
8207     * making them as big as you wish.
8208     *
8209     * @see elm_gengrid_item_size_get()
8210     *
8211     * @ingroup Gengrid
8212     */
8213    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8214
8215    /**
8216     * Get the size set for the items of a given gengrid widget
8217     *
8218     * @param obj The gengrid object.
8219     * @param w Pointer to a variable where to store the items' width.
8220     * @param h Pointer to a variable where to store the items' height.
8221     *
8222     * @note Use @c NULL pointers on the size values you're not
8223     * interested in: they'll be ignored by the function.
8224     *
8225     * @see elm_gengrid_item_size_get() for more details
8226     *
8227     * @ingroup Gengrid
8228     */
8229    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8230
8231    /**
8232     * Set the size for the group items of a given gengrid widget
8233     *
8234     * @param obj The gengrid object.
8235     * @param w The group items' width.
8236     * @param h The group items' height;
8237     *
8238     * A gengrid, after creation, has still no information on the size
8239     * to give to each of its cells. So, you most probably will end up
8240     * with squares one @ref Fingers "finger" wide, the default
8241     * size. Use this function to force a custom size for you group items,
8242     * making them as big as you wish.
8243     *
8244     * @see elm_gengrid_group_item_size_get()
8245     *
8246     * @ingroup Gengrid
8247     */
8248    EAPI void               elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8249
8250    /**
8251     * Get the size set for the group items of a given gengrid widget
8252     *
8253     * @param obj The gengrid object.
8254     * @param w Pointer to a variable where to store the group items' width.
8255     * @param h Pointer to a variable where to store the group items' height.
8256     *
8257     * @note Use @c NULL pointers on the size values you're not
8258     * interested in: they'll be ignored by the function.
8259     *
8260     * @see elm_gengrid_group_item_size_get() for more details
8261     *
8262     * @ingroup Gengrid
8263     */
8264    EAPI void               elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8265
8266    /**
8267     * Set the items grid's alignment within a given gengrid widget
8268     *
8269     * @param obj The gengrid object.
8270     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8271     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8272     *
8273     * This sets the alignment of the whole grid of items of a gengrid
8274     * within its given viewport. By default, those values are both
8275     * 0.5, meaning that the gengrid will have its items grid placed
8276     * exactly in the middle of its viewport.
8277     *
8278     * @note If given alignment values are out of the cited ranges,
8279     * they'll be changed to the nearest boundary values on the valid
8280     * ranges.
8281     *
8282     * @see elm_gengrid_align_get()
8283     *
8284     * @ingroup Gengrid
8285     */
8286    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8287
8288    /**
8289     * Get the items grid's alignment values within a given gengrid
8290     * widget
8291     *
8292     * @param obj The gengrid object.
8293     * @param align_x Pointer to a variable where to store the
8294     * horizontal alignment.
8295     * @param align_y Pointer to a variable where to store the vertical
8296     * alignment.
8297     *
8298     * @note Use @c NULL pointers on the alignment values you're not
8299     * interested in: they'll be ignored by the function.
8300     *
8301     * @see elm_gengrid_align_set() for more details
8302     *
8303     * @ingroup Gengrid
8304     */
8305    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8306
8307    /**
8308     * Set whether a given gengrid widget is or not able have items
8309     * @b reordered
8310     *
8311     * @param obj The gengrid object
8312     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8313     * @c EINA_FALSE to turn it off
8314     *
8315     * If a gengrid is set to allow reordering, a click held for more
8316     * than 0.5 over a given item will highlight it specially,
8317     * signalling the gengrid has entered the reordering state. From
8318     * that time on, the user will be able to, while still holding the
8319     * mouse button down, move the item freely in the gengrid's
8320     * viewport, replacing to said item to the locations it goes to.
8321     * The replacements will be animated and, whenever the user
8322     * releases the mouse button, the item being replaced gets a new
8323     * definitive place in the grid.
8324     *
8325     * @see elm_gengrid_reorder_mode_get()
8326     *
8327     * @ingroup Gengrid
8328     */
8329    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8330
8331    /**
8332     * Get whether a given gengrid widget is or not able have items
8333     * @b reordered
8334     *
8335     * @param obj The gengrid object
8336     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8337     * off
8338     *
8339     * @see elm_gengrid_reorder_mode_set() for more details
8340     *
8341     * @ingroup Gengrid
8342     */
8343    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8344
8345    /**
8346     * Append a new item in a given gengrid widget.
8347     *
8348     * @param obj The gengrid object.
8349     * @param gic The item class for the item.
8350     * @param data The item data.
8351     * @param func Convenience function called when the item is
8352     * selected.
8353     * @param func_data Data to be passed to @p func.
8354     * @return A handle to the item added or @c NULL, on errors.
8355     *
8356     * This adds an item to the beginning of the gengrid.
8357     *
8358     * @see elm_gengrid_item_prepend()
8359     * @see elm_gengrid_item_insert_before()
8360     * @see elm_gengrid_item_insert_after()
8361     * @see elm_gengrid_item_del()
8362     *
8363     * @ingroup Gengrid
8364     */
8365    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);
8366
8367    /**
8368     * Prepend a new item in a given gengrid widget.
8369     *
8370     * @param obj The gengrid object.
8371     * @param gic The item class for the item.
8372     * @param data The item data.
8373     * @param func Convenience function called when the item is
8374     * selected.
8375     * @param func_data Data to be passed to @p func.
8376     * @return A handle to the item added or @c NULL, on errors.
8377     *
8378     * This adds an item to the end of the gengrid.
8379     *
8380     * @see elm_gengrid_item_append()
8381     * @see elm_gengrid_item_insert_before()
8382     * @see elm_gengrid_item_insert_after()
8383     * @see elm_gengrid_item_del()
8384     *
8385     * @ingroup Gengrid
8386     */
8387    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);
8388
8389    /**
8390     * Insert an item before another in a gengrid widget
8391     *
8392     * @param obj The gengrid object.
8393     * @param gic The item class for the item.
8394     * @param data The item data.
8395     * @param relative The item to place this new one before.
8396     * @param func Convenience function called when the item is
8397     * selected.
8398     * @param func_data Data to be passed to @p func.
8399     * @return A handle to the item added or @c NULL, on errors.
8400     *
8401     * This inserts an item before another in the gengrid.
8402     *
8403     * @see elm_gengrid_item_append()
8404     * @see elm_gengrid_item_prepend()
8405     * @see elm_gengrid_item_insert_after()
8406     * @see elm_gengrid_item_del()
8407     *
8408     * @ingroup Gengrid
8409     */
8410    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);
8411
8412    /**
8413     * Insert an item after another in a gengrid widget
8414     *
8415     * @param obj The gengrid object.
8416     * @param gic The item class for the item.
8417     * @param data The item data.
8418     * @param relative The item to place this new one after.
8419     * @param func Convenience function called when the item is
8420     * selected.
8421     * @param func_data Data to be passed to @p func.
8422     * @return A handle to the item added or @c NULL, on errors.
8423     *
8424     * This inserts an item after another in the gengrid.
8425     *
8426     * @see elm_gengrid_item_append()
8427     * @see elm_gengrid_item_prepend()
8428     * @see elm_gengrid_item_insert_after()
8429     * @see elm_gengrid_item_del()
8430     *
8431     * @ingroup Gengrid
8432     */
8433    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);
8434
8435    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);
8436
8437    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);
8438
8439    /**
8440     * Set whether items on a given gengrid widget are to get their
8441     * selection callbacks issued for @b every subsequent selection
8442     * click on them or just for the first click.
8443     *
8444     * @param obj The gengrid object
8445     * @param always_select @c EINA_TRUE to make items "always
8446     * selected", @c EINA_FALSE, otherwise
8447     *
8448     * By default, grid items will only call their selection callback
8449     * function when firstly getting selected, any subsequent further
8450     * clicks will do nothing. With this call, you make those
8451     * subsequent clicks also to issue the selection callbacks.
8452     *
8453     * @note <b>Double clicks</b> will @b always be reported on items.
8454     *
8455     * @see elm_gengrid_always_select_mode_get()
8456     *
8457     * @ingroup Gengrid
8458     */
8459    EINA_DEPRECATED EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8460
8461    /**
8462     * Get whether items on a given gengrid widget have their selection
8463     * callbacks issued for @b every subsequent selection click on them
8464     * or just for the first click.
8465     *
8466     * @param obj The gengrid object.
8467     * @return @c EINA_TRUE if the gengrid items are "always selected",
8468     * @c EINA_FALSE, otherwise
8469     *
8470     * @see elm_gengrid_always_select_mode_set() for more details
8471     *
8472     * @ingroup Gengrid
8473     */
8474    EINA_DEPRECATED EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8475
8476    /**
8477     * Set whether items on a given gengrid widget can be selected or not.
8478     *
8479     * @param obj The gengrid object
8480     * @param no_select @c EINA_TRUE to make items selectable,
8481     * @c EINA_FALSE otherwise
8482     *
8483     * This will make items in @p obj selectable or not. In the latter
8484     * case, any user interaction on the gengrid items will neither make
8485     * them appear selected nor them call their selection callback
8486     * functions.
8487     *
8488     * @see elm_gengrid_no_select_mode_get()
8489     *
8490     * @ingroup Gengrid
8491     */
8492    EINA_DEPRECATED EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8493
8494    /**
8495     * Get whether items on a given gengrid widget can be selected or
8496     * not.
8497     *
8498     * @param obj The gengrid object
8499     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8500     * otherwise
8501     *
8502     * @see elm_gengrid_no_select_mode_set() for more details
8503     *
8504     * @ingroup Gengrid
8505     */
8506    EINA_DEPRECATED EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8507
8508    /**
8509     * Enable or disable multi-selection in a given gengrid widget
8510     *
8511     * @param obj The gengrid object.
8512     * @param multi @c EINA_TRUE, to enable multi-selection,
8513     * @c EINA_FALSE to disable it.
8514     *
8515     * Multi-selection is the ability for one to have @b more than one
8516     * item selected, on a given gengrid, simultaneously. When it is
8517     * enabled, a sequence of clicks on different items will make them
8518     * all selected, progressively. A click on an already selected item
8519     * will unselect it. If interecting via the keyboard,
8520     * multi-selection is enabled while holding the "Shift" key.
8521     *
8522     * @note By default, multi-selection is @b disabled on gengrids
8523     *
8524     * @see elm_gengrid_multi_select_get()
8525     *
8526     * @ingroup Gengrid
8527     */
8528    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8529
8530    /**
8531     * Get whether multi-selection is enabled or disabled for a given
8532     * gengrid widget
8533     *
8534     * @param obj The gengrid object.
8535     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8536     * EINA_FALSE otherwise
8537     *
8538     * @see elm_gengrid_multi_select_set() for more details
8539     *
8540     * @ingroup Gengrid
8541     */
8542    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8543
8544    /**
8545     * Enable or disable bouncing effect for a given gengrid widget
8546     *
8547     * @param obj The gengrid object
8548     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8549     * @c EINA_FALSE to disable it
8550     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8551     * @c EINA_FALSE to disable it
8552     *
8553     * The bouncing effect occurs whenever one reaches the gengrid's
8554     * edge's while panning it -- it will scroll past its limits a
8555     * little bit and return to the edge again, in a animated for,
8556     * automatically.
8557     *
8558     * @note By default, gengrids have bouncing enabled on both axis
8559     *
8560     * @see elm_gengrid_bounce_get()
8561     *
8562     * @ingroup Gengrid
8563     */
8564    EINA_DEPRECATED EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8565
8566    /**
8567     * Get whether bouncing effects are enabled or disabled, for a
8568     * given gengrid widget, on each axis
8569     *
8570     * @param obj The gengrid object
8571     * @param h_bounce Pointer to a variable where to store the
8572     * horizontal bouncing flag.
8573     * @param v_bounce Pointer to a variable where to store the
8574     * vertical bouncing flag.
8575     *
8576     * @see elm_gengrid_bounce_set() for more details
8577     *
8578     * @ingroup Gengrid
8579     */
8580    EINA_DEPRECATED EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8581
8582    /**
8583     * Set a given gengrid widget's scrolling page size, relative to
8584     * its viewport size.
8585     *
8586     * @param obj The gengrid object
8587     * @param h_pagerel The horizontal page (relative) size
8588     * @param v_pagerel The vertical page (relative) size
8589     *
8590     * The gengrid's scroller is capable of binding scrolling by the
8591     * user to "pages". It means that, while scrolling and, specially
8592     * after releasing the mouse button, the grid will @b snap to the
8593     * nearest displaying page's area. When page sizes are set, the
8594     * grid's continuous content area is split into (equal) page sized
8595     * pieces.
8596     *
8597     * This function sets the size of a page <b>relatively to the
8598     * viewport dimensions</b> of the gengrid, for each axis. A value
8599     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8600     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8601     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8602     * 1.0. Values beyond those will make it behave behave
8603     * inconsistently. If you only want one axis to snap to pages, use
8604     * the value @c 0.0 for the other one.
8605     *
8606     * There is a function setting page size values in @b absolute
8607     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8608     * is mutually exclusive to this one.
8609     *
8610     * @see elm_gengrid_page_relative_get()
8611     *
8612     * @ingroup Gengrid
8613     */
8614    EINA_DEPRECATED EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8615
8616    /**
8617     * Get a given gengrid widget's scrolling page size, relative to
8618     * its viewport size.
8619     *
8620     * @param obj The gengrid object
8621     * @param h_pagerel Pointer to a variable where to store the
8622     * horizontal page (relative) size
8623     * @param v_pagerel Pointer to a variable where to store the
8624     * vertical page (relative) size
8625     *
8626     * @see elm_gengrid_page_relative_set() for more details
8627     *
8628     * @ingroup Gengrid
8629     */
8630    EINA_DEPRECATED EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8631
8632    /**
8633     * Set a given gengrid widget's scrolling page size
8634     *
8635     * @param obj The gengrid object
8636     * @param h_pagerel The horizontal page size, in pixels
8637     * @param v_pagerel The vertical page size, in pixels
8638     *
8639     * The gengrid's scroller is capable of binding scrolling by the
8640     * user to "pages". It means that, while scrolling and, specially
8641     * after releasing the mouse button, the grid will @b snap to the
8642     * nearest displaying page's area. When page sizes are set, the
8643     * grid's continuous content area is split into (equal) page sized
8644     * pieces.
8645     *
8646     * This function sets the size of a page of the gengrid, in pixels,
8647     * for each axis. Sane usable values are, between @c 0 and the
8648     * dimensions of @p obj, for each axis. Values beyond those will
8649     * make it behave behave inconsistently. If you only want one axis
8650     * to snap to pages, use the value @c 0 for the other one.
8651     *
8652     * There is a function setting page size values in @b relative
8653     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8654     * use is mutually exclusive to this one.
8655     *
8656     * @ingroup Gengrid
8657     */
8658    EINA_DEPRECATED EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8659
8660    /**
8661     * @brief Get gengrid current page number.
8662     *
8663     * @param obj The gengrid object
8664     * @param h_pagenumber The horizontal page number
8665     * @param v_pagenumber The vertical page number
8666     *
8667     * The page number starts from 0. 0 is the first page.
8668     * Current page means the page which meet the top-left of the viewport.
8669     * If there are two or more pages in the viewport, it returns the number of page
8670     * which meet the top-left of the viewport.
8671     *
8672     * @see elm_gengrid_last_page_get()
8673     * @see elm_gengrid_page_show()
8674     * @see elm_gengrid_page_brint_in()
8675     */
8676    EINA_DEPRECATED EAPI void         elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8677
8678    /**
8679     * @brief Get scroll last page number.
8680     *
8681     * @param obj The gengrid object
8682     * @param h_pagenumber The horizontal page number
8683     * @param v_pagenumber The vertical page number
8684     *
8685     * The page number starts from 0. 0 is the first page.
8686     * This returns the last page number among the pages.
8687     *
8688     * @see elm_gengrid_current_page_get()
8689     * @see elm_gengrid_page_show()
8690     * @see elm_gengrid_page_brint_in()
8691     */
8692    EINA_DEPRECATED EAPI void         elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8693
8694    /**
8695     * Show a specific virtual region within the gengrid content object by page number.
8696     *
8697     * @param obj The gengrid object
8698     * @param h_pagenumber The horizontal page number
8699     * @param v_pagenumber The vertical page number
8700     *
8701     * 0, 0 of the indicated page is located at the top-left of the viewport.
8702     * This will jump to the page directly without animation.
8703     *
8704     * Example of usage:
8705     *
8706     * @code
8707     * sc = elm_gengrid_add(win);
8708     * elm_gengrid_content_set(sc, content);
8709     * elm_gengrid_page_relative_set(sc, 1, 0);
8710     * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8711     * elm_gengrid_page_show(sc, h_page + 1, v_page);
8712     * @endcode
8713     *
8714     * @see elm_gengrid_page_bring_in()
8715     */
8716    EINA_DEPRECATED EAPI void         elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8717
8718    /**
8719     * Show a specific virtual region within the gengrid content object by page number.
8720     *
8721     * @param obj The gengrid object
8722     * @param h_pagenumber The horizontal page number
8723     * @param v_pagenumber The vertical page number
8724     *
8725     * 0, 0 of the indicated page is located at the top-left of the viewport.
8726     * This will slide to the page with animation.
8727     *
8728     * Example of usage:
8729     *
8730     * @code
8731     * sc = elm_gengrid_add(win);
8732     * elm_gengrid_content_set(sc, content);
8733     * elm_gengrid_page_relative_set(sc, 1, 0);
8734     * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8735     * elm_gengrid_page_bring_in(sc, h_page, v_page);
8736     * @endcode
8737     *
8738     * @see elm_gengrid_page_show()
8739     */
8740     EINA_DEPRECATED EAPI void         elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8741
8742    /**
8743     * Set for what direction a given gengrid widget will expand while
8744     * placing its items.
8745     *
8746     * @param obj The gengrid object.
8747     * @param setting @c EINA_TRUE to make the gengrid expand
8748     * horizontally, @c EINA_FALSE to expand vertically.
8749     *
8750     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8751     * in @b columns, from top to bottom and, when the space for a
8752     * column is filled, another one is started on the right, thus
8753     * expanding the grid horizontally. When in "vertical mode"
8754     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8755     * to right and, when the space for a row is filled, another one is
8756     * started below, thus expanding the grid vertically.
8757     *
8758     * @see elm_gengrid_horizontal_get()
8759     *
8760     * @ingroup Gengrid
8761     */
8762    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8763
8764    /**
8765     * Get for what direction a given gengrid widget will expand while
8766     * placing its items.
8767     *
8768     * @param obj The gengrid object.
8769     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8770     * @c EINA_FALSE if it's set to expand vertically.
8771     *
8772     * @see elm_gengrid_horizontal_set() for more detais
8773     *
8774     * @ingroup Gengrid
8775     */
8776    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8777
8778    /**
8779     * Get the first item in a given gengrid widget
8780     *
8781     * @param obj The gengrid object
8782     * @return The first item's handle or @c NULL, if there are no
8783     * items in @p obj (and on errors)
8784     *
8785     * This returns the first item in the @p obj's internal list of
8786     * items.
8787     *
8788     * @see elm_gengrid_last_item_get()
8789     *
8790     * @ingroup Gengrid
8791     */
8792    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8793
8794    /**
8795     * Get the last item in a given gengrid widget
8796     *
8797     * @param obj The gengrid object
8798     * @return The last item's handle or @c NULL, if there are no
8799     * items in @p obj (and on errors)
8800     *
8801     * This returns the last item in the @p obj's internal list of
8802     * items.
8803     *
8804     * @see elm_gengrid_first_item_get()
8805     *
8806     * @ingroup Gengrid
8807     */
8808    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8809
8810    /**
8811     * Get the @b next item in a gengrid widget's internal list of items,
8812     * given a handle to one of those items.
8813     *
8814     * @param item The gengrid item to fetch next from
8815     * @return The item after @p item, or @c NULL if there's none (and
8816     * on errors)
8817     *
8818     * This returns the item placed after the @p item, on the container
8819     * gengrid.
8820     *
8821     * @see elm_gengrid_item_prev_get()
8822     *
8823     * @ingroup Gengrid
8824     */
8825    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8826
8827    /**
8828     * Get the @b previous item in a gengrid widget's internal list of items,
8829     * given a handle to one of those items.
8830     *
8831     * @param item The gengrid item to fetch previous from
8832     * @return The item before @p item, or @c NULL if there's none (and
8833     * on errors)
8834     *
8835     * This returns the item placed before the @p item, on the container
8836     * gengrid.
8837     *
8838     * @see elm_gengrid_item_next_get()
8839     *
8840     * @ingroup Gengrid
8841     */
8842    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8843
8844    /**
8845     * Get the gengrid object's handle which contains a given gengrid
8846     * item
8847     *
8848     * @param item The item to fetch the container from
8849     * @return The gengrid (parent) object
8850     *
8851     * This returns the gengrid object itself that an item belongs to.
8852     *
8853     * @ingroup Gengrid
8854     */
8855    EINA_DEPRECATED EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8856
8857    /**
8858     * Remove a gengrid item from the its parent, deleting it.
8859     *
8860     * @param item The item to be removed.
8861     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8862     *
8863     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8864     * once.
8865     *
8866     * @ingroup Gengrid
8867     */
8868    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8869
8870    /**
8871     * Update the contents of a given gengrid item
8872     *
8873     * @param item The gengrid item
8874     *
8875     * This updates an item by calling all the item class functions
8876     * again to get the contents, labels and states. Use this when the
8877     * original item data has changed and you want thta changes to be
8878     * reflected.
8879     *
8880     * @ingroup Gengrid
8881     */
8882    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8883    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8884    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8885
8886    /**
8887     * Return the data associated to a given gengrid item
8888     *
8889     * @param item The gengrid item.
8890     * @return the data associated to this item.
8891     *
8892     * This returns the @c data value passed on the
8893     * elm_gengrid_item_append() and related item addition calls.
8894     *
8895     * @see elm_gengrid_item_append()
8896     * @see elm_gengrid_item_data_set()
8897     *
8898     * @ingroup Gengrid
8899     */
8900    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8901
8902    /**
8903     * Set the data associated to a given gengrid item
8904     *
8905     * @param item The gengrid item
8906     * @param data The new data pointer to set on it
8907     *
8908     * This @b overrides the @c data value passed on the
8909     * elm_gengrid_item_append() and related item addition calls. This
8910     * function @b won't call elm_gengrid_item_update() automatically,
8911     * so you'd issue it afterwards if you want to hove the item
8912     * updated to reflect the that new data.
8913     *
8914     * @see elm_gengrid_item_data_get()
8915     *
8916     * @ingroup Gengrid
8917     */
8918    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8919
8920    /**
8921     * Get a given gengrid item's position, relative to the whole
8922     * gengrid's grid area.
8923     *
8924     * @param item The Gengrid item.
8925     * @param x Pointer to variable where to store the item's <b>row
8926     * number</b>.
8927     * @param y Pointer to variable where to store the item's <b>column
8928     * number</b>.
8929     *
8930     * This returns the "logical" position of the item whithin the
8931     * gengrid. For example, @c (0, 1) would stand for first row,
8932     * second column.
8933     *
8934     * @ingroup Gengrid
8935     */
8936    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8937
8938    /**
8939     * Set whether a given gengrid item is selected or not
8940     *
8941     * @param item The gengrid item
8942     * @param selected Use @c EINA_TRUE, to make it selected, @c
8943     * EINA_FALSE to make it unselected
8944     *
8945     * This sets the selected state of an item. If multi selection is
8946     * not enabled on the containing gengrid and @p selected is @c
8947     * EINA_TRUE, any other previously selected items will get
8948     * unselected in favor of this new one.
8949     *
8950     * @see elm_gengrid_item_selected_get()
8951     *
8952     * @ingroup Gengrid
8953     */
8954    EINA_DEPRECATED EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8955
8956    /**
8957     * Get whether a given gengrid item is selected or not
8958     *
8959     * @param item The gengrid item
8960     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8961     *
8962     * @see elm_gengrid_item_selected_set() for more details
8963     *
8964     * @ingroup Gengrid
8965     */
8966    EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8967
8968    /**
8969     * Get the real Evas object created to implement the view of a
8970     * given gengrid item
8971     *
8972     * @param item The gengrid item.
8973     * @return the Evas object implementing this item's view.
8974     *
8975     * This returns the actual Evas object used to implement the
8976     * specified gengrid item's view. This may be @c NULL, as it may
8977     * not have been created or may have been deleted, at any time, by
8978     * the gengrid. <b>Do not modify this object</b> (move, resize,
8979     * show, hide, etc.), as the gengrid is controlling it. This
8980     * function is for querying, emitting custom signals or hooking
8981     * lower level callbacks for events on that object. Do not delete
8982     * this object under any circumstances.
8983     *
8984     * @see elm_gengrid_item_data_get()
8985     *
8986     * @ingroup Gengrid
8987     */
8988    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8989
8990    /**
8991     * Show the portion of a gengrid's internal grid containing a given
8992     * item, @b immediately.
8993     *
8994     * @param item The item to display
8995     *
8996     * This causes gengrid to @b redraw its viewport's contents to the
8997     * region contining the given @p item item, if it is not fully
8998     * visible.
8999     *
9000     * @see elm_gengrid_item_bring_in()
9001     *
9002     * @ingroup Gengrid
9003     */
9004    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9005
9006    /**
9007     * Animatedly bring in, to the visible are of a gengrid, a given
9008     * item on it.
9009     *
9010     * @param item The gengrid item to display
9011     *
9012     * This causes gengrig to jump to the given @p item item and show
9013     * it (by scrolling), if it is not fully visible. This will use
9014     * animation to do so and take a period of time to complete.
9015     *
9016     * @see elm_gengrid_item_show()
9017     *
9018     * @ingroup Gengrid
9019     */
9020    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9021
9022    /**
9023     * Set whether a given gengrid item is disabled or not.
9024     *
9025     * @param item The gengrid item
9026     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9027     * to enable it back.
9028     *
9029     * A disabled item cannot be selected or unselected. It will also
9030     * change its appearance, to signal the user it's disabled.
9031     *
9032     * @see elm_gengrid_item_disabled_get()
9033     *
9034     * @ingroup Gengrid
9035     */
9036    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9037
9038    /**
9039     * Get whether a given gengrid item is disabled or not.
9040     *
9041     * @param item The gengrid item
9042     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9043     * (and on errors).
9044     *
9045     * @see elm_gengrid_item_disabled_set() for more details
9046     *
9047     * @ingroup Gengrid
9048     */
9049    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9050
9051    /**
9052     * Set the text to be shown in a given gengrid item's tooltips.
9053     *
9054     * @param item The gengrid item
9055     * @param text The text to set in the content
9056     *
9057     * This call will setup the text to be used as tooltip to that item
9058     * (analogous to elm_object_tooltip_text_set(), but being item
9059     * tooltips with higher precedence than object tooltips). It can
9060     * have only one tooltip at a time, so any previous tooltip data
9061     * will get removed.
9062     *
9063     * @ingroup Gengrid
9064     */
9065    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9066
9067    /**
9068     * Set the content to be shown in a given gengrid item's tooltips
9069     *
9070     * @param item The gengrid item.
9071     * @param func The function returning the tooltip contents.
9072     * @param data What to provide to @a func as callback data/context.
9073     * @param del_cb Called when data is not needed anymore, either when
9074     *        another callback replaces @p func, the tooltip is unset with
9075     *        elm_gengrid_item_tooltip_unset() or the owner @p item
9076     *        dies. This callback receives as its first parameter the
9077     *        given @p data, being @c event_info the item handle.
9078     *
9079     * This call will setup the tooltip's contents to @p item
9080     * (analogous to elm_object_tooltip_content_cb_set(), but being
9081     * item tooltips with higher precedence than object tooltips). It
9082     * can have only one tooltip at a time, so any previous tooltip
9083     * content will get removed. @p func (with @p data) will be called
9084     * every time Elementary needs to show the tooltip and it should
9085     * return a valid Evas object, which will be fully managed by the
9086     * tooltip system, getting deleted when the tooltip is gone.
9087     *
9088     * @ingroup Gengrid
9089     */
9090    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);
9091
9092    /**
9093     * Unset a tooltip from a given gengrid item
9094     *
9095     * @param item gengrid item to remove a previously set tooltip from.
9096     *
9097     * This call removes any tooltip set on @p item. The callback
9098     * provided as @c del_cb to
9099     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9100     * notify it is not used anymore (and have resources cleaned, if
9101     * need be).
9102     *
9103     * @see elm_gengrid_item_tooltip_content_cb_set()
9104     *
9105     * @ingroup Gengrid
9106     */
9107    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9108
9109    /**
9110     * Set a different @b style for a given gengrid item's tooltip.
9111     *
9112     * @param item gengrid item with tooltip set
9113     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9114     * "default", @c "transparent", etc)
9115     *
9116     * Tooltips can have <b>alternate styles</b> to be displayed on,
9117     * which are defined by the theme set on Elementary. This function
9118     * works analogously as elm_object_tooltip_style_set(), but here
9119     * applied only to gengrid item objects. The default style for
9120     * tooltips is @c "default".
9121     *
9122     * @note before you set a style you should define a tooltip with
9123     *       elm_gengrid_item_tooltip_content_cb_set() or
9124     *       elm_gengrid_item_tooltip_text_set()
9125     *
9126     * @see elm_gengrid_item_tooltip_style_get()
9127     *
9128     * @ingroup Gengrid
9129     */
9130    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9131
9132    /**
9133     * Get the style set a given gengrid item's tooltip.
9134     *
9135     * @param item gengrid item with tooltip already set on.
9136     * @return style the theme style in use, which defaults to
9137     *         "default". If the object does not have a tooltip set,
9138     *         then @c NULL is returned.
9139     *
9140     * @see elm_gengrid_item_tooltip_style_set() for more details
9141     *
9142     * @ingroup Gengrid
9143     */
9144    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9145    /**
9146     * @brief Disable size restrictions on an object's tooltip
9147     * @param item The tooltip's anchor object
9148     * @param disable If EINA_TRUE, size restrictions are disabled
9149     * @return EINA_FALSE on failure, EINA_TRUE on success
9150     *
9151     * This function allows a tooltip to expand beyond its parant window's canvas.
9152     * It will instead be limited only by the size of the display.
9153     */
9154    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9155    /**
9156     * @brief Retrieve size restriction state of an object's tooltip
9157     * @param item The tooltip's anchor object
9158     * @return If EINA_TRUE, size restrictions are disabled
9159     *
9160     * This function returns whether a tooltip is allowed to expand beyond
9161     * its parant window's canvas.
9162     * It will instead be limited only by the size of the display.
9163     */
9164    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9165    /**
9166     * Set the type of mouse pointer/cursor decoration to be shown,
9167     * when the mouse pointer is over the given gengrid widget item
9168     *
9169     * @param item gengrid item to customize cursor on
9170     * @param cursor the cursor type's name
9171     *
9172     * This function works analogously as elm_object_cursor_set(), but
9173     * here the cursor's changing area is restricted to the item's
9174     * area, and not the whole widget's. Note that that item cursors
9175     * have precedence over widget cursors, so that a mouse over @p
9176     * item will always show cursor @p type.
9177     *
9178     * If this function is called twice for an object, a previously set
9179     * cursor will be unset on the second call.
9180     *
9181     * @see elm_object_cursor_set()
9182     * @see elm_gengrid_item_cursor_get()
9183     * @see elm_gengrid_item_cursor_unset()
9184     *
9185     * @ingroup Gengrid
9186     */
9187    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9188
9189    /**
9190     * Get the type of mouse pointer/cursor decoration set to be shown,
9191     * when the mouse pointer is over the given gengrid widget item
9192     *
9193     * @param item gengrid item with custom cursor set
9194     * @return the cursor type's name or @c NULL, if no custom cursors
9195     * were set to @p item (and on errors)
9196     *
9197     * @see elm_object_cursor_get()
9198     * @see elm_gengrid_item_cursor_set() for more details
9199     * @see elm_gengrid_item_cursor_unset()
9200     *
9201     * @ingroup Gengrid
9202     */
9203    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9204
9205    /**
9206     * Unset any custom mouse pointer/cursor decoration set to be
9207     * shown, when the mouse pointer is over the given gengrid widget
9208     * item, thus making it show the @b default cursor again.
9209     *
9210     * @param item a gengrid item
9211     *
9212     * Use this call to undo any custom settings on this item's cursor
9213     * decoration, bringing it back to defaults (no custom style set).
9214     *
9215     * @see elm_object_cursor_unset()
9216     * @see elm_gengrid_item_cursor_set() for more details
9217     *
9218     * @ingroup Gengrid
9219     */
9220    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9221
9222    /**
9223     * Set a different @b style for a given custom cursor set for a
9224     * gengrid item.
9225     *
9226     * @param item gengrid item with custom cursor set
9227     * @param style the <b>theme style</b> to use (e.g. @c "default",
9228     * @c "transparent", etc)
9229     *
9230     * This function only makes sense when one is using custom mouse
9231     * cursor decorations <b>defined in a theme file</b> , which can
9232     * have, given a cursor name/type, <b>alternate styles</b> on
9233     * it. It works analogously as elm_object_cursor_style_set(), but
9234     * here applied only to gengrid item objects.
9235     *
9236     * @warning Before you set a cursor style you should have defined a
9237     *       custom cursor previously on the item, with
9238     *       elm_gengrid_item_cursor_set()
9239     *
9240     * @see elm_gengrid_item_cursor_engine_only_set()
9241     * @see elm_gengrid_item_cursor_style_get()
9242     *
9243     * @ingroup Gengrid
9244     */
9245    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9246
9247    /**
9248     * Get the current @b style set for a given gengrid item's custom
9249     * cursor
9250     *
9251     * @param item gengrid item with custom cursor set.
9252     * @return style the cursor style in use. If the object does not
9253     *         have a cursor set, then @c NULL is returned.
9254     *
9255     * @see elm_gengrid_item_cursor_style_set() for more details
9256     *
9257     * @ingroup Gengrid
9258     */
9259    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9260
9261    /**
9262     * Set if the (custom) cursor for a given gengrid item should be
9263     * searched in its theme, also, or should only rely on the
9264     * rendering engine.
9265     *
9266     * @param item item with custom (custom) cursor already set on
9267     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9268     * only on those provided by the rendering engine, @c EINA_FALSE to
9269     * have them searched on the widget's theme, as well.
9270     *
9271     * @note This call is of use only if you've set a custom cursor
9272     * for gengrid items, with elm_gengrid_item_cursor_set().
9273     *
9274     * @note By default, cursors will only be looked for between those
9275     * provided by the rendering engine.
9276     *
9277     * @ingroup Gengrid
9278     */
9279    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9280
9281    /**
9282     * Get if the (custom) cursor for a given gengrid item is being
9283     * searched in its theme, also, or is only relying on the rendering
9284     * engine.
9285     *
9286     * @param item a gengrid item
9287     * @return @c EINA_TRUE, if cursors are being looked for only on
9288     * those provided by the rendering engine, @c EINA_FALSE if they
9289     * are being searched on the widget's theme, as well.
9290     *
9291     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9292     *
9293     * @ingroup Gengrid
9294     */
9295    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9296
9297    /**
9298     * Remove all items from a given gengrid widget
9299     *
9300     * @param obj The gengrid object.
9301     *
9302     * This removes (and deletes) all items in @p obj, leaving it
9303     * empty.
9304     *
9305     * @see elm_gengrid_item_del(), to remove just one item.
9306     *
9307     * @ingroup Gengrid
9308     */
9309    EINA_DEPRECATED EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9310
9311    /**
9312     * Get the selected item in a given gengrid widget
9313     *
9314     * @param obj The gengrid object.
9315     * @return The selected item's handleor @c NULL, if none is
9316     * selected at the moment (and on errors)
9317     *
9318     * This returns the selected item in @p obj. If multi selection is
9319     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9320     * the first item in the list is selected, which might not be very
9321     * useful. For that case, see elm_gengrid_selected_items_get().
9322     *
9323     * @ingroup Gengrid
9324     */
9325    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9326
9327    /**
9328     * Get <b>a list</b> of selected items in a given gengrid
9329     *
9330     * @param obj The gengrid object.
9331     * @return The list of selected items or @c NULL, if none is
9332     * selected at the moment (and on errors)
9333     *
9334     * This returns a list of the selected items, in the order that
9335     * they appear in the grid. This list is only valid as long as no
9336     * more items are selected or unselected (or unselected implictly
9337     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9338     * data, naturally.
9339     *
9340     * @see elm_gengrid_selected_item_get()
9341     *
9342     * @ingroup Gengrid
9343     */
9344    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9345
9346    /**
9347     * @}
9348     */
9349
9350    /**
9351     * @defgroup Clock Clock
9352     *
9353     * @image html img/widget/clock/preview-00.png
9354     * @image latex img/widget/clock/preview-00.eps
9355     *
9356     * This is a @b digital clock widget. In its default theme, it has a
9357     * vintage "flipping numbers clock" appearance, which will animate
9358     * sheets of individual algarisms individually as time goes by.
9359     *
9360     * A newly created clock will fetch system's time (already
9361     * considering local time adjustments) to start with, and will tick
9362     * accondingly. It may or may not show seconds.
9363     *
9364     * Clocks have an @b edition mode. When in it, the sheets will
9365     * display extra arrow indications on the top and bottom and the
9366     * user may click on them to raise or lower the time values. After
9367     * it's told to exit edition mode, it will keep ticking with that
9368     * new time set (it keeps the difference from local time).
9369     *
9370     * Also, when under edition mode, user clicks on the cited arrows
9371     * which are @b held for some time will make the clock to flip the
9372     * sheet, thus editing the time, continuosly and automatically for
9373     * the user. The interval between sheet flips will keep growing in
9374     * time, so that it helps the user to reach a time which is distant
9375     * from the one set.
9376     *
9377     * The time display is, by default, in military mode (24h), but an
9378     * am/pm indicator may be optionally shown, too, when it will
9379     * switch to 12h.
9380     *
9381     * Smart callbacks one can register to:
9382     * - "changed" - the clock's user changed the time
9383     *
9384     * Here is an example on its usage:
9385     * @li @ref clock_example
9386     */
9387
9388    /**
9389     * @addtogroup Clock
9390     * @{
9391     */
9392
9393    /**
9394     * Identifiers for which clock digits should be editable, when a
9395     * clock widget is in edition mode. Values may be ORed together to
9396     * make a mask, naturally.
9397     *
9398     * @see elm_clock_edit_set()
9399     * @see elm_clock_digit_edit_set()
9400     */
9401    typedef enum _Elm_Clock_Digedit
9402      {
9403         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9404         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9405         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9406         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9407         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9408         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9409         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9410         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9411      } Elm_Clock_Digedit;
9412
9413    /**
9414     * Add a new clock widget to the given parent Elementary
9415     * (container) object
9416     *
9417     * @param parent The parent object
9418     * @return a new clock widget handle or @c NULL, on errors
9419     *
9420     * This function inserts a new clock widget on the canvas.
9421     *
9422     * @ingroup Clock
9423     */
9424    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9425
9426    /**
9427     * Set a clock widget's time, programmatically
9428     *
9429     * @param obj The clock widget object
9430     * @param hrs The hours to set
9431     * @param min The minutes to set
9432     * @param sec The secondes to set
9433     *
9434     * This function updates the time that is showed by the clock
9435     * widget.
9436     *
9437     *  Values @b must be set within the following ranges:
9438     * - 0 - 23, for hours
9439     * - 0 - 59, for minutes
9440     * - 0 - 59, for seconds,
9441     *
9442     * even if the clock is not in "military" mode.
9443     *
9444     * @warning The behavior for values set out of those ranges is @b
9445     * indefined.
9446     *
9447     * @ingroup Clock
9448     */
9449    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9450
9451    /**
9452     * Get a clock widget's time values
9453     *
9454     * @param obj The clock object
9455     * @param[out] hrs Pointer to the variable to get the hours value
9456     * @param[out] min Pointer to the variable to get the minutes value
9457     * @param[out] sec Pointer to the variable to get the seconds value
9458     *
9459     * This function gets the time set for @p obj, returning
9460     * it on the variables passed as the arguments to function
9461     *
9462     * @note Use @c NULL pointers on the time values you're not
9463     * interested in: they'll be ignored by the function.
9464     *
9465     * @ingroup Clock
9466     */
9467    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9468
9469    /**
9470     * Set whether a given clock widget is under <b>edition mode</b> or
9471     * under (default) displaying-only mode.
9472     *
9473     * @param obj The clock object
9474     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9475     * put it back to "displaying only" mode
9476     *
9477     * This function makes a clock's time to be editable or not <b>by
9478     * user interaction</b>. When in edition mode, clocks @b stop
9479     * ticking, until one brings them back to canonical mode. The
9480     * elm_clock_digit_edit_set() function will influence which digits
9481     * of the clock will be editable. By default, all of them will be
9482     * (#ELM_CLOCK_NONE).
9483     *
9484     * @note am/pm sheets, if being shown, will @b always be editable
9485     * under edition mode.
9486     *
9487     * @see elm_clock_edit_get()
9488     *
9489     * @ingroup Clock
9490     */
9491    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9492
9493    /**
9494     * Retrieve whether a given clock widget is under <b>edition
9495     * mode</b> or under (default) displaying-only mode.
9496     *
9497     * @param obj The clock object
9498     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9499     * otherwise
9500     *
9501     * This function retrieves whether the clock's time can be edited
9502     * or not by user interaction.
9503     *
9504     * @see elm_clock_edit_set() for more details
9505     *
9506     * @ingroup Clock
9507     */
9508    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9509
9510    /**
9511     * Set what digits of the given clock widget should be editable
9512     * when in edition mode.
9513     *
9514     * @param obj The clock object
9515     * @param digedit Bit mask indicating the digits to be editable
9516     * (values in #Elm_Clock_Digedit).
9517     *
9518     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9519     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9520     * EINA_FALSE).
9521     *
9522     * @see elm_clock_digit_edit_get()
9523     *
9524     * @ingroup Clock
9525     */
9526    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9527
9528    /**
9529     * Retrieve what digits of the given clock widget should be
9530     * editable when in edition mode.
9531     *
9532     * @param obj The clock object
9533     * @return Bit mask indicating the digits to be editable
9534     * (values in #Elm_Clock_Digedit).
9535     *
9536     * @see elm_clock_digit_edit_set() for more details
9537     *
9538     * @ingroup Clock
9539     */
9540    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9541
9542    /**
9543     * Set if the given clock widget must show hours in military or
9544     * am/pm mode
9545     *
9546     * @param obj The clock object
9547     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9548     * to military mode
9549     *
9550     * This function sets if the clock must show hours in military or
9551     * am/pm mode. In some countries like Brazil the military mode
9552     * (00-24h-format) is used, in opposition to the USA, where the
9553     * am/pm mode is more commonly used.
9554     *
9555     * @see elm_clock_show_am_pm_get()
9556     *
9557     * @ingroup Clock
9558     */
9559    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9560
9561    /**
9562     * Get if the given clock widget shows hours in military or am/pm
9563     * mode
9564     *
9565     * @param obj The clock object
9566     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9567     * military
9568     *
9569     * This function gets if the clock shows hours in military or am/pm
9570     * mode.
9571     *
9572     * @see elm_clock_show_am_pm_set() for more details
9573     *
9574     * @ingroup Clock
9575     */
9576    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9577
9578    /**
9579     * Set if the given clock widget must show time with seconds or not
9580     *
9581     * @param obj The clock object
9582     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9583     *
9584     * This function sets if the given clock must show or not elapsed
9585     * seconds. By default, they are @b not shown.
9586     *
9587     * @see elm_clock_show_seconds_get()
9588     *
9589     * @ingroup Clock
9590     */
9591    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9592
9593    /**
9594     * Get whether the given clock widget is showing time with seconds
9595     * or not
9596     *
9597     * @param obj The clock object
9598     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9599     *
9600     * This function gets whether @p obj is showing or not the elapsed
9601     * seconds.
9602     *
9603     * @see elm_clock_show_seconds_set()
9604     *
9605     * @ingroup Clock
9606     */
9607    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9608
9609    /**
9610     * Set the interval on time updates for an user mouse button hold
9611     * on clock widgets' time edition.
9612     *
9613     * @param obj The clock object
9614     * @param interval The (first) interval value in seconds
9615     *
9616     * This interval value is @b decreased while the user holds the
9617     * mouse pointer either incrementing or decrementing a given the
9618     * clock digit's value.
9619     *
9620     * This helps the user to get to a given time distant from the
9621     * current one easier/faster, as it will start to flip quicker and
9622     * quicker on mouse button holds.
9623     *
9624     * The calculation for the next flip interval value, starting from
9625     * the one set with this call, is the previous interval divided by
9626     * 1.05, so it decreases a little bit.
9627     *
9628     * The default starting interval value for automatic flips is
9629     * @b 0.85 seconds.
9630     *
9631     * @see elm_clock_interval_get()
9632     *
9633     * @ingroup Clock
9634     */
9635    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9636
9637    /**
9638     * Get the interval on time updates for an user mouse button hold
9639     * on clock widgets' time edition.
9640     *
9641     * @param obj The clock object
9642     * @return The (first) interval value, in seconds, set on it
9643     *
9644     * @see elm_clock_interval_set() for more details
9645     *
9646     * @ingroup Clock
9647     */
9648    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9649
9650    /**
9651     * @}
9652     */
9653
9654    /**
9655     * @defgroup Layout Layout
9656     *
9657     * @image html img/widget/layout/preview-00.png
9658     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9659     *
9660     * @image html img/layout-predefined.png
9661     * @image latex img/layout-predefined.eps width=\textwidth
9662     *
9663     * This is a container widget that takes a standard Edje design file and
9664     * wraps it very thinly in a widget.
9665     *
9666     * An Edje design (theme) file has a very wide range of possibilities to
9667     * describe the behavior of elements added to the Layout. Check out the Edje
9668     * documentation and the EDC reference to get more information about what can
9669     * be done with Edje.
9670     *
9671     * Just like @ref List, @ref Box, and other container widgets, any
9672     * object added to the Layout will become its child, meaning that it will be
9673     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9674     *
9675     * The Layout widget can contain as many Contents, Boxes or Tables as
9676     * described in its theme file. For instance, objects can be added to
9677     * different Tables by specifying the respective Table part names. The same
9678     * is valid for Content and Box.
9679     *
9680     * The objects added as child of the Layout will behave as described in the
9681     * part description where they were added. There are 3 possible types of
9682     * parts where a child can be added:
9683     *
9684     * @section secContent Content (SWALLOW part)
9685     *
9686     * Only one object can be added to the @c SWALLOW part (but you still can
9687     * have many @c SWALLOW parts and one object on each of them). Use the @c
9688     * elm_layout_content_* set of functions to set, retrieve and unset objects
9689     * as content of the @c SWALLOW. After being set to this part, the object
9690     * size, position, visibility, clipping and other description properties
9691     * will be totally controled by the description of the given part (inside
9692     * the Edje theme file).
9693     *
9694     * One can use @c evas_object_size_hint_* functions on the child to have some
9695     * kind of control over its behavior, but the resulting behavior will still
9696     * depend heavily on the @c SWALLOW part description.
9697     *
9698     * The Edje theme also can change the part description, based on signals or
9699     * scripts running inside the theme. This change can also be animated. All of
9700     * this will affect the child object set as content accordingly. The object
9701     * size will be changed if the part size is changed, it will animate move if
9702     * the part is moving, and so on.
9703     *
9704     * The following picture demonstrates a Layout widget with a child object
9705     * added to its @c SWALLOW:
9706     *
9707     * @image html layout_swallow.png
9708     * @image latex layout_swallow.eps width=\textwidth
9709     *
9710     * @section secBox Box (BOX part)
9711     *
9712     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9713     * allows one to add objects to the box and have them distributed along its
9714     * area, accordingly to the specified @a layout property (now by @a layout we
9715     * mean the chosen layouting design of the Box, not the Layout widget
9716     * itself).
9717     *
9718     * A similar effect for having a box with its position, size and other things
9719     * controled by the Layout theme would be to create an Elementary @ref Box
9720     * widget and add it as a Content in the @c SWALLOW part.
9721     *
9722     * The main difference of using the Layout Box is that its behavior, the box
9723     * properties like layouting format, padding, align, etc. will be all
9724     * controled by the theme. This means, for example, that a signal could be
9725     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9726     * handled the signal by changing the box padding, or align, or both. Using
9727     * the Elementary @ref Box widget is not necessarily harder or easier, it
9728     * just depends on the circunstances and requirements.
9729     *
9730     * The Layout Box can be used through the @c elm_layout_box_* set of
9731     * functions.
9732     *
9733     * The following picture demonstrates a Layout widget with many child objects
9734     * added to its @c BOX part:
9735     *
9736     * @image html layout_box.png
9737     * @image latex layout_box.eps width=\textwidth
9738     *
9739     * @section secTable Table (TABLE part)
9740     *
9741     * Just like the @ref secBox, the Layout Table is very similar to the
9742     * Elementary @ref Table widget. It allows one to add objects to the Table
9743     * specifying the row and column where the object should be added, and any
9744     * column or row span if necessary.
9745     *
9746     * Again, we could have this design by adding a @ref Table widget to the @c
9747     * SWALLOW part using elm_layout_content_set(). The same difference happens
9748     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9749     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9750     *
9751     * The Layout Table can be used through the @c elm_layout_table_* set of
9752     * functions.
9753     *
9754     * The following picture demonstrates a Layout widget with many child objects
9755     * added to its @c TABLE part:
9756     *
9757     * @image html layout_table.png
9758     * @image latex layout_table.eps width=\textwidth
9759     *
9760     * @section secPredef Predefined Layouts
9761     *
9762     * Another interesting thing about the Layout widget is that it offers some
9763     * predefined themes that come with the default Elementary theme. These
9764     * themes can be set by the call elm_layout_theme_set(), and provide some
9765     * basic functionality depending on the theme used.
9766     *
9767     * Most of them already send some signals, some already provide a toolbar or
9768     * back and next buttons.
9769     *
9770     * These are available predefined theme layouts. All of them have class = @c
9771     * layout, group = @c application, and style = one of the following options:
9772     *
9773     * @li @c toolbar-content - application with toolbar and main content area
9774     * @li @c toolbar-content-back - application with toolbar and main content
9775     * area with a back button and title area
9776     * @li @c toolbar-content-back-next - application with toolbar and main
9777     * content area with a back and next buttons and title area
9778     * @li @c content-back - application with a main content area with a back
9779     * button and title area
9780     * @li @c content-back-next - application with a main content area with a
9781     * back and next buttons and title area
9782     * @li @c toolbar-vbox - application with toolbar and main content area as a
9783     * vertical box
9784     * @li @c toolbar-table - application with toolbar and main content area as a
9785     * table
9786     *
9787     * @section secExamples Examples
9788     *
9789     * Some examples of the Layout widget can be found here:
9790     * @li @ref layout_example_01
9791     * @li @ref layout_example_02
9792     * @li @ref layout_example_03
9793     * @li @ref layout_example_edc
9794     *
9795     */
9796
9797    /**
9798     * Add a new layout to the parent
9799     *
9800     * @param parent The parent object
9801     * @return The new object or NULL if it cannot be created
9802     *
9803     * @see elm_layout_file_set()
9804     * @see elm_layout_theme_set()
9805     *
9806     * @ingroup Layout
9807     */
9808    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9809    /**
9810     * Set the file that will be used as layout
9811     *
9812     * @param obj The layout object
9813     * @param file The path to file (edj) that will be used as layout
9814     * @param group The group that the layout belongs in edje file
9815     *
9816     * @return (1 = success, 0 = error)
9817     *
9818     * @ingroup Layout
9819     */
9820    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9821    /**
9822     * Set the edje group from the elementary theme that will be used as layout
9823     *
9824     * @param obj The layout object
9825     * @param clas the clas of the group
9826     * @param group the group
9827     * @param style the style to used
9828     *
9829     * @return (1 = success, 0 = error)
9830     *
9831     * @ingroup Layout
9832     */
9833    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9834    /**
9835     * Set the layout content.
9836     *
9837     * @param obj The layout object
9838     * @param swallow The swallow part name in the edje file
9839     * @param content The child that will be added in this layout object
9840     *
9841     * Once the content object is set, a previously set one will be deleted.
9842     * If you want to keep that old content object, use the
9843     * elm_layout_content_unset() function.
9844     *
9845     * @note In an Edje theme, the part used as a content container is called @c
9846     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9847     * expected to be a part name just like the second parameter of
9848     * elm_layout_box_append().
9849     *
9850     * @see elm_layout_box_append()
9851     * @see elm_layout_content_get()
9852     * @see elm_layout_content_unset()
9853     * @see @ref secBox
9854     *
9855     * @ingroup Layout
9856     */
9857    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9858    /**
9859     * Get the child object in the given content part.
9860     *
9861     * @param obj The layout object
9862     * @param swallow The SWALLOW part to get its content
9863     *
9864     * @return The swallowed object or NULL if none or an error occurred
9865     *
9866     * @see elm_layout_content_set()
9867     *
9868     * @ingroup Layout
9869     */
9870    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9871    /**
9872     * Unset the layout content.
9873     *
9874     * @param obj The layout object
9875     * @param swallow The swallow part name in the edje file
9876     * @return The content that was being used
9877     *
9878     * Unparent and return the content object which was set for this part.
9879     *
9880     * @see elm_layout_content_set()
9881     *
9882     * @ingroup Layout
9883     */
9884     EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9885    /**
9886     * Set the text of the given part
9887     *
9888     * @param obj The layout object
9889     * @param part The TEXT part where to set the text
9890     * @param text The text to set
9891     *
9892     * @ingroup Layout
9893     * @deprecated use elm_object_text_* instead.
9894     */
9895    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9896    /**
9897     * Get the text set in the given part
9898     *
9899     * @param obj The layout object
9900     * @param part The TEXT part to retrieve the text off
9901     *
9902     * @return The text set in @p part
9903     *
9904     * @ingroup Layout
9905     * @deprecated use elm_object_text_* instead.
9906     */
9907    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9908    /**
9909     * Append child to layout box part.
9910     *
9911     * @param obj the layout object
9912     * @param part the box part to which the object will be appended.
9913     * @param child the child object to append to box.
9914     *
9915     * Once the object is appended, it will become child of the layout. Its
9916     * lifetime will be bound to the layout, whenever the layout dies the child
9917     * will be deleted automatically. One should use elm_layout_box_remove() to
9918     * make this layout forget about the object.
9919     *
9920     * @see elm_layout_box_prepend()
9921     * @see elm_layout_box_insert_before()
9922     * @see elm_layout_box_insert_at()
9923     * @see elm_layout_box_remove()
9924     *
9925     * @ingroup Layout
9926     */
9927    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9928    /**
9929     * Prepend child to layout box part.
9930     *
9931     * @param obj the layout object
9932     * @param part the box part to prepend.
9933     * @param child the child object to prepend to box.
9934     *
9935     * Once the object is prepended, it will become child of the layout. Its
9936     * lifetime will be bound to the layout, whenever the layout dies the child
9937     * will be deleted automatically. One should use elm_layout_box_remove() to
9938     * make this layout forget about the object.
9939     *
9940     * @see elm_layout_box_append()
9941     * @see elm_layout_box_insert_before()
9942     * @see elm_layout_box_insert_at()
9943     * @see elm_layout_box_remove()
9944     *
9945     * @ingroup Layout
9946     */
9947    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9948    /**
9949     * Insert child to layout box part before a reference object.
9950     *
9951     * @param obj the layout object
9952     * @param part the box part to insert.
9953     * @param child the child object to insert into box.
9954     * @param reference another reference object to insert before in box.
9955     *
9956     * Once the object is inserted, it will become child of the layout. Its
9957     * lifetime will be bound to the layout, whenever the layout dies the child
9958     * will be deleted automatically. One should use elm_layout_box_remove() to
9959     * make this layout forget about the object.
9960     *
9961     * @see elm_layout_box_append()
9962     * @see elm_layout_box_prepend()
9963     * @see elm_layout_box_insert_before()
9964     * @see elm_layout_box_remove()
9965     *
9966     * @ingroup Layout
9967     */
9968    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9969    /**
9970     * Insert child to layout box part at a given position.
9971     *
9972     * @param obj the layout object
9973     * @param part the box part to insert.
9974     * @param child the child object to insert into box.
9975     * @param pos the numeric position >=0 to insert the child.
9976     *
9977     * Once the object is inserted, it will become child of the layout. Its
9978     * lifetime will be bound to the layout, whenever the layout dies the child
9979     * will be deleted automatically. One should use elm_layout_box_remove() to
9980     * make this layout forget about the object.
9981     *
9982     * @see elm_layout_box_append()
9983     * @see elm_layout_box_prepend()
9984     * @see elm_layout_box_insert_before()
9985     * @see elm_layout_box_remove()
9986     *
9987     * @ingroup Layout
9988     */
9989    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9990    /**
9991     * Remove a child of the given part box.
9992     *
9993     * @param obj The layout object
9994     * @param part The box part name to remove child.
9995     * @param child The object to remove from box.
9996     * @return The object that was being used, or NULL if not found.
9997     *
9998     * The object will be removed from the box part and its lifetime will
9999     * not be handled by the layout anymore. This is equivalent to
10000     * elm_layout_content_unset() for box.
10001     *
10002     * @see elm_layout_box_append()
10003     * @see elm_layout_box_remove_all()
10004     *
10005     * @ingroup Layout
10006     */
10007    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10008    /**
10009     * Remove all child of the given part box.
10010     *
10011     * @param obj The layout object
10012     * @param part The box part name to remove child.
10013     * @param clear If EINA_TRUE, then all objects will be deleted as
10014     *        well, otherwise they will just be removed and will be
10015     *        dangling on the canvas.
10016     *
10017     * The objects will be removed from the box part and their lifetime will
10018     * not be handled by the layout anymore. This is equivalent to
10019     * elm_layout_box_remove() for all box children.
10020     *
10021     * @see elm_layout_box_append()
10022     * @see elm_layout_box_remove()
10023     *
10024     * @ingroup Layout
10025     */
10026    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10027    /**
10028     * Insert child to layout table part.
10029     *
10030     * @param obj the layout object
10031     * @param part the box part to pack child.
10032     * @param child_obj the child object to pack into table.
10033     * @param col the column to which the child should be added. (>= 0)
10034     * @param row the row to which the child should be added. (>= 0)
10035     * @param colspan how many columns should be used to store this object. (>=
10036     *        1)
10037     * @param rowspan how many rows should be used to store this object. (>= 1)
10038     *
10039     * Once the object is inserted, it will become child of the table. Its
10040     * lifetime will be bound to the layout, and whenever the layout dies the
10041     * child will be deleted automatically. One should use
10042     * elm_layout_table_remove() to make this layout forget about the object.
10043     *
10044     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10045     * more space than a single cell. For instance, the following code:
10046     * @code
10047     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10048     * @endcode
10049     *
10050     * Would result in an object being added like the following picture:
10051     *
10052     * @image html layout_colspan.png
10053     * @image latex layout_colspan.eps width=\textwidth
10054     *
10055     * @see elm_layout_table_unpack()
10056     * @see elm_layout_table_clear()
10057     *
10058     * @ingroup Layout
10059     */
10060    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);
10061    /**
10062     * Unpack (remove) a child of the given part table.
10063     *
10064     * @param obj The layout object
10065     * @param part The table part name to remove child.
10066     * @param child_obj The object to remove from table.
10067     * @return The object that was being used, or NULL if not found.
10068     *
10069     * The object will be unpacked from the table part and its lifetime
10070     * will not be handled by the layout anymore. This is equivalent to
10071     * elm_layout_content_unset() for table.
10072     *
10073     * @see elm_layout_table_pack()
10074     * @see elm_layout_table_clear()
10075     *
10076     * @ingroup Layout
10077     */
10078    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10079    /**
10080     * Remove all child of the given part table.
10081     *
10082     * @param obj The layout object
10083     * @param part The table part name to remove child.
10084     * @param clear If EINA_TRUE, then all objects will be deleted as
10085     *        well, otherwise they will just be removed and will be
10086     *        dangling on the canvas.
10087     *
10088     * The objects will be removed from the table part and their lifetime will
10089     * not be handled by the layout anymore. This is equivalent to
10090     * elm_layout_table_unpack() for all table children.
10091     *
10092     * @see elm_layout_table_pack()
10093     * @see elm_layout_table_unpack()
10094     *
10095     * @ingroup Layout
10096     */
10097    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10098    /**
10099     * Get the edje layout
10100     *
10101     * @param obj The layout object
10102     *
10103     * @return A Evas_Object with the edje layout settings loaded
10104     * with function elm_layout_file_set
10105     *
10106     * This returns the edje object. It is not expected to be used to then
10107     * swallow objects via edje_object_part_swallow() for example. Use
10108     * elm_layout_content_set() instead so child object handling and sizing is
10109     * done properly.
10110     *
10111     * @note This function should only be used if you really need to call some
10112     * low level Edje function on this edje object. All the common stuff (setting
10113     * text, emitting signals, hooking callbacks to signals, etc.) can be done
10114     * with proper elementary functions.
10115     *
10116     * @see elm_object_signal_callback_add()
10117     * @see elm_object_signal_emit()
10118     * @see elm_object_text_part_set()
10119     * @see elm_layout_content_set()
10120     * @see elm_layout_box_append()
10121     * @see elm_layout_table_pack()
10122     * @see elm_layout_data_get()
10123     *
10124     * @ingroup Layout
10125     */
10126    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10127    /**
10128     * Get the edje data from the given layout
10129     *
10130     * @param obj The layout object
10131     * @param key The data key
10132     *
10133     * @return The edje data string
10134     *
10135     * This function fetches data specified inside the edje theme of this layout.
10136     * This function return NULL if data is not found.
10137     *
10138     * In EDC this comes from a data block within the group block that @p
10139     * obj was loaded from. E.g.
10140     *
10141     * @code
10142     * collections {
10143     *   group {
10144     *     name: "a_group";
10145     *     data {
10146     *       item: "key1" "value1";
10147     *       item: "key2" "value2";
10148     *     }
10149     *   }
10150     * }
10151     * @endcode
10152     *
10153     * @ingroup Layout
10154     */
10155    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10156    /**
10157     * Eval sizing
10158     *
10159     * @param obj The layout object
10160     *
10161     * Manually forces a sizing re-evaluation. This is useful when the minimum
10162     * size required by the edje theme of this layout has changed. The change on
10163     * the minimum size required by the edje theme is not immediately reported to
10164     * the elementary layout, so one needs to call this function in order to tell
10165     * the widget (layout) that it needs to reevaluate its own size.
10166     *
10167     * The minimum size of the theme is calculated based on minimum size of
10168     * parts, the size of elements inside containers like box and table, etc. All
10169     * of this can change due to state changes, and that's when this function
10170     * should be called.
10171     *
10172     * Also note that a standard signal of "size,eval" "elm" emitted from the
10173     * edje object will cause this to happen too.
10174     *
10175     * @ingroup Layout
10176     */
10177    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10178
10179    /**
10180     * Sets a specific cursor for an edje part.
10181     *
10182     * @param obj The layout object.
10183     * @param part_name a part from loaded edje group.
10184     * @param cursor cursor name to use, see Elementary_Cursor.h
10185     *
10186     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10187     *         part not exists or it has "mouse_events: 0".
10188     *
10189     * @ingroup Layout
10190     */
10191    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10192
10193    /**
10194     * Get the cursor to be shown when mouse is over an edje part
10195     *
10196     * @param obj The layout object.
10197     * @param part_name a part from loaded edje group.
10198     * @return the cursor name.
10199     *
10200     * @ingroup Layout
10201     */
10202    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10203
10204    /**
10205     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10206     *
10207     * @param obj The layout object.
10208     * @param part_name a part from loaded edje group, that had a cursor set
10209     *        with elm_layout_part_cursor_set().
10210     *
10211     * @ingroup Layout
10212     */
10213    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10214
10215    /**
10216     * Sets a specific cursor style for an edje part.
10217     *
10218     * @param obj The layout object.
10219     * @param part_name a part from loaded edje group.
10220     * @param style the theme style to use (default, transparent, ...)
10221     *
10222     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10223     *         part not exists or it did not had a cursor set.
10224     *
10225     * @ingroup Layout
10226     */
10227    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10228
10229    /**
10230     * Gets a specific cursor style for an edje part.
10231     *
10232     * @param obj The layout object.
10233     * @param part_name a part from loaded edje group.
10234     *
10235     * @return the theme style in use, defaults to "default". If the
10236     *         object does not have a cursor set, then NULL is returned.
10237     *
10238     * @ingroup Layout
10239     */
10240    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10241
10242    /**
10243     * Sets if the cursor set should be searched on the theme or should use
10244     * the provided by the engine, only.
10245     *
10246     * @note before you set if should look on theme you should define a
10247     * cursor with elm_layout_part_cursor_set(). By default it will only
10248     * look for cursors provided by the engine.
10249     *
10250     * @param obj The layout object.
10251     * @param part_name a part from loaded edje group.
10252     * @param engine_only if cursors should be just provided by the engine
10253     *        or should also search on widget's theme as well
10254     *
10255     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10256     *         part not exists or it did not had a cursor set.
10257     *
10258     * @ingroup Layout
10259     */
10260    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);
10261
10262    /**
10263     * Gets a specific cursor engine_only for an edje part.
10264     *
10265     * @param obj The layout object.
10266     * @param part_name a part from loaded edje group.
10267     *
10268     * @return whenever the cursor is just provided by engine or also from theme.
10269     *
10270     * @ingroup Layout
10271     */
10272    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10273
10274 /**
10275  * @def elm_layout_icon_set
10276  * Convienience macro to set the icon object in a layout that follows the
10277  * Elementary naming convention for its parts.
10278  *
10279  * @ingroup Layout
10280  */
10281 #define elm_layout_icon_set(_ly, _obj) \
10282   do { \
10283     const char *sig; \
10284     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10285     if ((_obj)) sig = "elm,state,icon,visible"; \
10286     else sig = "elm,state,icon,hidden"; \
10287     elm_object_signal_emit((_ly), sig, "elm"); \
10288   } while (0)
10289
10290 /**
10291  * @def elm_layout_icon_get
10292  * Convienience macro to get the icon object from a layout that follows the
10293  * Elementary naming convention for its parts.
10294  *
10295  * @ingroup Layout
10296  */
10297 #define elm_layout_icon_get(_ly) \
10298   elm_layout_content_get((_ly), "elm.swallow.icon")
10299
10300 /**
10301  * @def elm_layout_end_set
10302  * Convienience macro to set the end object in a layout that follows the
10303  * Elementary naming convention for its parts.
10304  *
10305  * @ingroup Layout
10306  */
10307 #define elm_layout_end_set(_ly, _obj) \
10308   do { \
10309     const char *sig; \
10310     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10311     if ((_obj)) sig = "elm,state,end,visible"; \
10312     else sig = "elm,state,end,hidden"; \
10313     elm_object_signal_emit((_ly), sig, "elm"); \
10314   } while (0)
10315
10316 /**
10317  * @def elm_layout_end_get
10318  * Convienience macro to get the end object in a layout that follows the
10319  * Elementary naming convention for its parts.
10320  *
10321  * @ingroup Layout
10322  */
10323 #define elm_layout_end_get(_ly) \
10324   elm_layout_content_get((_ly), "elm.swallow.end")
10325
10326 /**
10327  * @def elm_layout_label_set
10328  * Convienience macro to set the label in a layout that follows the
10329  * Elementary naming convention for its parts.
10330  *
10331  * @ingroup Layout
10332  * @deprecated use elm_object_text_* instead.
10333  */
10334 #define elm_layout_label_set(_ly, _txt) \
10335   elm_layout_text_set((_ly), "elm.text", (_txt))
10336
10337 /**
10338  * @def elm_layout_label_get
10339  * Convienience macro to get the label in a layout that follows the
10340  * Elementary naming convention for its parts.
10341  *
10342  * @ingroup Layout
10343  * @deprecated use elm_object_text_* instead.
10344  */
10345 #define elm_layout_label_get(_ly) \
10346   elm_layout_text_get((_ly), "elm.text")
10347
10348    /* smart callbacks called:
10349     * "theme,changed" - when elm theme is changed.
10350     */
10351
10352    /**
10353     * @defgroup Notify Notify
10354     *
10355     * @image html img/widget/notify/preview-00.png
10356     * @image latex img/widget/notify/preview-00.eps
10357     *
10358     * Display a container in a particular region of the parent(top, bottom,
10359     * etc.  A timeout can be set to automatically hide the notify. This is so
10360     * that, after an evas_object_show() on a notify object, if a timeout was set
10361     * on it, it will @b automatically get hidden after that time.
10362     *
10363     * Signals that you can add callbacks for are:
10364     * @li "timeout" - when timeout happens on notify and it's hidden
10365     * @li "block,clicked" - when a click outside of the notify happens
10366     *
10367     * @ref tutorial_notify show usage of the API.
10368     *
10369     * @{
10370     */
10371    /**
10372     * @brief Possible orient values for notify.
10373     *
10374     * This values should be used in conjunction to elm_notify_orient_set() to
10375     * set the position in which the notify should appear(relative to its parent)
10376     * and in conjunction with elm_notify_orient_get() to know where the notify
10377     * is appearing.
10378     */
10379    typedef enum _Elm_Notify_Orient
10380      {
10381         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10382         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10383         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10384         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10385         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10386         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10387         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10388         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10389         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10390         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10391      } Elm_Notify_Orient;
10392    /**
10393     * @brief Add a new notify to the parent
10394     *
10395     * @param parent The parent object
10396     * @return The new object or NULL if it cannot be created
10397     */
10398    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10399    /**
10400     * @brief Set the content of the notify widget
10401     *
10402     * @param obj The notify object
10403     * @param content The content will be filled in this notify object
10404     *
10405     * Once the content object is set, a previously set one will be deleted. If
10406     * you want to keep that old content object, use the
10407     * elm_notify_content_unset() function.
10408     */
10409    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10410    /**
10411     * @brief Unset the content of the notify widget
10412     *
10413     * @param obj The notify object
10414     * @return The content that was being used
10415     *
10416     * Unparent and return the content object which was set for this widget
10417     *
10418     * @see elm_notify_content_set()
10419     */
10420    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10421    /**
10422     * @brief Return the content of the notify widget
10423     *
10424     * @param obj The notify object
10425     * @return The content that is being used
10426     *
10427     * @see elm_notify_content_set()
10428     */
10429    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10430    /**
10431     * @brief Set the notify parent
10432     *
10433     * @param obj The notify object
10434     * @param content The new parent
10435     *
10436     * Once the parent object is set, a previously set one will be disconnected
10437     * and replaced.
10438     */
10439    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10440    /**
10441     * @brief Get the notify parent
10442     *
10443     * @param obj The notify object
10444     * @return The parent
10445     *
10446     * @see elm_notify_parent_set()
10447     */
10448    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10449    /**
10450     * @brief Set the orientation
10451     *
10452     * @param obj The notify object
10453     * @param orient The new orientation
10454     *
10455     * Sets the position in which the notify will appear in its parent.
10456     *
10457     * @see @ref Elm_Notify_Orient for possible values.
10458     */
10459    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10460    /**
10461     * @brief Return the orientation
10462     * @param obj The notify object
10463     * @return The orientation of the notification
10464     *
10465     * @see elm_notify_orient_set()
10466     * @see Elm_Notify_Orient
10467     */
10468    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10469    /**
10470     * @brief Set the time interval after which the notify window is going to be
10471     * hidden.
10472     *
10473     * @param obj The notify object
10474     * @param time The timeout in seconds
10475     *
10476     * This function sets a timeout and starts the timer controlling when the
10477     * notify is hidden. Since calling evas_object_show() on a notify restarts
10478     * the timer controlling when the notify is hidden, setting this before the
10479     * notify is shown will in effect mean starting the timer when the notify is
10480     * shown.
10481     *
10482     * @note Set a value <= 0.0 to disable a running timer.
10483     *
10484     * @note If the value > 0.0 and the notify is previously visible, the
10485     * timer will be started with this value, canceling any running timer.
10486     */
10487    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10488    /**
10489     * @brief Return the timeout value (in seconds)
10490     * @param obj the notify object
10491     *
10492     * @see elm_notify_timeout_set()
10493     */
10494    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10495    /**
10496     * @brief Sets whether events should be passed to by a click outside
10497     * its area.
10498     *
10499     * @param obj The notify object
10500     * @param repeats EINA_TRUE Events are repeats, else no
10501     *
10502     * When true if the user clicks outside the window the events will be caught
10503     * by the others widgets, else the events are blocked.
10504     *
10505     * @note The default value is EINA_TRUE.
10506     */
10507    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10508    /**
10509     * @brief Return true if events are repeat below the notify object
10510     * @param obj the notify object
10511     *
10512     * @see elm_notify_repeat_events_set()
10513     */
10514    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10515    /**
10516     * @}
10517     */
10518
10519    /**
10520     * @defgroup Hover Hover
10521     *
10522     * @image html img/widget/hover/preview-00.png
10523     * @image latex img/widget/hover/preview-00.eps
10524     *
10525     * A Hover object will hover over its @p parent object at the @p target
10526     * location. Anything in the background will be given a darker coloring to
10527     * indicate that the hover object is on top (at the default theme). When the
10528     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10529     * clicked that @b doesn't cause the hover to be dismissed.
10530     *
10531     * A Hover object has two parents. One parent that owns it during creation
10532     * and the other parent being the one over which the hover object spans.
10533     *
10534     *
10535     * @note The hover object will take up the entire space of @p target
10536     * object.
10537     *
10538     * Elementary has the following styles for the hover widget:
10539     * @li default
10540     * @li popout
10541     * @li menu
10542     * @li hoversel_vertical
10543     *
10544     * The following are the available position for content:
10545     * @li left
10546     * @li top-left
10547     * @li top
10548     * @li top-right
10549     * @li right
10550     * @li bottom-right
10551     * @li bottom
10552     * @li bottom-left
10553     * @li middle
10554     * @li smart
10555     *
10556     * Signals that you can add callbacks for are:
10557     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10558     * @li "smart,changed" - a content object placed under the "smart"
10559     *                   policy was replaced to a new slot direction.
10560     *
10561     * See @ref tutorial_hover for more information.
10562     *
10563     * @{
10564     */
10565    typedef enum _Elm_Hover_Axis
10566      {
10567         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10568         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10569         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10570         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10571      } Elm_Hover_Axis;
10572    /**
10573     * @brief Adds a hover object to @p parent
10574     *
10575     * @param parent The parent object
10576     * @return The hover object or NULL if one could not be created
10577     */
10578    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10579    /**
10580     * @brief Sets the target object for the hover.
10581     *
10582     * @param obj The hover object
10583     * @param target The object to center the hover onto. The hover
10584     *
10585     * This function will cause the hover to be centered on the target object.
10586     */
10587    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10588    /**
10589     * @brief Gets the target object for the hover.
10590     *
10591     * @param obj The hover object
10592     * @param parent The object to locate the hover over.
10593     *
10594     * @see elm_hover_target_set()
10595     */
10596    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10597    /**
10598     * @brief Sets the parent object for the hover.
10599     *
10600     * @param obj The hover object
10601     * @param parent The object to locate the hover over.
10602     *
10603     * This function will cause the hover to take up the entire space that the
10604     * parent object fills.
10605     */
10606    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10607    /**
10608     * @brief Gets the parent object for the hover.
10609     *
10610     * @param obj The hover object
10611     * @return The parent object to locate the hover over.
10612     *
10613     * @see elm_hover_parent_set()
10614     */
10615    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10616    /**
10617     * @brief Sets the content of the hover object and the direction in which it
10618     * will pop out.
10619     *
10620     * @param obj The hover object
10621     * @param swallow The direction that the object will be displayed
10622     * at. Accepted values are "left", "top-left", "top", "top-right",
10623     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10624     * "smart".
10625     * @param content The content to place at @p swallow
10626     *
10627     * Once the content object is set for a given direction, a previously
10628     * set one (on the same direction) will be deleted. If you want to
10629     * keep that old content object, use the elm_hover_content_unset()
10630     * function.
10631     *
10632     * All directions may have contents at the same time, except for
10633     * "smart". This is a special placement hint and its use case
10634     * independs of the calculations coming from
10635     * elm_hover_best_content_location_get(). Its use is for cases when
10636     * one desires only one hover content, but with a dinamic special
10637     * placement within the hover area. The content's geometry, whenever
10638     * it changes, will be used to decide on a best location not
10639     * extrapolating the hover's parent object view to show it in (still
10640     * being the hover's target determinant of its medium part -- move and
10641     * resize it to simulate finger sizes, for example). If one of the
10642     * directions other than "smart" are used, a previously content set
10643     * using it will be deleted, and vice-versa.
10644     */
10645    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10646    /**
10647     * @brief Get the content of the hover object, in a given direction.
10648     *
10649     * Return the content object which was set for this widget in the
10650     * @p swallow direction.
10651     *
10652     * @param obj The hover object
10653     * @param swallow The direction that the object was display at.
10654     * @return The content that was being used
10655     *
10656     * @see elm_hover_content_set()
10657     */
10658    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10659    /**
10660     * @brief Unset the content of the hover object, in a given direction.
10661     *
10662     * Unparent and return the content object set at @p swallow direction.
10663     *
10664     * @param obj The hover object
10665     * @param swallow The direction that the object was display at.
10666     * @return The content that was being used.
10667     *
10668     * @see elm_hover_content_set()
10669     */
10670    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10671    /**
10672     * @brief Returns the best swallow location for content in the hover.
10673     *
10674     * @param obj The hover object
10675     * @param pref_axis The preferred orientation axis for the hover object to use
10676     * @return The edje location to place content into the hover or @c
10677     *         NULL, on errors.
10678     *
10679     * Best is defined here as the location at which there is the most available
10680     * space.
10681     *
10682     * @p pref_axis may be one of
10683     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10684     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10685     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10686     * - @c ELM_HOVER_AXIS_BOTH -- both
10687     *
10688     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10689     * nescessarily be along the horizontal axis("left" or "right"). If
10690     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10691     * be along the vertical axis("top" or "bottom"). Chossing
10692     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10693     * returned position may be in either axis.
10694     *
10695     * @see elm_hover_content_set()
10696     */
10697    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10698    /**
10699     * @}
10700     */
10701
10702    /* entry */
10703    /**
10704     * @defgroup Entry Entry
10705     *
10706     * @image html img/widget/entry/preview-00.png
10707     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10708     * @image html img/widget/entry/preview-01.png
10709     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10710     * @image html img/widget/entry/preview-02.png
10711     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10712     * @image html img/widget/entry/preview-03.png
10713     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10714     *
10715     * An entry is a convenience widget which shows a box that the user can
10716     * enter text into. Entries by default don't scroll, so they grow to
10717     * accomodate the entire text, resizing the parent window as needed. This
10718     * can be changed with the elm_entry_scrollable_set() function.
10719     *
10720     * They can also be single line or multi line (the default) and when set
10721     * to multi line mode they support text wrapping in any of the modes
10722     * indicated by #Elm_Wrap_Type.
10723     *
10724     * Other features include password mode, filtering of inserted text with
10725     * elm_entry_text_filter_append() and related functions, inline "items" and
10726     * formatted markup text.
10727     *
10728     * @section entry-markup Formatted text
10729     *
10730     * The markup tags supported by the Entry are defined by the theme, but
10731     * even when writing new themes or extensions it's a good idea to stick to
10732     * a sane default, to maintain coherency and avoid application breakages.
10733     * Currently defined by the default theme are the following tags:
10734     * @li \<br\>: Inserts a line break.
10735     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10736     * breaks.
10737     * @li \<tab\>: Inserts a tab.
10738     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10739     * enclosed text.
10740     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10741     * @li \<link\>...\</link\>: Underlines the enclosed text.
10742     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10743     *
10744     * @section entry-special Special markups
10745     *
10746     * Besides those used to format text, entries support two special markup
10747     * tags used to insert clickable portions of text or items inlined within
10748     * the text.
10749     *
10750     * @subsection entry-anchors Anchors
10751     *
10752     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10753     * \</a\> tags and an event will be generated when this text is clicked,
10754     * like this:
10755     *
10756     * @code
10757     * This text is outside <a href=anc-01>but this one is an anchor</a>
10758     * @endcode
10759     *
10760     * The @c href attribute in the opening tag gives the name that will be
10761     * used to identify the anchor and it can be any valid utf8 string.
10762     *
10763     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10764     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10765     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10766     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10767     * an anchor.
10768     *
10769     * @subsection entry-items Items
10770     *
10771     * Inlined in the text, any other @c Evas_Object can be inserted by using
10772     * \<item\> tags this way:
10773     *
10774     * @code
10775     * <item size=16x16 vsize=full href=emoticon/haha></item>
10776     * @endcode
10777     *
10778     * Just like with anchors, the @c href identifies each item, but these need,
10779     * in addition, to indicate their size, which is done using any one of
10780     * @c size, @c absize or @c relsize attributes. These attributes take their
10781     * value in the WxH format, where W is the width and H the height of the
10782     * item.
10783     *
10784     * @li absize: Absolute pixel size for the item. Whatever value is set will
10785     * be the item's size regardless of any scale value the object may have
10786     * been set to. The final line height will be adjusted to fit larger items.
10787     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10788     * for the object.
10789     * @li relsize: Size is adjusted for the item to fit within the current
10790     * line height.
10791     *
10792     * Besides their size, items are specificed a @c vsize value that affects
10793     * how their final size and position are calculated. The possible values
10794     * are:
10795     * @li ascent: Item will be placed within the line's baseline and its
10796     * ascent. That is, the height between the line where all characters are
10797     * positioned and the highest point in the line. For @c size and @c absize
10798     * items, the descent value will be added to the total line height to make
10799     * them fit. @c relsize items will be adjusted to fit within this space.
10800     * @li full: Items will be placed between the descent and ascent, or the
10801     * lowest point in the line and its highest.
10802     *
10803     * The next image shows different configurations of items and how they
10804     * are the previously mentioned options affect their sizes. In all cases,
10805     * the green line indicates the ascent, blue for the baseline and red for
10806     * the descent.
10807     *
10808     * @image html entry_item.png
10809     * @image latex entry_item.eps width=\textwidth
10810     *
10811     * And another one to show how size differs from absize. In the first one,
10812     * the scale value is set to 1.0, while the second one is using one of 2.0.
10813     *
10814     * @image html entry_item_scale.png
10815     * @image latex entry_item_scale.eps width=\textwidth
10816     *
10817     * After the size for an item is calculated, the entry will request an
10818     * object to place in its space. For this, the functions set with
10819     * elm_entry_item_provider_append() and related functions will be called
10820     * in order until one of them returns a @c non-NULL value. If no providers
10821     * are available, or all of them return @c NULL, then the entry falls back
10822     * to one of the internal defaults, provided the name matches with one of
10823     * them.
10824     *
10825     * All of the following are currently supported:
10826     *
10827     * - emoticon/angry
10828     * - emoticon/angry-shout
10829     * - emoticon/crazy-laugh
10830     * - emoticon/evil-laugh
10831     * - emoticon/evil
10832     * - emoticon/goggle-smile
10833     * - emoticon/grumpy
10834     * - emoticon/grumpy-smile
10835     * - emoticon/guilty
10836     * - emoticon/guilty-smile
10837     * - emoticon/haha
10838     * - emoticon/half-smile
10839     * - emoticon/happy-panting
10840     * - emoticon/happy
10841     * - emoticon/indifferent
10842     * - emoticon/kiss
10843     * - emoticon/knowing-grin
10844     * - emoticon/laugh
10845     * - emoticon/little-bit-sorry
10846     * - emoticon/love-lots
10847     * - emoticon/love
10848     * - emoticon/minimal-smile
10849     * - emoticon/not-happy
10850     * - emoticon/not-impressed
10851     * - emoticon/omg
10852     * - emoticon/opensmile
10853     * - emoticon/smile
10854     * - emoticon/sorry
10855     * - emoticon/squint-laugh
10856     * - emoticon/surprised
10857     * - emoticon/suspicious
10858     * - emoticon/tongue-dangling
10859     * - emoticon/tongue-poke
10860     * - emoticon/uh
10861     * - emoticon/unhappy
10862     * - emoticon/very-sorry
10863     * - emoticon/what
10864     * - emoticon/wink
10865     * - emoticon/worried
10866     * - emoticon/wtf
10867     *
10868     * Alternatively, an item may reference an image by its path, using
10869     * the URI form @c file:///path/to/an/image.png and the entry will then
10870     * use that image for the item.
10871     *
10872     * @section entry-files Loading and saving files
10873     *
10874     * Entries have convinience functions to load text from a file and save
10875     * changes back to it after a short delay. The automatic saving is enabled
10876     * by default, but can be disabled with elm_entry_autosave_set() and files
10877     * can be loaded directly as plain text or have any markup in them
10878     * recognized. See elm_entry_file_set() for more details.
10879     *
10880     * @section entry-signals Emitted signals
10881     *
10882     * This widget emits the following signals:
10883     *
10884     * @li "changed": The text within the entry was changed.
10885     * @li "changed,user": The text within the entry was changed because of user interaction.
10886     * @li "activated": The enter key was pressed on a single line entry.
10887     * @li "press": A mouse button has been pressed on the entry.
10888     * @li "longpressed": A mouse button has been pressed and held for a couple
10889     * seconds.
10890     * @li "clicked": The entry has been clicked (mouse press and release).
10891     * @li "clicked,double": The entry has been double clicked.
10892     * @li "clicked,triple": The entry has been triple clicked.
10893     * @li "focused": The entry has received focus.
10894     * @li "unfocused": The entry has lost focus.
10895     * @li "selection,paste": A paste of the clipboard contents was requested.
10896     * @li "selection,copy": A copy of the selected text into the clipboard was
10897     * requested.
10898     * @li "selection,cut": A cut of the selected text into the clipboard was
10899     * requested.
10900     * @li "selection,start": A selection has begun and no previous selection
10901     * existed.
10902     * @li "selection,changed": The current selection has changed.
10903     * @li "selection,cleared": The current selection has been cleared.
10904     * @li "cursor,changed": The cursor has changed position.
10905     * @li "anchor,clicked": An anchor has been clicked. The event_info
10906     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10907     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10908     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10909     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10910     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10911     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10912     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10913     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10914     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10915     * @li "preedit,changed": The preedit string has changed.
10916     * @li "language,changed": Program language changed.
10917     *
10918     * @section entry-examples
10919     *
10920     * An overview of the Entry API can be seen in @ref entry_example_01
10921     *
10922     * @{
10923     */
10924    /**
10925     * @typedef Elm_Entry_Anchor_Info
10926     *
10927     * The info sent in the callback for the "anchor,clicked" signals emitted
10928     * by entries.
10929     */
10930    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10931    /**
10932     * @struct _Elm_Entry_Anchor_Info
10933     *
10934     * The info sent in the callback for the "anchor,clicked" signals emitted
10935     * by entries.
10936     */
10937    struct _Elm_Entry_Anchor_Info
10938      {
10939         const char *name; /**< The name of the anchor, as stated in its href */
10940         int         button; /**< The mouse button used to click on it */
10941         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
10942                     y, /**< Anchor geometry, relative to canvas */
10943                     w, /**< Anchor geometry, relative to canvas */
10944                     h; /**< Anchor geometry, relative to canvas */
10945      };
10946    /**
10947     * @typedef Elm_Entry_Filter_Cb
10948     * This callback type is used by entry filters to modify text.
10949     * @param data The data specified as the last param when adding the filter
10950     * @param entry The entry object
10951     * @param text A pointer to the location of the text being filtered. This data can be modified,
10952     * but any additional allocations must be managed by the user.
10953     * @see elm_entry_text_filter_append
10954     * @see elm_entry_text_filter_prepend
10955     */
10956    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10957
10958    /**
10959     * This adds an entry to @p parent object.
10960     *
10961     * By default, entries are:
10962     * @li not scrolled
10963     * @li multi-line
10964     * @li word wrapped
10965     * @li autosave is enabled
10966     *
10967     * @param parent The parent object
10968     * @return The new object or NULL if it cannot be created
10969     */
10970    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10971    /**
10972     * Sets the entry to single line mode.
10973     *
10974     * In single line mode, entries don't ever wrap when the text reaches the
10975     * edge, and instead they keep growing horizontally. Pressing the @c Enter
10976     * key will generate an @c "activate" event instead of adding a new line.
10977     *
10978     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10979     * and pressing enter will break the text into a different line
10980     * without generating any events.
10981     *
10982     * @param obj The entry object
10983     * @param single_line If true, the text in the entry
10984     * will be on a single line.
10985     */
10986    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10987    /**
10988     * Gets whether the entry is set to be single line.
10989     *
10990     * @param obj The entry object
10991     * @return single_line If true, the text in the entry is set to display
10992     * on a single line.
10993     *
10994     * @see elm_entry_single_line_set()
10995     */
10996    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10997    /**
10998     * Sets the entry to password mode.
10999     *
11000     * In password mode, entries are implicitly single line and the display of
11001     * any text in them is replaced with asterisks (*).
11002     *
11003     * @param obj The entry object
11004     * @param password If true, password mode is enabled.
11005     */
11006    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11007    /**
11008     * Gets whether the entry is set to password mode.
11009     *
11010     * @param obj The entry object
11011     * @return If true, the entry is set to display all characters
11012     * as asterisks (*).
11013     *
11014     * @see elm_entry_password_set()
11015     */
11016    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11017    /**
11018     * This sets the text displayed within the entry to @p entry.
11019     *
11020     * @param obj The entry object
11021     * @param entry The text to be displayed
11022     *
11023     * @deprecated Use elm_object_text_set() instead.
11024     */
11025    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11026    /**
11027     * This returns the text currently shown in object @p entry.
11028     * See also elm_entry_entry_set().
11029     *
11030     * @param obj The entry object
11031     * @return The currently displayed text or NULL on failure
11032     *
11033     * @deprecated Use elm_object_text_get() instead.
11034     */
11035    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11036    /**
11037     * Appends @p entry to the text of the entry.
11038     *
11039     * Adds the text in @p entry to the end of any text already present in the
11040     * widget.
11041     *
11042     * The appended text is subject to any filters set for the widget.
11043     *
11044     * @param obj The entry object
11045     * @param entry The text to be displayed
11046     *
11047     * @see elm_entry_text_filter_append()
11048     */
11049    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11050    /**
11051     * Gets whether the entry is empty.
11052     *
11053     * Empty means no text at all. If there are any markup tags, like an item
11054     * tag for which no provider finds anything, and no text is displayed, this
11055     * function still returns EINA_FALSE.
11056     *
11057     * @param obj The entry object
11058     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11059     */
11060    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11061    /**
11062     * Gets any selected text within the entry.
11063     *
11064     * If there's any selected text in the entry, this function returns it as
11065     * a string in markup format. NULL is returned if no selection exists or
11066     * if an error occurred.
11067     *
11068     * The returned value points to an internal string and should not be freed
11069     * or modified in any way. If the @p entry object is deleted or its
11070     * contents are changed, the returned pointer should be considered invalid.
11071     *
11072     * @param obj The entry object
11073     * @return The selected text within the entry or NULL on failure
11074     */
11075    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11076    /**
11077     * Inserts the given text into the entry at the current cursor position.
11078     *
11079     * This inserts text at the cursor position as if it was typed
11080     * by the user (note that this also allows markup which a user
11081     * can't just "type" as it would be converted to escaped text, so this
11082     * call can be used to insert things like emoticon items or bold push/pop
11083     * tags, other font and color change tags etc.)
11084     *
11085     * If any selection exists, it will be replaced by the inserted text.
11086     *
11087     * The inserted text is subject to any filters set for the widget.
11088     *
11089     * @param obj The entry object
11090     * @param entry The text to insert
11091     *
11092     * @see elm_entry_text_filter_append()
11093     */
11094    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11095    /**
11096     * Set the line wrap type to use on multi-line entries.
11097     *
11098     * Sets the wrap type used by the entry to any of the specified in
11099     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11100     * line (without inserting a line break or paragraph separator) when it
11101     * reaches the far edge of the widget.
11102     *
11103     * Note that this only makes sense for multi-line entries. A widget set
11104     * to be single line will never wrap.
11105     *
11106     * @param obj The entry object
11107     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11108     */
11109    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11110    /**
11111     * Gets the wrap mode the entry was set to use.
11112     *
11113     * @param obj The entry object
11114     * @return Wrap type
11115     *
11116     * @see also elm_entry_line_wrap_set()
11117     */
11118    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11119    /**
11120     * Sets if the entry is to be editable or not.
11121     *
11122     * By default, entries are editable and when focused, any text input by the
11123     * user will be inserted at the current cursor position. But calling this
11124     * function with @p editable as EINA_FALSE will prevent the user from
11125     * inputting text into the entry.
11126     *
11127     * The only way to change the text of a non-editable entry is to use
11128     * elm_object_text_set(), elm_entry_entry_insert() and other related
11129     * functions.
11130     *
11131     * @param obj The entry object
11132     * @param editable If EINA_TRUE, user input will be inserted in the entry,
11133     * if not, the entry is read-only and no user input is allowed.
11134     */
11135    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11136    /**
11137     * Gets whether the entry is editable or not.
11138     *
11139     * @param obj The entry object
11140     * @return If true, the entry is editable by the user.
11141     * If false, it is not editable by the user
11142     *
11143     * @see elm_entry_editable_set()
11144     */
11145    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11146    /**
11147     * This drops any existing text selection within the entry.
11148     *
11149     * @param obj The entry object
11150     */
11151    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11152    /**
11153     * This selects all text within the entry.
11154     *
11155     * @param obj The entry object
11156     */
11157    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11158    /**
11159     * This moves the cursor one place to the right within the entry.
11160     *
11161     * @param obj The entry object
11162     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11163     */
11164    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11165    /**
11166     * This moves the cursor one place to the left within the entry.
11167     *
11168     * @param obj The entry object
11169     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11170     */
11171    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11172    /**
11173     * This moves the cursor one line up within the entry.
11174     *
11175     * @param obj The entry object
11176     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11177     */
11178    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11179    /**
11180     * This moves the cursor one line down within the entry.
11181     *
11182     * @param obj The entry object
11183     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11184     */
11185    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11186    /**
11187     * This moves the cursor to the beginning of the entry.
11188     *
11189     * @param obj The entry object
11190     */
11191    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11192    /**
11193     * This moves the cursor to the end of the entry.
11194     *
11195     * @param obj The entry object
11196     */
11197    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11198    /**
11199     * This moves the cursor to the beginning of the current line.
11200     *
11201     * @param obj The entry object
11202     */
11203    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11204    /**
11205     * This moves the cursor to the end of the current line.
11206     *
11207     * @param obj The entry object
11208     */
11209    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11210    /**
11211     * This begins a selection within the entry as though
11212     * the user were holding down the mouse button to make a selection.
11213     *
11214     * @param obj The entry object
11215     */
11216    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11217    /**
11218     * This ends a selection within the entry as though
11219     * the user had just released the mouse button while making a selection.
11220     *
11221     * @param obj The entry object
11222     */
11223    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11224    /**
11225     * Gets whether a format node exists at the current cursor position.
11226     *
11227     * A format node is anything that defines how the text is rendered. It can
11228     * be a visible format node, such as a line break or a paragraph separator,
11229     * or an invisible one, such as bold begin or end tag.
11230     * This function returns whether any format node exists at the current
11231     * cursor position.
11232     *
11233     * @param obj The entry object
11234     * @return EINA_TRUE if the current cursor position contains a format node,
11235     * EINA_FALSE otherwise.
11236     *
11237     * @see elm_entry_cursor_is_visible_format_get()
11238     */
11239    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11240    /**
11241     * Gets if the current cursor position holds a visible format node.
11242     *
11243     * @param obj The entry object
11244     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11245     * if it's an invisible one or no format exists.
11246     *
11247     * @see elm_entry_cursor_is_format_get()
11248     */
11249    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11250    /**
11251     * Gets the character pointed by the cursor at its current position.
11252     *
11253     * This function returns a string with the utf8 character stored at the
11254     * current cursor position.
11255     * Only the text is returned, any format that may exist will not be part
11256     * of the return value.
11257     *
11258     * @param obj The entry object
11259     * @return The text pointed by the cursors.
11260     */
11261    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11262    /**
11263     * This function returns the geometry of the cursor.
11264     *
11265     * It's useful if you want to draw something on the cursor (or where it is),
11266     * or for example in the case of scrolled entry where you want to show the
11267     * cursor.
11268     *
11269     * @param obj The entry object
11270     * @param x returned geometry
11271     * @param y returned geometry
11272     * @param w returned geometry
11273     * @param h returned geometry
11274     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11275     */
11276    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);
11277    /**
11278     * Sets the cursor position in the entry to the given value
11279     *
11280     * The value in @p pos is the index of the character position within the
11281     * contents of the string as returned by elm_entry_cursor_pos_get().
11282     *
11283     * @param obj The entry object
11284     * @param pos The position of the cursor
11285     */
11286    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11287    /**
11288     * Retrieves the current position of the cursor in the entry
11289     *
11290     * @param obj The entry object
11291     * @return The cursor position
11292     */
11293    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11294    /**
11295     * This executes a "cut" action on the selected text in the entry.
11296     *
11297     * @param obj The entry object
11298     */
11299    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11300    /**
11301     * This executes a "copy" action on the selected text in the entry.
11302     *
11303     * @param obj The entry object
11304     */
11305    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11306    /**
11307     * This executes a "paste" action in the entry.
11308     *
11309     * @param obj The entry object
11310     */
11311    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11312    /**
11313     * This clears and frees the items in a entry's contextual (longpress)
11314     * menu.
11315     *
11316     * @param obj The entry object
11317     *
11318     * @see elm_entry_context_menu_item_add()
11319     */
11320    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11321    /**
11322     * This adds an item to the entry's contextual menu.
11323     *
11324     * A longpress on an entry will make the contextual menu show up, if this
11325     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11326     * By default, this menu provides a few options like enabling selection mode,
11327     * which is useful on embedded devices that need to be explicit about it,
11328     * and when a selection exists it also shows the copy and cut actions.
11329     *
11330     * With this function, developers can add other options to this menu to
11331     * perform any action they deem necessary.
11332     *
11333     * @param obj The entry object
11334     * @param label The item's text label
11335     * @param icon_file The item's icon file
11336     * @param icon_type The item's icon type
11337     * @param func The callback to execute when the item is clicked
11338     * @param data The data to associate with the item for related functions
11339     */
11340    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);
11341    /**
11342     * This disables the entry's contextual (longpress) menu.
11343     *
11344     * @param obj The entry object
11345     * @param disabled If true, the menu is disabled
11346     */
11347    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11348    /**
11349     * This returns whether the entry's contextual (longpress) menu is
11350     * disabled.
11351     *
11352     * @param obj The entry object
11353     * @return If true, the menu is disabled
11354     */
11355    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11356    /**
11357     * This appends a custom item provider to the list for that entry
11358     *
11359     * This appends the given callback. The list is walked from beginning to end
11360     * with each function called given the item href string in the text. If the
11361     * function returns an object handle other than NULL (it should create an
11362     * object to do this), then this object is used to replace that item. If
11363     * not the next provider is called until one provides an item object, or the
11364     * default provider in entry does.
11365     *
11366     * @param obj The entry object
11367     * @param func The function called to provide the item object
11368     * @param data The data passed to @p func
11369     *
11370     * @see @ref entry-items
11371     */
11372    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);
11373    /**
11374     * This prepends a custom item provider to the list for that entry
11375     *
11376     * This prepends the given callback. See elm_entry_item_provider_append() for
11377     * more information
11378     *
11379     * @param obj The entry object
11380     * @param func The function called to provide the item object
11381     * @param data The data passed to @p func
11382     */
11383    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);
11384    /**
11385     * This removes a custom item provider to the list for that entry
11386     *
11387     * This removes the given callback. See elm_entry_item_provider_append() for
11388     * more information
11389     *
11390     * @param obj The entry object
11391     * @param func The function called to provide the item object
11392     * @param data The data passed to @p func
11393     */
11394    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);
11395    /**
11396     * Append a filter function for text inserted in the entry
11397     *
11398     * Append the given callback to the list. This functions will be called
11399     * whenever any text is inserted into the entry, with the text to be inserted
11400     * as a parameter. The callback function is free to alter the text in any way
11401     * it wants, but it must remember to free the given pointer and update it.
11402     * If the new text is to be discarded, the function can free it and set its
11403     * text parameter to NULL. This will also prevent any following filters from
11404     * being called.
11405     *
11406     * @param obj The entry object
11407     * @param func The function to use as text filter
11408     * @param data User data to pass to @p func
11409     */
11410    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11411    /**
11412     * Prepend a filter function for text insdrted in the entry
11413     *
11414     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11415     * for more information
11416     *
11417     * @param obj The entry object
11418     * @param func The function to use as text filter
11419     * @param data User data to pass to @p func
11420     */
11421    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11422    /**
11423     * Remove a filter from the list
11424     *
11425     * Removes the given callback from the filter list. See
11426     * elm_entry_text_filter_append() for more information.
11427     *
11428     * @param obj The entry object
11429     * @param func The filter function to remove
11430     * @param data The user data passed when adding the function
11431     */
11432    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11433    /**
11434     * This converts a markup (HTML-like) string into UTF-8.
11435     *
11436     * The returned string is a malloc'ed buffer and it should be freed when
11437     * not needed anymore.
11438     *
11439     * @param s The string (in markup) to be converted
11440     * @return The converted string (in UTF-8). It should be freed.
11441     */
11442    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11443    /**
11444     * This converts a UTF-8 string into markup (HTML-like).
11445     *
11446     * The returned string is a malloc'ed buffer and it should be freed when
11447     * not needed anymore.
11448     *
11449     * @param s The string (in UTF-8) to be converted
11450     * @return The converted string (in markup). It should be freed.
11451     */
11452    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11453    /**
11454     * This sets the file (and implicitly loads it) for the text to display and
11455     * then edit. All changes are written back to the file after a short delay if
11456     * the entry object is set to autosave (which is the default).
11457     *
11458     * If the entry had any other file set previously, any changes made to it
11459     * will be saved if the autosave feature is enabled, otherwise, the file
11460     * will be silently discarded and any non-saved changes will be lost.
11461     *
11462     * @param obj The entry object
11463     * @param file The path to the file to load and save
11464     * @param format The file format
11465     */
11466    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11467    /**
11468     * Gets the file being edited by the entry.
11469     *
11470     * This function can be used to retrieve any file set on the entry for
11471     * edition, along with the format used to load and save it.
11472     *
11473     * @param obj The entry object
11474     * @param file The path to the file to load and save
11475     * @param format The file format
11476     */
11477    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11478    /**
11479     * This function writes any changes made to the file set with
11480     * elm_entry_file_set()
11481     *
11482     * @param obj The entry object
11483     */
11484    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11485    /**
11486     * This sets the entry object to 'autosave' the loaded text file or not.
11487     *
11488     * @param obj The entry object
11489     * @param autosave Autosave the loaded file or not
11490     *
11491     * @see elm_entry_file_set()
11492     */
11493    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11494    /**
11495     * This gets the entry object's 'autosave' status.
11496     *
11497     * @param obj The entry object
11498     * @return Autosave the loaded file or not
11499     *
11500     * @see elm_entry_file_set()
11501     */
11502    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11503    /**
11504     * Control pasting of text and images for the widget.
11505     *
11506     * Normally the entry allows both text and images to be pasted.  By setting
11507     * textonly to be true, this prevents images from being pasted.
11508     *
11509     * Note this only changes the behaviour of text.
11510     *
11511     * @param obj The entry object
11512     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11513     * text+image+other.
11514     */
11515    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11516    /**
11517     * Getting elm_entry text paste/drop mode.
11518     *
11519     * In textonly mode, only text may be pasted or dropped into the widget.
11520     *
11521     * @param obj The entry object
11522     * @return If the widget only accepts text from pastes.
11523     */
11524    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11525    /**
11526     * Enable or disable scrolling in entry
11527     *
11528     * Normally the entry is not scrollable unless you enable it with this call.
11529     *
11530     * @param obj The entry object
11531     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11532     */
11533    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11534    /**
11535     * Get the scrollable state of the entry
11536     *
11537     * Normally the entry is not scrollable. This gets the scrollable state
11538     * of the entry. See elm_entry_scrollable_set() for more information.
11539     *
11540     * @param obj The entry object
11541     * @return The scrollable state
11542     */
11543    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11544    /**
11545     * This sets a widget to be displayed to the left of a scrolled entry.
11546     *
11547     * @param obj The scrolled entry object
11548     * @param icon The widget to display on the left side of the scrolled
11549     * entry.
11550     *
11551     * @note A previously set widget will be destroyed.
11552     * @note If the object being set does not have minimum size hints set,
11553     * it won't get properly displayed.
11554     *
11555     * @see elm_entry_end_set()
11556     */
11557    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11558    /**
11559     * Gets the leftmost widget of the scrolled entry. This object is
11560     * owned by the scrolled entry and should not be modified.
11561     *
11562     * @param obj The scrolled entry object
11563     * @return the left widget inside the scroller
11564     */
11565    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11566    /**
11567     * Unset the leftmost widget of the scrolled entry, unparenting and
11568     * returning it.
11569     *
11570     * @param obj The scrolled entry object
11571     * @return the previously set icon sub-object of this entry, on
11572     * success.
11573     *
11574     * @see elm_entry_icon_set()
11575     */
11576    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11577    /**
11578     * Sets the visibility of the left-side widget of the scrolled entry,
11579     * set by elm_entry_icon_set().
11580     *
11581     * @param obj The scrolled entry object
11582     * @param setting EINA_TRUE if the object should be displayed,
11583     * EINA_FALSE if not.
11584     */
11585    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11586    /**
11587     * This sets a widget to be displayed to the end of a scrolled entry.
11588     *
11589     * @param obj The scrolled entry object
11590     * @param end The widget to display on the right side of the scrolled
11591     * entry.
11592     *
11593     * @note A previously set widget will be destroyed.
11594     * @note If the object being set does not have minimum size hints set,
11595     * it won't get properly displayed.
11596     *
11597     * @see elm_entry_icon_set
11598     */
11599    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11600    /**
11601     * Gets the endmost widget of the scrolled entry. This object is owned
11602     * by the scrolled entry and should not be modified.
11603     *
11604     * @param obj The scrolled entry object
11605     * @return the right widget inside the scroller
11606     */
11607    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11608    /**
11609     * Unset the endmost widget of the scrolled entry, unparenting and
11610     * returning it.
11611     *
11612     * @param obj The scrolled entry object
11613     * @return the previously set icon sub-object of this entry, on
11614     * success.
11615     *
11616     * @see elm_entry_icon_set()
11617     */
11618    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11619    /**
11620     * Sets the visibility of the end widget of the scrolled entry, set by
11621     * elm_entry_end_set().
11622     *
11623     * @param obj The scrolled entry object
11624     * @param setting EINA_TRUE if the object should be displayed,
11625     * EINA_FALSE if not.
11626     */
11627    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11628    /**
11629     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11630     * them).
11631     *
11632     * Setting an entry to single-line mode with elm_entry_single_line_set()
11633     * will automatically disable the display of scrollbars when the entry
11634     * moves inside its scroller.
11635     *
11636     * @param obj The scrolled entry object
11637     * @param h The horizontal scrollbar policy to apply
11638     * @param v The vertical scrollbar policy to apply
11639     */
11640    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11641    /**
11642     * This enables/disables bouncing within the entry.
11643     *
11644     * This function sets whether the entry will bounce when scrolling reaches
11645     * the end of the contained entry.
11646     *
11647     * @param obj The scrolled entry object
11648     * @param h The horizontal bounce state
11649     * @param v The vertical bounce state
11650     */
11651    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11652    /**
11653     * Get the bounce mode
11654     *
11655     * @param obj The Entry object
11656     * @param h_bounce Allow bounce horizontally
11657     * @param v_bounce Allow bounce vertically
11658     */
11659    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11660
11661    /* pre-made filters for entries */
11662    /**
11663     * @typedef Elm_Entry_Filter_Limit_Size
11664     *
11665     * Data for the elm_entry_filter_limit_size() entry filter.
11666     */
11667    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11668    /**
11669     * @struct _Elm_Entry_Filter_Limit_Size
11670     *
11671     * Data for the elm_entry_filter_limit_size() entry filter.
11672     */
11673    struct _Elm_Entry_Filter_Limit_Size
11674      {
11675         int max_char_count; /**< The maximum number of characters allowed. */
11676         int max_byte_count; /**< The maximum number of bytes allowed*/
11677      };
11678    /**
11679     * Filter inserted text based on user defined character and byte limits
11680     *
11681     * Add this filter to an entry to limit the characters that it will accept
11682     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11683     * The funtion works on the UTF-8 representation of the string, converting
11684     * it from the set markup, thus not accounting for any format in it.
11685     *
11686     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11687     * it as data when setting the filter. In it, it's possible to set limits
11688     * by character count or bytes (any of them is disabled if 0), and both can
11689     * be set at the same time. In that case, it first checks for characters,
11690     * then bytes.
11691     *
11692     * The function will cut the inserted text in order to allow only the first
11693     * number of characters that are still allowed. The cut is made in
11694     * characters, even when limiting by bytes, in order to always contain
11695     * valid ones and avoid half unicode characters making it in.
11696     *
11697     * This filter, like any others, does not apply when setting the entry text
11698     * directly with elm_object_text_set() (or the deprecated
11699     * elm_entry_entry_set()).
11700     */
11701    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11702    /**
11703     * @typedef Elm_Entry_Filter_Accept_Set
11704     *
11705     * Data for the elm_entry_filter_accept_set() entry filter.
11706     */
11707    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11708    /**
11709     * @struct _Elm_Entry_Filter_Accept_Set
11710     *
11711     * Data for the elm_entry_filter_accept_set() entry filter.
11712     */
11713    struct _Elm_Entry_Filter_Accept_Set
11714      {
11715         const char *accepted; /**< Set of characters accepted in the entry. */
11716         const char *rejected; /**< Set of characters rejected from the entry. */
11717      };
11718    /**
11719     * Filter inserted text based on accepted or rejected sets of characters
11720     *
11721     * Add this filter to an entry to restrict the set of accepted characters
11722     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11723     * This structure contains both accepted and rejected sets, but they are
11724     * mutually exclusive.
11725     *
11726     * The @c accepted set takes preference, so if it is set, the filter will
11727     * only work based on the accepted characters, ignoring anything in the
11728     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11729     *
11730     * In both cases, the function filters by matching utf8 characters to the
11731     * raw markup text, so it can be used to remove formatting tags.
11732     *
11733     * This filter, like any others, does not apply when setting the entry text
11734     * directly with elm_object_text_set() (or the deprecated
11735     * elm_entry_entry_set()).
11736     */
11737    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11738    /**
11739     * Set the input panel layout of the entry
11740     *
11741     * @param obj The entry object
11742     * @param layout layout type
11743     */
11744    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11745    /**
11746     * Get the input panel layout of the entry
11747     *
11748     * @param obj The entry object
11749     * @return layout type
11750     *
11751     * @see elm_entry_input_panel_layout_set
11752     */
11753    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11754    /**
11755     * @}
11756     */
11757
11758    /* composite widgets - these basically put together basic widgets above
11759     * in convenient packages that do more than basic stuff */
11760
11761    /* anchorview */
11762    /**
11763     * @defgroup Anchorview Anchorview
11764     *
11765     * @image html img/widget/anchorview/preview-00.png
11766     * @image latex img/widget/anchorview/preview-00.eps
11767     *
11768     * Anchorview is for displaying text that contains markup with anchors
11769     * like <c>\<a href=1234\>something\</\></c> in it.
11770     *
11771     * Besides being styled differently, the anchorview widget provides the
11772     * necessary functionality so that clicking on these anchors brings up a
11773     * popup with user defined content such as "call", "add to contacts" or
11774     * "open web page". This popup is provided using the @ref Hover widget.
11775     *
11776     * This widget is very similar to @ref Anchorblock, so refer to that
11777     * widget for an example. The only difference Anchorview has is that the
11778     * widget is already provided with scrolling functionality, so if the
11779     * text set to it is too large to fit in the given space, it will scroll,
11780     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11781     * text can be displayed.
11782     *
11783     * This widget emits the following signals:
11784     * @li "anchor,clicked": will be called when an anchor is clicked. The
11785     * @p event_info parameter on the callback will be a pointer of type
11786     * ::Elm_Entry_Anchorview_Info.
11787     *
11788     * See @ref Anchorblock for an example on how to use both of them.
11789     *
11790     * @see Anchorblock
11791     * @see Entry
11792     * @see Hover
11793     *
11794     * @{
11795     */
11796    /**
11797     * @typedef Elm_Entry_Anchorview_Info
11798     *
11799     * The info sent in the callback for "anchor,clicked" signals emitted by
11800     * the Anchorview widget.
11801     */
11802    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11803    /**
11804     * @struct _Elm_Entry_Anchorview_Info
11805     *
11806     * The info sent in the callback for "anchor,clicked" signals emitted by
11807     * the Anchorview widget.
11808     */
11809    struct _Elm_Entry_Anchorview_Info
11810      {
11811         const char     *name; /**< Name of the anchor, as indicated in its href
11812                                    attribute */
11813         int             button; /**< The mouse button used to click on it */
11814         Evas_Object    *hover; /**< The hover object to use for the popup */
11815         struct {
11816              Evas_Coord    x, y, w, h;
11817         } anchor, /**< Geometry selection of text used as anchor */
11818           hover_parent; /**< Geometry of the object used as parent by the
11819                              hover */
11820         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11821                                              for content on the left side of
11822                                              the hover. Before calling the
11823                                              callback, the widget will make the
11824                                              necessary calculations to check
11825                                              which sides are fit to be set with
11826                                              content, based on the position the
11827                                              hover is activated and its distance
11828                                              to the edges of its parent object
11829                                              */
11830         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11831                                               the right side of the hover.
11832                                               See @ref hover_left */
11833         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11834                                             of the hover. See @ref hover_left */
11835         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11836                                                below the hover. See @ref
11837                                                hover_left */
11838      };
11839    /**
11840     * Add a new Anchorview object
11841     *
11842     * @param parent The parent object
11843     * @return The new object or NULL if it cannot be created
11844     */
11845    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11846    /**
11847     * Set the text to show in the anchorview
11848     *
11849     * Sets the text of the anchorview to @p text. This text can include markup
11850     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11851     * text that will be specially styled and react to click events, ended with
11852     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11853     * "anchor,clicked" signal that you can attach a callback to with
11854     * evas_object_smart_callback_add(). The name of the anchor given in the
11855     * event info struct will be the one set in the href attribute, in this
11856     * case, anchorname.
11857     *
11858     * Other markup can be used to style the text in different ways, but it's
11859     * up to the style defined in the theme which tags do what.
11860     * @deprecated use elm_object_text_set() instead.
11861     */
11862    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11863    /**
11864     * Get the markup text set for the anchorview
11865     *
11866     * Retrieves the text set on the anchorview, with markup tags included.
11867     *
11868     * @param obj The anchorview object
11869     * @return The markup text set or @c NULL if nothing was set or an error
11870     * occurred
11871     * @deprecated use elm_object_text_set() instead.
11872     */
11873    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11874    /**
11875     * Set the parent of the hover popup
11876     *
11877     * Sets the parent object to use by the hover created by the anchorview
11878     * when an anchor is clicked. See @ref Hover for more details on this.
11879     * If no parent is set, the same anchorview object will be used.
11880     *
11881     * @param obj The anchorview object
11882     * @param parent The object to use as parent for the hover
11883     */
11884    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11885    /**
11886     * Get the parent of the hover popup
11887     *
11888     * Get the object used as parent for the hover created by the anchorview
11889     * widget. See @ref Hover for more details on this.
11890     *
11891     * @param obj The anchorview object
11892     * @return The object used as parent for the hover, NULL if none is set.
11893     */
11894    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11895    /**
11896     * Set the style that the hover should use
11897     *
11898     * When creating the popup hover, anchorview will request that it's
11899     * themed according to @p style.
11900     *
11901     * @param obj The anchorview object
11902     * @param style The style to use for the underlying hover
11903     *
11904     * @see elm_object_style_set()
11905     */
11906    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11907    /**
11908     * Get the style that the hover should use
11909     *
11910     * Get the style the hover created by anchorview will use.
11911     *
11912     * @param obj The anchorview object
11913     * @return The style to use by the hover. NULL means the default is used.
11914     *
11915     * @see elm_object_style_set()
11916     */
11917    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11918    /**
11919     * Ends the hover popup in the anchorview
11920     *
11921     * When an anchor is clicked, the anchorview widget will create a hover
11922     * object to use as a popup with user provided content. This function
11923     * terminates this popup, returning the anchorview to its normal state.
11924     *
11925     * @param obj The anchorview object
11926     */
11927    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11928    /**
11929     * Set bouncing behaviour when the scrolled content reaches an edge
11930     *
11931     * Tell the internal scroller object whether it should bounce or not
11932     * when it reaches the respective edges for each axis.
11933     *
11934     * @param obj The anchorview object
11935     * @param h_bounce Whether to bounce or not in the horizontal axis
11936     * @param v_bounce Whether to bounce or not in the vertical axis
11937     *
11938     * @see elm_scroller_bounce_set()
11939     */
11940    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11941    /**
11942     * Get the set bouncing behaviour of the internal scroller
11943     *
11944     * Get whether the internal scroller should bounce when the edge of each
11945     * axis is reached scrolling.
11946     *
11947     * @param obj The anchorview object
11948     * @param h_bounce Pointer where to store the bounce state of the horizontal
11949     *                 axis
11950     * @param v_bounce Pointer where to store the bounce state of the vertical
11951     *                 axis
11952     *
11953     * @see elm_scroller_bounce_get()
11954     */
11955    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11956    /**
11957     * Appends a custom item provider to the given anchorview
11958     *
11959     * Appends the given function to the list of items providers. This list is
11960     * called, one function at a time, with the given @p data pointer, the
11961     * anchorview object and, in the @p item parameter, the item name as
11962     * referenced in its href string. Following functions in the list will be
11963     * called in order until one of them returns something different to NULL,
11964     * which should be an Evas_Object which will be used in place of the item
11965     * element.
11966     *
11967     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11968     * href=item/name\>\</item\>
11969     *
11970     * @param obj The anchorview object
11971     * @param func The function to add to the list of providers
11972     * @param data User data that will be passed to the callback function
11973     *
11974     * @see elm_entry_item_provider_append()
11975     */
11976    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);
11977    /**
11978     * Prepend a custom item provider to the given anchorview
11979     *
11980     * Like elm_anchorview_item_provider_append(), but it adds the function
11981     * @p func to the beginning of the list, instead of the end.
11982     *
11983     * @param obj The anchorview object
11984     * @param func The function to add to the list of providers
11985     * @param data User data that will be passed to the callback function
11986     */
11987    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);
11988    /**
11989     * Remove a custom item provider from the list of the given anchorview
11990     *
11991     * Removes the function and data pairing that matches @p func and @p data.
11992     * That is, unless the same function and same user data are given, the
11993     * function will not be removed from the list. This allows us to add the
11994     * same callback several times, with different @p data pointers and be
11995     * able to remove them later without conflicts.
11996     *
11997     * @param obj The anchorview object
11998     * @param func The function to remove from the list
11999     * @param data The data matching the function to remove from the list
12000     */
12001    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);
12002    /**
12003     * @}
12004     */
12005
12006    /* anchorblock */
12007    /**
12008     * @defgroup Anchorblock Anchorblock
12009     *
12010     * @image html img/widget/anchorblock/preview-00.png
12011     * @image latex img/widget/anchorblock/preview-00.eps
12012     *
12013     * Anchorblock is for displaying text that contains markup with anchors
12014     * like <c>\<a href=1234\>something\</\></c> in it.
12015     *
12016     * Besides being styled differently, the anchorblock widget provides the
12017     * necessary functionality so that clicking on these anchors brings up a
12018     * popup with user defined content such as "call", "add to contacts" or
12019     * "open web page". This popup is provided using the @ref Hover widget.
12020     *
12021     * This widget emits the following signals:
12022     * @li "anchor,clicked": will be called when an anchor is clicked. The
12023     * @p event_info parameter on the callback will be a pointer of type
12024     * ::Elm_Entry_Anchorblock_Info.
12025     *
12026     * @see Anchorview
12027     * @see Entry
12028     * @see Hover
12029     *
12030     * Since examples are usually better than plain words, we might as well
12031     * try @ref tutorial_anchorblock_example "one".
12032     */
12033    /**
12034     * @addtogroup Anchorblock
12035     * @{
12036     */
12037    /**
12038     * @typedef Elm_Entry_Anchorblock_Info
12039     *
12040     * The info sent in the callback for "anchor,clicked" signals emitted by
12041     * the Anchorblock widget.
12042     */
12043    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12044    /**
12045     * @struct _Elm_Entry_Anchorblock_Info
12046     *
12047     * The info sent in the callback for "anchor,clicked" signals emitted by
12048     * the Anchorblock widget.
12049     */
12050    struct _Elm_Entry_Anchorblock_Info
12051      {
12052         const char     *name; /**< Name of the anchor, as indicated in its href
12053                                    attribute */
12054         int             button; /**< The mouse button used to click on it */
12055         Evas_Object    *hover; /**< The hover object to use for the popup */
12056         struct {
12057              Evas_Coord    x, y, w, h;
12058         } anchor, /**< Geometry selection of text used as anchor */
12059           hover_parent; /**< Geometry of the object used as parent by the
12060                              hover */
12061         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12062                                              for content on the left side of
12063                                              the hover. Before calling the
12064                                              callback, the widget will make the
12065                                              necessary calculations to check
12066                                              which sides are fit to be set with
12067                                              content, based on the position the
12068                                              hover is activated and its distance
12069                                              to the edges of its parent object
12070                                              */
12071         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12072                                               the right side of the hover.
12073                                               See @ref hover_left */
12074         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12075                                             of the hover. See @ref hover_left */
12076         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12077                                                below the hover. See @ref
12078                                                hover_left */
12079      };
12080    /**
12081     * Add a new Anchorblock object
12082     *
12083     * @param parent The parent object
12084     * @return The new object or NULL if it cannot be created
12085     */
12086    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12087    /**
12088     * Set the text to show in the anchorblock
12089     *
12090     * Sets the text of the anchorblock to @p text. This text can include markup
12091     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12092     * of text that will be specially styled and react to click events, ended
12093     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12094     * "anchor,clicked" signal that you can attach a callback to with
12095     * evas_object_smart_callback_add(). The name of the anchor given in the
12096     * event info struct will be the one set in the href attribute, in this
12097     * case, anchorname.
12098     *
12099     * Other markup can be used to style the text in different ways, but it's
12100     * up to the style defined in the theme which tags do what.
12101     * @deprecated use elm_object_text_set() instead.
12102     */
12103    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12104    /**
12105     * Get the markup text set for the anchorblock
12106     *
12107     * Retrieves the text set on the anchorblock, with markup tags included.
12108     *
12109     * @param obj The anchorblock object
12110     * @return The markup text set or @c NULL if nothing was set or an error
12111     * occurred
12112     * @deprecated use elm_object_text_set() instead.
12113     */
12114    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12115    /**
12116     * Set the parent of the hover popup
12117     *
12118     * Sets the parent object to use by the hover created by the anchorblock
12119     * when an anchor is clicked. See @ref Hover for more details on this.
12120     *
12121     * @param obj The anchorblock object
12122     * @param parent The object to use as parent for the hover
12123     */
12124    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12125    /**
12126     * Get the parent of the hover popup
12127     *
12128     * Get the object used as parent for the hover created by the anchorblock
12129     * widget. See @ref Hover for more details on this.
12130     * If no parent is set, the same anchorblock object will be used.
12131     *
12132     * @param obj The anchorblock object
12133     * @return The object used as parent for the hover, NULL if none is set.
12134     */
12135    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12136    /**
12137     * Set the style that the hover should use
12138     *
12139     * When creating the popup hover, anchorblock will request that it's
12140     * themed according to @p style.
12141     *
12142     * @param obj The anchorblock object
12143     * @param style The style to use for the underlying hover
12144     *
12145     * @see elm_object_style_set()
12146     */
12147    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12148    /**
12149     * Get the style that the hover should use
12150     *
12151     * Get the style the hover created by anchorblock will use.
12152     *
12153     * @param obj The anchorblock object
12154     * @return The style to use by the hover. NULL means the default is used.
12155     *
12156     * @see elm_object_style_set()
12157     */
12158    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12159    /**
12160     * Ends the hover popup in the anchorblock
12161     *
12162     * When an anchor is clicked, the anchorblock widget will create a hover
12163     * object to use as a popup with user provided content. This function
12164     * terminates this popup, returning the anchorblock to its normal state.
12165     *
12166     * @param obj The anchorblock object
12167     */
12168    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12169    /**
12170     * Appends a custom item provider to the given anchorblock
12171     *
12172     * Appends the given function to the list of items providers. This list is
12173     * called, one function at a time, with the given @p data pointer, the
12174     * anchorblock object and, in the @p item parameter, the item name as
12175     * referenced in its href string. Following functions in the list will be
12176     * called in order until one of them returns something different to NULL,
12177     * which should be an Evas_Object which will be used in place of the item
12178     * element.
12179     *
12180     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12181     * href=item/name\>\</item\>
12182     *
12183     * @param obj The anchorblock object
12184     * @param func The function to add to the list of providers
12185     * @param data User data that will be passed to the callback function
12186     *
12187     * @see elm_entry_item_provider_append()
12188     */
12189    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);
12190    /**
12191     * Prepend a custom item provider to the given anchorblock
12192     *
12193     * Like elm_anchorblock_item_provider_append(), but it adds the function
12194     * @p func to the beginning of the list, instead of the end.
12195     *
12196     * @param obj The anchorblock object
12197     * @param func The function to add to the list of providers
12198     * @param data User data that will be passed to the callback function
12199     */
12200    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);
12201    /**
12202     * Remove a custom item provider from the list of the given anchorblock
12203     *
12204     * Removes the function and data pairing that matches @p func and @p data.
12205     * That is, unless the same function and same user data are given, the
12206     * function will not be removed from the list. This allows us to add the
12207     * same callback several times, with different @p data pointers and be
12208     * able to remove them later without conflicts.
12209     *
12210     * @param obj The anchorblock object
12211     * @param func The function to remove from the list
12212     * @param data The data matching the function to remove from the list
12213     */
12214    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);
12215    /**
12216     * @}
12217     */
12218
12219    /**
12220     * @defgroup Bubble Bubble
12221     *
12222     * @image html img/widget/bubble/preview-00.png
12223     * @image latex img/widget/bubble/preview-00.eps
12224     * @image html img/widget/bubble/preview-01.png
12225     * @image latex img/widget/bubble/preview-01.eps
12226     * @image html img/widget/bubble/preview-02.png
12227     * @image latex img/widget/bubble/preview-02.eps
12228     *
12229     * @brief The Bubble is a widget to show text similarly to how speech is
12230     * represented in comics.
12231     *
12232     * The bubble widget contains 5 important visual elements:
12233     * @li The frame is a rectangle with rounded rectangles and an "arrow".
12234     * @li The @p icon is an image to which the frame's arrow points to.
12235     * @li The @p label is a text which appears to the right of the icon if the
12236     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12237     * otherwise.
12238     * @li The @p info is a text which appears to the right of the label. Info's
12239     * font is of a ligther color than label.
12240     * @li The @p content is an evas object that is shown inside the frame.
12241     *
12242     * The position of the arrow, icon, label and info depends on which corner is
12243     * selected. The four available corners are:
12244     * @li "top_left" - Default
12245     * @li "top_right"
12246     * @li "bottom_left"
12247     * @li "bottom_right"
12248     *
12249     * Signals that you can add callbacks for are:
12250     * @li "clicked" - This is called when a user has clicked the bubble.
12251     *
12252     * For an example of using a buble see @ref bubble_01_example_page "this".
12253     *
12254     * @{
12255     */
12256    /**
12257     * Add a new bubble to the parent
12258     *
12259     * @param parent The parent object
12260     * @return The new object or NULL if it cannot be created
12261     *
12262     * This function adds a text bubble to the given parent evas object.
12263     */
12264    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12265    /**
12266     * Set the label of the bubble
12267     *
12268     * @param obj The bubble object
12269     * @param label The string to set in the label
12270     *
12271     * This function sets the title of the bubble. Where this appears depends on
12272     * the selected corner.
12273     * @deprecated use elm_object_text_set() instead.
12274     */
12275    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12276    /**
12277     * Get the label of the bubble
12278     *
12279     * @param obj The bubble object
12280     * @return The string of set in the label
12281     *
12282     * This function gets the title of the bubble.
12283     * @deprecated use elm_object_text_get() instead.
12284     */
12285    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12286    /**
12287     * Set the info of the bubble
12288     *
12289     * @param obj The bubble object
12290     * @param info The given info about the bubble
12291     *
12292     * This function sets the info of the bubble. Where this appears depends on
12293     * the selected corner.
12294     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12295     */
12296    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12297    /**
12298     * Get the info of the bubble
12299     *
12300     * @param obj The bubble object
12301     *
12302     * @return The "info" string of the bubble
12303     *
12304     * This function gets the info text.
12305     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12306     */
12307    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12308    /**
12309     * Set the content to be shown in the bubble
12310     *
12311     * Once the content object is set, a previously set one will be deleted.
12312     * If you want to keep the old content object, use the
12313     * elm_bubble_content_unset() function.
12314     *
12315     * @param obj The bubble object
12316     * @param content The given content of the bubble
12317     *
12318     * This function sets the content shown on the middle of the bubble.
12319     */
12320    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12321    /**
12322     * Get the content shown in the bubble
12323     *
12324     * Return the content object which is set for this widget.
12325     *
12326     * @param obj The bubble object
12327     * @return The content that is being used
12328     */
12329    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12330    /**
12331     * Unset the content shown in the bubble
12332     *
12333     * Unparent and return the content object which was set for this widget.
12334     *
12335     * @param obj The bubble object
12336     * @return The content that was being used
12337     */
12338    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12339    /**
12340     * Set the icon of the bubble
12341     *
12342     * Once the icon object is set, a previously set one will be deleted.
12343     * If you want to keep the old content object, use the
12344     * elm_icon_content_unset() function.
12345     *
12346     * @param obj The bubble object
12347     * @param icon The given icon for the bubble
12348     */
12349    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12350    /**
12351     * Get the icon of the bubble
12352     *
12353     * @param obj The bubble object
12354     * @return The icon for the bubble
12355     *
12356     * This function gets the icon shown on the top left of bubble.
12357     */
12358    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12359    /**
12360     * Unset the icon of the bubble
12361     *
12362     * Unparent and return the icon object which was set for this widget.
12363     *
12364     * @param obj The bubble object
12365     * @return The icon that was being used
12366     */
12367    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12368    /**
12369     * Set the corner of the bubble
12370     *
12371     * @param obj The bubble object.
12372     * @param corner The given corner for the bubble.
12373     *
12374     * This function sets the corner of the bubble. The corner will be used to
12375     * determine where the arrow in the frame points to and where label, icon and
12376     * info are shown.
12377     *
12378     * Possible values for corner are:
12379     * @li "top_left" - Default
12380     * @li "top_right"
12381     * @li "bottom_left"
12382     * @li "bottom_right"
12383     */
12384    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12385    /**
12386     * Get the corner of the bubble
12387     *
12388     * @param obj The bubble object.
12389     * @return The given corner for the bubble.
12390     *
12391     * This function gets the selected corner of the bubble.
12392     */
12393    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12394    /**
12395     * @}
12396     */
12397
12398    /**
12399     * @defgroup Photo Photo
12400     *
12401     * For displaying the photo of a person (contact). Simple yet
12402     * with a very specific purpose.
12403     *
12404     * Signals that you can add callbacks for are:
12405     *
12406     * "clicked" - This is called when a user has clicked the photo
12407     * "drag,start" - Someone started dragging the image out of the object
12408     * "drag,end" - Dragged item was dropped (somewhere)
12409     *
12410     * @{
12411     */
12412
12413    /**
12414     * Add a new photo to the parent
12415     *
12416     * @param parent The parent object
12417     * @return The new object or NULL if it cannot be created
12418     *
12419     * @ingroup Photo
12420     */
12421    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12422
12423    /**
12424     * Set the file that will be used as photo
12425     *
12426     * @param obj The photo object
12427     * @param file The path to file that will be used as photo
12428     *
12429     * @return (1 = success, 0 = error)
12430     *
12431     * @ingroup Photo
12432     */
12433    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12434
12435     /**
12436     * Set the file that will be used as thumbnail in the photo.
12437     *
12438     * @param obj The photo object.
12439     * @param file The path to file that will be used as thumb.
12440     * @param group The key used in case of an EET file.
12441     *
12442     * @ingroup Photo
12443     */
12444    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12445
12446    /**
12447     * Set the size that will be used on the photo
12448     *
12449     * @param obj The photo object
12450     * @param size The size that the photo will be
12451     *
12452     * @ingroup Photo
12453     */
12454    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12455
12456    /**
12457     * Set if the photo should be completely visible or not.
12458     *
12459     * @param obj The photo object
12460     * @param fill if true the photo will be completely visible
12461     *
12462     * @ingroup Photo
12463     */
12464    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12465
12466    /**
12467     * Set editability of the photo.
12468     *
12469     * An editable photo can be dragged to or from, and can be cut or
12470     * pasted too.  Note that pasting an image or dropping an item on
12471     * the image will delete the existing content.
12472     *
12473     * @param obj The photo object.
12474     * @param set To set of clear editablity.
12475     */
12476    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12477
12478    /**
12479     * @}
12480     */
12481
12482    /* gesture layer */
12483    /**
12484     * @defgroup Elm_Gesture_Layer Gesture Layer
12485     * Gesture Layer Usage:
12486     *
12487     * Use Gesture Layer to detect gestures.
12488     * The advantage is that you don't have to implement
12489     * gesture detection, just set callbacks of gesture state.
12490     * By using gesture layer we make standard interface.
12491     *
12492     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12493     * with a parent object parameter.
12494     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12495     * call. Usually with same object as target (2nd parameter).
12496     *
12497     * Now you need to tell gesture layer what gestures you follow.
12498     * This is done with @ref elm_gesture_layer_cb_set call.
12499     * By setting the callback you actually saying to gesture layer:
12500     * I would like to know when the gesture @ref Elm_Gesture_Types
12501     * switches to state @ref Elm_Gesture_State.
12502     *
12503     * Next, you need to implement the actual action that follows the input
12504     * in your callback.
12505     *
12506     * Note that if you like to stop being reported about a gesture, just set
12507     * all callbacks referring this gesture to NULL.
12508     * (again with @ref elm_gesture_layer_cb_set)
12509     *
12510     * The information reported by gesture layer to your callback is depending
12511     * on @ref Elm_Gesture_Types:
12512     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12513     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12514     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12515     *
12516     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12517     * @ref ELM_GESTURE_MOMENTUM.
12518     *
12519     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12520     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12521     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12522     * Note that we consider a flick as a line-gesture that should be completed
12523     * in flick-time-limit as defined in @ref Config.
12524     *
12525     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12526     *
12527     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12528     *
12529     *
12530     * Gesture Layer Tweaks:
12531     *
12532     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12533     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12534     *
12535     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12536     * so gesture starts when user touches (a *DOWN event) touch-surface
12537     * and ends when no fingers touches surface (a *UP event).
12538     */
12539
12540    /**
12541     * @enum _Elm_Gesture_Types
12542     * Enum of supported gesture types.
12543     * @ingroup Elm_Gesture_Layer
12544     */
12545    enum _Elm_Gesture_Types
12546      {
12547         ELM_GESTURE_FIRST = 0,
12548
12549         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12550         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12551         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12552         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12553
12554         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12555
12556         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12557         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12558
12559         ELM_GESTURE_ZOOM, /**< Zoom */
12560         ELM_GESTURE_ROTATE, /**< Rotate */
12561
12562         ELM_GESTURE_LAST
12563      };
12564
12565    /**
12566     * @typedef Elm_Gesture_Types
12567     * gesture types enum
12568     * @ingroup Elm_Gesture_Layer
12569     */
12570    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12571
12572    /**
12573     * @enum _Elm_Gesture_State
12574     * Enum of gesture states.
12575     * @ingroup Elm_Gesture_Layer
12576     */
12577    enum _Elm_Gesture_State
12578      {
12579         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12580         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12581         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12582         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12583         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12584      };
12585
12586    /**
12587     * @typedef Elm_Gesture_State
12588     * gesture states enum
12589     * @ingroup Elm_Gesture_Layer
12590     */
12591    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12592
12593    /**
12594     * @struct _Elm_Gesture_Taps_Info
12595     * Struct holds taps info for user
12596     * @ingroup Elm_Gesture_Layer
12597     */
12598    struct _Elm_Gesture_Taps_Info
12599      {
12600         Evas_Coord x, y;         /**< Holds center point between fingers */
12601         unsigned int n;          /**< Number of fingers tapped           */
12602         unsigned int timestamp;  /**< event timestamp       */
12603      };
12604
12605    /**
12606     * @typedef Elm_Gesture_Taps_Info
12607     * holds taps info for user
12608     * @ingroup Elm_Gesture_Layer
12609     */
12610    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12611
12612    /**
12613     * @struct _Elm_Gesture_Momentum_Info
12614     * Struct holds momentum info for user
12615     * x1 and y1 are not necessarily in sync
12616     * x1 holds x value of x direction starting point
12617     * and same holds for y1.
12618     * This is noticeable when doing V-shape movement
12619     * @ingroup Elm_Gesture_Layer
12620     */
12621    struct _Elm_Gesture_Momentum_Info
12622      {  /* Report line ends, timestamps, and momentum computed        */
12623         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12624         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12625         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12626         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12627
12628         unsigned int tx; /**< Timestamp of start of final x-swipe */
12629         unsigned int ty; /**< Timestamp of start of final y-swipe */
12630
12631         Evas_Coord mx; /**< Momentum on X */
12632         Evas_Coord my; /**< Momentum on Y */
12633      };
12634
12635    /**
12636     * @typedef Elm_Gesture_Momentum_Info
12637     * holds momentum info for user
12638     * @ingroup Elm_Gesture_Layer
12639     */
12640     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12641
12642    /**
12643     * @struct _Elm_Gesture_Line_Info
12644     * Struct holds line info for user
12645     * @ingroup Elm_Gesture_Layer
12646     */
12647    struct _Elm_Gesture_Line_Info
12648      {  /* Report line ends, timestamps, and momentum computed      */
12649         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12650         unsigned int n;            /**< Number of fingers (lines)   */
12651         /* FIXME should be radians, bot degrees */
12652         double angle;              /**< Angle (direction) of lines  */
12653      };
12654
12655    /**
12656     * @typedef Elm_Gesture_Line_Info
12657     * Holds line info for user
12658     * @ingroup Elm_Gesture_Layer
12659     */
12660     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12661
12662    /**
12663     * @struct _Elm_Gesture_Zoom_Info
12664     * Struct holds zoom info for user
12665     * @ingroup Elm_Gesture_Layer
12666     */
12667    struct _Elm_Gesture_Zoom_Info
12668      {
12669         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12670         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12671         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12672         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12673      };
12674
12675    /**
12676     * @typedef Elm_Gesture_Zoom_Info
12677     * Holds zoom info for user
12678     * @ingroup Elm_Gesture_Layer
12679     */
12680    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12681
12682    /**
12683     * @struct _Elm_Gesture_Rotate_Info
12684     * Struct holds rotation info for user
12685     * @ingroup Elm_Gesture_Layer
12686     */
12687    struct _Elm_Gesture_Rotate_Info
12688      {
12689         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12690         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12691         double base_angle; /**< Holds start-angle */
12692         double angle;      /**< Rotation value: 0.0 means no rotation         */
12693         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12694      };
12695
12696    /**
12697     * @typedef Elm_Gesture_Rotate_Info
12698     * Holds rotation info for user
12699     * @ingroup Elm_Gesture_Layer
12700     */
12701    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12702
12703    /**
12704     * @typedef Elm_Gesture_Event_Cb
12705     * User callback used to stream gesture info from gesture layer
12706     * @param data user data
12707     * @param event_info gesture report info
12708     * Returns a flag field to be applied on the causing event.
12709     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12710     * upon the event, in an irreversible way.
12711     *
12712     * @ingroup Elm_Gesture_Layer
12713     */
12714    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12715
12716    /**
12717     * Use function to set callbacks to be notified about
12718     * change of state of gesture.
12719     * When a user registers a callback with this function
12720     * this means this gesture has to be tested.
12721     *
12722     * When ALL callbacks for a gesture are set to NULL
12723     * it means user isn't interested in gesture-state
12724     * and it will not be tested.
12725     *
12726     * @param obj Pointer to gesture-layer.
12727     * @param idx The gesture you would like to track its state.
12728     * @param cb callback function pointer.
12729     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12730     * @param data user info to be sent to callback (usually, Smart Data)
12731     *
12732     * @ingroup Elm_Gesture_Layer
12733     */
12734    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);
12735
12736    /**
12737     * Call this function to get repeat-events settings.
12738     *
12739     * @param obj Pointer to gesture-layer.
12740     *
12741     * @return repeat events settings.
12742     * @see elm_gesture_layer_hold_events_set()
12743     * @ingroup Elm_Gesture_Layer
12744     */
12745    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12746
12747    /**
12748     * This function called in order to make gesture-layer repeat events.
12749     * Set this of you like to get the raw events only if gestures were not detected.
12750     * Clear this if you like gesture layer to fwd events as testing gestures.
12751     *
12752     * @param obj Pointer to gesture-layer.
12753     * @param r Repeat: TRUE/FALSE
12754     *
12755     * @ingroup Elm_Gesture_Layer
12756     */
12757    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12758
12759    /**
12760     * This function sets step-value for zoom action.
12761     * Set step to any positive value.
12762     * Cancel step setting by setting to 0.0
12763     *
12764     * @param obj Pointer to gesture-layer.
12765     * @param s new zoom step value.
12766     *
12767     * @ingroup Elm_Gesture_Layer
12768     */
12769    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12770
12771    /**
12772     * This function sets step-value for rotate action.
12773     * Set step to any positive value.
12774     * Cancel step setting by setting to 0.0
12775     *
12776     * @param obj Pointer to gesture-layer.
12777     * @param s new roatate step value.
12778     *
12779     * @ingroup Elm_Gesture_Layer
12780     */
12781    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12782
12783    /**
12784     * This function called to attach gesture-layer to an Evas_Object.
12785     * @param obj Pointer to gesture-layer.
12786     * @param t Pointer to underlying object (AKA Target)
12787     *
12788     * @return TRUE, FALSE on success, failure.
12789     *
12790     * @ingroup Elm_Gesture_Layer
12791     */
12792    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12793
12794    /**
12795     * Call this function to construct a new gesture-layer object.
12796     * This does not activate the gesture layer. You have to
12797     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12798     *
12799     * @param parent the parent object.
12800     *
12801     * @return Pointer to new gesture-layer object.
12802     *
12803     * @ingroup Elm_Gesture_Layer
12804     */
12805    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12806
12807    /**
12808     * @defgroup Thumb Thumb
12809     *
12810     * @image html img/widget/thumb/preview-00.png
12811     * @image latex img/widget/thumb/preview-00.eps
12812     *
12813     * A thumb object is used for displaying the thumbnail of an image or video.
12814     * You must have compiled Elementary with Ethumb_Client support and the DBus
12815     * service must be present and auto-activated in order to have thumbnails to
12816     * be generated.
12817     *
12818     * Once the thumbnail object becomes visible, it will check if there is a
12819     * previously generated thumbnail image for the file set on it. If not, it
12820     * will start generating this thumbnail.
12821     *
12822     * Different config settings will cause different thumbnails to be generated
12823     * even on the same file.
12824     *
12825     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12826     * Ethumb documentation to change this path, and to see other configuration
12827     * options.
12828     *
12829     * Signals that you can add callbacks for are:
12830     *
12831     * - "clicked" - This is called when a user has clicked the thumb without dragging
12832     *             around.
12833     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12834     * - "press" - This is called when a user has pressed down the thumb.
12835     * - "generate,start" - The thumbnail generation started.
12836     * - "generate,stop" - The generation process stopped.
12837     * - "generate,error" - The generation failed.
12838     * - "load,error" - The thumbnail image loading failed.
12839     *
12840     * available styles:
12841     * - default
12842     * - noframe
12843     *
12844     * An example of use of thumbnail:
12845     *
12846     * - @ref thumb_example_01
12847     */
12848
12849    /**
12850     * @addtogroup Thumb
12851     * @{
12852     */
12853
12854    /**
12855     * @enum _Elm_Thumb_Animation_Setting
12856     * @typedef Elm_Thumb_Animation_Setting
12857     *
12858     * Used to set if a video thumbnail is animating or not.
12859     *
12860     * @ingroup Thumb
12861     */
12862    typedef enum _Elm_Thumb_Animation_Setting
12863      {
12864         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12865         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12866         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12867         ELM_THUMB_ANIMATION_LAST
12868      } Elm_Thumb_Animation_Setting;
12869
12870    /**
12871     * Add a new thumb object to the parent.
12872     *
12873     * @param parent The parent object.
12874     * @return The new object or NULL if it cannot be created.
12875     *
12876     * @see elm_thumb_file_set()
12877     * @see elm_thumb_ethumb_client_get()
12878     *
12879     * @ingroup Thumb
12880     */
12881    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12882    /**
12883     * Reload thumbnail if it was generated before.
12884     *
12885     * @param obj The thumb object to reload
12886     *
12887     * This is useful if the ethumb client configuration changed, like its
12888     * size, aspect or any other property one set in the handle returned
12889     * by elm_thumb_ethumb_client_get().
12890     *
12891     * If the options didn't change, the thumbnail won't be generated again, but
12892     * the old one will still be used.
12893     *
12894     * @see elm_thumb_file_set()
12895     *
12896     * @ingroup Thumb
12897     */
12898    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12899    /**
12900     * Set the file that will be used as thumbnail.
12901     *
12902     * @param obj The thumb object.
12903     * @param file The path to file that will be used as thumb.
12904     * @param key The key used in case of an EET file.
12905     *
12906     * The file can be an image or a video (in that case, acceptable extensions are:
12907     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12908     * function elm_thumb_animate().
12909     *
12910     * @see elm_thumb_file_get()
12911     * @see elm_thumb_reload()
12912     * @see elm_thumb_animate()
12913     *
12914     * @ingroup Thumb
12915     */
12916    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12917    /**
12918     * Get the image or video path and key used to generate the thumbnail.
12919     *
12920     * @param obj The thumb object.
12921     * @param file Pointer to filename.
12922     * @param key Pointer to key.
12923     *
12924     * @see elm_thumb_file_set()
12925     * @see elm_thumb_path_get()
12926     *
12927     * @ingroup Thumb
12928     */
12929    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12930    /**
12931     * Get the path and key to the image or video generated by ethumb.
12932     *
12933     * One just need to make sure that the thumbnail was generated before getting
12934     * its path; otherwise, the path will be NULL. One way to do that is by asking
12935     * for the path when/after the "generate,stop" smart callback is called.
12936     *
12937     * @param obj The thumb object.
12938     * @param file Pointer to thumb path.
12939     * @param key Pointer to thumb key.
12940     *
12941     * @see elm_thumb_file_get()
12942     *
12943     * @ingroup Thumb
12944     */
12945    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12946    /**
12947     * Set the animation state for the thumb object. If its content is an animated
12948     * video, you may start/stop the animation or tell it to play continuously and
12949     * looping.
12950     *
12951     * @param obj The thumb object.
12952     * @param setting The animation setting.
12953     *
12954     * @see elm_thumb_file_set()
12955     *
12956     * @ingroup Thumb
12957     */
12958    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12959    /**
12960     * Get the animation state for the thumb object.
12961     *
12962     * @param obj The thumb object.
12963     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12964     * on errors.
12965     *
12966     * @see elm_thumb_animate_set()
12967     *
12968     * @ingroup Thumb
12969     */
12970    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12971    /**
12972     * Get the ethumb_client handle so custom configuration can be made.
12973     *
12974     * @return Ethumb_Client instance or NULL.
12975     *
12976     * This must be called before the objects are created to be sure no object is
12977     * visible and no generation started.
12978     *
12979     * Example of usage:
12980     *
12981     * @code
12982     * #include <Elementary.h>
12983     * #ifndef ELM_LIB_QUICKLAUNCH
12984     * EAPI_MAIN int
12985     * elm_main(int argc, char **argv)
12986     * {
12987     *    Ethumb_Client *client;
12988     *
12989     *    elm_need_ethumb();
12990     *
12991     *    // ... your code
12992     *
12993     *    client = elm_thumb_ethumb_client_get();
12994     *    if (!client)
12995     *      {
12996     *         ERR("could not get ethumb_client");
12997     *         return 1;
12998     *      }
12999     *    ethumb_client_size_set(client, 100, 100);
13000     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
13001     *    // ... your code
13002     *
13003     *    // Create elm_thumb objects here
13004     *
13005     *    elm_run();
13006     *    elm_shutdown();
13007     *    return 0;
13008     * }
13009     * #endif
13010     * ELM_MAIN()
13011     * @endcode
13012     *
13013     * @note There's only one client handle for Ethumb, so once a configuration
13014     * change is done to it, any other request for thumbnails (for any thumbnail
13015     * object) will use that configuration. Thus, this configuration is global.
13016     *
13017     * @ingroup Thumb
13018     */
13019    EAPI void                        *elm_thumb_ethumb_client_get(void);
13020    /**
13021     * Get the ethumb_client connection state.
13022     *
13023     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13024     * otherwise.
13025     */
13026    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
13027    /**
13028     * Make the thumbnail 'editable'.
13029     *
13030     * @param obj Thumb object.
13031     * @param set Turn on or off editability. Default is @c EINA_FALSE.
13032     *
13033     * This means the thumbnail is a valid drag target for drag and drop, and can be
13034     * cut or pasted too.
13035     *
13036     * @see elm_thumb_editable_get()
13037     *
13038     * @ingroup Thumb
13039     */
13040    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13041    /**
13042     * Make the thumbnail 'editable'.
13043     *
13044     * @param obj Thumb object.
13045     * @return Editability.
13046     *
13047     * This means the thumbnail is a valid drag target for drag and drop, and can be
13048     * cut or pasted too.
13049     *
13050     * @see elm_thumb_editable_set()
13051     *
13052     * @ingroup Thumb
13053     */
13054    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13055
13056    /**
13057     * @}
13058     */
13059
13060    /**
13061     * @defgroup Web Web
13062     *
13063     * @image html img/widget/web/preview-00.png
13064     * @image latex img/widget/web/preview-00.eps
13065     *
13066     * A web object is used for displaying web pages (HTML/CSS/JS)
13067     * using WebKit-EFL. You must have compiled Elementary with
13068     * ewebkit support.
13069     *
13070     * Signals that you can add callbacks for are:
13071     * @li "download,request": A file download has been requested. Event info is
13072     * a pointer to a Elm_Web_Download
13073     * @li "editorclient,contents,changed": Editor client's contents changed
13074     * @li "editorclient,selection,changed": Editor client's selection changed
13075     * @li "frame,created": A new frame was created. Event info is an
13076     * Evas_Object which can be handled with WebKit's ewk_frame API
13077     * @li "icon,received": An icon was received by the main frame
13078     * @li "inputmethod,changed": Input method changed. Event info is an
13079     * Eina_Bool indicating whether it's enabled or not
13080     * @li "js,windowobject,clear": JS window object has been cleared
13081     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13082     * is a char *link[2], where the first string contains the URL the link
13083     * points to, and the second one the title of the link
13084     * @li "link,hover,out": Mouse cursor left the link
13085     * @li "load,document,finished": Loading of a document finished. Event info
13086     * is the frame that finished loading
13087     * @li "load,error": Load failed. Event info is a pointer to
13088     * Elm_Web_Frame_Load_Error
13089     * @li "load,finished": Load finished. Event info is NULL on success, on
13090     * error it's a pointer to Elm_Web_Frame_Load_Error
13091     * @li "load,newwindow,show": A new window was created and is ready to be
13092     * shown
13093     * @li "load,progress": Overall load progress. Event info is a pointer to
13094     * a double containing a value between 0.0 and 1.0
13095     * @li "load,provisional": Started provisional load
13096     * @li "load,started": Loading of a document started
13097     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13098     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13099     * the menubar is visible, or EINA_FALSE in case it's not
13100     * @li "menubar,visible,set": Informs menubar visibility. Event info is
13101     * an Eina_Bool indicating the visibility
13102     * @li "popup,created": A dropdown widget was activated, requesting its
13103     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13104     * @li "popup,willdelete": The web object is ready to destroy the popup
13105     * object created. Event info is a pointer to Elm_Web_Menu
13106     * @li "ready": Page is fully loaded
13107     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13108     * info is a pointer to Eina_Bool where the visibility state should be set
13109     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13110     * is an Eina_Bool with the visibility state set
13111     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13112     * a string with the new text
13113     * @li "statusbar,visible,get": Queries visibility of the status bar.
13114     * Event info is a pointer to Eina_Bool where the visibility state should be
13115     * set.
13116     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13117     * an Eina_Bool with the visibility value
13118     * @li "title,changed": Title of the main frame changed. Event info is a
13119     * string with the new title
13120     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13121     * is a pointer to Eina_Bool where the visibility state should be set
13122     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13123     * info is an Eina_Bool with the visibility state
13124     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13125     * a string with the text to show
13126     * @li "uri,changed": URI of the main frame changed. Event info is a string
13127     * with the new URI
13128     * @li "view,resized": The web object internal's view changed sized
13129     * @li "windows,close,request": A JavaScript request to close the current
13130     * window was requested
13131     * @li "zoom,animated,end": Animated zoom finished
13132     *
13133     * available styles:
13134     * - default
13135     *
13136     * An example of use of web:
13137     *
13138     * - @ref web_example_01 TBD
13139     */
13140
13141    /**
13142     * @addtogroup Web
13143     * @{
13144     */
13145
13146    /**
13147     * Structure used to report load errors.
13148     *
13149     * Load errors are reported as signal by elm_web. All the strings are
13150     * temporary references and should @b not be used after the signal
13151     * callback returns. If it's required, make copies with strdup() or
13152     * eina_stringshare_add() (they are not even guaranteed to be
13153     * stringshared, so must use eina_stringshare_add() and not
13154     * eina_stringshare_ref()).
13155     */
13156    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13157    /**
13158     * Structure used to report load errors.
13159     *
13160     * Load errors are reported as signal by elm_web. All the strings are
13161     * temporary references and should @b not be used after the signal
13162     * callback returns. If it's required, make copies with strdup() or
13163     * eina_stringshare_add() (they are not even guaranteed to be
13164     * stringshared, so must use eina_stringshare_add() and not
13165     * eina_stringshare_ref()).
13166     */
13167    struct _Elm_Web_Frame_Load_Error
13168      {
13169         int code; /**< Numeric error code */
13170         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13171         const char *domain; /**< Error domain name */
13172         const char *description; /**< Error description (already localized) */
13173         const char *failing_url; /**< The URL that failed to load */
13174         Evas_Object *frame; /**< Frame object that produced the error */
13175      };
13176
13177    /**
13178     * The possibles types that the items in a menu can be
13179     */
13180    typedef enum _Elm_Web_Menu_Item_Type
13181      {
13182         ELM_WEB_MENU_SEPARATOR,
13183         ELM_WEB_MENU_GROUP,
13184         ELM_WEB_MENU_OPTION
13185      } Elm_Web_Menu_Item_Type;
13186
13187    /**
13188     * Structure describing the items in a menu
13189     */
13190    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13191    /**
13192     * Structure describing the items in a menu
13193     */
13194    struct _Elm_Web_Menu_Item
13195      {
13196         const char *text; /**< The text for the item */
13197         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13198      };
13199
13200    /**
13201     * Structure describing the menu of a popup
13202     *
13203     * This structure will be passed as the @c event_info for the "popup,create"
13204     * signal, which is emitted when a dropdown menu is opened. Users wanting
13205     * to handle these popups by themselves should listen to this signal and
13206     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13207     * property as @c EINA_FALSE means that the user will not handle the popup
13208     * and the default implementation will be used.
13209     *
13210     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13211     * will be emitted to notify the user that it can destroy any objects and
13212     * free all data related to it.
13213     *
13214     * @see elm_web_popup_selected_set()
13215     * @see elm_web_popup_destroy()
13216     */
13217    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13218    /**
13219     * Structure describing the menu of a popup
13220     *
13221     * This structure will be passed as the @c event_info for the "popup,create"
13222     * signal, which is emitted when a dropdown menu is opened. Users wanting
13223     * to handle these popups by themselves should listen to this signal and
13224     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13225     * property as @c EINA_FALSE means that the user will not handle the popup
13226     * and the default implementation will be used.
13227     *
13228     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13229     * will be emitted to notify the user that it can destroy any objects and
13230     * free all data related to it.
13231     *
13232     * @see elm_web_popup_selected_set()
13233     * @see elm_web_popup_destroy()
13234     */
13235    struct _Elm_Web_Menu
13236      {
13237         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13238         int x; /**< The X position of the popup, relative to the elm_web object */
13239         int y; /**< The Y position of the popup, relative to the elm_web object */
13240         int width; /**< Width of the popup menu */
13241         int height; /**< Height of the popup menu */
13242
13243         Eina_Bool handled : 1; /**< Set to @c EINA_TRUE by the user to indicate that the popup has been handled and the default implementation should be ignored. Leave as @c EINA_FALSE otherwise. */
13244      };
13245
13246    typedef struct _Elm_Web_Download Elm_Web_Download;
13247    struct _Elm_Web_Download
13248      {
13249         const char *url;
13250      };
13251
13252    /**
13253     * Types of zoom available.
13254     */
13255    typedef enum _Elm_Web_Zoom_Mode
13256      {
13257         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13258         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13259         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13260         ELM_WEB_ZOOM_MODE_LAST
13261      } Elm_Web_Zoom_Mode;
13262    /**
13263     * Opaque handler containing the features (such as statusbar, menubar, etc)
13264     * that are to be set on a newly requested window.
13265     */
13266    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13267    /**
13268     * Callback type for the create_window hook.
13269     *
13270     * The function parameters are:
13271     * @li @p data User data pointer set when setting the hook function
13272     * @li @p obj The elm_web object requesting the new window
13273     * @li @p js Set to @c EINA_TRUE if the request was originated from
13274     * JavaScript. @c EINA_FALSE otherwise.
13275     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13276     * the features requested for the new window.
13277     *
13278     * The returned value of the function should be the @c elm_web widget where
13279     * the request will be loaded. That is, if a new window or tab is created,
13280     * the elm_web widget in it should be returned, and @b NOT the window
13281     * object.
13282     * Returning @c NULL should cancel the request.
13283     *
13284     * @see elm_web_window_create_hook_set()
13285     */
13286    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13287    /**
13288     * Callback type for the JS alert hook.
13289     *
13290     * The function parameters are:
13291     * @li @p data User data pointer set when setting the hook function
13292     * @li @p obj The elm_web object requesting the new window
13293     * @li @p message The message to show in the alert dialog
13294     *
13295     * The function should return the object representing the alert dialog.
13296     * Elm_Web will run a second main loop to handle the dialog and normal
13297     * flow of the application will be restored when the object is deleted, so
13298     * the user should handle the popup properly in order to delete the object
13299     * when the action is finished.
13300     * If the function returns @c NULL the popup will be ignored.
13301     *
13302     * @see elm_web_dialog_alert_hook_set()
13303     */
13304    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13305    /**
13306     * Callback type for the JS confirm hook.
13307     *
13308     * The function parameters are:
13309     * @li @p data User data pointer set when setting the hook function
13310     * @li @p obj The elm_web object requesting the new window
13311     * @li @p message The message to show in the confirm dialog
13312     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13313     * the user selected @c Ok, @c EINA_FALSE otherwise.
13314     *
13315     * The function should return the object representing the confirm dialog.
13316     * Elm_Web will run a second main loop to handle the dialog and normal
13317     * flow of the application will be restored when the object is deleted, so
13318     * the user should handle the popup properly in order to delete the object
13319     * when the action is finished.
13320     * If the function returns @c NULL the popup will be ignored.
13321     *
13322     * @see elm_web_dialog_confirm_hook_set()
13323     */
13324    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13325    /**
13326     * Callback type for the JS prompt hook.
13327     *
13328     * The function parameters are:
13329     * @li @p data User data pointer set when setting the hook function
13330     * @li @p obj The elm_web object requesting the new window
13331     * @li @p message The message to show in the prompt dialog
13332     * @li @p def_value The default value to present the user in the entry
13333     * @li @p value Pointer where to store the value given by the user. Must
13334     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13335     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13336     * the user selected @c Ok, @c EINA_FALSE otherwise.
13337     *
13338     * The function should return the object representing the prompt dialog.
13339     * Elm_Web will run a second main loop to handle the dialog and normal
13340     * flow of the application will be restored when the object is deleted, so
13341     * the user should handle the popup properly in order to delete the object
13342     * when the action is finished.
13343     * If the function returns @c NULL the popup will be ignored.
13344     *
13345     * @see elm_web_dialog_prompt_hook_set()
13346     */
13347    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13348    /**
13349     * Callback type for the JS file selector hook.
13350     *
13351     * The function parameters are:
13352     * @li @p data User data pointer set when setting the hook function
13353     * @li @p obj The elm_web object requesting the new window
13354     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13355     * @li @p accept_types Mime types accepted
13356     * @li @p selected Pointer where to store the list of malloc'ed strings
13357     * containing the path to each file selected. Must be @c NULL if the file
13358     * dialog is cancelled
13359     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13360     * the user selected @c Ok, @c EINA_FALSE otherwise.
13361     *
13362     * The function should return the object representing the file selector
13363     * dialog.
13364     * Elm_Web will run a second main loop to handle the dialog and normal
13365     * flow of the application will be restored when the object is deleted, so
13366     * the user should handle the popup properly in order to delete the object
13367     * when the action is finished.
13368     * If the function returns @c NULL the popup will be ignored.
13369     *
13370     * @see elm_web_dialog_file selector_hook_set()
13371     */
13372    typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, Eina_List *accept_types, Eina_List **selected, Eina_Bool *ret);
13373    /**
13374     * Callback type for the JS console message hook.
13375     *
13376     * When a console message is added from JavaScript, any set function to the
13377     * console message hook will be called for the user to handle. There is no
13378     * default implementation of this hook.
13379     *
13380     * The function parameters are:
13381     * @li @p data User data pointer set when setting the hook function
13382     * @li @p obj The elm_web object that originated the message
13383     * @li @p message The message sent
13384     * @li @p line_number The line number
13385     * @li @p source_id Source id
13386     *
13387     * @see elm_web_console_message_hook_set()
13388     */
13389    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13390    /**
13391     * Add a new web object to the parent.
13392     *
13393     * @param parent The parent object.
13394     * @return The new object or NULL if it cannot be created.
13395     *
13396     * @see elm_web_uri_set()
13397     * @see elm_web_webkit_view_get()
13398     */
13399    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13400
13401    /**
13402     * Get internal ewk_view object from web object.
13403     *
13404     * Elementary may not provide some low level features of EWebKit,
13405     * instead of cluttering the API with proxy methods we opted to
13406     * return the internal reference. Be careful using it as it may
13407     * interfere with elm_web behavior.
13408     *
13409     * @param obj The web object.
13410     * @return The internal ewk_view object or NULL if it does not
13411     *         exist. (Failure to create or Elementary compiled without
13412     *         ewebkit)
13413     *
13414     * @see elm_web_add()
13415     */
13416    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13417
13418    /**
13419     * Sets the function to call when a new window is requested
13420     *
13421     * This hook will be called when a request to create a new window is
13422     * issued from the web page loaded.
13423     * There is no default implementation for this feature, so leaving this
13424     * unset or passing @c NULL in @p func will prevent new windows from
13425     * opening.
13426     *
13427     * @param obj The web object where to set the hook function
13428     * @param func The hook function to be called when a window is requested
13429     * @param data User data
13430     */
13431    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13432    /**
13433     * Sets the function to call when an alert dialog
13434     *
13435     * This hook will be called when a JavaScript alert dialog is requested.
13436     * If no function is set or @c NULL is passed in @p func, the default
13437     * implementation will take place.
13438     *
13439     * @param obj The web object where to set the hook function
13440     * @param func The callback function to be used
13441     * @param data User data
13442     *
13443     * @see elm_web_inwin_mode_set()
13444     */
13445    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13446    /**
13447     * Sets the function to call when an confirm dialog
13448     *
13449     * This hook will be called when a JavaScript confirm dialog is requested.
13450     * If no function is set or @c NULL is passed in @p func, the default
13451     * implementation will take place.
13452     *
13453     * @param obj The web object where to set the hook function
13454     * @param func The callback function to be used
13455     * @param data User data
13456     *
13457     * @see elm_web_inwin_mode_set()
13458     */
13459    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13460    /**
13461     * Sets the function to call when an prompt dialog
13462     *
13463     * This hook will be called when a JavaScript prompt dialog is requested.
13464     * If no function is set or @c NULL is passed in @p func, the default
13465     * implementation will take place.
13466     *
13467     * @param obj The web object where to set the hook function
13468     * @param func The callback function to be used
13469     * @param data User data
13470     *
13471     * @see elm_web_inwin_mode_set()
13472     */
13473    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13474    /**
13475     * Sets the function to call when an file selector dialog
13476     *
13477     * This hook will be called when a JavaScript file selector dialog is
13478     * requested.
13479     * If no function is set or @c NULL is passed in @p func, the default
13480     * implementation will take place.
13481     *
13482     * @param obj The web object where to set the hook function
13483     * @param func The callback function to be used
13484     * @param data User data
13485     *
13486     * @see elm_web_inwin_mode_set()
13487     */
13488    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13489    /**
13490     * Sets the function to call when a console message is emitted from JS
13491     *
13492     * This hook will be called when a console message is emitted from
13493     * JavaScript. There is no default implementation for this feature.
13494     *
13495     * @param obj The web object where to set the hook function
13496     * @param func The callback function to be used
13497     * @param data User data
13498     */
13499    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13500    /**
13501     * Gets the status of the tab propagation
13502     *
13503     * @param obj The web object to query
13504     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13505     *
13506     * @see elm_web_tab_propagate_set()
13507     */
13508    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
13509    /**
13510     * Sets whether to use tab propagation
13511     *
13512     * If tab propagation is enabled, whenever the user presses the Tab key,
13513     * Elementary will handle it and switch focus to the next widget.
13514     * The default value is disabled, where WebKit will handle the Tab key to
13515     * cycle focus though its internal objects, jumping to the next widget
13516     * only when that cycle ends.
13517     *
13518     * @param obj The web object
13519     * @param propagate Whether to propagate Tab keys to Elementary or not
13520     */
13521    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13522    /**
13523     * Sets the URI for the web object
13524     *
13525     * It must be a full URI, with resource included, in the form
13526     * http://www.enlightenment.org or file:///tmp/something.html
13527     *
13528     * @param obj The web object
13529     * @param uri The URI to set
13530     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13531     */
13532    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
13533    /**
13534     * Gets the current URI for the object
13535     *
13536     * The returned string must not be freed and is guaranteed to be
13537     * stringshared.
13538     *
13539     * @param obj The web object
13540     * @return A stringshared internal string with the current URI, or NULL on
13541     * failure
13542     */
13543    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
13544    /**
13545     * Gets the current title
13546     *
13547     * The returned string must not be freed and is guaranteed to be
13548     * stringshared.
13549     *
13550     * @param obj The web object
13551     * @return A stringshared internal string with the current title, or NULL on
13552     * failure
13553     */
13554    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
13555    /**
13556     * Sets the background color to be used by the web object
13557     *
13558     * This is the color that will be used by default when the loaded page
13559     * does not set it's own. Color values are pre-multiplied.
13560     *
13561     * @param obj The web object
13562     * @param r Red component
13563     * @param g Green component
13564     * @param b Blue component
13565     * @param a Alpha component
13566     */
13567    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13568    /**
13569     * Gets the background color to be used by the web object
13570     *
13571     * This is the color that will be used by default when the loaded page
13572     * does not set it's own. Color values are pre-multiplied.
13573     *
13574     * @param obj The web object
13575     * @param r Red component
13576     * @param g Green component
13577     * @param b Blue component
13578     * @param a Alpha component
13579     */
13580    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13581    /**
13582     * Gets a copy of the currently selected text
13583     *
13584     * The string returned must be freed by the user when it's done with it.
13585     *
13586     * @param obj The web object
13587     * @return A newly allocated string, or NULL if nothing is selected or an
13588     * error occurred
13589     */
13590    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
13591    /**
13592     * Tells the web object which index in the currently open popup was selected
13593     *
13594     * When the user handles the popup creation from the "popup,created" signal,
13595     * it needs to tell the web object which item was selected by calling this
13596     * function with the index corresponding to the item.
13597     *
13598     * @param obj The web object
13599     * @param index The index selected
13600     *
13601     * @see elm_web_popup_destroy()
13602     */
13603    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
13604    /**
13605     * Dismisses an open dropdown popup
13606     *
13607     * When the popup from a dropdown widget is to be dismissed, either after
13608     * selecting an option or to cancel it, this function must be called, which
13609     * will later emit an "popup,willdelete" signal to notify the user that
13610     * any memory and objects related to this popup can be freed.
13611     *
13612     * @param obj The web object
13613     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13614     * if there was no menu to destroy
13615     */
13616    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
13617    /**
13618     * Searches the given string in a document.
13619     *
13620     * @param obj The web object where to search the text
13621     * @param string String to search
13622     * @param case_sensitive If search should be case sensitive or not
13623     * @param forward If search is from cursor and on or backwards
13624     * @param wrap If search should wrap at the end
13625     *
13626     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13627     * or failure
13628     */
13629    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13630    /**
13631     * Marks matches of the given string in a document.
13632     *
13633     * @param obj The web object where to search text
13634     * @param string String to match
13635     * @param case_sensitive If match should be case sensitive or not
13636     * @param highlight If matches should be highlighted
13637     * @param limit Maximum amount of matches, or zero to unlimited
13638     *
13639     * @return number of matched @a string
13640     */
13641    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13642    /**
13643     * Clears all marked matches in the document
13644     *
13645     * @param obj The web object
13646     *
13647     * @return EINA_TRUE on success, EINA_FALSE otherwise
13648     */
13649    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
13650    /**
13651     * Sets whether to highlight the matched marks
13652     *
13653     * If enabled, marks set with elm_web_text_matches_mark() will be
13654     * highlighted.
13655     *
13656     * @param obj The web object
13657     * @param highlight Whether to highlight the marks or not
13658     *
13659     * @return EINA_TRUE on success, EINA_FALSE otherwise
13660     */
13661    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13662    /**
13663     * Gets whether highlighting marks is enabled
13664     *
13665     * @param The web object
13666     *
13667     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13668     * otherwise
13669     */
13670    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
13671    /**
13672     * Gets the overall loading progress of the page
13673     *
13674     * Returns the estimated loading progress of the page, with a value between
13675     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13676     * included in the page.
13677     *
13678     * @param The web object
13679     *
13680     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13681     * failure
13682     */
13683    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
13684    /**
13685     * Stops loading the current page
13686     *
13687     * Cancels the loading of the current page in the web object. This will
13688     * cause a "load,error" signal to be emitted, with the is_cancellation
13689     * flag set to EINA_TRUE.
13690     *
13691     * @param obj The web object
13692     *
13693     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13694     */
13695    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
13696    /**
13697     * Requests a reload of the current document in the object
13698     *
13699     * @param obj The web object
13700     *
13701     * @return EINA_TRUE on success, EINA_FALSE otherwise
13702     */
13703    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
13704    /**
13705     * Requests a reload of the current document, avoiding any existing caches
13706     *
13707     * @param obj The web object
13708     *
13709     * @return EINA_TRUE on success, EINA_FALSE otherwise
13710     */
13711    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
13712    /**
13713     * Goes back one step in the browsing history
13714     *
13715     * This is equivalent to calling elm_web_object_navigate(obj, -1);
13716     *
13717     * @param obj The web object
13718     *
13719     * @return EINA_TRUE on success, EINA_FALSE otherwise
13720     *
13721     * @see elm_web_history_enable_set()
13722     * @see elm_web_back_possible()
13723     * @see elm_web_forward()
13724     * @see elm_web_navigate()
13725     */
13726    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
13727    /**
13728     * Goes forward one step in the browsing history
13729     *
13730     * This is equivalent to calling elm_web_object_navigate(obj, 1);
13731     *
13732     * @param obj The web object
13733     *
13734     * @return EINA_TRUE on success, EINA_FALSE otherwise
13735     *
13736     * @see elm_web_history_enable_set()
13737     * @see elm_web_forward_possible()
13738     * @see elm_web_back()
13739     * @see elm_web_navigate()
13740     */
13741    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
13742    /**
13743     * Jumps the given number of steps in the browsing history
13744     *
13745     * The @p steps value can be a negative integer to back in history, or a
13746     * positive to move forward.
13747     *
13748     * @param obj The web object
13749     * @param steps The number of steps to jump
13750     *
13751     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13752     * history exists to jump the given number of steps
13753     *
13754     * @see elm_web_history_enable_set()
13755     * @see elm_web_navigate_possible()
13756     * @see elm_web_back()
13757     * @see elm_web_forward()
13758     */
13759    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
13760    /**
13761     * Queries whether it's possible to go back in history
13762     *
13763     * @param obj The web object
13764     *
13765     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13766     * otherwise
13767     */
13768    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
13769    /**
13770     * Queries whether it's possible to go forward in history
13771     *
13772     * @param obj The web object
13773     *
13774     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13775     * otherwise
13776     */
13777    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
13778    /**
13779     * Queries whether it's possible to jump the given number of steps
13780     *
13781     * The @p steps value can be a negative integer to back in history, or a
13782     * positive to move forward.
13783     *
13784     * @param obj The web object
13785     * @param steps The number of steps to check for
13786     *
13787     * @return EINA_TRUE if enough history exists to perform the given jump,
13788     * EINA_FALSE otherwise
13789     */
13790    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
13791    /**
13792     * Gets whether browsing history is enabled for the given object
13793     *
13794     * @param obj The web object
13795     *
13796     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13797     */
13798    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
13799    /**
13800     * Enables or disables the browsing history
13801     *
13802     * @param obj The web object
13803     * @param enable Whether to enable or disable the browsing history
13804     */
13805    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13806    /**
13807     * Sets the zoom level of the web object
13808     *
13809     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13810     * values meaning zoom in and lower meaning zoom out. This function will
13811     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13812     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13813     *
13814     * @param obj The web object
13815     * @param zoom The zoom level to set
13816     */
13817    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
13818    /**
13819     * Gets the current zoom level set on the web object
13820     *
13821     * Note that this is the zoom level set on the web object and not that
13822     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13823     * the two zoom levels should match, but for the other two modes the
13824     * Webkit zoom is calculated internally to match the chosen mode without
13825     * changing the zoom level set for the web object.
13826     *
13827     * @param obj The web object
13828     *
13829     * @return The zoom level set on the object
13830     */
13831    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
13832    /**
13833     * Sets the zoom mode to use
13834     *
13835     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13836     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13837     *
13838     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13839     * with the elm_web_zoom_set() function.
13840     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13841     * make sure the entirety of the web object's contents are shown.
13842     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13843     * fit the contents in the web object's size, without leaving any space
13844     * unused.
13845     *
13846     * @param obj The web object
13847     * @param mode The mode to set
13848     */
13849    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13850    /**
13851     * Gets the currently set zoom mode
13852     *
13853     * @param obj The web object
13854     *
13855     * @return The current zoom mode set for the object, or
13856     * ::ELM_WEB_ZOOM_MODE_LAST on error
13857     */
13858    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
13859    /**
13860     * Shows the given region in the web object
13861     *
13862     * @param obj The web object
13863     * @param x The x coordinate of the region to show
13864     * @param y The y coordinate of the region to show
13865     * @param w The width of the region to show
13866     * @param h The height of the region to show
13867     */
13868    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13869    /**
13870     * Brings in the region to the visible area
13871     *
13872     * Like elm_web_region_show(), but it animates the scrolling of the object
13873     * to show the area
13874     *
13875     * @param obj The web object
13876     * @param x The x coordinate of the region to show
13877     * @param y The y coordinate of the region to show
13878     * @param w The width of the region to show
13879     * @param h The height of the region to show
13880     */
13881    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13882    /**
13883     * Sets the default dialogs to use an Inwin instead of a normal window
13884     *
13885     * If set, then the default implementation for the JavaScript dialogs and
13886     * file selector will be opened in an Inwin. Otherwise they will use a
13887     * normal separated window.
13888     *
13889     * @param obj The web object
13890     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13891     */
13892    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13893    /**
13894     * Gets whether Inwin mode is set for the current object
13895     *
13896     * @param obj The web object
13897     *
13898     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13899     */
13900    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
13901
13902    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13903    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13904    EAPI void                         elm_web_window_features_bool_property_get(const Elm_Web_Window_Features *wf, Eina_Bool *toolbar_visible, Eina_Bool *statusbar_visible, Eina_Bool *scrollbars_visible, Eina_Bool *menubar_visible, Eina_Bool *locationbar_visble, Eina_Bool *fullscreen);
13905    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13906
13907    /**
13908     * @}
13909     */
13910
13911    /**
13912     * @defgroup Hoversel Hoversel
13913     *
13914     * @image html img/widget/hoversel/preview-00.png
13915     * @image latex img/widget/hoversel/preview-00.eps
13916     *
13917     * A hoversel is a button that pops up a list of items (automatically
13918     * choosing the direction to display) that have a label and, optionally, an
13919     * icon to select from. It is a convenience widget to avoid the need to do
13920     * all the piecing together yourself. It is intended for a small number of
13921     * items in the hoversel menu (no more than 8), though is capable of many
13922     * more.
13923     *
13924     * Signals that you can add callbacks for are:
13925     * "clicked" - the user clicked the hoversel button and popped up the sel
13926     * "selected" - an item in the hoversel list is selected. event_info is the item
13927     * "dismissed" - the hover is dismissed
13928     *
13929     * See @ref tutorial_hoversel for an example.
13930     * @{
13931     */
13932    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13933    /**
13934     * @brief Add a new Hoversel object
13935     *
13936     * @param parent The parent object
13937     * @return The new object or NULL if it cannot be created
13938     */
13939    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13940    /**
13941     * @brief This sets the hoversel to expand horizontally.
13942     *
13943     * @param obj The hoversel object
13944     * @param horizontal If true, the hover will expand horizontally to the
13945     * right.
13946     *
13947     * @note The initial button will display horizontally regardless of this
13948     * setting.
13949     */
13950    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13951    /**
13952     * @brief This returns whether the hoversel is set to expand horizontally.
13953     *
13954     * @param obj The hoversel object
13955     * @return If true, the hover will expand horizontally to the right.
13956     *
13957     * @see elm_hoversel_horizontal_set()
13958     */
13959    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13960    /**
13961     * @brief Set the Hover parent
13962     *
13963     * @param obj The hoversel object
13964     * @param parent The parent to use
13965     *
13966     * Sets the hover parent object, the area that will be darkened when the
13967     * hoversel is clicked. Should probably be the window that the hoversel is
13968     * in. See @ref Hover objects for more information.
13969     */
13970    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13971    /**
13972     * @brief Get the Hover parent
13973     *
13974     * @param obj The hoversel object
13975     * @return The used parent
13976     *
13977     * Gets the hover parent object.
13978     *
13979     * @see elm_hoversel_hover_parent_set()
13980     */
13981    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13982    /**
13983     * @brief Set the hoversel button label
13984     *
13985     * @param obj The hoversel object
13986     * @param label The label text.
13987     *
13988     * This sets the label of the button that is always visible (before it is
13989     * clicked and expanded).
13990     *
13991     * @deprecated elm_object_text_set()
13992     */
13993    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13994    /**
13995     * @brief Get the hoversel button label
13996     *
13997     * @param obj The hoversel object
13998     * @return The label text.
13999     *
14000     * @deprecated elm_object_text_get()
14001     */
14002    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14003    /**
14004     * @brief Set the icon of the hoversel button
14005     *
14006     * @param obj The hoversel object
14007     * @param icon The icon object
14008     *
14009     * Sets the icon of the button that is always visible (before it is clicked
14010     * and expanded).  Once the icon object is set, a previously set one will be
14011     * deleted, if you want to keep that old content object, use the
14012     * elm_hoversel_icon_unset() function.
14013     *
14014     * @see elm_button_icon_set()
14015     */
14016    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14017    /**
14018     * @brief Get the icon of the hoversel button
14019     *
14020     * @param obj The hoversel object
14021     * @return The icon object
14022     *
14023     * Get the icon of the button that is always visible (before it is clicked
14024     * and expanded). Also see elm_button_icon_get().
14025     *
14026     * @see elm_hoversel_icon_set()
14027     */
14028    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14029    /**
14030     * @brief Get and unparent the icon of the hoversel button
14031     *
14032     * @param obj The hoversel object
14033     * @return The icon object that was being used
14034     *
14035     * Unparent and return the icon of the button that is always visible
14036     * (before it is clicked and expanded).
14037     *
14038     * @see elm_hoversel_icon_set()
14039     * @see elm_button_icon_unset()
14040     */
14041    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14042    /**
14043     * @brief This triggers the hoversel popup from code, the same as if the user
14044     * had clicked the button.
14045     *
14046     * @param obj The hoversel object
14047     */
14048    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14049    /**
14050     * @brief This dismisses the hoversel popup as if the user had clicked
14051     * outside the hover.
14052     *
14053     * @param obj The hoversel object
14054     */
14055    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14056    /**
14057     * @brief Returns whether the hoversel is expanded.
14058     *
14059     * @param obj The hoversel object
14060     * @return  This will return EINA_TRUE if the hoversel is expanded or
14061     * EINA_FALSE if it is not expanded.
14062     */
14063    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14064    /**
14065     * @brief This will remove all the children items from the hoversel.
14066     *
14067     * @param obj The hoversel object
14068     *
14069     * @warning Should @b not be called while the hoversel is active; use
14070     * elm_hoversel_expanded_get() to check first.
14071     *
14072     * @see elm_hoversel_item_del_cb_set()
14073     * @see elm_hoversel_item_del()
14074     */
14075    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14076    /**
14077     * @brief Get the list of items within the given hoversel.
14078     *
14079     * @param obj The hoversel object
14080     * @return Returns a list of Elm_Hoversel_Item*
14081     *
14082     * @see elm_hoversel_item_add()
14083     */
14084    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14085    /**
14086     * @brief Add an item to the hoversel button
14087     *
14088     * @param obj The hoversel object
14089     * @param label The text label to use for the item (NULL if not desired)
14090     * @param icon_file An image file path on disk to use for the icon or standard
14091     * icon name (NULL if not desired)
14092     * @param icon_type The icon type if relevant
14093     * @param func Convenience function to call when this item is selected
14094     * @param data Data to pass to item-related functions
14095     * @return A handle to the item added.
14096     *
14097     * This adds an item to the hoversel to show when it is clicked. Note: if you
14098     * need to use an icon from an edje file then use
14099     * elm_hoversel_item_icon_set() right after the this function, and set
14100     * icon_file to NULL here.
14101     *
14102     * For more information on what @p icon_file and @p icon_type are see the
14103     * @ref Icon "icon documentation".
14104     */
14105    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);
14106    /**
14107     * @brief Delete an item from the hoversel
14108     *
14109     * @param item The item to delete
14110     *
14111     * This deletes the item from the hoversel (should not be called while the
14112     * hoversel is active; use elm_hoversel_expanded_get() to check first).
14113     *
14114     * @see elm_hoversel_item_add()
14115     * @see elm_hoversel_item_del_cb_set()
14116     */
14117    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14118    /**
14119     * @brief Set the function to be called when an item from the hoversel is
14120     * freed.
14121     *
14122     * @param item The item to set the callback on
14123     * @param func The function called
14124     *
14125     * That function will receive these parameters:
14126     * @li void *item_data
14127     * @li Evas_Object *the_item_object
14128     * @li Elm_Hoversel_Item *the_object_struct
14129     *
14130     * @see elm_hoversel_item_add()
14131     */
14132    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14133    /**
14134     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14135     * that will be passed to associated function callbacks.
14136     *
14137     * @param item The item to get the data from
14138     * @return The data pointer set with elm_hoversel_item_add()
14139     *
14140     * @see elm_hoversel_item_add()
14141     */
14142    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14143    /**
14144     * @brief This returns the label text of the given hoversel item.
14145     *
14146     * @param item The item to get the label
14147     * @return The label text of the hoversel item
14148     *
14149     * @see elm_hoversel_item_add()
14150     */
14151    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14152    /**
14153     * @brief This sets the icon for the given hoversel item.
14154     *
14155     * @param item The item to set the icon
14156     * @param icon_file An image file path on disk to use for the icon or standard
14157     * icon name
14158     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14159     * to NULL if the icon is not an edje file
14160     * @param icon_type The icon type
14161     *
14162     * The icon can be loaded from the standard set, from an image file, or from
14163     * an edje file.
14164     *
14165     * @see elm_hoversel_item_add()
14166     */
14167    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);
14168    /**
14169     * @brief Get the icon object of the hoversel item
14170     *
14171     * @param item The item to get the icon from
14172     * @param icon_file The image file path on disk used for the icon or standard
14173     * icon name
14174     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14175     * if the icon is not an edje file
14176     * @param icon_type The icon type
14177     *
14178     * @see elm_hoversel_item_icon_set()
14179     * @see elm_hoversel_item_add()
14180     */
14181    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);
14182    /**
14183     * @}
14184     */
14185
14186    /**
14187     * @defgroup Toolbar Toolbar
14188     * @ingroup Elementary
14189     *
14190     * @image html img/widget/toolbar/preview-00.png
14191     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14192     *
14193     * @image html img/toolbar.png
14194     * @image latex img/toolbar.eps width=\textwidth
14195     *
14196     * A toolbar is a widget that displays a list of items inside
14197     * a box. It can be scrollable, show a menu with items that don't fit
14198     * to toolbar size or even crop them.
14199     *
14200     * Only one item can be selected at a time.
14201     *
14202     * Items can have multiple states, or show menus when selected by the user.
14203     *
14204     * Smart callbacks one can listen to:
14205     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14206     * - "language,changed" - when the program language changes
14207     *
14208     * Available styles for it:
14209     * - @c "default"
14210     * - @c "transparent" - no background or shadow, just show the content
14211     *
14212     * List of examples:
14213     * @li @ref toolbar_example_01
14214     * @li @ref toolbar_example_02
14215     * @li @ref toolbar_example_03
14216     */
14217
14218    /**
14219     * @addtogroup Toolbar
14220     * @{
14221     */
14222
14223    /**
14224     * @enum _Elm_Toolbar_Shrink_Mode
14225     * @typedef Elm_Toolbar_Shrink_Mode
14226     *
14227     * Set toolbar's items display behavior, it can be scrollabel,
14228     * show a menu with exceeding items, or simply hide them.
14229     *
14230     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14231     * from elm config.
14232     *
14233     * Values <b> don't </b> work as bitmask, only one can be choosen.
14234     *
14235     * @see elm_toolbar_mode_shrink_set()
14236     * @see elm_toolbar_mode_shrink_get()
14237     *
14238     * @ingroup Toolbar
14239     */
14240    typedef enum _Elm_Toolbar_Shrink_Mode
14241      {
14242         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
14243         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
14244         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14245         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
14246      } Elm_Toolbar_Shrink_Mode;
14247
14248    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(). */
14249
14250    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(). */
14251
14252    /**
14253     * Add a new toolbar widget to the given parent Elementary
14254     * (container) object.
14255     *
14256     * @param parent The parent object.
14257     * @return a new toolbar widget handle or @c NULL, on errors.
14258     *
14259     * This function inserts a new toolbar widget on the canvas.
14260     *
14261     * @ingroup Toolbar
14262     */
14263    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14264
14265    /**
14266     * Set the icon size, in pixels, to be used by toolbar items.
14267     *
14268     * @param obj The toolbar object
14269     * @param icon_size The icon size in pixels
14270     *
14271     * @note Default value is @c 32. It reads value from elm config.
14272     *
14273     * @see elm_toolbar_icon_size_get()
14274     *
14275     * @ingroup Toolbar
14276     */
14277    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14278
14279    /**
14280     * Get the icon size, in pixels, to be used by toolbar items.
14281     *
14282     * @param obj The toolbar object.
14283     * @return The icon size in pixels.
14284     *
14285     * @see elm_toolbar_icon_size_set() for details.
14286     *
14287     * @ingroup Toolbar
14288     */
14289    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14290
14291    /**
14292     * Sets icon lookup order, for toolbar items' icons.
14293     *
14294     * @param obj The toolbar object.
14295     * @param order The icon lookup order.
14296     *
14297     * Icons added before calling this function will not be affected.
14298     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14299     *
14300     * @see elm_toolbar_icon_order_lookup_get()
14301     *
14302     * @ingroup Toolbar
14303     */
14304    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14305
14306    /**
14307     * Gets the icon lookup order.
14308     *
14309     * @param obj The toolbar object.
14310     * @return The icon lookup order.
14311     *
14312     * @see elm_toolbar_icon_order_lookup_set() for details.
14313     *
14314     * @ingroup Toolbar
14315     */
14316    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14317
14318    /**
14319     * Set whether the toolbar should always have an item selected.
14320     *
14321     * @param obj The toolbar object.
14322     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14323     * disable it.
14324     *
14325     * This will cause the toolbar to always have an item selected, and clicking
14326     * the selected item will not cause a selected event to be emitted. Enabling this mode
14327     * will immediately select the first toolbar item.
14328     *
14329     * Always-selected is disabled by default.
14330     *
14331     * @see elm_toolbar_always_select_mode_get().
14332     *
14333     * @ingroup Toolbar
14334     */
14335    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14336
14337    /**
14338     * Get whether the toolbar should always have an item selected.
14339     *
14340     * @param obj The toolbar object.
14341     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14342     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14343     *
14344     * @see elm_toolbar_always_select_mode_set() for details.
14345     *
14346     * @ingroup Toolbar
14347     */
14348    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14349
14350    /**
14351     * Set whether the toolbar items' should be selected by the user or not.
14352     *
14353     * @param obj The toolbar object.
14354     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14355     * enable it.
14356     *
14357     * This will turn off the ability to select items entirely and they will
14358     * neither appear selected nor emit selected signals. The clicked
14359     * callback function will still be called.
14360     *
14361     * Selection is enabled by default.
14362     *
14363     * @see elm_toolbar_no_select_mode_get().
14364     *
14365     * @ingroup Toolbar
14366     */
14367    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14368
14369    /**
14370     * Set whether the toolbar items' should be selected by the user or not.
14371     *
14372     * @param obj The toolbar object.
14373     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14374     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14375     *
14376     * @see elm_toolbar_no_select_mode_set() for details.
14377     *
14378     * @ingroup Toolbar
14379     */
14380    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14381
14382    /**
14383     * Append item to the toolbar.
14384     *
14385     * @param obj The toolbar object.
14386     * @param icon A string with icon name or the absolute path of an image file.
14387     * @param label The label of the item.
14388     * @param func The function to call when the item is clicked.
14389     * @param data The data to associate with the item for related callbacks.
14390     * @return The created item or @c NULL upon failure.
14391     *
14392     * A new item will be created and appended to the toolbar, i.e., will
14393     * be set as @b last item.
14394     *
14395     * Items created with this method can be deleted with
14396     * elm_toolbar_item_del().
14397     *
14398     * Associated @p data can be properly freed when item is deleted if a
14399     * callback function is set with elm_toolbar_item_del_cb_set().
14400     *
14401     * If a function is passed as argument, it will be called everytime this item
14402     * is selected, i.e., the user clicks over an unselected item.
14403     * If such function isn't needed, just passing
14404     * @c NULL as @p func is enough. The same should be done for @p data.
14405     *
14406     * Toolbar will load icon image from fdo or current theme.
14407     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14408     * If an absolute path is provided it will load it direct from a file.
14409     *
14410     * @see elm_toolbar_item_icon_set()
14411     * @see elm_toolbar_item_del()
14412     * @see elm_toolbar_item_del_cb_set()
14413     *
14414     * @ingroup Toolbar
14415     */
14416    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);
14417
14418    /**
14419     * Prepend item to the toolbar.
14420     *
14421     * @param obj The toolbar object.
14422     * @param icon A string with icon name or the absolute path of an image file.
14423     * @param label The label of the item.
14424     * @param func The function to call when the item is clicked.
14425     * @param data The data to associate with the item for related callbacks.
14426     * @return The created item or @c NULL upon failure.
14427     *
14428     * A new item will be created and prepended to the toolbar, i.e., will
14429     * be set as @b first item.
14430     *
14431     * Items created with this method can be deleted with
14432     * elm_toolbar_item_del().
14433     *
14434     * Associated @p data can be properly freed when item is deleted if a
14435     * callback function is set with elm_toolbar_item_del_cb_set().
14436     *
14437     * If a function is passed as argument, it will be called everytime this item
14438     * is selected, i.e., the user clicks over an unselected item.
14439     * If such function isn't needed, just passing
14440     * @c NULL as @p func is enough. The same should be done for @p data.
14441     *
14442     * Toolbar will load icon image from fdo or current theme.
14443     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14444     * If an absolute path is provided it will load it direct from a file.
14445     *
14446     * @see elm_toolbar_item_icon_set()
14447     * @see elm_toolbar_item_del()
14448     * @see elm_toolbar_item_del_cb_set()
14449     *
14450     * @ingroup Toolbar
14451     */
14452    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);
14453
14454    /**
14455     * Insert a new item into the toolbar object before item @p before.
14456     *
14457     * @param obj The toolbar object.
14458     * @param before The toolbar item to insert before.
14459     * @param icon A string with icon name or the absolute path of an image file.
14460     * @param label The label of the item.
14461     * @param func The function to call when the item is clicked.
14462     * @param data The data to associate with the item for related callbacks.
14463     * @return The created item or @c NULL upon failure.
14464     *
14465     * A new item will be created and added to the toolbar. Its position in
14466     * this toolbar will be just before item @p before.
14467     *
14468     * Items created with this method can be deleted with
14469     * elm_toolbar_item_del().
14470     *
14471     * Associated @p data can be properly freed when item is deleted if a
14472     * callback function is set with elm_toolbar_item_del_cb_set().
14473     *
14474     * If a function is passed as argument, it will be called everytime this item
14475     * is selected, i.e., the user clicks over an unselected item.
14476     * If such function isn't needed, just passing
14477     * @c NULL as @p func is enough. The same should be done for @p data.
14478     *
14479     * Toolbar will load icon image from fdo or current theme.
14480     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14481     * If an absolute path is provided it will load it direct from a file.
14482     *
14483     * @see elm_toolbar_item_icon_set()
14484     * @see elm_toolbar_item_del()
14485     * @see elm_toolbar_item_del_cb_set()
14486     *
14487     * @ingroup Toolbar
14488     */
14489    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);
14490
14491    /**
14492     * Insert a new item into the toolbar object after item @p after.
14493     *
14494     * @param obj The toolbar object.
14495     * @param before The toolbar item to insert before.
14496     * @param icon A string with icon name or the absolute path of an image file.
14497     * @param label The label of the item.
14498     * @param func The function to call when the item is clicked.
14499     * @param data The data to associate with the item for related callbacks.
14500     * @return The created item or @c NULL upon failure.
14501     *
14502     * A new item will be created and added to the toolbar. Its position in
14503     * this toolbar will be just after item @p after.
14504     *
14505     * Items created with this method can be deleted with
14506     * elm_toolbar_item_del().
14507     *
14508     * Associated @p data can be properly freed when item is deleted if a
14509     * callback function is set with elm_toolbar_item_del_cb_set().
14510     *
14511     * If a function is passed as argument, it will be called everytime this item
14512     * is selected, i.e., the user clicks over an unselected item.
14513     * If such function isn't needed, just passing
14514     * @c NULL as @p func is enough. The same should be done for @p data.
14515     *
14516     * Toolbar will load icon image from fdo or current theme.
14517     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14518     * If an absolute path is provided it will load it direct from a file.
14519     *
14520     * @see elm_toolbar_item_icon_set()
14521     * @see elm_toolbar_item_del()
14522     * @see elm_toolbar_item_del_cb_set()
14523     *
14524     * @ingroup Toolbar
14525     */
14526    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);
14527
14528    /**
14529     * Get the first item in the given toolbar widget's list of
14530     * items.
14531     *
14532     * @param obj The toolbar object
14533     * @return The first item or @c NULL, if it has no items (and on
14534     * errors)
14535     *
14536     * @see elm_toolbar_item_append()
14537     * @see elm_toolbar_last_item_get()
14538     *
14539     * @ingroup Toolbar
14540     */
14541    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14542
14543    /**
14544     * Get the last item in the given toolbar widget's list of
14545     * items.
14546     *
14547     * @param obj The toolbar object
14548     * @return The last item or @c NULL, if it has no items (and on
14549     * errors)
14550     *
14551     * @see elm_toolbar_item_prepend()
14552     * @see elm_toolbar_first_item_get()
14553     *
14554     * @ingroup Toolbar
14555     */
14556    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14557
14558    /**
14559     * Get the item after @p item in toolbar.
14560     *
14561     * @param item The toolbar item.
14562     * @return The item after @p item, or @c NULL if none or on failure.
14563     *
14564     * @note If it is the last item, @c NULL will be returned.
14565     *
14566     * @see elm_toolbar_item_append()
14567     *
14568     * @ingroup Toolbar
14569     */
14570    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14571
14572    /**
14573     * Get the item before @p item in toolbar.
14574     *
14575     * @param item The toolbar item.
14576     * @return The item before @p item, or @c NULL if none or on failure.
14577     *
14578     * @note If it is the first item, @c NULL will be returned.
14579     *
14580     * @see elm_toolbar_item_prepend()
14581     *
14582     * @ingroup Toolbar
14583     */
14584    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14585
14586    /**
14587     * Get the toolbar object from an item.
14588     *
14589     * @param item The item.
14590     * @return The toolbar object.
14591     *
14592     * This returns the toolbar object itself that an item belongs to.
14593     *
14594     * @ingroup Toolbar
14595     */
14596    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14597
14598    /**
14599     * Set the priority of a toolbar item.
14600     *
14601     * @param item The toolbar item.
14602     * @param priority The item priority. The default is zero.
14603     *
14604     * This is used only when the toolbar shrink mode is set to
14605     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14606     * When space is less than required, items with low priority
14607     * will be removed from the toolbar and added to a dynamically-created menu,
14608     * while items with higher priority will remain on the toolbar,
14609     * with the same order they were added.
14610     *
14611     * @see elm_toolbar_item_priority_get()
14612     *
14613     * @ingroup Toolbar
14614     */
14615    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14616
14617    /**
14618     * Get the priority of a toolbar item.
14619     *
14620     * @param item The toolbar item.
14621     * @return The @p item priority, or @c 0 on failure.
14622     *
14623     * @see elm_toolbar_item_priority_set() for details.
14624     *
14625     * @ingroup Toolbar
14626     */
14627    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14628
14629    /**
14630     * Get the label of item.
14631     *
14632     * @param item The item of toolbar.
14633     * @return The label of item.
14634     *
14635     * The return value is a pointer to the label associated to @p item when
14636     * it was created, with function elm_toolbar_item_append() or similar,
14637     * or later,
14638     * with function elm_toolbar_item_label_set. If no label
14639     * was passed as argument, it will return @c NULL.
14640     *
14641     * @see elm_toolbar_item_label_set() for more details.
14642     * @see elm_toolbar_item_append()
14643     *
14644     * @ingroup Toolbar
14645     */
14646    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14647
14648    /**
14649     * Set the label of item.
14650     *
14651     * @param item The item of toolbar.
14652     * @param text The label of item.
14653     *
14654     * The label to be displayed by the item.
14655     * Label will be placed at icons bottom (if set).
14656     *
14657     * If a label was passed as argument on item creation, with function
14658     * elm_toolbar_item_append() or similar, it will be already
14659     * displayed by the item.
14660     *
14661     * @see elm_toolbar_item_label_get()
14662     * @see elm_toolbar_item_append()
14663     *
14664     * @ingroup Toolbar
14665     */
14666    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14667
14668    /**
14669     * Return the data associated with a given toolbar widget item.
14670     *
14671     * @param item The toolbar widget item handle.
14672     * @return The data associated with @p item.
14673     *
14674     * @see elm_toolbar_item_data_set()
14675     *
14676     * @ingroup Toolbar
14677     */
14678    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14679
14680    /**
14681     * Set the data associated with a given toolbar widget item.
14682     *
14683     * @param item The toolbar widget item handle.
14684     * @param data The new data pointer to set to @p item.
14685     *
14686     * This sets new item data on @p item.
14687     *
14688     * @warning The old data pointer won't be touched by this function, so
14689     * the user had better to free that old data himself/herself.
14690     *
14691     * @ingroup Toolbar
14692     */
14693    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14694
14695    /**
14696     * Returns a pointer to a toolbar item by its label.
14697     *
14698     * @param obj The toolbar object.
14699     * @param label The label of the item to find.
14700     *
14701     * @return The pointer to the toolbar item matching @p label or @c NULL
14702     * on failure.
14703     *
14704     * @ingroup Toolbar
14705     */
14706    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14707
14708    /*
14709     * Get whether the @p item is selected or not.
14710     *
14711     * @param item The toolbar item.
14712     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14713     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14714     *
14715     * @see elm_toolbar_selected_item_set() for details.
14716     * @see elm_toolbar_item_selected_get()
14717     *
14718     * @ingroup Toolbar
14719     */
14720    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14721
14722    /**
14723     * Set the selected state of an item.
14724     *
14725     * @param item The toolbar item
14726     * @param selected The selected state
14727     *
14728     * This sets the selected state of the given item @p it.
14729     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14730     *
14731     * If a new item is selected the previosly selected will be unselected.
14732     * Previoulsy selected item can be get with function
14733     * elm_toolbar_selected_item_get().
14734     *
14735     * Selected items will be highlighted.
14736     *
14737     * @see elm_toolbar_item_selected_get()
14738     * @see elm_toolbar_selected_item_get()
14739     *
14740     * @ingroup Toolbar
14741     */
14742    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14743
14744    /**
14745     * Get the selected item.
14746     *
14747     * @param obj The toolbar object.
14748     * @return The selected toolbar item.
14749     *
14750     * The selected item can be unselected with function
14751     * elm_toolbar_item_selected_set().
14752     *
14753     * The selected item always will be highlighted on toolbar.
14754     *
14755     * @see elm_toolbar_selected_items_get()
14756     *
14757     * @ingroup Toolbar
14758     */
14759    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14760
14761    /**
14762     * Set the icon associated with @p item.
14763     *
14764     * @param obj The parent of this item.
14765     * @param item The toolbar item.
14766     * @param icon A string with icon name or the absolute path of an image file.
14767     *
14768     * Toolbar will load icon image from fdo or current theme.
14769     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14770     * If an absolute path is provided it will load it direct from a file.
14771     *
14772     * @see elm_toolbar_icon_order_lookup_set()
14773     * @see elm_toolbar_icon_order_lookup_get()
14774     *
14775     * @ingroup Toolbar
14776     */
14777    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14778
14779    /**
14780     * Get the string used to set the icon of @p item.
14781     *
14782     * @param item The toolbar item.
14783     * @return The string associated with the icon object.
14784     *
14785     * @see elm_toolbar_item_icon_set() for details.
14786     *
14787     * @ingroup Toolbar
14788     */
14789    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14790
14791    /**
14792     * Get the object of @p item.
14793     *
14794     * @param item The toolbar item.
14795     * @return The object
14796     *
14797     * @ingroup Toolbar
14798     */
14799    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14800
14801    /**
14802     * Get the icon object of @p item.
14803     *
14804     * @param item The toolbar item.
14805     * @return The icon object
14806     *
14807     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14808     *
14809     * @ingroup Toolbar
14810     */
14811    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14812
14813    /**
14814     * Set the icon associated with @p item to an image in a binary buffer.
14815     *
14816     * @param item The toolbar item.
14817     * @param img The binary data that will be used as an image
14818     * @param size The size of binary data @p img
14819     * @param format Optional format of @p img to pass to the image loader
14820     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14821     *
14822     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14823     *
14824     * @note The icon image set by this function can be changed by
14825     * elm_toolbar_item_icon_set().
14826     * 
14827     * @ingroup Toolbar
14828     */
14829    EAPI Eina_Bool elm_toolbar_item_icon_memfile_set(Elm_Toolbar_Item *item, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1);
14830
14831    /**
14832     * Delete them item from the toolbar.
14833     *
14834     * @param item The item of toolbar to be deleted.
14835     *
14836     * @see elm_toolbar_item_append()
14837     * @see elm_toolbar_item_del_cb_set()
14838     *
14839     * @ingroup Toolbar
14840     */
14841    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14842
14843    /**
14844     * Set the function called when a toolbar item is freed.
14845     *
14846     * @param item The item to set the callback on.
14847     * @param func The function called.
14848     *
14849     * If there is a @p func, then it will be called prior item's memory release.
14850     * That will be called with the following arguments:
14851     * @li item's data;
14852     * @li item's Evas object;
14853     * @li item itself;
14854     *
14855     * This way, a data associated to a toolbar item could be properly freed.
14856     *
14857     * @ingroup Toolbar
14858     */
14859    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14860
14861    /**
14862     * Get a value whether toolbar item is disabled or not.
14863     *
14864     * @param item The item.
14865     * @return The disabled state.
14866     *
14867     * @see elm_toolbar_item_disabled_set() for more details.
14868     *
14869     * @ingroup Toolbar
14870     */
14871    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14872
14873    /**
14874     * Sets the disabled/enabled state of a toolbar item.
14875     *
14876     * @param item The item.
14877     * @param disabled The disabled state.
14878     *
14879     * A disabled item cannot be selected or unselected. It will also
14880     * change its appearance (generally greyed out). This sets the
14881     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14882     * enabled).
14883     *
14884     * @ingroup Toolbar
14885     */
14886    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14887
14888    /**
14889     * Set or unset item as a separator.
14890     *
14891     * @param item The toolbar item.
14892     * @param setting @c EINA_TRUE to set item @p item as separator or
14893     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14894     *
14895     * Items aren't set as separator by default.
14896     *
14897     * If set as separator it will display separator theme, so won't display
14898     * icons or label.
14899     *
14900     * @see elm_toolbar_item_separator_get()
14901     *
14902     * @ingroup Toolbar
14903     */
14904    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14905
14906    /**
14907     * Get a value whether item is a separator or not.
14908     *
14909     * @param item The toolbar item.
14910     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14911     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14912     *
14913     * @see elm_toolbar_item_separator_set() for details.
14914     *
14915     * @ingroup Toolbar
14916     */
14917    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14918
14919    /**
14920     * Set the shrink state of toolbar @p obj.
14921     *
14922     * @param obj The toolbar object.
14923     * @param shrink_mode Toolbar's items display behavior.
14924     *
14925     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14926     * but will enforce a minimun size so all the items will fit, won't scroll
14927     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14928     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14929     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14930     *
14931     * @ingroup Toolbar
14932     */
14933    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
14934
14935    /**
14936     * Get the shrink mode of toolbar @p obj.
14937     *
14938     * @param obj The toolbar object.
14939     * @return Toolbar's items display behavior.
14940     *
14941     * @see elm_toolbar_mode_shrink_set() for details.
14942     *
14943     * @ingroup Toolbar
14944     */
14945    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14946
14947    /**
14948     * Enable/disable homogenous mode.
14949     *
14950     * @param obj The toolbar object
14951     * @param homogeneous Assume the items within the toolbar are of the
14952     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14953     *
14954     * This will enable the homogeneous mode where items are of the same size.
14955     * @see elm_toolbar_homogeneous_get()
14956     *
14957     * @ingroup Toolbar
14958     */
14959    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14960
14961    /**
14962     * Get whether the homogenous mode is enabled.
14963     *
14964     * @param obj The toolbar object.
14965     * @return Assume the items within the toolbar are of the same height
14966     * and width (EINA_TRUE = on, EINA_FALSE = off).
14967     *
14968     * @see elm_toolbar_homogeneous_set()
14969     *
14970     * @ingroup Toolbar
14971     */
14972    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14973
14974    /**
14975     * Enable/disable homogenous mode.
14976     *
14977     * @param obj The toolbar object
14978     * @param homogeneous Assume the items within the toolbar are of the
14979     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14980     *
14981     * This will enable the homogeneous mode where items are of the same size.
14982     * @see elm_toolbar_homogeneous_get()
14983     *
14984     * @deprecated use elm_toolbar_homogeneous_set() instead.
14985     *
14986     * @ingroup Toolbar
14987     */
14988    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
14989
14990    /**
14991     * Get whether the homogenous mode is enabled.
14992     *
14993     * @param obj The toolbar object.
14994     * @return Assume the items within the toolbar are of the same height
14995     * and width (EINA_TRUE = on, EINA_FALSE = off).
14996     *
14997     * @see elm_toolbar_homogeneous_set()
14998     * @deprecated use elm_toolbar_homogeneous_get() instead.
14999     *
15000     * @ingroup Toolbar
15001     */
15002    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15003
15004    /**
15005     * Set the parent object of the toolbar items' menus.
15006     *
15007     * @param obj The toolbar object.
15008     * @param parent The parent of the menu objects.
15009     *
15010     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15011     *
15012     * For more details about setting the parent for toolbar menus, see
15013     * elm_menu_parent_set().
15014     *
15015     * @see elm_menu_parent_set() for details.
15016     * @see elm_toolbar_item_menu_set() for details.
15017     *
15018     * @ingroup Toolbar
15019     */
15020    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15021
15022    /**
15023     * Get the parent object of the toolbar items' menus.
15024     *
15025     * @param obj The toolbar object.
15026     * @return The parent of the menu objects.
15027     *
15028     * @see elm_toolbar_menu_parent_set() for details.
15029     *
15030     * @ingroup Toolbar
15031     */
15032    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15033
15034    /**
15035     * Set the alignment of the items.
15036     *
15037     * @param obj The toolbar object.
15038     * @param align The new alignment, a float between <tt> 0.0 </tt>
15039     * and <tt> 1.0 </tt>.
15040     *
15041     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15042     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15043     * items.
15044     *
15045     * Centered items by default.
15046     *
15047     * @see elm_toolbar_align_get()
15048     *
15049     * @ingroup Toolbar
15050     */
15051    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15052
15053    /**
15054     * Get the alignment of the items.
15055     *
15056     * @param obj The toolbar object.
15057     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15058     * <tt> 1.0 </tt>.
15059     *
15060     * @see elm_toolbar_align_set() for details.
15061     *
15062     * @ingroup Toolbar
15063     */
15064    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15065
15066    /**
15067     * Set whether the toolbar item opens a menu.
15068     *
15069     * @param item The toolbar item.
15070     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15071     *
15072     * A toolbar item can be set to be a menu, using this function.
15073     *
15074     * Once it is set to be a menu, it can be manipulated through the
15075     * menu-like function elm_toolbar_menu_parent_set() and the other
15076     * elm_menu functions, using the Evas_Object @c menu returned by
15077     * elm_toolbar_item_menu_get().
15078     *
15079     * So, items to be displayed in this item's menu should be added with
15080     * elm_menu_item_add().
15081     *
15082     * The following code exemplifies the most basic usage:
15083     * @code
15084     * tb = elm_toolbar_add(win)
15085     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15086     * elm_toolbar_item_menu_set(item, EINA_TRUE);
15087     * elm_toolbar_menu_parent_set(tb, win);
15088     * menu = elm_toolbar_item_menu_get(item);
15089     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15090     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15091     * NULL);
15092     * @endcode
15093     *
15094     * @see elm_toolbar_item_menu_get()
15095     *
15096     * @ingroup Toolbar
15097     */
15098    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15099
15100    /**
15101     * Get toolbar item's menu.
15102     *
15103     * @param item The toolbar item.
15104     * @return Item's menu object or @c NULL on failure.
15105     *
15106     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15107     * this function will set it.
15108     *
15109     * @see elm_toolbar_item_menu_set() for details.
15110     *
15111     * @ingroup Toolbar
15112     */
15113    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15114
15115    /**
15116     * Add a new state to @p item.
15117     *
15118     * @param item The item.
15119     * @param icon A string with icon name or the absolute path of an image file.
15120     * @param label The label of the new state.
15121     * @param func The function to call when the item is clicked when this
15122     * state is selected.
15123     * @param data The data to associate with the state.
15124     * @return The toolbar item state, or @c NULL upon failure.
15125     *
15126     * Toolbar will load icon image from fdo or current theme.
15127     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15128     * If an absolute path is provided it will load it direct from a file.
15129     *
15130     * States created with this function can be removed with
15131     * elm_toolbar_item_state_del().
15132     *
15133     * @see elm_toolbar_item_state_del()
15134     * @see elm_toolbar_item_state_sel()
15135     * @see elm_toolbar_item_state_get()
15136     *
15137     * @ingroup Toolbar
15138     */
15139    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);
15140
15141    /**
15142     * Delete a previoulsy added state to @p item.
15143     *
15144     * @param item The toolbar item.
15145     * @param state The state to be deleted.
15146     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15147     *
15148     * @see elm_toolbar_item_state_add()
15149     */
15150    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15151
15152    /**
15153     * Set @p state as the current state of @p it.
15154     *
15155     * @param it The item.
15156     * @param state The state to use.
15157     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15158     *
15159     * If @p state is @c NULL, it won't select any state and the default item's
15160     * icon and label will be used. It's the same behaviour than
15161     * elm_toolbar_item_state_unser().
15162     *
15163     * @see elm_toolbar_item_state_unset()
15164     *
15165     * @ingroup Toolbar
15166     */
15167    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15168
15169    /**
15170     * Unset the state of @p it.
15171     *
15172     * @param it The item.
15173     *
15174     * The default icon and label from this item will be displayed.
15175     *
15176     * @see elm_toolbar_item_state_set() for more details.
15177     *
15178     * @ingroup Toolbar
15179     */
15180    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15181
15182    /**
15183     * Get the current state of @p it.
15184     *
15185     * @param item The item.
15186     * @return The selected state or @c NULL if none is selected or on failure.
15187     *
15188     * @see elm_toolbar_item_state_set() for details.
15189     * @see elm_toolbar_item_state_unset()
15190     * @see elm_toolbar_item_state_add()
15191     *
15192     * @ingroup Toolbar
15193     */
15194    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15195
15196    /**
15197     * Get the state after selected state in toolbar's @p item.
15198     *
15199     * @param it The toolbar item to change state.
15200     * @return The state after current state, or @c NULL on failure.
15201     *
15202     * If last state is selected, this function will return first state.
15203     *
15204     * @see elm_toolbar_item_state_set()
15205     * @see elm_toolbar_item_state_add()
15206     *
15207     * @ingroup Toolbar
15208     */
15209    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15210
15211    /**
15212     * Get the state before selected state in toolbar's @p item.
15213     *
15214     * @param it The toolbar item to change state.
15215     * @return The state before current state, or @c NULL on failure.
15216     *
15217     * If first state is selected, this function will return last state.
15218     *
15219     * @see elm_toolbar_item_state_set()
15220     * @see elm_toolbar_item_state_add()
15221     *
15222     * @ingroup Toolbar
15223     */
15224    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15225
15226    /**
15227     * Set the text to be shown in a given toolbar item's tooltips.
15228     *
15229     * @param item Target item.
15230     * @param text The text to set in the content.
15231     *
15232     * Setup the text as tooltip to object. The item can have only one tooltip,
15233     * so any previous tooltip data - set with this function or
15234     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15235     *
15236     * @see elm_object_tooltip_text_set() for more details.
15237     *
15238     * @ingroup Toolbar
15239     */
15240    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15241
15242    /**
15243     * Set the content to be shown in the tooltip item.
15244     *
15245     * Setup the tooltip to item. The item can have only one tooltip,
15246     * so any previous tooltip data is removed. @p func(with @p data) will
15247     * be called every time that need show the tooltip and it should
15248     * return a valid Evas_Object. This object is then managed fully by
15249     * tooltip system and is deleted when the tooltip is gone.
15250     *
15251     * @param item the toolbar item being attached a tooltip.
15252     * @param func the function used to create the tooltip contents.
15253     * @param data what to provide to @a func as callback data/context.
15254     * @param del_cb called when data is not needed anymore, either when
15255     *        another callback replaces @a func, the tooltip is unset with
15256     *        elm_toolbar_item_tooltip_unset() or the owner @a item
15257     *        dies. This callback receives as the first parameter the
15258     *        given @a data, and @c event_info is the item.
15259     *
15260     * @see elm_object_tooltip_content_cb_set() for more details.
15261     *
15262     * @ingroup Toolbar
15263     */
15264    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);
15265
15266    /**
15267     * Unset tooltip from item.
15268     *
15269     * @param item toolbar item to remove previously set tooltip.
15270     *
15271     * Remove tooltip from item. The callback provided as del_cb to
15272     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15273     * it is not used anymore.
15274     *
15275     * @see elm_object_tooltip_unset() for more details.
15276     * @see elm_toolbar_item_tooltip_content_cb_set()
15277     *
15278     * @ingroup Toolbar
15279     */
15280    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15281
15282    /**
15283     * Sets a different style for this item tooltip.
15284     *
15285     * @note before you set a style you should define a tooltip with
15286     *       elm_toolbar_item_tooltip_content_cb_set() or
15287     *       elm_toolbar_item_tooltip_text_set()
15288     *
15289     * @param item toolbar item with tooltip already set.
15290     * @param style the theme style to use (default, transparent, ...)
15291     *
15292     * @see elm_object_tooltip_style_set() for more details.
15293     *
15294     * @ingroup Toolbar
15295     */
15296    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15297
15298    /**
15299     * Get the style for this item tooltip.
15300     *
15301     * @param item toolbar item with tooltip already set.
15302     * @return style the theme style in use, defaults to "default". If the
15303     *         object does not have a tooltip set, then NULL is returned.
15304     *
15305     * @see elm_object_tooltip_style_get() for more details.
15306     * @see elm_toolbar_item_tooltip_style_set()
15307     *
15308     * @ingroup Toolbar
15309     */
15310    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15311
15312    /**
15313     * Set the type of mouse pointer/cursor decoration to be shown,
15314     * when the mouse pointer is over the given toolbar widget item
15315     *
15316     * @param item toolbar item to customize cursor on
15317     * @param cursor the cursor type's name
15318     *
15319     * This function works analogously as elm_object_cursor_set(), but
15320     * here the cursor's changing area is restricted to the item's
15321     * area, and not the whole widget's. Note that that item cursors
15322     * have precedence over widget cursors, so that a mouse over an
15323     * item with custom cursor set will always show @b that cursor.
15324     *
15325     * If this function is called twice for an object, a previously set
15326     * cursor will be unset on the second call.
15327     *
15328     * @see elm_object_cursor_set()
15329     * @see elm_toolbar_item_cursor_get()
15330     * @see elm_toolbar_item_cursor_unset()
15331     *
15332     * @ingroup Toolbar
15333     */
15334    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15335
15336    /*
15337     * Get the type of mouse pointer/cursor decoration set to be shown,
15338     * when the mouse pointer is over the given toolbar widget item
15339     *
15340     * @param item toolbar item with custom cursor set
15341     * @return the cursor type's name or @c NULL, if no custom cursors
15342     * were set to @p item (and on errors)
15343     *
15344     * @see elm_object_cursor_get()
15345     * @see elm_toolbar_item_cursor_set()
15346     * @see elm_toolbar_item_cursor_unset()
15347     *
15348     * @ingroup Toolbar
15349     */
15350    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15351
15352    /**
15353     * Unset any custom mouse pointer/cursor decoration set to be
15354     * shown, when the mouse pointer is over the given toolbar widget
15355     * item, thus making it show the @b default cursor again.
15356     *
15357     * @param item a toolbar item
15358     *
15359     * Use this call to undo any custom settings on this item's cursor
15360     * decoration, bringing it back to defaults (no custom style set).
15361     *
15362     * @see elm_object_cursor_unset()
15363     * @see elm_toolbar_item_cursor_set()
15364     *
15365     * @ingroup Toolbar
15366     */
15367    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15368
15369    /**
15370     * Set a different @b style for a given custom cursor set for a
15371     * toolbar item.
15372     *
15373     * @param item toolbar item with custom cursor set
15374     * @param style the <b>theme style</b> to use (e.g. @c "default",
15375     * @c "transparent", etc)
15376     *
15377     * This function only makes sense when one is using custom mouse
15378     * cursor decorations <b>defined in a theme file</b>, which can have,
15379     * given a cursor name/type, <b>alternate styles</b> on it. It
15380     * works analogously as elm_object_cursor_style_set(), but here
15381     * applyed only to toolbar item objects.
15382     *
15383     * @warning Before you set a cursor style you should have definen a
15384     *       custom cursor previously on the item, with
15385     *       elm_toolbar_item_cursor_set()
15386     *
15387     * @see elm_toolbar_item_cursor_engine_only_set()
15388     * @see elm_toolbar_item_cursor_style_get()
15389     *
15390     * @ingroup Toolbar
15391     */
15392    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15393
15394    /**
15395     * Get the current @b style set for a given toolbar item's custom
15396     * cursor
15397     *
15398     * @param item toolbar item with custom cursor set.
15399     * @return style the cursor style in use. If the object does not
15400     *         have a cursor set, then @c NULL is returned.
15401     *
15402     * @see elm_toolbar_item_cursor_style_set() for more details
15403     *
15404     * @ingroup Toolbar
15405     */
15406    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15407
15408    /**
15409     * Set if the (custom)cursor for a given toolbar item should be
15410     * searched in its theme, also, or should only rely on the
15411     * rendering engine.
15412     *
15413     * @param item item with custom (custom) cursor already set on
15414     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15415     * only on those provided by the rendering engine, @c EINA_FALSE to
15416     * have them searched on the widget's theme, as well.
15417     *
15418     * @note This call is of use only if you've set a custom cursor
15419     * for toolbar items, with elm_toolbar_item_cursor_set().
15420     *
15421     * @note By default, cursors will only be looked for between those
15422     * provided by the rendering engine.
15423     *
15424     * @ingroup Toolbar
15425     */
15426    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15427
15428    /**
15429     * Get if the (custom) cursor for a given toolbar item is being
15430     * searched in its theme, also, or is only relying on the rendering
15431     * engine.
15432     *
15433     * @param item a toolbar item
15434     * @return @c EINA_TRUE, if cursors are being looked for only on
15435     * those provided by the rendering engine, @c EINA_FALSE if they
15436     * are being searched on the widget's theme, as well.
15437     *
15438     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15439     *
15440     * @ingroup Toolbar
15441     */
15442    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15443
15444    /**
15445     * Change a toolbar's orientation
15446     * @param obj The toolbar object
15447     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15448     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15449     * @ingroup Toolbar
15450     */
15451    EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15452
15453    /**
15454     * Get a toolbar's orientation
15455     * @param obj The toolbar object
15456     * @return If @c EINA_TRUE, the toolbar is vertical
15457     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15458     * @ingroup Toolbar
15459     */
15460    EAPI Eina_Bool        elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
15461
15462    /**
15463     * @}
15464     */
15465
15466    /**
15467     * @defgroup Tooltips Tooltips
15468     *
15469     * The Tooltip is an (internal, for now) smart object used to show a
15470     * content in a frame on mouse hover of objects(or widgets), with
15471     * tips/information about them.
15472     *
15473     * @{
15474     */
15475
15476    EAPI double       elm_tooltip_delay_get(void);
15477    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
15478    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15479    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15480    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15481    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15482 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15483    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);
15484    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15485    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15486    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15487    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15488    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15489
15490    /**
15491     * @}
15492     */
15493
15494    /**
15495     * @defgroup Cursors Cursors
15496     *
15497     * The Elementary cursor is an internal smart object used to
15498     * customize the mouse cursor displayed over objects (or
15499     * widgets). In the most common scenario, the cursor decoration
15500     * comes from the graphical @b engine Elementary is running
15501     * on. Those engines may provide different decorations for cursors,
15502     * and Elementary provides functions to choose them (think of X11
15503     * cursors, as an example).
15504     *
15505     * There's also the possibility of, besides using engine provided
15506     * cursors, also use ones coming from Edje theming files. Both
15507     * globally and per widget, Elementary makes it possible for one to
15508     * make the cursors lookup to be held on engines only or on
15509     * Elementary's theme file, too.
15510     *
15511     * @{
15512     */
15513
15514    /**
15515     * Set the cursor to be shown when mouse is over the object
15516     *
15517     * Set the cursor that will be displayed when mouse is over the
15518     * object. The object can have only one cursor set to it, so if
15519     * this function is called twice for an object, the previous set
15520     * will be unset.
15521     * If using X cursors, a definition of all the valid cursor names
15522     * is listed on Elementary_Cursors.h. If an invalid name is set
15523     * the default cursor will be used.
15524     *
15525     * @param obj the object being set a cursor.
15526     * @param cursor the cursor name to be used.
15527     *
15528     * @ingroup Cursors
15529     */
15530    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15531
15532    /**
15533     * Get the cursor to be shown when mouse is over the object
15534     *
15535     * @param obj an object with cursor already set.
15536     * @return the cursor name.
15537     *
15538     * @ingroup Cursors
15539     */
15540    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15541
15542    /**
15543     * Unset cursor for object
15544     *
15545     * Unset cursor for object, and set the cursor to default if the mouse
15546     * was over this object.
15547     *
15548     * @param obj Target object
15549     * @see elm_object_cursor_set()
15550     *
15551     * @ingroup Cursors
15552     */
15553    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15554
15555    /**
15556     * Sets a different style for this object cursor.
15557     *
15558     * @note before you set a style you should define a cursor with
15559     *       elm_object_cursor_set()
15560     *
15561     * @param obj an object with cursor already set.
15562     * @param style the theme style to use (default, transparent, ...)
15563     *
15564     * @ingroup Cursors
15565     */
15566    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15567
15568    /**
15569     * Get the style for this object cursor.
15570     *
15571     * @param obj an object with cursor already set.
15572     * @return style the theme style in use, defaults to "default". If the
15573     *         object does not have a cursor set, then NULL is returned.
15574     *
15575     * @ingroup Cursors
15576     */
15577    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15578
15579    /**
15580     * Set if the cursor set should be searched on the theme or should use
15581     * the provided by the engine, only.
15582     *
15583     * @note before you set if should look on theme you should define a cursor
15584     * with elm_object_cursor_set(). By default it will only look for cursors
15585     * provided by the engine.
15586     *
15587     * @param obj an object with cursor already set.
15588     * @param engine_only boolean to define it cursors should be looked only
15589     * between the provided by the engine or searched on widget's theme as well.
15590     *
15591     * @ingroup Cursors
15592     */
15593    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15594
15595    /**
15596     * Get the cursor engine only usage for this object cursor.
15597     *
15598     * @param obj an object with cursor already set.
15599     * @return engine_only boolean to define it cursors should be
15600     * looked only between the provided by the engine or searched on
15601     * widget's theme as well. If the object does not have a cursor
15602     * set, then EINA_FALSE is returned.
15603     *
15604     * @ingroup Cursors
15605     */
15606    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15607
15608    /**
15609     * Get the configured cursor engine only usage
15610     *
15611     * This gets the globally configured exclusive usage of engine cursors.
15612     *
15613     * @return 1 if only engine cursors should be used
15614     * @ingroup Cursors
15615     */
15616    EAPI int          elm_cursor_engine_only_get(void);
15617
15618    /**
15619     * Set the configured cursor engine only usage
15620     *
15621     * This sets the globally configured exclusive usage of engine cursors.
15622     * It won't affect cursors set before changing this value.
15623     *
15624     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15625     * look for them on theme before.
15626     * @return EINA_TRUE if value is valid and setted (0 or 1)
15627     * @ingroup Cursors
15628     */
15629    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
15630
15631    /**
15632     * @}
15633     */
15634
15635    /**
15636     * @defgroup Menu Menu
15637     *
15638     * @image html img/widget/menu/preview-00.png
15639     * @image latex img/widget/menu/preview-00.eps
15640     *
15641     * A menu is a list of items displayed above its parent. When the menu is
15642     * showing its parent is darkened. Each item can have a sub-menu. The menu
15643     * object can be used to display a menu on a right click event, in a toolbar,
15644     * anywhere.
15645     *
15646     * Signals that you can add callbacks for are:
15647     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15648     *             event_info is NULL.
15649     *
15650     * @see @ref tutorial_menu
15651     * @{
15652     */
15653    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15654    /**
15655     * @brief Add a new menu to the parent
15656     *
15657     * @param parent The parent object.
15658     * @return The new object or NULL if it cannot be created.
15659     */
15660    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15661    /**
15662     * @brief Set the parent for the given menu widget
15663     *
15664     * @param obj The menu object.
15665     * @param parent The new parent.
15666     */
15667    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15668    /**
15669     * @brief Get the parent for the given menu widget
15670     *
15671     * @param obj The menu object.
15672     * @return The parent.
15673     *
15674     * @see elm_menu_parent_set()
15675     */
15676    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15677    /**
15678     * @brief Move the menu to a new position
15679     *
15680     * @param obj The menu object.
15681     * @param x The new position.
15682     * @param y The new position.
15683     *
15684     * Sets the top-left position of the menu to (@p x,@p y).
15685     *
15686     * @note @p x and @p y coordinates are relative to parent.
15687     */
15688    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15689    /**
15690     * @brief Close a opened menu
15691     *
15692     * @param obj the menu object
15693     * @return void
15694     *
15695     * Hides the menu and all it's sub-menus.
15696     */
15697    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15698    /**
15699     * @brief Returns a list of @p item's items.
15700     *
15701     * @param obj The menu object
15702     * @return An Eina_List* of @p item's items
15703     */
15704    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15705    /**
15706     * @brief Get the Evas_Object of an Elm_Menu_Item
15707     *
15708     * @param item The menu item object.
15709     * @return The edje object containing the swallowed content
15710     *
15711     * @warning Don't manipulate this object!
15712     */
15713    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15714    /**
15715     * @brief Add an item at the end of the given menu widget
15716     *
15717     * @param obj The menu object.
15718     * @param parent The parent menu item (optional)
15719     * @param icon A icon display on the item. The icon will be destryed by the menu.
15720     * @param label The label of the item.
15721     * @param func Function called when the user select the item.
15722     * @param data Data sent by the callback.
15723     * @return Returns the new item.
15724     */
15725    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);
15726    /**
15727     * @brief Add an object swallowed in an item at the end of the given menu
15728     * widget
15729     *
15730     * @param obj The menu object.
15731     * @param parent The parent menu item (optional)
15732     * @param subobj The object to swallow
15733     * @param func Function called when the user select the item.
15734     * @param data Data sent by the callback.
15735     * @return Returns the new item.
15736     *
15737     * Add an evas object as an item to the menu.
15738     */
15739    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);
15740    /**
15741     * @brief Set the label of a menu item
15742     *
15743     * @param item The menu item object.
15744     * @param label The label to set for @p item
15745     *
15746     * @warning Don't use this funcion on items created with
15747     * elm_menu_item_add_object() or elm_menu_item_separator_add().
15748     */
15749    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15750    /**
15751     * @brief Get the label of a menu item
15752     *
15753     * @param item The menu item object.
15754     * @return The label of @p item
15755     */
15756    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15757    /**
15758     * @brief Set the icon of a menu item to the standard icon with name @p icon
15759     *
15760     * @param item The menu item object.
15761     * @param icon The icon object to set for the content of @p item
15762     *
15763     * Once this icon is set, any previously set icon will be deleted.
15764     */
15765    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15766    /**
15767     * @brief Get the string representation from the icon of a menu item
15768     *
15769     * @param item The menu item object.
15770     * @return The string representation of @p item's icon or NULL
15771     *
15772     * @see elm_menu_item_object_icon_name_set()
15773     */
15774    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15775    /**
15776     * @brief Set the content object of a menu item
15777     *
15778     * @param item The menu item object
15779     * @param The content object or NULL
15780     * @return EINA_TRUE on success, else EINA_FALSE
15781     *
15782     * Use this function to change the object swallowed by a menu item, deleting
15783     * any previously swallowed object.
15784     */
15785    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15786    /**
15787     * @brief Get the content object of a menu item
15788     *
15789     * @param item The menu item object
15790     * @return The content object or NULL
15791     * @note If @p item was added with elm_menu_item_add_object, this
15792     * function will return the object passed, else it will return the
15793     * icon object.
15794     *
15795     * @see elm_menu_item_object_content_set()
15796     */
15797    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15798    /**
15799     * @brief Set the selected state of @p item.
15800     *
15801     * @param item The menu item object.
15802     * @param selected The selected/unselected state of the item
15803     */
15804    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15805    /**
15806     * @brief Get the selected state of @p item.
15807     *
15808     * @param item The menu item object.
15809     * @return The selected/unselected state of the item
15810     *
15811     * @see elm_menu_item_selected_set()
15812     */
15813    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15814    /**
15815     * @brief Set the disabled state of @p item.
15816     *
15817     * @param item The menu item object.
15818     * @param disabled The enabled/disabled state of the item
15819     */
15820    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15821    /**
15822     * @brief Get the disabled state of @p item.
15823     *
15824     * @param item The menu item object.
15825     * @return The enabled/disabled state of the item
15826     *
15827     * @see elm_menu_item_disabled_set()
15828     */
15829    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15830    /**
15831     * @brief Add a separator item to menu @p obj under @p parent.
15832     *
15833     * @param obj The menu object
15834     * @param parent The item to add the separator under
15835     * @return The created item or NULL on failure
15836     *
15837     * This is item is a @ref Separator.
15838     */
15839    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15840    /**
15841     * @brief Returns whether @p item is a separator.
15842     *
15843     * @param item The item to check
15844     * @return If true, @p item is a separator
15845     *
15846     * @see elm_menu_item_separator_add()
15847     */
15848    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15849    /**
15850     * @brief Deletes an item from the menu.
15851     *
15852     * @param item The item to delete.
15853     *
15854     * @see elm_menu_item_add()
15855     */
15856    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15857    /**
15858     * @brief Set the function called when a menu item is deleted.
15859     *
15860     * @param item The item to set the callback on
15861     * @param func The function called
15862     *
15863     * @see elm_menu_item_add()
15864     * @see elm_menu_item_del()
15865     */
15866    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15867    /**
15868     * @brief Returns the data associated with menu item @p item.
15869     *
15870     * @param item The item
15871     * @return The data associated with @p item or NULL if none was set.
15872     *
15873     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15874     */
15875    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15876    /**
15877     * @brief Sets the data to be associated with menu item @p item.
15878     *
15879     * @param item The item
15880     * @param data The data to be associated with @p item
15881     */
15882    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15883    /**
15884     * @brief Returns a list of @p item's subitems.
15885     *
15886     * @param item The item
15887     * @return An Eina_List* of @p item's subitems
15888     *
15889     * @see elm_menu_add()
15890     */
15891    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15892    /**
15893     * @brief Get the position of a menu item
15894     *
15895     * @param item The menu item
15896     * @return The item's index
15897     *
15898     * This function returns the index position of a menu item in a menu.
15899     * For a sub-menu, this number is relative to the first item in the sub-menu.
15900     *
15901     * @note Index values begin with 0
15902     */
15903    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15904    /**
15905     * @brief @brief Return a menu item's owner menu
15906     *
15907     * @param item The menu item
15908     * @return The menu object owning @p item, or NULL on failure
15909     *
15910     * Use this function to get the menu object owning an item.
15911     */
15912    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15913    /**
15914     * @brief Get the selected item in the menu
15915     *
15916     * @param obj The menu object
15917     * @return The selected item, or NULL if none
15918     *
15919     * @see elm_menu_item_selected_get()
15920     * @see elm_menu_item_selected_set()
15921     */
15922    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15923    /**
15924     * @brief Get the last item in the menu
15925     *
15926     * @param obj The menu object
15927     * @return The last item, or NULL if none
15928     */
15929    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15930    /**
15931     * @brief Get the first item in the menu
15932     *
15933     * @param obj The menu object
15934     * @return The first item, or NULL if none
15935     */
15936    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15937    /**
15938     * @brief Get the next item in the menu.
15939     *
15940     * @param item The menu item object.
15941     * @return The item after it, or NULL if none
15942     */
15943    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15944    /**
15945     * @brief Get the previous item in the menu.
15946     *
15947     * @param item The menu item object.
15948     * @return The item before it, or NULL if none
15949     */
15950    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15951    /**
15952     * @}
15953     */
15954
15955    /**
15956     * @defgroup List List
15957     * @ingroup Elementary
15958     *
15959     * @image html img/widget/list/preview-00.png
15960     * @image latex img/widget/list/preview-00.eps width=\textwidth
15961     *
15962     * @image html img/list.png
15963     * @image latex img/list.eps width=\textwidth
15964     *
15965     * A list widget is a container whose children are displayed vertically or
15966     * horizontally, in order, and can be selected.
15967     * The list can accept only one or multiple items selection. Also has many
15968     * modes of items displaying.
15969     *
15970     * A list is a very simple type of list widget.  For more robust
15971     * lists, @ref Genlist should probably be used.
15972     *
15973     * Smart callbacks one can listen to:
15974     * - @c "activated" - The user has double-clicked or pressed
15975     *   (enter|return|spacebar) on an item. The @c event_info parameter
15976     *   is the item that was activated.
15977     * - @c "clicked,double" - The user has double-clicked an item.
15978     *   The @c event_info parameter is the item that was double-clicked.
15979     * - "selected" - when the user selected an item
15980     * - "unselected" - when the user unselected an item
15981     * - "longpressed" - an item in the list is long-pressed
15982     * - "edge,top" - the list is scrolled until the top edge
15983     * - "edge,bottom" - the list is scrolled until the bottom edge
15984     * - "edge,left" - the list is scrolled until the left edge
15985     * - "edge,right" - the list is scrolled until the right edge
15986     * - "language,changed" - the program's language changed
15987     *
15988     * Available styles for it:
15989     * - @c "default"
15990     *
15991     * List of examples:
15992     * @li @ref list_example_01
15993     * @li @ref list_example_02
15994     * @li @ref list_example_03
15995     */
15996
15997    /**
15998     * @addtogroup List
15999     * @{
16000     */
16001
16002    /**
16003     * @enum _Elm_List_Mode
16004     * @typedef Elm_List_Mode
16005     *
16006     * Set list's resize behavior, transverse axis scroll and
16007     * items cropping. See each mode's description for more details.
16008     *
16009     * @note Default value is #ELM_LIST_SCROLL.
16010     *
16011     * Values <b> don't </b> work as bitmask, only one can be choosen.
16012     *
16013     * @see elm_list_mode_set()
16014     * @see elm_list_mode_get()
16015     *
16016     * @ingroup List
16017     */
16018    typedef enum _Elm_List_Mode
16019      {
16020         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. */
16021         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). */
16022         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. */
16023         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. */
16024         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16025      } Elm_List_Mode;
16026
16027    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().  */
16028
16029    /**
16030     * Add a new list widget to the given parent Elementary
16031     * (container) object.
16032     *
16033     * @param parent The parent object.
16034     * @return a new list widget handle or @c NULL, on errors.
16035     *
16036     * This function inserts a new list widget on the canvas.
16037     *
16038     * @ingroup List
16039     */
16040    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16041
16042    /**
16043     * Starts the list.
16044     *
16045     * @param obj The list object
16046     *
16047     * @note Call before running show() on the list object.
16048     * @warning If not called, it won't display the list properly.
16049     *
16050     * @code
16051     * li = elm_list_add(win);
16052     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16053     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16054     * elm_list_go(li);
16055     * evas_object_show(li);
16056     * @endcode
16057     *
16058     * @ingroup List
16059     */
16060    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16061
16062    /**
16063     * Enable or disable multiple items selection on the list object.
16064     *
16065     * @param obj The list object
16066     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16067     * disable it.
16068     *
16069     * Disabled by default. If disabled, the user can select a single item of
16070     * the list each time. Selected items are highlighted on list.
16071     * If enabled, many items can be selected.
16072     *
16073     * If a selected item is selected again, it will be unselected.
16074     *
16075     * @see elm_list_multi_select_get()
16076     *
16077     * @ingroup List
16078     */
16079    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16080
16081    /**
16082     * Get a value whether multiple items selection is enabled or not.
16083     *
16084     * @see elm_list_multi_select_set() for details.
16085     *
16086     * @param obj The list object.
16087     * @return @c EINA_TRUE means multiple items selection is enabled.
16088     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16089     * @c EINA_FALSE is returned.
16090     *
16091     * @ingroup List
16092     */
16093    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16094
16095    /**
16096     * Set which mode to use for the list object.
16097     *
16098     * @param obj The list object
16099     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16100     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16101     *
16102     * Set list's resize behavior, transverse axis scroll and
16103     * items cropping. See each mode's description for more details.
16104     *
16105     * @note Default value is #ELM_LIST_SCROLL.
16106     *
16107     * Only one can be set, if a previous one was set, it will be changed
16108     * by the new mode set. Bitmask won't work as well.
16109     *
16110     * @see elm_list_mode_get()
16111     *
16112     * @ingroup List
16113     */
16114    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16115
16116    /**
16117     * Get the mode the list is at.
16118     *
16119     * @param obj The list object
16120     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16121     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16122     *
16123     * @note see elm_list_mode_set() for more information.
16124     *
16125     * @ingroup List
16126     */
16127    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16128
16129    /**
16130     * Enable or disable horizontal mode on the list object.
16131     *
16132     * @param obj The list object.
16133     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16134     * disable it, i.e., to enable vertical mode.
16135     *
16136     * @note Vertical mode is set by default.
16137     *
16138     * On horizontal mode items are displayed on list from left to right,
16139     * instead of from top to bottom. Also, the list will scroll horizontally.
16140     * Each item will presents left icon on top and right icon, or end, at
16141     * the bottom.
16142     *
16143     * @see elm_list_horizontal_get()
16144     *
16145     * @ingroup List
16146     */
16147    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16148
16149    /**
16150     * Get a value whether horizontal mode is enabled or not.
16151     *
16152     * @param obj The list object.
16153     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16154     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16155     * @c EINA_FALSE is returned.
16156     *
16157     * @see elm_list_horizontal_set() for details.
16158     *
16159     * @ingroup List
16160     */
16161    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16162
16163    /**
16164     * Enable or disable always select mode on the list object.
16165     *
16166     * @param obj The list object
16167     * @param always_select @c EINA_TRUE to enable always select mode or
16168     * @c EINA_FALSE to disable it.
16169     *
16170     * @note Always select mode is disabled by default.
16171     *
16172     * Default behavior of list items is to only call its callback function
16173     * the first time it's pressed, i.e., when it is selected. If a selected
16174     * item is pressed again, and multi-select is disabled, it won't call
16175     * this function (if multi-select is enabled it will unselect the item).
16176     *
16177     * If always select is enabled, it will call the callback function
16178     * everytime a item is pressed, so it will call when the item is selected,
16179     * and again when a selected item is pressed.
16180     *
16181     * @see elm_list_always_select_mode_get()
16182     * @see elm_list_multi_select_set()
16183     *
16184     * @ingroup List
16185     */
16186    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16187
16188    /**
16189     * Get a value whether always select mode is enabled or not, meaning that
16190     * an item will always call its callback function, even if already selected.
16191     *
16192     * @param obj The list object
16193     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16194     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16195     * @c EINA_FALSE is returned.
16196     *
16197     * @see elm_list_always_select_mode_set() for details.
16198     *
16199     * @ingroup List
16200     */
16201    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16202
16203    /**
16204     * Set bouncing behaviour when the scrolled content reaches an edge.
16205     *
16206     * Tell the internal scroller object whether it should bounce or not
16207     * when it reaches the respective edges for each axis.
16208     *
16209     * @param obj The list object
16210     * @param h_bounce Whether to bounce or not in the horizontal axis.
16211     * @param v_bounce Whether to bounce or not in the vertical axis.
16212     *
16213     * @see elm_scroller_bounce_set()
16214     *
16215     * @ingroup List
16216     */
16217    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16218
16219    /**
16220     * Get the bouncing behaviour of the internal scroller.
16221     *
16222     * Get whether the internal scroller should bounce when the edge of each
16223     * axis is reached scrolling.
16224     *
16225     * @param obj The list object.
16226     * @param h_bounce Pointer where to store the bounce state of the horizontal
16227     * axis.
16228     * @param v_bounce Pointer where to store the bounce state of the vertical
16229     * axis.
16230     *
16231     * @see elm_scroller_bounce_get()
16232     * @see elm_list_bounce_set()
16233     *
16234     * @ingroup List
16235     */
16236    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16237
16238    /**
16239     * Set the scrollbar policy.
16240     *
16241     * @param obj The list object
16242     * @param policy_h Horizontal scrollbar policy.
16243     * @param policy_v Vertical scrollbar policy.
16244     *
16245     * This sets the scrollbar visibility policy for the given scroller.
16246     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16247     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16248     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16249     * This applies respectively for the horizontal and vertical scrollbars.
16250     *
16251     * The both are disabled by default, i.e., are set to
16252     * #ELM_SCROLLER_POLICY_OFF.
16253     *
16254     * @ingroup List
16255     */
16256    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16257
16258    /**
16259     * Get the scrollbar policy.
16260     *
16261     * @see elm_list_scroller_policy_get() for details.
16262     *
16263     * @param obj The list object.
16264     * @param policy_h Pointer where to store horizontal scrollbar policy.
16265     * @param policy_v Pointer where to store vertical scrollbar policy.
16266     *
16267     * @ingroup List
16268     */
16269    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);
16270
16271    /**
16272     * Append a new item to the list object.
16273     *
16274     * @param obj The list object.
16275     * @param label The label of the list item.
16276     * @param icon The icon object to use for the left side of the item. An
16277     * icon can be any Evas object, but usually it is an icon created
16278     * with elm_icon_add().
16279     * @param end The icon object to use for the right side of the item. An
16280     * icon can be any Evas object.
16281     * @param func The function to call when the item is clicked.
16282     * @param data The data to associate with the item for related callbacks.
16283     *
16284     * @return The created item or @c NULL upon failure.
16285     *
16286     * A new item will be created and appended to the list, i.e., will
16287     * be set as @b last item.
16288     *
16289     * Items created with this method can be deleted with
16290     * elm_list_item_del().
16291     *
16292     * Associated @p data can be properly freed when item is deleted if a
16293     * callback function is set with elm_list_item_del_cb_set().
16294     *
16295     * If a function is passed as argument, it will be called everytime this item
16296     * is selected, i.e., the user clicks over an unselected item.
16297     * If always select is enabled it will call this function every time
16298     * user clicks over an item (already selected or not).
16299     * If such function isn't needed, just passing
16300     * @c NULL as @p func is enough. The same should be done for @p data.
16301     *
16302     * Simple example (with no function callback or data associated):
16303     * @code
16304     * li = elm_list_add(win);
16305     * ic = elm_icon_add(win);
16306     * elm_icon_file_set(ic, "path/to/image", NULL);
16307     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16308     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16309     * elm_list_go(li);
16310     * evas_object_show(li);
16311     * @endcode
16312     *
16313     * @see elm_list_always_select_mode_set()
16314     * @see elm_list_item_del()
16315     * @see elm_list_item_del_cb_set()
16316     * @see elm_list_clear()
16317     * @see elm_icon_add()
16318     *
16319     * @ingroup List
16320     */
16321    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);
16322
16323    /**
16324     * Prepend a new item to the list object.
16325     *
16326     * @param obj The list object.
16327     * @param label The label of the list item.
16328     * @param icon The icon object to use for the left side of the item. An
16329     * icon can be any Evas object, but usually it is an icon created
16330     * with elm_icon_add().
16331     * @param end The icon object to use for the right side of the item. An
16332     * icon can be any Evas object.
16333     * @param func The function to call when the item is clicked.
16334     * @param data The data to associate with the item for related callbacks.
16335     *
16336     * @return The created item or @c NULL upon failure.
16337     *
16338     * A new item will be created and prepended to the list, i.e., will
16339     * be set as @b first item.
16340     *
16341     * Items created with this method can be deleted with
16342     * elm_list_item_del().
16343     *
16344     * Associated @p data can be properly freed when item is deleted if a
16345     * callback function is set with elm_list_item_del_cb_set().
16346     *
16347     * If a function is passed as argument, it will be called everytime this item
16348     * is selected, i.e., the user clicks over an unselected item.
16349     * If always select is enabled it will call this function every time
16350     * user clicks over an item (already selected or not).
16351     * If such function isn't needed, just passing
16352     * @c NULL as @p func is enough. The same should be done for @p data.
16353     *
16354     * @see elm_list_item_append() for a simple code example.
16355     * @see elm_list_always_select_mode_set()
16356     * @see elm_list_item_del()
16357     * @see elm_list_item_del_cb_set()
16358     * @see elm_list_clear()
16359     * @see elm_icon_add()
16360     *
16361     * @ingroup List
16362     */
16363    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);
16364
16365    /**
16366     * Insert a new item into the list object before item @p before.
16367     *
16368     * @param obj The list object.
16369     * @param before The list item to insert before.
16370     * @param label The label of the list item.
16371     * @param icon The icon object to use for the left side of the item. An
16372     * icon can be any Evas object, but usually it is an icon created
16373     * with elm_icon_add().
16374     * @param end The icon object to use for the right side of the item. An
16375     * icon can be any Evas object.
16376     * @param func The function to call when the item is clicked.
16377     * @param data The data to associate with the item for related callbacks.
16378     *
16379     * @return The created item or @c NULL upon failure.
16380     *
16381     * A new item will be created and added to the list. Its position in
16382     * this list will be just before item @p before.
16383     *
16384     * Items created with this method can be deleted with
16385     * elm_list_item_del().
16386     *
16387     * Associated @p data can be properly freed when item is deleted if a
16388     * callback function is set with elm_list_item_del_cb_set().
16389     *
16390     * If a function is passed as argument, it will be called everytime this item
16391     * is selected, i.e., the user clicks over an unselected item.
16392     * If always select is enabled it will call this function every time
16393     * user clicks over an item (already selected or not).
16394     * If such function isn't needed, just passing
16395     * @c NULL as @p func is enough. The same should be done for @p data.
16396     *
16397     * @see elm_list_item_append() for a simple code example.
16398     * @see elm_list_always_select_mode_set()
16399     * @see elm_list_item_del()
16400     * @see elm_list_item_del_cb_set()
16401     * @see elm_list_clear()
16402     * @see elm_icon_add()
16403     *
16404     * @ingroup List
16405     */
16406    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);
16407
16408    /**
16409     * Insert a new item into the list object after item @p after.
16410     *
16411     * @param obj The list object.
16412     * @param after The list item to insert after.
16413     * @param label The label of the list item.
16414     * @param icon The icon object to use for the left side of the item. An
16415     * icon can be any Evas object, but usually it is an icon created
16416     * with elm_icon_add().
16417     * @param end The icon object to use for the right side of the item. An
16418     * icon can be any Evas object.
16419     * @param func The function to call when the item is clicked.
16420     * @param data The data to associate with the item for related callbacks.
16421     *
16422     * @return The created item or @c NULL upon failure.
16423     *
16424     * A new item will be created and added to the list. Its position in
16425     * this list will be just after item @p after.
16426     *
16427     * Items created with this method can be deleted with
16428     * elm_list_item_del().
16429     *
16430     * Associated @p data can be properly freed when item is deleted if a
16431     * callback function is set with elm_list_item_del_cb_set().
16432     *
16433     * If a function is passed as argument, it will be called everytime this item
16434     * is selected, i.e., the user clicks over an unselected item.
16435     * If always select is enabled it will call this function every time
16436     * user clicks over an item (already selected or not).
16437     * If such function isn't needed, just passing
16438     * @c NULL as @p func is enough. The same should be done for @p data.
16439     *
16440     * @see elm_list_item_append() for a simple code example.
16441     * @see elm_list_always_select_mode_set()
16442     * @see elm_list_item_del()
16443     * @see elm_list_item_del_cb_set()
16444     * @see elm_list_clear()
16445     * @see elm_icon_add()
16446     *
16447     * @ingroup List
16448     */
16449    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);
16450
16451    /**
16452     * Insert a new item into the sorted list object.
16453     *
16454     * @param obj The list object.
16455     * @param label The label of the list item.
16456     * @param icon The icon object to use for the left side of the item. An
16457     * icon can be any Evas object, but usually it is an icon created
16458     * with elm_icon_add().
16459     * @param end The icon object to use for the right side of the item. An
16460     * icon can be any Evas object.
16461     * @param func The function to call when the item is clicked.
16462     * @param data The data to associate with the item for related callbacks.
16463     * @param cmp_func The comparing function to be used to sort list
16464     * items <b>by #Elm_List_Item item handles</b>. This function will
16465     * receive two items and compare them, returning a non-negative integer
16466     * if the second item should be place after the first, or negative value
16467     * if should be placed before.
16468     *
16469     * @return The created item or @c NULL upon failure.
16470     *
16471     * @note This function inserts values into a list object assuming it was
16472     * sorted and the result will be sorted.
16473     *
16474     * A new item will be created and added to the list. Its position in
16475     * this list will be found comparing the new item with previously inserted
16476     * items using function @p cmp_func.
16477     *
16478     * Items created with this method can be deleted with
16479     * elm_list_item_del().
16480     *
16481     * Associated @p data can be properly freed when item is deleted if a
16482     * callback function is set with elm_list_item_del_cb_set().
16483     *
16484     * If a function is passed as argument, it will be called everytime this item
16485     * is selected, i.e., the user clicks over an unselected item.
16486     * If always select is enabled it will call this function every time
16487     * user clicks over an item (already selected or not).
16488     * If such function isn't needed, just passing
16489     * @c NULL as @p func is enough. The same should be done for @p data.
16490     *
16491     * @see elm_list_item_append() for a simple code example.
16492     * @see elm_list_always_select_mode_set()
16493     * @see elm_list_item_del()
16494     * @see elm_list_item_del_cb_set()
16495     * @see elm_list_clear()
16496     * @see elm_icon_add()
16497     *
16498     * @ingroup List
16499     */
16500    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);
16501
16502    /**
16503     * Remove all list's items.
16504     *
16505     * @param obj The list object
16506     *
16507     * @see elm_list_item_del()
16508     * @see elm_list_item_append()
16509     *
16510     * @ingroup List
16511     */
16512    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16513
16514    /**
16515     * Get a list of all the list items.
16516     *
16517     * @param obj The list object
16518     * @return An @c Eina_List of list items, #Elm_List_Item,
16519     * or @c NULL on failure.
16520     *
16521     * @see elm_list_item_append()
16522     * @see elm_list_item_del()
16523     * @see elm_list_clear()
16524     *
16525     * @ingroup List
16526     */
16527    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16528
16529    /**
16530     * Get the selected item.
16531     *
16532     * @param obj The list object.
16533     * @return The selected list item.
16534     *
16535     * The selected item can be unselected with function
16536     * elm_list_item_selected_set().
16537     *
16538     * The selected item always will be highlighted on list.
16539     *
16540     * @see elm_list_selected_items_get()
16541     *
16542     * @ingroup List
16543     */
16544    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16545
16546    /**
16547     * Return a list of the currently selected list items.
16548     *
16549     * @param obj The list object.
16550     * @return An @c Eina_List of list items, #Elm_List_Item,
16551     * or @c NULL on failure.
16552     *
16553     * Multiple items can be selected if multi select is enabled. It can be
16554     * done with elm_list_multi_select_set().
16555     *
16556     * @see elm_list_selected_item_get()
16557     * @see elm_list_multi_select_set()
16558     *
16559     * @ingroup List
16560     */
16561    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16562
16563    /**
16564     * Set the selected state of an item.
16565     *
16566     * @param item The list item
16567     * @param selected The selected state
16568     *
16569     * This sets the selected state of the given item @p it.
16570     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16571     *
16572     * If a new item is selected the previosly selected will be unselected,
16573     * unless multiple selection is enabled with elm_list_multi_select_set().
16574     * Previoulsy selected item can be get with function
16575     * elm_list_selected_item_get().
16576     *
16577     * Selected items will be highlighted.
16578     *
16579     * @see elm_list_item_selected_get()
16580     * @see elm_list_selected_item_get()
16581     * @see elm_list_multi_select_set()
16582     *
16583     * @ingroup List
16584     */
16585    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16586
16587    /*
16588     * Get whether the @p item is selected or not.
16589     *
16590     * @param item The list item.
16591     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16592     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16593     *
16594     * @see elm_list_selected_item_set() for details.
16595     * @see elm_list_item_selected_get()
16596     *
16597     * @ingroup List
16598     */
16599    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16600
16601    /**
16602     * Set or unset item as a separator.
16603     *
16604     * @param it The list item.
16605     * @param setting @c EINA_TRUE to set item @p it as separator or
16606     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16607     *
16608     * Items aren't set as separator by default.
16609     *
16610     * If set as separator it will display separator theme, so won't display
16611     * icons or label.
16612     *
16613     * @see elm_list_item_separator_get()
16614     *
16615     * @ingroup List
16616     */
16617    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16618
16619    /**
16620     * Get a value whether item is a separator or not.
16621     *
16622     * @see elm_list_item_separator_set() for details.
16623     *
16624     * @param it The list item.
16625     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16626     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16627     *
16628     * @ingroup List
16629     */
16630    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16631
16632    /**
16633     * Show @p item in the list view.
16634     *
16635     * @param item The list item to be shown.
16636     *
16637     * It won't animate list until item is visible. If such behavior is wanted,
16638     * use elm_list_bring_in() intead.
16639     *
16640     * @ingroup List
16641     */
16642    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16643
16644    /**
16645     * Bring in the given item to list view.
16646     *
16647     * @param item The item.
16648     *
16649     * This causes list to jump to the given item @p item and show it
16650     * (by scrolling), if it is not fully visible.
16651     *
16652     * This may use animation to do so and take a period of time.
16653     *
16654     * If animation isn't wanted, elm_list_item_show() can be used.
16655     *
16656     * @ingroup List
16657     */
16658    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16659
16660    /**
16661     * Delete them item from the list.
16662     *
16663     * @param item The item of list to be deleted.
16664     *
16665     * If deleting all list items is required, elm_list_clear()
16666     * should be used instead of getting items list and deleting each one.
16667     *
16668     * @see elm_list_clear()
16669     * @see elm_list_item_append()
16670     * @see elm_list_item_del_cb_set()
16671     *
16672     * @ingroup List
16673     */
16674    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16675
16676    /**
16677     * Set the function called when a list item is freed.
16678     *
16679     * @param item The item to set the callback on
16680     * @param func The function called
16681     *
16682     * If there is a @p func, then it will be called prior item's memory release.
16683     * That will be called with the following arguments:
16684     * @li item's data;
16685     * @li item's Evas object;
16686     * @li item itself;
16687     *
16688     * This way, a data associated to a list item could be properly freed.
16689     *
16690     * @ingroup List
16691     */
16692    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16693
16694    /**
16695     * Get the data associated to the item.
16696     *
16697     * @param item The list item
16698     * @return The data associated to @p item
16699     *
16700     * The return value is a pointer to data associated to @p item when it was
16701     * created, with function elm_list_item_append() or similar. If no data
16702     * was passed as argument, it will return @c NULL.
16703     *
16704     * @see elm_list_item_append()
16705     *
16706     * @ingroup List
16707     */
16708    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16709
16710    /**
16711     * Get the left side icon associated to the item.
16712     *
16713     * @param item The list item
16714     * @return The left side icon associated to @p item
16715     *
16716     * The return value is a pointer to the icon associated to @p item when
16717     * it was
16718     * created, with function elm_list_item_append() or similar, or later
16719     * with function elm_list_item_icon_set(). If no icon
16720     * was passed as argument, it will return @c NULL.
16721     *
16722     * @see elm_list_item_append()
16723     * @see elm_list_item_icon_set()
16724     *
16725     * @ingroup List
16726     */
16727    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16728
16729    /**
16730     * Set the left side icon associated to the item.
16731     *
16732     * @param item The list item
16733     * @param icon The left side icon object to associate with @p item
16734     *
16735     * The icon object to use at left side of the item. An
16736     * icon can be any Evas object, but usually it is an icon created
16737     * with elm_icon_add().
16738     *
16739     * Once the icon object is set, a previously set one will be deleted.
16740     * @warning Setting the same icon for two items will cause the icon to
16741     * dissapear from the first item.
16742     *
16743     * If an icon was passed as argument on item creation, with function
16744     * elm_list_item_append() or similar, it will be already
16745     * associated to the item.
16746     *
16747     * @see elm_list_item_append()
16748     * @see elm_list_item_icon_get()
16749     *
16750     * @ingroup List
16751     */
16752    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16753
16754    /**
16755     * Get the right side icon associated to the item.
16756     *
16757     * @param item The list item
16758     * @return The right side icon associated to @p item
16759     *
16760     * The return value is a pointer to the icon associated to @p item when
16761     * it was
16762     * created, with function elm_list_item_append() or similar, or later
16763     * with function elm_list_item_icon_set(). If no icon
16764     * was passed as argument, it will return @c NULL.
16765     *
16766     * @see elm_list_item_append()
16767     * @see elm_list_item_icon_set()
16768     *
16769     * @ingroup List
16770     */
16771    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16772
16773    /**
16774     * Set the right side icon associated to the item.
16775     *
16776     * @param item The list item
16777     * @param end The right side icon object to associate with @p item
16778     *
16779     * The icon object to use at right side of the item. An
16780     * icon can be any Evas object, but usually it is an icon created
16781     * with elm_icon_add().
16782     *
16783     * Once the icon object is set, a previously set one will be deleted.
16784     * @warning Setting the same icon for two items will cause the icon to
16785     * dissapear from the first item.
16786     *
16787     * If an icon was passed as argument on item creation, with function
16788     * elm_list_item_append() or similar, it will be already
16789     * associated to the item.
16790     *
16791     * @see elm_list_item_append()
16792     * @see elm_list_item_end_get()
16793     *
16794     * @ingroup List
16795     */
16796    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16797
16798    /**
16799     * Gets the base object of the item.
16800     *
16801     * @param item The list item
16802     * @return The base object associated with @p item
16803     *
16804     * Base object is the @c Evas_Object that represents that item.
16805     *
16806     * @ingroup List
16807     */
16808    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16809    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16810
16811    /**
16812     * Get the label of item.
16813     *
16814     * @param item The item of list.
16815     * @return The label of item.
16816     *
16817     * The return value is a pointer to the label associated to @p item when
16818     * it was created, with function elm_list_item_append(), or later
16819     * with function elm_list_item_label_set. If no label
16820     * was passed as argument, it will return @c NULL.
16821     *
16822     * @see elm_list_item_label_set() for more details.
16823     * @see elm_list_item_append()
16824     *
16825     * @ingroup List
16826     */
16827    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16828
16829    /**
16830     * Set the label of item.
16831     *
16832     * @param item The item of list.
16833     * @param text The label of item.
16834     *
16835     * The label to be displayed by the item.
16836     * Label will be placed between left and right side icons (if set).
16837     *
16838     * If a label was passed as argument on item creation, with function
16839     * elm_list_item_append() or similar, it will be already
16840     * displayed by the item.
16841     *
16842     * @see elm_list_item_label_get()
16843     * @see elm_list_item_append()
16844     *
16845     * @ingroup List
16846     */
16847    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16848
16849
16850    /**
16851     * Get the item before @p it in list.
16852     *
16853     * @param it The list item.
16854     * @return The item before @p it, or @c NULL if none or on failure.
16855     *
16856     * @note If it is the first item, @c NULL will be returned.
16857     *
16858     * @see elm_list_item_append()
16859     * @see elm_list_items_get()
16860     *
16861     * @ingroup List
16862     */
16863    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16864
16865    /**
16866     * Get the item after @p it in list.
16867     *
16868     * @param it The list item.
16869     * @return The item after @p it, or @c NULL if none or on failure.
16870     *
16871     * @note If it is the last item, @c NULL will be returned.
16872     *
16873     * @see elm_list_item_append()
16874     * @see elm_list_items_get()
16875     *
16876     * @ingroup List
16877     */
16878    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16879
16880    /**
16881     * Sets the disabled/enabled state of a list item.
16882     *
16883     * @param it The item.
16884     * @param disabled The disabled state.
16885     *
16886     * A disabled item cannot be selected or unselected. It will also
16887     * change its appearance (generally greyed out). This sets the
16888     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16889     * enabled).
16890     *
16891     * @ingroup List
16892     */
16893    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16894
16895    /**
16896     * Get a value whether list item is disabled or not.
16897     *
16898     * @param it The item.
16899     * @return The disabled state.
16900     *
16901     * @see elm_list_item_disabled_set() for more details.
16902     *
16903     * @ingroup List
16904     */
16905    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16906
16907    /**
16908     * Set the text to be shown in a given list item's tooltips.
16909     *
16910     * @param item Target item.
16911     * @param text The text to set in the content.
16912     *
16913     * Setup the text as tooltip to object. The item can have only one tooltip,
16914     * so any previous tooltip data - set with this function or
16915     * elm_list_item_tooltip_content_cb_set() - is removed.
16916     *
16917     * @see elm_object_tooltip_text_set() for more details.
16918     *
16919     * @ingroup List
16920     */
16921    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16922
16923
16924    /**
16925     * @brief Disable size restrictions on an object's tooltip
16926     * @param item The tooltip's anchor object
16927     * @param disable If EINA_TRUE, size restrictions are disabled
16928     * @return EINA_FALSE on failure, EINA_TRUE on success
16929     *
16930     * This function allows a tooltip to expand beyond its parant window's canvas.
16931     * It will instead be limited only by the size of the display.
16932     */
16933    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
16934    /**
16935     * @brief Retrieve size restriction state of an object's tooltip
16936     * @param obj The tooltip's anchor object
16937     * @return If EINA_TRUE, size restrictions are disabled
16938     *
16939     * This function returns whether a tooltip is allowed to expand beyond
16940     * its parant window's canvas.
16941     * It will instead be limited only by the size of the display.
16942     */
16943    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16944
16945    /**
16946     * Set the content to be shown in the tooltip item.
16947     *
16948     * Setup the tooltip to item. The item can have only one tooltip,
16949     * so any previous tooltip data is removed. @p func(with @p data) will
16950     * be called every time that need show the tooltip and it should
16951     * return a valid Evas_Object. This object is then managed fully by
16952     * tooltip system and is deleted when the tooltip is gone.
16953     *
16954     * @param item the list item being attached a tooltip.
16955     * @param func the function used to create the tooltip contents.
16956     * @param data what to provide to @a func as callback data/context.
16957     * @param del_cb called when data is not needed anymore, either when
16958     *        another callback replaces @a func, the tooltip is unset with
16959     *        elm_list_item_tooltip_unset() or the owner @a item
16960     *        dies. This callback receives as the first parameter the
16961     *        given @a data, and @c event_info is the item.
16962     *
16963     * @see elm_object_tooltip_content_cb_set() for more details.
16964     *
16965     * @ingroup List
16966     */
16967    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);
16968
16969    /**
16970     * Unset tooltip from item.
16971     *
16972     * @param item list item to remove previously set tooltip.
16973     *
16974     * Remove tooltip from item. The callback provided as del_cb to
16975     * elm_list_item_tooltip_content_cb_set() will be called to notify
16976     * it is not used anymore.
16977     *
16978     * @see elm_object_tooltip_unset() for more details.
16979     * @see elm_list_item_tooltip_content_cb_set()
16980     *
16981     * @ingroup List
16982     */
16983    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16984
16985    /**
16986     * Sets a different style for this item tooltip.
16987     *
16988     * @note before you set a style you should define a tooltip with
16989     *       elm_list_item_tooltip_content_cb_set() or
16990     *       elm_list_item_tooltip_text_set()
16991     *
16992     * @param item list item with tooltip already set.
16993     * @param style the theme style to use (default, transparent, ...)
16994     *
16995     * @see elm_object_tooltip_style_set() for more details.
16996     *
16997     * @ingroup List
16998     */
16999    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17000
17001    /**
17002     * Get the style for this item tooltip.
17003     *
17004     * @param item list item with tooltip already set.
17005     * @return style the theme style in use, defaults to "default". If the
17006     *         object does not have a tooltip set, then NULL is returned.
17007     *
17008     * @see elm_object_tooltip_style_get() for more details.
17009     * @see elm_list_item_tooltip_style_set()
17010     *
17011     * @ingroup List
17012     */
17013    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17014
17015    /**
17016     * Set the type of mouse pointer/cursor decoration to be shown,
17017     * when the mouse pointer is over the given list widget item
17018     *
17019     * @param item list item to customize cursor on
17020     * @param cursor the cursor type's name
17021     *
17022     * This function works analogously as elm_object_cursor_set(), but
17023     * here the cursor's changing area is restricted to the item's
17024     * area, and not the whole widget's. Note that that item cursors
17025     * have precedence over widget cursors, so that a mouse over an
17026     * item with custom cursor set will always show @b that cursor.
17027     *
17028     * If this function is called twice for an object, a previously set
17029     * cursor will be unset on the second call.
17030     *
17031     * @see elm_object_cursor_set()
17032     * @see elm_list_item_cursor_get()
17033     * @see elm_list_item_cursor_unset()
17034     *
17035     * @ingroup List
17036     */
17037    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17038
17039    /*
17040     * Get the type of mouse pointer/cursor decoration set to be shown,
17041     * when the mouse pointer is over the given list widget item
17042     *
17043     * @param item list item with custom cursor set
17044     * @return the cursor type's name or @c NULL, if no custom cursors
17045     * were set to @p item (and on errors)
17046     *
17047     * @see elm_object_cursor_get()
17048     * @see elm_list_item_cursor_set()
17049     * @see elm_list_item_cursor_unset()
17050     *
17051     * @ingroup List
17052     */
17053    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17054
17055    /**
17056     * Unset any custom mouse pointer/cursor decoration set to be
17057     * shown, when the mouse pointer is over the given list widget
17058     * item, thus making it show the @b default cursor again.
17059     *
17060     * @param item a list item
17061     *
17062     * Use this call to undo any custom settings on this item's cursor
17063     * decoration, bringing it back to defaults (no custom style set).
17064     *
17065     * @see elm_object_cursor_unset()
17066     * @see elm_list_item_cursor_set()
17067     *
17068     * @ingroup List
17069     */
17070    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17071
17072    /**
17073     * Set a different @b style for a given custom cursor set for a
17074     * list item.
17075     *
17076     * @param item list item with custom cursor set
17077     * @param style the <b>theme style</b> to use (e.g. @c "default",
17078     * @c "transparent", etc)
17079     *
17080     * This function only makes sense when one is using custom mouse
17081     * cursor decorations <b>defined in a theme file</b>, which can have,
17082     * given a cursor name/type, <b>alternate styles</b> on it. It
17083     * works analogously as elm_object_cursor_style_set(), but here
17084     * applyed only to list item objects.
17085     *
17086     * @warning Before you set a cursor style you should have definen a
17087     *       custom cursor previously on the item, with
17088     *       elm_list_item_cursor_set()
17089     *
17090     * @see elm_list_item_cursor_engine_only_set()
17091     * @see elm_list_item_cursor_style_get()
17092     *
17093     * @ingroup List
17094     */
17095    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17096
17097    /**
17098     * Get the current @b style set for a given list item's custom
17099     * cursor
17100     *
17101     * @param item list item with custom cursor set.
17102     * @return style the cursor style in use. If the object does not
17103     *         have a cursor set, then @c NULL is returned.
17104     *
17105     * @see elm_list_item_cursor_style_set() for more details
17106     *
17107     * @ingroup List
17108     */
17109    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17110
17111    /**
17112     * Set if the (custom)cursor for a given list item should be
17113     * searched in its theme, also, or should only rely on the
17114     * rendering engine.
17115     *
17116     * @param item item with custom (custom) cursor already set on
17117     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17118     * only on those provided by the rendering engine, @c EINA_FALSE to
17119     * have them searched on the widget's theme, as well.
17120     *
17121     * @note This call is of use only if you've set a custom cursor
17122     * for list items, with elm_list_item_cursor_set().
17123     *
17124     * @note By default, cursors will only be looked for between those
17125     * provided by the rendering engine.
17126     *
17127     * @ingroup List
17128     */
17129    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17130
17131    /**
17132     * Get if the (custom) cursor for a given list item is being
17133     * searched in its theme, also, or is only relying on the rendering
17134     * engine.
17135     *
17136     * @param item a list item
17137     * @return @c EINA_TRUE, if cursors are being looked for only on
17138     * those provided by the rendering engine, @c EINA_FALSE if they
17139     * are being searched on the widget's theme, as well.
17140     *
17141     * @see elm_list_item_cursor_engine_only_set(), for more details
17142     *
17143     * @ingroup List
17144     */
17145    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17146
17147    /**
17148     * @}
17149     */
17150
17151    /**
17152     * @defgroup Slider Slider
17153     * @ingroup Elementary
17154     *
17155     * @image html img/widget/slider/preview-00.png
17156     * @image latex img/widget/slider/preview-00.eps width=\textwidth
17157     *
17158     * The slider adds a dragable “slider” widget for selecting the value of
17159     * something within a range.
17160     *
17161     * A slider can be horizontal or vertical. It can contain an Icon and has a
17162     * primary label as well as a units label (that is formatted with floating
17163     * point values and thus accepts a printf-style format string, like
17164     * “%1.2f units”. There is also an indicator string that may be somewhere
17165     * else (like on the slider itself) that also accepts a format string like
17166     * units. Label, Icon Unit and Indicator strings/objects are optional.
17167     *
17168     * A slider may be inverted which means values invert, with high vales being
17169     * on the left or top and low values on the right or bottom (as opposed to
17170     * normally being low on the left or top and high on the bottom and right).
17171     *
17172     * The slider should have its minimum and maximum values set by the
17173     * application with  elm_slider_min_max_set() and value should also be set by
17174     * the application before use with  elm_slider_value_set(). The span of the
17175     * slider is its length (horizontally or vertically). This will be scaled by
17176     * the object or applications scaling factor. At any point code can query the
17177     * slider for its value with elm_slider_value_get().
17178     *
17179     * Smart callbacks one can listen to:
17180     * - "changed" - Whenever the slider value is changed by the user.
17181     * - "slider,drag,start" - dragging the slider indicator around has started.
17182     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17183     * - "delay,changed" - A short time after the value is changed by the user.
17184     * This will be called only when the user stops dragging for
17185     * a very short period or when they release their
17186     * finger/mouse, so it avoids possibly expensive reactions to
17187     * the value change.
17188     *
17189     * Available styles for it:
17190     * - @c "default"
17191     *
17192     * Here is an example on its usage:
17193     * @li @ref slider_example
17194     */
17195
17196    /**
17197     * @addtogroup Slider
17198     * @{
17199     */
17200
17201    /**
17202     * Add a new slider widget to the given parent Elementary
17203     * (container) object.
17204     *
17205     * @param parent The parent object.
17206     * @return a new slider widget handle or @c NULL, on errors.
17207     *
17208     * This function inserts a new slider widget on the canvas.
17209     *
17210     * @ingroup Slider
17211     */
17212    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17213
17214    /**
17215     * Set the label of a given slider widget
17216     *
17217     * @param obj The progress bar object
17218     * @param label The text label string, in UTF-8
17219     *
17220     * @ingroup Slider
17221     * @deprecated use elm_object_text_set() instead.
17222     */
17223    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17224
17225    /**
17226     * Get the label of a given slider widget
17227     *
17228     * @param obj The progressbar object
17229     * @return The text label string, in UTF-8
17230     *
17231     * @ingroup Slider
17232     * @deprecated use elm_object_text_get() instead.
17233     */
17234    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17235
17236    /**
17237     * Set the icon object of the slider object.
17238     *
17239     * @param obj The slider object.
17240     * @param icon The icon object.
17241     *
17242     * On horizontal mode, icon is placed at left, and on vertical mode,
17243     * placed at top.
17244     *
17245     * @note Once the icon object is set, a previously set one will be deleted.
17246     * If you want to keep that old content object, use the
17247     * elm_slider_icon_unset() function.
17248     *
17249     * @warning If the object being set does not have minimum size hints set,
17250     * it won't get properly displayed.
17251     *
17252     * @ingroup Slider
17253     */
17254    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17255
17256    /**
17257     * Unset an icon set on a given slider widget.
17258     *
17259     * @param obj The slider object.
17260     * @return The icon object that was being used, if any was set, or
17261     * @c NULL, otherwise (and on errors).
17262     *
17263     * On horizontal mode, icon is placed at left, and on vertical mode,
17264     * placed at top.
17265     *
17266     * This call will unparent and return the icon object which was set
17267     * for this widget, previously, on success.
17268     *
17269     * @see elm_slider_icon_set() for more details
17270     * @see elm_slider_icon_get()
17271     *
17272     * @ingroup Slider
17273     */
17274    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17275
17276    /**
17277     * Retrieve the icon object set for a given slider widget.
17278     *
17279     * @param obj The slider object.
17280     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17281     * otherwise (and on errors).
17282     *
17283     * On horizontal mode, icon is placed at left, and on vertical mode,
17284     * placed at top.
17285     *
17286     * @see elm_slider_icon_set() for more details
17287     * @see elm_slider_icon_unset()
17288     *
17289     * @ingroup Slider
17290     */
17291    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17292
17293    /**
17294     * Set the end object of the slider object.
17295     *
17296     * @param obj The slider object.
17297     * @param end The end object.
17298     *
17299     * On horizontal mode, end is placed at left, and on vertical mode,
17300     * placed at bottom.
17301     *
17302     * @note Once the icon object is set, a previously set one will be deleted.
17303     * If you want to keep that old content object, use the
17304     * elm_slider_end_unset() function.
17305     *
17306     * @warning If the object being set does not have minimum size hints set,
17307     * it won't get properly displayed.
17308     *
17309     * @ingroup Slider
17310     */
17311    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17312
17313    /**
17314     * Unset an end object set on a given slider widget.
17315     *
17316     * @param obj The slider object.
17317     * @return The end object that was being used, if any was set, or
17318     * @c NULL, otherwise (and on errors).
17319     *
17320     * On horizontal mode, end is placed at left, and on vertical mode,
17321     * placed at bottom.
17322     *
17323     * This call will unparent and return the icon object which was set
17324     * for this widget, previously, on success.
17325     *
17326     * @see elm_slider_end_set() for more details.
17327     * @see elm_slider_end_get()
17328     *
17329     * @ingroup Slider
17330     */
17331    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17332
17333    /**
17334     * Retrieve the end object set for a given slider widget.
17335     *
17336     * @param obj The slider object.
17337     * @return The end object's handle, if @p obj had one set, or @c NULL,
17338     * otherwise (and on errors).
17339     *
17340     * On horizontal mode, icon is placed at right, and on vertical mode,
17341     * placed at bottom.
17342     *
17343     * @see elm_slider_end_set() for more details.
17344     * @see elm_slider_end_unset()
17345     *
17346     * @ingroup Slider
17347     */
17348    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17349
17350    /**
17351     * Set the (exact) length of the bar region of a given slider widget.
17352     *
17353     * @param obj The slider object.
17354     * @param size The length of the slider's bar region.
17355     *
17356     * This sets the minimum width (when in horizontal mode) or height
17357     * (when in vertical mode) of the actual bar area of the slider
17358     * @p obj. This in turn affects the object's minimum size. Use
17359     * this when you're not setting other size hints expanding on the
17360     * given direction (like weight and alignment hints) and you would
17361     * like it to have a specific size.
17362     *
17363     * @note Icon, end, label, indicator and unit text around @p obj
17364     * will require their
17365     * own space, which will make @p obj to require more the @p size,
17366     * actually.
17367     *
17368     * @see elm_slider_span_size_get()
17369     *
17370     * @ingroup Slider
17371     */
17372    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17373
17374    /**
17375     * Get the length set for the bar region of a given slider widget
17376     *
17377     * @param obj The slider object.
17378     * @return The length of the slider's bar region.
17379     *
17380     * If that size was not set previously, with
17381     * elm_slider_span_size_set(), this call will return @c 0.
17382     *
17383     * @ingroup Slider
17384     */
17385    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17386
17387    /**
17388     * Set the format string for the unit label.
17389     *
17390     * @param obj The slider object.
17391     * @param format The format string for the unit display.
17392     *
17393     * Unit label is displayed all the time, if set, after slider's bar.
17394     * In horizontal mode, at right and in vertical mode, at bottom.
17395     *
17396     * If @c NULL, unit label won't be visible. If not it sets the format
17397     * string for the label text. To the label text is provided a floating point
17398     * value, so the label text can display up to 1 floating point value.
17399     * Note that this is optional.
17400     *
17401     * Use a format string such as "%1.2f meters" for example, and it will
17402     * display values like: "3.14 meters" for a value equal to 3.14159.
17403     *
17404     * Default is unit label disabled.
17405     *
17406     * @see elm_slider_indicator_format_get()
17407     *
17408     * @ingroup Slider
17409     */
17410    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17411
17412    /**
17413     * Get the unit label format of the slider.
17414     *
17415     * @param obj The slider object.
17416     * @return The unit label format string in UTF-8.
17417     *
17418     * Unit label is displayed all the time, if set, after slider's bar.
17419     * In horizontal mode, at right and in vertical mode, at bottom.
17420     *
17421     * @see elm_slider_unit_format_set() for more
17422     * information on how this works.
17423     *
17424     * @ingroup Slider
17425     */
17426    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17427
17428    /**
17429     * Set the format string for the indicator label.
17430     *
17431     * @param obj The slider object.
17432     * @param indicator The format string for the indicator display.
17433     *
17434     * The slider may display its value somewhere else then unit label,
17435     * for example, above the slider knob that is dragged around. This function
17436     * sets the format string used for this.
17437     *
17438     * If @c NULL, indicator label won't be visible. If not it sets the format
17439     * string for the label text. To the label text is provided a floating point
17440     * value, so the label text can display up to 1 floating point value.
17441     * Note that this is optional.
17442     *
17443     * Use a format string such as "%1.2f meters" for example, and it will
17444     * display values like: "3.14 meters" for a value equal to 3.14159.
17445     *
17446     * Default is indicator label disabled.
17447     *
17448     * @see elm_slider_indicator_format_get()
17449     *
17450     * @ingroup Slider
17451     */
17452    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17453
17454    /**
17455     * Get the indicator label format of the slider.
17456     *
17457     * @param obj The slider object.
17458     * @return The indicator label format string in UTF-8.
17459     *
17460     * The slider may display its value somewhere else then unit label,
17461     * for example, above the slider knob that is dragged around. This function
17462     * gets the format string used for this.
17463     *
17464     * @see elm_slider_indicator_format_set() for more
17465     * information on how this works.
17466     *
17467     * @ingroup Slider
17468     */
17469    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17470
17471    /**
17472     * Set the format function pointer for the indicator label
17473     *
17474     * @param obj The slider object.
17475     * @param func The indicator format function.
17476     * @param free_func The freeing function for the format string.
17477     *
17478     * Set the callback function to format the indicator string.
17479     *
17480     * @see elm_slider_indicator_format_set() for more info on how this works.
17481     *
17482     * @ingroup Slider
17483     */
17484   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);
17485
17486   /**
17487    * Set the format function pointer for the units label
17488    *
17489    * @param obj The slider object.
17490    * @param func The units format function.
17491    * @param free_func The freeing function for the format string.
17492    *
17493    * Set the callback function to format the indicator string.
17494    *
17495    * @see elm_slider_units_format_set() for more info on how this works.
17496    *
17497    * @ingroup Slider
17498    */
17499   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);
17500
17501   /**
17502    * Set the orientation of a given slider widget.
17503    *
17504    * @param obj The slider object.
17505    * @param horizontal Use @c EINA_TRUE to make @p obj to be
17506    * @b horizontal, @c EINA_FALSE to make it @b vertical.
17507    *
17508    * Use this function to change how your slider is to be
17509    * disposed: vertically or horizontally.
17510    *
17511    * By default it's displayed horizontally.
17512    *
17513    * @see elm_slider_horizontal_get()
17514    *
17515    * @ingroup Slider
17516    */
17517    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17518
17519    /**
17520     * Retrieve the orientation of a given slider widget
17521     *
17522     * @param obj The slider object.
17523     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17524     * @c EINA_FALSE if it's @b vertical (and on errors).
17525     *
17526     * @see elm_slider_horizontal_set() for more details.
17527     *
17528     * @ingroup Slider
17529     */
17530    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17531
17532    /**
17533     * Set the minimum and maximum values for the slider.
17534     *
17535     * @param obj The slider object.
17536     * @param min The minimum value.
17537     * @param max The maximum value.
17538     *
17539     * Define the allowed range of values to be selected by the user.
17540     *
17541     * If actual value is less than @p min, it will be updated to @p min. If it
17542     * is bigger then @p max, will be updated to @p max. Actual value can be
17543     * get with elm_slider_value_get().
17544     *
17545     * By default, min is equal to 0.0, and max is equal to 1.0.
17546     *
17547     * @warning Maximum must be greater than minimum, otherwise behavior
17548     * is undefined.
17549     *
17550     * @see elm_slider_min_max_get()
17551     *
17552     * @ingroup Slider
17553     */
17554    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17555
17556    /**
17557     * Get the minimum and maximum values of the slider.
17558     *
17559     * @param obj The slider object.
17560     * @param min Pointer where to store the minimum value.
17561     * @param max Pointer where to store the maximum value.
17562     *
17563     * @note If only one value is needed, the other pointer can be passed
17564     * as @c NULL.
17565     *
17566     * @see elm_slider_min_max_set() for details.
17567     *
17568     * @ingroup Slider
17569     */
17570    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17571
17572    /**
17573     * Set the value the slider displays.
17574     *
17575     * @param obj The slider object.
17576     * @param val The value to be displayed.
17577     *
17578     * Value will be presented on the unit label following format specified with
17579     * elm_slider_unit_format_set() and on indicator with
17580     * elm_slider_indicator_format_set().
17581     *
17582     * @warning The value must to be between min and max values. This values
17583     * are set by elm_slider_min_max_set().
17584     *
17585     * @see elm_slider_value_get()
17586     * @see elm_slider_unit_format_set()
17587     * @see elm_slider_indicator_format_set()
17588     * @see elm_slider_min_max_set()
17589     *
17590     * @ingroup Slider
17591     */
17592    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17593
17594    /**
17595     * Get the value displayed by the spinner.
17596     *
17597     * @param obj The spinner object.
17598     * @return The value displayed.
17599     *
17600     * @see elm_spinner_value_set() for details.
17601     *
17602     * @ingroup Slider
17603     */
17604    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17605
17606    /**
17607     * Invert a given slider widget's displaying values order
17608     *
17609     * @param obj The slider object.
17610     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17611     * @c EINA_FALSE to bring it back to default, non-inverted values.
17612     *
17613     * A slider may be @b inverted, in which state it gets its
17614     * values inverted, with high vales being on the left or top and
17615     * low values on the right or bottom, as opposed to normally have
17616     * the low values on the former and high values on the latter,
17617     * respectively, for horizontal and vertical modes.
17618     *
17619     * @see elm_slider_inverted_get()
17620     *
17621     * @ingroup Slider
17622     */
17623    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17624
17625    /**
17626     * Get whether a given slider widget's displaying values are
17627     * inverted or not.
17628     *
17629     * @param obj The slider object.
17630     * @return @c EINA_TRUE, if @p obj has inverted values,
17631     * @c EINA_FALSE otherwise (and on errors).
17632     *
17633     * @see elm_slider_inverted_set() for more details.
17634     *
17635     * @ingroup Slider
17636     */
17637    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17638
17639    /**
17640     * Set whether to enlarge slider indicator (augmented knob) or not.
17641     *
17642     * @param obj The slider object.
17643     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17644     * let the knob always at default size.
17645     *
17646     * By default, indicator will be bigger while dragged by the user.
17647     *
17648     * @warning It won't display values set with
17649     * elm_slider_indicator_format_set() if you disable indicator.
17650     *
17651     * @ingroup Slider
17652     */
17653    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17654
17655    /**
17656     * Get whether a given slider widget's enlarging indicator or not.
17657     *
17658     * @param obj The slider object.
17659     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17660     * @c EINA_FALSE otherwise (and on errors).
17661     *
17662     * @see elm_slider_indicator_show_set() for details.
17663     *
17664     * @ingroup Slider
17665     */
17666    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17667
17668    /**
17669     * @}
17670     */
17671
17672    /**
17673     * @addtogroup Actionslider Actionslider
17674     *
17675     * @image html img/widget/actionslider/preview-00.png
17676     * @image latex img/widget/actionslider/preview-00.eps
17677     *
17678     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17679     * properties. The user drags and releases the indicator, to choose a label.
17680     *
17681     * Labels occupy the following positions.
17682     * a. Left
17683     * b. Right
17684     * c. Center
17685     *
17686     * Positions can be enabled or disabled.
17687     *
17688     * Magnets can be set on the above positions.
17689     *
17690     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17691     *
17692     * @note By default all positions are set as enabled.
17693     *
17694     * Signals that you can add callbacks for are:
17695     *
17696     * "selected" - when user selects an enabled position (the label is passed
17697     *              as event info)".
17698     * @n
17699     * "pos_changed" - when the indicator reaches any of the positions("left",
17700     *                 "right" or "center").
17701     *
17702     * See an example of actionslider usage @ref actionslider_example_page "here"
17703     * @{
17704     */
17705    typedef enum _Elm_Actionslider_Pos
17706      {
17707         ELM_ACTIONSLIDER_NONE = 0,
17708         ELM_ACTIONSLIDER_LEFT = 1 << 0,
17709         ELM_ACTIONSLIDER_CENTER = 1 << 1,
17710         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17711         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17712      } Elm_Actionslider_Pos;
17713
17714    /**
17715     * Add a new actionslider to the parent.
17716     *
17717     * @param parent The parent object
17718     * @return The new actionslider object or NULL if it cannot be created
17719     */
17720    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17721    /**
17722     * Set actionslider labels.
17723     *
17724     * @param obj The actionslider object
17725     * @param left_label The label to be set on the left.
17726     * @param center_label The label to be set on the center.
17727     * @param right_label The label to be set on the right.
17728     * @deprecated use elm_object_text_set() instead.
17729     */
17730    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);
17731    /**
17732     * Get actionslider labels.
17733     *
17734     * @param obj The actionslider object
17735     * @param left_label A char** to place the left_label of @p obj into.
17736     * @param center_label A char** to place the center_label of @p obj into.
17737     * @param right_label A char** to place the right_label of @p obj into.
17738     * @deprecated use elm_object_text_set() instead.
17739     */
17740    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);
17741    /**
17742     * Get actionslider selected label.
17743     *
17744     * @param obj The actionslider object
17745     * @return The selected label
17746     */
17747    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17748    /**
17749     * Set actionslider indicator position.
17750     *
17751     * @param obj The actionslider object.
17752     * @param pos The position of the indicator.
17753     */
17754    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17755    /**
17756     * Get actionslider indicator position.
17757     *
17758     * @param obj The actionslider object.
17759     * @return The position of the indicator.
17760     */
17761    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17762    /**
17763     * Set actionslider magnet position. To make multiple positions magnets @c or
17764     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
17765     *
17766     * @param obj The actionslider object.
17767     * @param pos Bit mask indicating the magnet positions.
17768     */
17769    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17770    /**
17771     * Get actionslider magnet position.
17772     *
17773     * @param obj The actionslider object.
17774     * @return The positions with magnet property.
17775     */
17776    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17777    /**
17778     * Set actionslider enabled position. To set multiple positions as enabled @c or
17779     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
17780     *
17781     * @note All the positions are enabled by default.
17782     *
17783     * @param obj The actionslider object.
17784     * @param pos Bit mask indicating the enabled positions.
17785     */
17786    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17787    /**
17788     * Get actionslider enabled position.
17789     *
17790     * @param obj The actionslider object.
17791     * @return The enabled positions.
17792     */
17793    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17794    /**
17795     * Set the label used on the indicator.
17796     *
17797     * @param obj The actionslider object
17798     * @param label The label to be set on the indicator.
17799     * @deprecated use elm_object_text_set() instead.
17800     */
17801    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17802    /**
17803     * Get the label used on the indicator object.
17804     *
17805     * @param obj The actionslider object
17806     * @return The indicator label
17807     * @deprecated use elm_object_text_get() instead.
17808     */
17809    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17810    /**
17811     * @}
17812     */
17813
17814    /**
17815     * @defgroup Genlist Genlist
17816     *
17817     * @image html img/widget/genlist/preview-00.png
17818     * @image latex img/widget/genlist/preview-00.eps
17819     * @image html img/genlist.png
17820     * @image latex img/genlist.eps
17821     *
17822     * This widget aims to have more expansive list than the simple list in
17823     * Elementary that could have more flexible items and allow many more entries
17824     * while still being fast and low on memory usage. At the same time it was
17825     * also made to be able to do tree structures. But the price to pay is more
17826     * complexity when it comes to usage. If all you want is a simple list with
17827     * icons and a single label, use the normal @ref List object.
17828     *
17829     * Genlist has a fairly large API, mostly because it's relatively complex,
17830     * trying to be both expansive, powerful and efficient. First we will begin
17831     * an overview on the theory behind genlist.
17832     *
17833     * @section Genlist_Item_Class Genlist item classes - creating items
17834     *
17835     * In order to have the ability to add and delete items on the fly, genlist
17836     * implements a class (callback) system where the application provides a
17837     * structure with information about that type of item (genlist may contain
17838     * multiple different items with different classes, states and styles).
17839     * Genlist will call the functions in this struct (methods) when an item is
17840     * "realized" (i.e., created dynamically, while the user is scrolling the
17841     * grid). All objects will simply be deleted when no longer needed with
17842     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17843     * following members:
17844     * - @c item_style - This is a constant string and simply defines the name
17845     *   of the item style. It @b must be specified and the default should be @c
17846     *   "default".
17847     *
17848     * - @c func - A struct with pointers to functions that will be called when
17849     *   an item is going to be actually created. All of them receive a @c data
17850     *   parameter that will point to the same data passed to
17851     *   elm_genlist_item_append() and related item creation functions, and a @c
17852     *   obj parameter that points to the genlist object itself.
17853     *
17854     * The function pointers inside @c func are @c label_get, @c icon_get, @c
17855     * state_get and @c del. The 3 first functions also receive a @c part
17856     * parameter described below. A brief description of these functions follows:
17857     *
17858     * - @c label_get - The @c part parameter is the name string of one of the
17859     *   existing text parts in the Edje group implementing the item's theme.
17860     *   This function @b must return a strdup'()ed string, as the caller will
17861     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17862     * - @c content_get - The @c part parameter is the name string of one of the
17863     *   existing (content) swallow parts in the Edje group implementing the item's
17864     *   theme. It must return @c NULL, when no content is desired, or a valid
17865     *   object handle, otherwise.  The object will be deleted by the genlist on
17866     *   its deletion or when the item is "unrealized".  See
17867     *   #Elm_Genlist_Item_Icon_Get_Cb.
17868     * - @c func.state_get - The @c part parameter is the name string of one of
17869     *   the state parts in the Edje group implementing the item's theme. Return
17870     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17871     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17872     *   and @c "elm" as "emission" and "source" arguments, respectively, when
17873     *   the state is true (the default is false), where @c XXX is the name of
17874     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
17875     * - @c func.del - This is intended for use when genlist items are deleted,
17876     *   so any data attached to the item (e.g. its data parameter on creation)
17877     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
17878     *
17879     * available item styles:
17880     * - default
17881     * - default_style - The text part is a textblock
17882     *
17883     * @image html img/widget/genlist/preview-04.png
17884     * @image latex img/widget/genlist/preview-04.eps
17885     *
17886     * - double_label
17887     *
17888     * @image html img/widget/genlist/preview-01.png
17889     * @image latex img/widget/genlist/preview-01.eps
17890     *
17891     * - icon_top_text_bottom
17892     *
17893     * @image html img/widget/genlist/preview-02.png
17894     * @image latex img/widget/genlist/preview-02.eps
17895     *
17896     * - group_index
17897     *
17898     * @image html img/widget/genlist/preview-03.png
17899     * @image latex img/widget/genlist/preview-03.eps
17900     *
17901     * @section Genlist_Items Structure of items
17902     *
17903     * An item in a genlist can have 0 or more text labels (they can be regular
17904     * text or textblock Evas objects - that's up to the style to determine), 0
17905     * or more contents (which are simply objects swallowed into the genlist item's
17906     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
17907     * behavior left to the user to define. The Edje part names for each of
17908     * these properties will be looked up, in the theme file for the genlist,
17909     * under the Edje (string) data items named @c "labels", @c "contents" and @c
17910     * "states", respectively. For each of those properties, if more than one
17911     * part is provided, they must have names listed separated by spaces in the
17912     * data fields. For the default genlist item theme, we have @b one label
17913     * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
17914     * "elm.swallow.end") and @b no state parts.
17915     *
17916     * A genlist item may be at one of several styles. Elementary provides one
17917     * by default - "default", but this can be extended by system or application
17918     * custom themes/overlays/extensions (see @ref Theme "themes" for more
17919     * details).
17920     *
17921     * @section Genlist_Manipulation Editing and Navigating
17922     *
17923     * Items can be added by several calls. All of them return a @ref
17924     * Elm_Genlist_Item handle that is an internal member inside the genlist.
17925     * They all take a data parameter that is meant to be used for a handle to
17926     * the applications internal data (eg the struct with the original item
17927     * data). The parent parameter is the parent genlist item this belongs to if
17928     * it is a tree or an indexed group, and NULL if there is no parent. The
17929     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
17930     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
17931     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
17932     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
17933     * is set then this item is group index item that is displayed at the top
17934     * until the next group comes. The func parameter is a convenience callback
17935     * that is called when the item is selected and the data parameter will be
17936     * the func_data parameter, obj be the genlist object and event_info will be
17937     * the genlist item.
17938     *
17939     * elm_genlist_item_append() adds an item to the end of the list, or if
17940     * there is a parent, to the end of all the child items of the parent.
17941     * elm_genlist_item_prepend() is the same but adds to the beginning of
17942     * the list or children list. elm_genlist_item_insert_before() inserts at
17943     * item before another item and elm_genlist_item_insert_after() inserts after
17944     * the indicated item.
17945     *
17946     * The application can clear the list with elm_genlist_clear() which deletes
17947     * all the items in the list and elm_genlist_item_del() will delete a specific
17948     * item. elm_genlist_item_subitems_clear() will clear all items that are
17949     * children of the indicated parent item.
17950     *
17951     * To help inspect list items you can jump to the item at the top of the list
17952     * with elm_genlist_first_item_get() which will return the item pointer, and
17953     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
17954     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
17955     * and previous items respectively relative to the indicated item. Using
17956     * these calls you can walk the entire item list/tree. Note that as a tree
17957     * the items are flattened in the list, so elm_genlist_item_parent_get() will
17958     * let you know which item is the parent (and thus know how to skip them if
17959     * wanted).
17960     *
17961     * @section Genlist_Muti_Selection Multi-selection
17962     *
17963     * If the application wants multiple items to be able to be selected,
17964     * elm_genlist_multi_select_set() can enable this. If the list is
17965     * single-selection only (the default), then elm_genlist_selected_item_get()
17966     * will return the selected item, if any, or NULL I none is selected. If the
17967     * list is multi-select then elm_genlist_selected_items_get() will return a
17968     * list (that is only valid as long as no items are modified (added, deleted,
17969     * selected or unselected)).
17970     *
17971     * @section Genlist_Usage_Hints Usage hints
17972     *
17973     * There are also convenience functions. elm_genlist_item_genlist_get() will
17974     * return the genlist object the item belongs to. elm_genlist_item_show()
17975     * will make the scroller scroll to show that specific item so its visible.
17976     * elm_genlist_item_data_get() returns the data pointer set by the item
17977     * creation functions.
17978     *
17979     * If an item changes (state of boolean changes, label or contents change),
17980     * then use elm_genlist_item_update() to have genlist update the item with
17981     * the new state. Genlist will re-realize the item thus call the functions
17982     * in the _Elm_Genlist_Item_Class for that item.
17983     *
17984     * To programmatically (un)select an item use elm_genlist_item_selected_set().
17985     * To get its selected state use elm_genlist_item_selected_get(). Similarly
17986     * to expand/contract an item and get its expanded state, use
17987     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
17988     * again to make an item disabled (unable to be selected and appear
17989     * differently) use elm_genlist_item_disabled_set() to set this and
17990     * elm_genlist_item_disabled_get() to get the disabled state.
17991     *
17992     * In general to indicate how the genlist should expand items horizontally to
17993     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
17994     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
17995     * mode means that if items are too wide to fit, the scroller will scroll
17996     * horizontally. Otherwise items are expanded to fill the width of the
17997     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
17998     * to the viewport width and limited to that size. This can be combined with
17999     * a different style that uses edjes' ellipsis feature (cutting text off like
18000     * this: "tex...").
18001     *
18002     * Items will only call their selection func and callback when first becoming
18003     * selected. Any further clicks will do nothing, unless you enable always
18004     * select with elm_genlist_always_select_mode_set(). This means even if
18005     * selected, every click will make the selected callbacks be called.
18006     * elm_genlist_no_select_mode_set() will turn off the ability to select
18007     * items entirely and they will neither appear selected nor call selected
18008     * callback functions.
18009     *
18010     * Remember that you can create new styles and add your own theme augmentation
18011     * per application with elm_theme_extension_add(). If you absolutely must
18012     * have a specific style that overrides any theme the user or system sets up
18013     * you can use elm_theme_overlay_add() to add such a file.
18014     *
18015     * @section Genlist_Implementation Implementation
18016     *
18017     * Evas tracks every object you create. Every time it processes an event
18018     * (mouse move, down, up etc.) it needs to walk through objects and find out
18019     * what event that affects. Even worse every time it renders display updates,
18020     * in order to just calculate what to re-draw, it needs to walk through many
18021     * many many objects. Thus, the more objects you keep active, the more
18022     * overhead Evas has in just doing its work. It is advisable to keep your
18023     * active objects to the minimum working set you need. Also remember that
18024     * object creation and deletion carries an overhead, so there is a
18025     * middle-ground, which is not easily determined. But don't keep massive lists
18026     * of objects you can't see or use. Genlist does this with list objects. It
18027     * creates and destroys them dynamically as you scroll around. It groups them
18028     * into blocks so it can determine the visibility etc. of a whole block at
18029     * once as opposed to having to walk the whole list. This 2-level list allows
18030     * for very large numbers of items to be in the list (tests have used up to
18031     * 2,000,000 items). Also genlist employs a queue for adding items. As items
18032     * may be different sizes, every item added needs to be calculated as to its
18033     * size and thus this presents a lot of overhead on populating the list, this
18034     * genlist employs a queue. Any item added is queued and spooled off over
18035     * time, actually appearing some time later, so if your list has many members
18036     * you may find it takes a while for them to all appear, with your process
18037     * consuming a lot of CPU while it is busy spooling.
18038     *
18039     * Genlist also implements a tree structure, but it does so with callbacks to
18040     * the application, with the application filling in tree structures when
18041     * requested (allowing for efficient building of a very deep tree that could
18042     * even be used for file-management). See the above smart signal callbacks for
18043     * details.
18044     *
18045     * @section Genlist_Smart_Events Genlist smart events
18046     *
18047     * Signals that you can add callbacks for are:
18048     * - @c "activated" - The user has double-clicked or pressed
18049     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
18050     *   item that was activated.
18051     * - @c "clicked,double" - The user has double-clicked an item.  The @c
18052     *   event_info parameter is the item that was double-clicked.
18053     * - @c "selected" - This is called when a user has made an item selected.
18054     *   The event_info parameter is the genlist item that was selected.
18055     * - @c "unselected" - This is called when a user has made an item
18056     *   unselected. The event_info parameter is the genlist item that was
18057     *   unselected.
18058     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18059     *   called and the item is now meant to be expanded. The event_info
18060     *   parameter is the genlist item that was indicated to expand.  It is the
18061     *   job of this callback to then fill in the child items.
18062     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18063     *   called and the item is now meant to be contracted. The event_info
18064     *   parameter is the genlist item that was indicated to contract. It is the
18065     *   job of this callback to then delete the child items.
18066     * - @c "expand,request" - This is called when a user has indicated they want
18067     *   to expand a tree branch item. The callback should decide if the item can
18068     *   expand (has any children) and then call elm_genlist_item_expanded_set()
18069     *   appropriately to set the state. The event_info parameter is the genlist
18070     *   item that was indicated to expand.
18071     * - @c "contract,request" - This is called when a user has indicated they
18072     *   want to contract a tree branch item. The callback should decide if the
18073     *   item can contract (has any children) and then call
18074     *   elm_genlist_item_expanded_set() appropriately to set the state. The
18075     *   event_info parameter is the genlist item that was indicated to contract.
18076     * - @c "realized" - This is called when the item in the list is created as a
18077     *   real evas object. event_info parameter is the genlist item that was
18078     *   created. The object may be deleted at any time, so it is up to the
18079     *   caller to not use the object pointer from elm_genlist_item_object_get()
18080     *   in a way where it may point to freed objects.
18081     * - @c "unrealized" - This is called just before an item is unrealized.
18082     *   After this call content objects provided will be deleted and the item
18083     *   object itself delete or be put into a floating cache.
18084     * - @c "drag,start,up" - This is called when the item in the list has been
18085     *   dragged (not scrolled) up.
18086     * - @c "drag,start,down" - This is called when the item in the list has been
18087     *   dragged (not scrolled) down.
18088     * - @c "drag,start,left" - This is called when the item in the list has been
18089     *   dragged (not scrolled) left.
18090     * - @c "drag,start,right" - This is called when the item in the list has
18091     *   been dragged (not scrolled) right.
18092     * - @c "drag,stop" - This is called when the item in the list has stopped
18093     *   being dragged.
18094     * - @c "drag" - This is called when the item in the list is being dragged.
18095     * - @c "longpressed" - This is called when the item is pressed for a certain
18096     *   amount of time. By default it's 1 second.
18097     * - @c "scroll,anim,start" - This is called when scrolling animation has
18098     *   started.
18099     * - @c "scroll,anim,stop" - This is called when scrolling animation has
18100     *   stopped.
18101     * - @c "scroll,drag,start" - This is called when dragging the content has
18102     *   started.
18103     * - @c "scroll,drag,stop" - This is called when dragging the content has
18104     *   stopped.
18105     * - @c "edge,top" - This is called when the genlist is scrolled until
18106     *   the top edge.
18107     * - @c "edge,bottom" - This is called when the genlist is scrolled
18108     *   until the bottom edge.
18109     * - @c "edge,left" - This is called when the genlist is scrolled
18110     *   until the left edge.
18111     * - @c "edge,right" - This is called when the genlist is scrolled
18112     *   until the right edge.
18113     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18114     *   swiped left.
18115     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18116     *   swiped right.
18117     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18118     *   swiped up.
18119     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18120     *   swiped down.
18121     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18122     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
18123     *   multi-touch pinched in.
18124     * - @c "swipe" - This is called when the genlist is swiped.
18125     * - @c "moved" - This is called when a genlist item is moved.
18126     * - @c "language,changed" - This is called when the program's language is
18127     *   changed.
18128     *
18129     * @section Genlist_Examples Examples
18130     *
18131     * Here is a list of examples that use the genlist, trying to show some of
18132     * its capabilities:
18133     * - @ref genlist_example_01
18134     * - @ref genlist_example_02
18135     * - @ref genlist_example_03
18136     * - @ref genlist_example_04
18137     * - @ref genlist_example_05
18138     */
18139
18140    /**
18141     * @addtogroup Genlist
18142     * @{
18143     */
18144
18145    /**
18146     * @enum _Elm_Genlist_Item_Flags
18147     * @typedef Elm_Genlist_Item_Flags
18148     *
18149     * Defines if the item is of any special type (has subitems or it's the
18150     * index of a group), or is just a simple item.
18151     *
18152     * @ingroup Genlist
18153     */
18154    typedef enum _Elm_Genlist_Item_Flags
18155      {
18156         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18157         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18158         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18159      } Elm_Genlist_Item_Flags;
18160    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
18161    #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18162    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18163    #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18164    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18165    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
18166    typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for genlist item classes. */
18167    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. */
18168    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
18169
18170    /**
18171     * @struct _Elm_Genlist_Item_Class
18172     *
18173     * Genlist item class definition structs.
18174     *
18175     * This struct contains the style and fetching functions that will define the
18176     * contents of each item.
18177     *
18178     * @see @ref Genlist_Item_Class
18179     */
18180    struct _Elm_Genlist_Item_Class
18181      {
18182         const char                *item_style; /**< style of this class. */
18183         struct Elm_Genlist_Item_Class_Func
18184           {
18185              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
18186              Elm_Genlist_Item_Content_Get_Cb   content_get; /**< Content fetching class function for genlist item classes. */
18187              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
18188              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
18189           } func;
18190      };
18191    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18192    /**
18193     * Add a new genlist widget to the given parent Elementary
18194     * (container) object
18195     *
18196     * @param parent The parent object
18197     * @return a new genlist widget handle or @c NULL, on errors
18198     *
18199     * This function inserts a new genlist widget on the canvas.
18200     *
18201     * @see elm_genlist_item_append()
18202     * @see elm_genlist_item_del()
18203     * @see elm_genlist_clear()
18204     *
18205     * @ingroup Genlist
18206     */
18207    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18208    /**
18209     * Remove all items from a given genlist widget.
18210     *
18211     * @param obj The genlist object
18212     *
18213     * This removes (and deletes) all items in @p obj, leaving it empty.
18214     *
18215     * @see elm_genlist_item_del(), to remove just one item.
18216     *
18217     * @ingroup Genlist
18218     */
18219    EINA_DEPRECATED EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18220    /**
18221     * Enable or disable multi-selection in the genlist
18222     *
18223     * @param obj The genlist object
18224     * @param multi Multi-select enable/disable. Default is disabled.
18225     *
18226     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18227     * the list. This allows more than 1 item to be selected. To retrieve the list
18228     * of selected items, use elm_genlist_selected_items_get().
18229     *
18230     * @see elm_genlist_selected_items_get()
18231     * @see elm_genlist_multi_select_get()
18232     *
18233     * @ingroup Genlist
18234     */
18235    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18236    /**
18237     * Gets if multi-selection in genlist is enabled or disabled.
18238     *
18239     * @param obj The genlist object
18240     * @return Multi-select enabled/disabled
18241     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18242     *
18243     * @see elm_genlist_multi_select_set()
18244     *
18245     * @ingroup Genlist
18246     */
18247    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18248    /**
18249     * This sets the horizontal stretching mode.
18250     *
18251     * @param obj The genlist object
18252     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18253     *
18254     * This sets the mode used for sizing items horizontally. Valid modes
18255     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18256     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18257     * the scroller will scroll horizontally. Otherwise items are expanded
18258     * to fill the width of the viewport of the scroller. If it is
18259     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18260     * limited to that size.
18261     *
18262     * @see elm_genlist_horizontal_get()
18263     *
18264     * @ingroup Genlist
18265     */
18266    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18267    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18268    /**
18269     * Gets the horizontal stretching mode.
18270     *
18271     * @param obj The genlist object
18272     * @return The mode to use
18273     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18274     *
18275     * @see elm_genlist_horizontal_set()
18276     *
18277     * @ingroup Genlist
18278     */
18279    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18280    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18281    /**
18282     * Set the always select mode.
18283     *
18284     * @param obj The genlist object
18285     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18286     * EINA_FALSE = off). Default is @c EINA_FALSE.
18287     *
18288     * Items will only call their selection func and callback when first
18289     * becoming selected. Any further clicks will do nothing, unless you
18290     * enable always select with elm_genlist_always_select_mode_set().
18291     * This means that, even if selected, every click will make the selected
18292     * callbacks be called.
18293     *
18294     * @see elm_genlist_always_select_mode_get()
18295     *
18296     * @ingroup Genlist
18297     */
18298    EINA_DEPRECATED EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18299    /**
18300     * Get the always select mode.
18301     *
18302     * @param obj The genlist object
18303     * @return The always select mode
18304     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18305     *
18306     * @see elm_genlist_always_select_mode_set()
18307     *
18308     * @ingroup Genlist
18309     */
18310    EINA_DEPRECATED EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18311    /**
18312     * Enable/disable the no select mode.
18313     *
18314     * @param obj The genlist object
18315     * @param no_select The no select mode
18316     * (EINA_TRUE = on, EINA_FALSE = off)
18317     *
18318     * This will turn off the ability to select items entirely and they
18319     * will neither appear selected nor call selected callback functions.
18320     *
18321     * @see elm_genlist_no_select_mode_get()
18322     *
18323     * @ingroup Genlist
18324     */
18325    EINA_DEPRECATED EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18326    /**
18327     * Gets whether the no select mode is enabled.
18328     *
18329     * @param obj The genlist object
18330     * @return The no select mode
18331     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18332     *
18333     * @see elm_genlist_no_select_mode_set()
18334     *
18335     * @ingroup Genlist
18336     */
18337    EINA_DEPRECATED EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18338    /**
18339     * Enable/disable compress mode.
18340     *
18341     * @param obj The genlist object
18342     * @param compress The compress mode
18343     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18344     *
18345     * This will enable the compress mode where items are "compressed"
18346     * horizontally to fit the genlist scrollable viewport width. This is
18347     * special for genlist.  Do not rely on
18348     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18349     * work as genlist needs to handle it specially.
18350     *
18351     * @see elm_genlist_compress_mode_get()
18352     *
18353     * @ingroup Genlist
18354     */
18355    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18356    /**
18357     * Get whether the compress mode is enabled.
18358     *
18359     * @param obj The genlist object
18360     * @return The compress mode
18361     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18362     *
18363     * @see elm_genlist_compress_mode_set()
18364     *
18365     * @ingroup Genlist
18366     */
18367    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18368    /**
18369     * Enable/disable height-for-width mode.
18370     *
18371     * @param obj The genlist object
18372     * @param setting The height-for-width mode (@c EINA_TRUE = on,
18373     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18374     *
18375     * With height-for-width mode the item width will be fixed (restricted
18376     * to a minimum of) to the list width when calculating its size in
18377     * order to allow the height to be calculated based on it. This allows,
18378     * for instance, text block to wrap lines if the Edje part is
18379     * configured with "text.min: 0 1".
18380     *
18381     * @note This mode will make list resize slower as it will have to
18382     *       recalculate every item height again whenever the list width
18383     *       changes!
18384     *
18385     * @note When height-for-width mode is enabled, it also enables
18386     *       compress mode (see elm_genlist_compress_mode_set()) and
18387     *       disables homogeneous (see elm_genlist_homogeneous_set()).
18388     *
18389     * @ingroup Genlist
18390     */
18391    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18392    /**
18393     * Get whether the height-for-width mode is enabled.
18394     *
18395     * @param obj The genlist object
18396     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18397     * off)
18398     *
18399     * @ingroup Genlist
18400     */
18401    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18402    /**
18403     * Enable/disable horizontal and vertical bouncing effect.
18404     *
18405     * @param obj The genlist object
18406     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18407     * EINA_FALSE = off). Default is @c EINA_FALSE.
18408     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18409     * EINA_FALSE = off). Default is @c EINA_TRUE.
18410     *
18411     * This will enable or disable the scroller bouncing effect for the
18412     * genlist. See elm_scroller_bounce_set() for details.
18413     *
18414     * @see elm_scroller_bounce_set()
18415     * @see elm_genlist_bounce_get()
18416     *
18417     * @ingroup Genlist
18418     */
18419    EINA_DEPRECATED EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18420    /**
18421     * Get whether the horizontal and vertical bouncing effect is enabled.
18422     *
18423     * @param obj The genlist object
18424     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18425     * option is set.
18426     * @param v_bounce Pointer to a bool to receive if the bounce vertically
18427     * option is set.
18428     *
18429     * @see elm_genlist_bounce_set()
18430     *
18431     * @ingroup Genlist
18432     */
18433    EINA_DEPRECATED EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18434    /**
18435     * Enable/disable homogenous mode.
18436     *
18437     * @param obj The genlist object
18438     * @param homogeneous Assume the items within the genlist are of the
18439     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18440     * EINA_FALSE.
18441     *
18442     * This will enable the homogeneous mode where items are of the same
18443     * height and width so that genlist may do the lazy-loading at its
18444     * maximum (which increases the performance for scrolling the list). This
18445     * implies 'compressed' mode.
18446     *
18447     * @see elm_genlist_compress_mode_set()
18448     * @see elm_genlist_homogeneous_get()
18449     *
18450     * @ingroup Genlist
18451     */
18452    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18453    /**
18454     * Get whether the homogenous mode is enabled.
18455     *
18456     * @param obj The genlist object
18457     * @return Assume the items within the genlist are of the same height
18458     * and width (EINA_TRUE = on, EINA_FALSE = off)
18459     *
18460     * @see elm_genlist_homogeneous_set()
18461     *
18462     * @ingroup Genlist
18463     */
18464    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18465    /**
18466     * Set the maximum number of items within an item block
18467     *
18468     * @param obj The genlist object
18469     * @param n   Maximum number of items within an item block. Default is 32.
18470     *
18471     * This will configure the block count to tune to the target with
18472     * particular performance matrix.
18473     *
18474     * A block of objects will be used to reduce the number of operations due to
18475     * many objects in the screen. It can determine the visibility, or if the
18476     * object has changed, it theme needs to be updated, etc. doing this kind of
18477     * calculation to the entire block, instead of per object.
18478     *
18479     * The default value for the block count is enough for most lists, so unless
18480     * you know you will have a lot of objects visible in the screen at the same
18481     * time, don't try to change this.
18482     *
18483     * @see elm_genlist_block_count_get()
18484     * @see @ref Genlist_Implementation
18485     *
18486     * @ingroup Genlist
18487     */
18488    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18489    /**
18490     * Get the maximum number of items within an item block
18491     *
18492     * @param obj The genlist object
18493     * @return Maximum number of items within an item block
18494     *
18495     * @see elm_genlist_block_count_set()
18496     *
18497     * @ingroup Genlist
18498     */
18499    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18500    /**
18501     * Set the timeout in seconds for the longpress event.
18502     *
18503     * @param obj The genlist object
18504     * @param timeout timeout in seconds. Default is 1.
18505     *
18506     * This option will change how long it takes to send an event "longpressed"
18507     * after the mouse down signal is sent to the list. If this event occurs, no
18508     * "clicked" event will be sent.
18509     *
18510     * @see elm_genlist_longpress_timeout_set()
18511     *
18512     * @ingroup Genlist
18513     */
18514    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18515    /**
18516     * Get the timeout in seconds for the longpress event.
18517     *
18518     * @param obj The genlist object
18519     * @return timeout in seconds
18520     *
18521     * @see elm_genlist_longpress_timeout_get()
18522     *
18523     * @ingroup Genlist
18524     */
18525    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18526    /**
18527     * Append a new item in a given genlist widget.
18528     *
18529     * @param obj The genlist object
18530     * @param itc The item class for the item
18531     * @param data The item data
18532     * @param parent The parent item, or NULL if none
18533     * @param flags Item flags
18534     * @param func Convenience function called when the item is selected
18535     * @param func_data Data passed to @p func above.
18536     * @return A handle to the item added or @c NULL if not possible
18537     *
18538     * This adds the given item to the end of the list or the end of
18539     * the children list if the @p parent is given.
18540     *
18541     * @see elm_genlist_item_prepend()
18542     * @see elm_genlist_item_insert_before()
18543     * @see elm_genlist_item_insert_after()
18544     * @see elm_genlist_item_del()
18545     *
18546     * @ingroup Genlist
18547     */
18548    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);
18549    /**
18550     * Prepend a new item in a given genlist widget.
18551     *
18552     * @param obj The genlist object
18553     * @param itc The item class for the item
18554     * @param data The item data
18555     * @param parent The parent item, or NULL if none
18556     * @param flags Item flags
18557     * @param func Convenience function called when the item is selected
18558     * @param func_data Data passed to @p func above.
18559     * @return A handle to the item added or NULL if not possible
18560     *
18561     * This adds an item to the beginning of the list or beginning of the
18562     * children of the parent if given.
18563     *
18564     * @see elm_genlist_item_append()
18565     * @see elm_genlist_item_insert_before()
18566     * @see elm_genlist_item_insert_after()
18567     * @see elm_genlist_item_del()
18568     *
18569     * @ingroup Genlist
18570     */
18571    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);
18572    /**
18573     * Insert an item before another in a genlist widget
18574     *
18575     * @param obj The genlist object
18576     * @param itc The item class for the item
18577     * @param data The item data
18578     * @param before The item to place this new one before.
18579     * @param flags Item flags
18580     * @param func Convenience function called when the item is selected
18581     * @param func_data Data passed to @p func above.
18582     * @return A handle to the item added or @c NULL if not possible
18583     *
18584     * This inserts an item before another in the list. It will be in the
18585     * same tree level or group as the item it is inserted before.
18586     *
18587     * @see elm_genlist_item_append()
18588     * @see elm_genlist_item_prepend()
18589     * @see elm_genlist_item_insert_after()
18590     * @see elm_genlist_item_del()
18591     *
18592     * @ingroup Genlist
18593     */
18594    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);
18595    /**
18596     * Insert an item after another in a genlist widget
18597     *
18598     * @param obj The genlist object
18599     * @param itc The item class for the item
18600     * @param data The item data
18601     * @param after The item to place this new one after.
18602     * @param flags Item flags
18603     * @param func Convenience function called when the item is selected
18604     * @param func_data Data passed to @p func above.
18605     * @return A handle to the item added or @c NULL if not possible
18606     *
18607     * This inserts an item after another in the list. It will be in the
18608     * same tree level or group as the item it is inserted after.
18609     *
18610     * @see elm_genlist_item_append()
18611     * @see elm_genlist_item_prepend()
18612     * @see elm_genlist_item_insert_before()
18613     * @see elm_genlist_item_del()
18614     *
18615     * @ingroup Genlist
18616     */
18617    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);
18618    /**
18619     * Insert a new item into the sorted genlist object
18620     *
18621     * @param obj The genlist object
18622     * @param itc The item class for the item
18623     * @param data The item data
18624     * @param parent The parent item, or NULL if none
18625     * @param flags Item flags
18626     * @param comp The function called for the sort
18627     * @param func Convenience function called when item selected
18628     * @param func_data Data passed to @p func above.
18629     * @return A handle to the item added or NULL if not possible
18630     *
18631     * @ingroup Genlist
18632     */
18633    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);
18634    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);
18635    /* operations to retrieve existing items */
18636    /**
18637     * Get the selectd item in the genlist.
18638     *
18639     * @param obj The genlist object
18640     * @return The selected item, or NULL if none is selected.
18641     *
18642     * This gets the selected item in the list (if multi-selection is enabled, only
18643     * the item that was first selected in the list is returned - which is not very
18644     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18645     * used).
18646     *
18647     * If no item is selected, NULL is returned.
18648     *
18649     * @see elm_genlist_selected_items_get()
18650     *
18651     * @ingroup Genlist
18652     */
18653    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18654    /**
18655     * Get a list of selected items in the genlist.
18656     *
18657     * @param obj The genlist object
18658     * @return The list of selected items, or NULL if none are selected.
18659     *
18660     * It returns a list of the selected items. This list pointer is only valid so
18661     * long as the selection doesn't change (no items are selected or unselected, or
18662     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18663     * pointers. The order of the items in this list is the order which they were
18664     * selected, i.e. the first item in this list is the first item that was
18665     * selected, and so on.
18666     *
18667     * @note If not in multi-select mode, consider using function
18668     * elm_genlist_selected_item_get() instead.
18669     *
18670     * @see elm_genlist_multi_select_set()
18671     * @see elm_genlist_selected_item_get()
18672     *
18673     * @ingroup Genlist
18674     */
18675    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18676    /**
18677     * Get the mode item style of items in the genlist
18678     * @param obj The genlist object
18679     * @return The mode item style string, or NULL if none is specified
18680     * 
18681     * This is a constant string and simply defines the name of the
18682     * style that will be used for mode animations. It can be
18683     * @c NULL if you don't plan to use Genlist mode. See
18684     * elm_genlist_item_mode_set() for more info.
18685     * 
18686     * @ingroup Genlist
18687     */
18688    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18689    /**
18690     * Set the mode item style of items in the genlist
18691     * @param obj The genlist object
18692     * @param style The mode item style string, or NULL if none is desired
18693     * 
18694     * This is a constant string and simply defines the name of the
18695     * style that will be used for mode animations. It can be
18696     * @c NULL if you don't plan to use Genlist mode. See
18697     * elm_genlist_item_mode_set() for more info.
18698     * 
18699     * @ingroup Genlist
18700     */
18701    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18702    /**
18703     * Get a list of realized items in genlist
18704     *
18705     * @param obj The genlist object
18706     * @return The list of realized items, nor NULL if none are realized.
18707     *
18708     * This returns a list of the realized items in the genlist. The list
18709     * contains Elm_Genlist_Item pointers. The list must be freed by the
18710     * caller when done with eina_list_free(). The item pointers in the
18711     * list are only valid so long as those items are not deleted or the
18712     * genlist is not deleted.
18713     *
18714     * @see elm_genlist_realized_items_update()
18715     *
18716     * @ingroup Genlist
18717     */
18718    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18719    /**
18720     * Get the item that is at the x, y canvas coords.
18721     *
18722     * @param obj The gelinst object.
18723     * @param x The input x coordinate
18724     * @param y The input y coordinate
18725     * @param posret The position relative to the item returned here
18726     * @return The item at the coordinates or NULL if none
18727     *
18728     * This returns the item at the given coordinates (which are canvas
18729     * relative, not object-relative). If an item is at that coordinate,
18730     * that item handle is returned, and if @p posret is not NULL, the
18731     * integer pointed to is set to a value of -1, 0 or 1, depending if
18732     * the coordinate is on the upper portion of that item (-1), on the
18733     * middle section (0) or on the lower part (1). If NULL is returned as
18734     * an item (no item found there), then posret may indicate -1 or 1
18735     * based if the coordinate is above or below all items respectively in
18736     * the genlist.
18737     *
18738     * @ingroup Genlist
18739     */
18740    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);
18741    /**
18742     * Get the first item in the genlist
18743     *
18744     * This returns the first item in the list.
18745     *
18746     * @param obj The genlist object
18747     * @return The first item, or NULL if none
18748     *
18749     * @ingroup Genlist
18750     */
18751    EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18752    /**
18753     * Get the last item in the genlist
18754     *
18755     * This returns the last item in the list.
18756     *
18757     * @return The last item, or NULL if none
18758     *
18759     * @ingroup Genlist
18760     */
18761    EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18762    /**
18763     * Set the scrollbar policy
18764     *
18765     * @param obj The genlist object
18766     * @param policy_h Horizontal scrollbar policy.
18767     * @param policy_v Vertical scrollbar policy.
18768     *
18769     * This sets the scrollbar visibility policy for the given genlist
18770     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18771     * made visible if it is needed, and otherwise kept hidden.
18772     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18773     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18774     * respectively for the horizontal and vertical scrollbars. Default is
18775     * #ELM_SMART_SCROLLER_POLICY_AUTO
18776     *
18777     * @see elm_genlist_scroller_policy_get()
18778     *
18779     * @ingroup Genlist
18780     */
18781    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18782    /**
18783     * Get the scrollbar policy
18784     *
18785     * @param obj The genlist object
18786     * @param policy_h Pointer to store the horizontal scrollbar policy.
18787     * @param policy_v Pointer to store the vertical scrollbar policy.
18788     *
18789     * @see elm_genlist_scroller_policy_set()
18790     *
18791     * @ingroup Genlist
18792     */
18793    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);
18794    /**
18795     * Get the @b next item in a genlist widget's internal list of items,
18796     * given a handle to one of those items.
18797     *
18798     * @param item The genlist item to fetch next from
18799     * @return The item after @p item, or @c NULL if there's none (and
18800     * on errors)
18801     *
18802     * This returns the item placed after the @p item, on the container
18803     * genlist.
18804     *
18805     * @see elm_genlist_item_prev_get()
18806     *
18807     * @ingroup Genlist
18808     */
18809    EINA_DEPRECATED EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18810    /**
18811     * Get the @b previous item in a genlist widget's internal list of items,
18812     * given a handle to one of those items.
18813     *
18814     * @param item The genlist item to fetch previous from
18815     * @return The item before @p item, or @c NULL if there's none (and
18816     * on errors)
18817     *
18818     * This returns the item placed before the @p item, on the container
18819     * genlist.
18820     *
18821     * @see elm_genlist_item_next_get()
18822     *
18823     * @ingroup Genlist
18824     */
18825    EINA_DEPRECATED EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18826    /**
18827     * Get the genlist object's handle which contains a given genlist
18828     * item
18829     *
18830     * @param item The item to fetch the container from
18831     * @return The genlist (parent) object
18832     *
18833     * This returns the genlist object itself that an item belongs to.
18834     *
18835     * @ingroup Genlist
18836     */
18837    EINA_DEPRECATED EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18838    /**
18839     * Get the parent item of the given item
18840     *
18841     * @param it The item
18842     * @return The parent of the item or @c NULL if it has no parent.
18843     *
18844     * This returns the item that was specified as parent of the item @p it on
18845     * elm_genlist_item_append() and insertion related functions.
18846     *
18847     * @ingroup Genlist
18848     */
18849    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18850    /**
18851     * Remove all sub-items (children) of the given item
18852     *
18853     * @param it The item
18854     *
18855     * This removes all items that are children (and their descendants) of the
18856     * given item @p it.
18857     *
18858     * @see elm_genlist_clear()
18859     * @see elm_genlist_item_del()
18860     *
18861     * @ingroup Genlist
18862     */
18863    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18864    /**
18865     * Set whether a given genlist item is selected or not
18866     *
18867     * @param it The item
18868     * @param selected Use @c EINA_TRUE, to make it selected, @c
18869     * EINA_FALSE to make it unselected
18870     *
18871     * This sets the selected state of an item. If multi selection is
18872     * not enabled on the containing genlist and @p selected is @c
18873     * EINA_TRUE, any other previously selected items will get
18874     * unselected in favor of this new one.
18875     *
18876     * @see elm_genlist_item_selected_get()
18877     *
18878     * @ingroup Genlist
18879     */
18880    EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18881    /**
18882     * Get whether a given genlist item is selected or not
18883     *
18884     * @param it The item
18885     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18886     *
18887     * @see elm_genlist_item_selected_set() for more details
18888     *
18889     * @ingroup Genlist
18890     */
18891    EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18892    /**
18893     * Sets the expanded state of an item.
18894     *
18895     * @param it The item
18896     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18897     *
18898     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
18899     * expanded or not.
18900     *
18901     * The theme will respond to this change visually, and a signal "expanded" or
18902     * "contracted" will be sent from the genlist with a pointer to the item that
18903     * has been expanded/contracted.
18904     *
18905     * Calling this function won't show or hide any child of this item (if it is
18906     * a parent). You must manually delete and create them on the callbacks fo
18907     * the "expanded" or "contracted" signals.
18908     *
18909     * @see elm_genlist_item_expanded_get()
18910     *
18911     * @ingroup Genlist
18912     */
18913    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
18914    /**
18915     * Get the expanded state of an item
18916     *
18917     * @param it The item
18918     * @return The expanded state
18919     *
18920     * This gets the expanded state of an item.
18921     *
18922     * @see elm_genlist_item_expanded_set()
18923     *
18924     * @ingroup Genlist
18925     */
18926    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18927    /**
18928     * Get the depth of expanded item
18929     *
18930     * @param it The genlist item object
18931     * @return The depth of expanded item
18932     *
18933     * @ingroup Genlist
18934     */
18935    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18936    /**
18937     * Set whether a given genlist item is disabled or not.
18938     *
18939     * @param it The item
18940     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
18941     * to enable it back.
18942     *
18943     * A disabled item cannot be selected or unselected. It will also
18944     * change its appearance, to signal the user it's disabled.
18945     *
18946     * @see elm_genlist_item_disabled_get()
18947     *
18948     * @ingroup Genlist
18949     */
18950    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18951    /**
18952     * Get whether a given genlist item is disabled or not.
18953     *
18954     * @param it The item
18955     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
18956     * (and on errors).
18957     *
18958     * @see elm_genlist_item_disabled_set() for more details
18959     *
18960     * @ingroup Genlist
18961     */
18962    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18963    /**
18964     * Sets the display only state of an item.
18965     *
18966     * @param it The item
18967     * @param display_only @c EINA_TRUE if the item is display only, @c
18968     * EINA_FALSE otherwise.
18969     *
18970     * A display only item cannot be selected or unselected. It is for
18971     * display only and not selecting or otherwise clicking, dragging
18972     * etc. by the user, thus finger size rules will not be applied to
18973     * this item.
18974     *
18975     * It's good to set group index items to display only state.
18976     *
18977     * @see elm_genlist_item_display_only_get()
18978     *
18979     * @ingroup Genlist
18980     */
18981    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
18982    /**
18983     * Get the display only state of an item
18984     *
18985     * @param it The item
18986     * @return @c EINA_TRUE if the item is display only, @c
18987     * EINA_FALSE otherwise.
18988     *
18989     * @see elm_genlist_item_display_only_set()
18990     *
18991     * @ingroup Genlist
18992     */
18993    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18994    /**
18995     * Show the portion of a genlist's internal list containing a given
18996     * item, immediately.
18997     *
18998     * @param it The item to display
18999     *
19000     * This causes genlist to jump to the given item @p it and show it (by
19001     * immediately scrolling to that position), if it is not fully visible.
19002     *
19003     * @see elm_genlist_item_bring_in()
19004     * @see elm_genlist_item_top_show()
19005     * @see elm_genlist_item_middle_show()
19006     *
19007     * @ingroup Genlist
19008     */
19009    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19010    /**
19011     * Animatedly bring in, to the visible are of a genlist, a given
19012     * item on it.
19013     *
19014     * @param it The item to display
19015     *
19016     * This causes genlist to jump to the given item @p it and show it (by
19017     * animatedly scrolling), if it is not fully visible. This may use animation
19018     * to do so and take a period of time
19019     *
19020     * @see elm_genlist_item_show()
19021     * @see elm_genlist_item_top_bring_in()
19022     * @see elm_genlist_item_middle_bring_in()
19023     *
19024     * @ingroup Genlist
19025     */
19026    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19027    /**
19028     * Show the portion of a genlist's internal list containing a given
19029     * item, immediately.
19030     *
19031     * @param it The item to display
19032     *
19033     * This causes genlist to jump to the given item @p it and show it (by
19034     * immediately scrolling to that position), if it is not fully visible.
19035     *
19036     * The item will be positioned at the top of the genlist viewport.
19037     *
19038     * @see elm_genlist_item_show()
19039     * @see elm_genlist_item_top_bring_in()
19040     *
19041     * @ingroup Genlist
19042     */
19043    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19044    /**
19045     * Animatedly bring in, to the visible are of a genlist, a given
19046     * item on it.
19047     *
19048     * @param it The item
19049     *
19050     * This causes genlist to jump to the given item @p it and show it (by
19051     * animatedly scrolling), if it is not fully visible. This may use animation
19052     * to do so and take a period of time
19053     *
19054     * The item will be positioned at the top of the genlist viewport.
19055     *
19056     * @see elm_genlist_item_bring_in()
19057     * @see elm_genlist_item_top_show()
19058     *
19059     * @ingroup Genlist
19060     */
19061    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19062    /**
19063     * Show the portion of a genlist's internal list containing a given
19064     * item, immediately.
19065     *
19066     * @param it The item to display
19067     *
19068     * This causes genlist to jump to the given item @p it and show it (by
19069     * immediately scrolling to that position), if it is not fully visible.
19070     *
19071     * The item will be positioned at the middle of the genlist viewport.
19072     *
19073     * @see elm_genlist_item_show()
19074     * @see elm_genlist_item_middle_bring_in()
19075     *
19076     * @ingroup Genlist
19077     */
19078    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19079    /**
19080     * Animatedly bring in, to the visible are of a genlist, a given
19081     * item on it.
19082     *
19083     * @param it The item
19084     *
19085     * This causes genlist to jump to the given item @p it and show it (by
19086     * animatedly scrolling), if it is not fully visible. This may use animation
19087     * to do so and take a period of time
19088     *
19089     * The item will be positioned at the middle of the genlist viewport.
19090     *
19091     * @see elm_genlist_item_bring_in()
19092     * @see elm_genlist_item_middle_show()
19093     *
19094     * @ingroup Genlist
19095     */
19096    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19097    /**
19098     * Remove a genlist item from the its parent, deleting it.
19099     *
19100     * @param item The item to be removed.
19101     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19102     *
19103     * @see elm_genlist_clear(), to remove all items in a genlist at
19104     * once.
19105     *
19106     * @ingroup Genlist
19107     */
19108    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19109    /**
19110     * Return the data associated to a given genlist item
19111     *
19112     * @param item The genlist item.
19113     * @return the data associated to this item.
19114     *
19115     * This returns the @c data value passed on the
19116     * elm_genlist_item_append() and related item addition calls.
19117     *
19118     * @see elm_genlist_item_append()
19119     * @see elm_genlist_item_data_set()
19120     *
19121     * @ingroup Genlist
19122     */
19123    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19124    /**
19125     * Set the data associated to a given genlist item
19126     *
19127     * @param item The genlist item
19128     * @param data The new data pointer to set on it
19129     *
19130     * This @b overrides the @c data value passed on the
19131     * elm_genlist_item_append() and related item addition calls. This
19132     * function @b won't call elm_genlist_item_update() automatically,
19133     * so you'd issue it afterwards if you want to hove the item
19134     * updated to reflect the that new data.
19135     *
19136     * @see elm_genlist_item_data_get()
19137     *
19138     * @ingroup Genlist
19139     */
19140    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19141    /**
19142     * Tells genlist to "orphan" icons fetchs by the item class
19143     *
19144     * @param it The item
19145     *
19146     * This instructs genlist to release references to icons in the item,
19147     * meaning that they will no longer be managed by genlist and are
19148     * floating "orphans" that can be re-used elsewhere if the user wants
19149     * to.
19150     *
19151     * @ingroup Genlist
19152     */
19153    EAPI void               elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19154    EINA_DEPRECATED EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19155    /**
19156     * Get the real Evas object created to implement the view of a
19157     * given genlist item
19158     *
19159     * @param item The genlist item.
19160     * @return the Evas object implementing this item's view.
19161     *
19162     * This returns the actual Evas object used to implement the
19163     * specified genlist item's view. This may be @c NULL, as it may
19164     * not have been created or may have been deleted, at any time, by
19165     * the genlist. <b>Do not modify this object</b> (move, resize,
19166     * show, hide, etc.), as the genlist is controlling it. This
19167     * function is for querying, emitting custom signals or hooking
19168     * lower level callbacks for events on that object. Do not delete
19169     * this object under any circumstances.
19170     *
19171     * @see elm_genlist_item_data_get()
19172     *
19173     * @ingroup Genlist
19174     */
19175    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19176    /**
19177     * Update the contents of an item
19178     *
19179     * @param it The item
19180     *
19181     * This updates an item by calling all the item class functions again
19182     * to get the icons, labels and states. Use this when the original
19183     * item data has changed and the changes are desired to be reflected.
19184     *
19185     * Use elm_genlist_realized_items_update() to update all already realized
19186     * items.
19187     *
19188     * @see elm_genlist_realized_items_update()
19189     *
19190     * @ingroup Genlist
19191     */
19192    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19193    /**
19194     * Update the item class of an item
19195     *
19196     * @param it The item
19197     * @param itc The item class for the item
19198     *
19199     * This sets another class fo the item, changing the way that it is
19200     * displayed. After changing the item class, elm_genlist_item_update() is
19201     * called on the item @p it.
19202     *
19203     * @ingroup Genlist
19204     */
19205    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19206    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19207    /**
19208     * Set the text to be shown in a given genlist item's tooltips.
19209     *
19210     * @param item The genlist item
19211     * @param text The text to set in the content
19212     *
19213     * This call will setup the text to be used as tooltip to that item
19214     * (analogous to elm_object_tooltip_text_set(), but being item
19215     * tooltips with higher precedence than object tooltips). It can
19216     * have only one tooltip at a time, so any previous tooltip data
19217     * will get removed.
19218     *
19219     * In order to set an icon or something else as a tooltip, look at
19220     * elm_genlist_item_tooltip_content_cb_set().
19221     *
19222     * @ingroup Genlist
19223     */
19224    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19225    /**
19226     * Set the content to be shown in a given genlist item's tooltips
19227     *
19228     * @param item The genlist item.
19229     * @param func The function returning the tooltip contents.
19230     * @param data What to provide to @a func as callback data/context.
19231     * @param del_cb Called when data is not needed anymore, either when
19232     *        another callback replaces @p func, the tooltip is unset with
19233     *        elm_genlist_item_tooltip_unset() or the owner @p item
19234     *        dies. This callback receives as its first parameter the
19235     *        given @p data, being @c event_info the item handle.
19236     *
19237     * This call will setup the tooltip's contents to @p item
19238     * (analogous to elm_object_tooltip_content_cb_set(), but being
19239     * item tooltips with higher precedence than object tooltips). It
19240     * can have only one tooltip at a time, so any previous tooltip
19241     * content will get removed. @p func (with @p data) will be called
19242     * every time Elementary needs to show the tooltip and it should
19243     * return a valid Evas object, which will be fully managed by the
19244     * tooltip system, getting deleted when the tooltip is gone.
19245     *
19246     * In order to set just a text as a tooltip, look at
19247     * elm_genlist_item_tooltip_text_set().
19248     *
19249     * @ingroup Genlist
19250     */
19251    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);
19252    /**
19253     * Unset a tooltip from a given genlist item
19254     *
19255     * @param item genlist item to remove a previously set tooltip from.
19256     *
19257     * This call removes any tooltip set on @p item. The callback
19258     * provided as @c del_cb to
19259     * elm_genlist_item_tooltip_content_cb_set() will be called to
19260     * notify it is not used anymore (and have resources cleaned, if
19261     * need be).
19262     *
19263     * @see elm_genlist_item_tooltip_content_cb_set()
19264     *
19265     * @ingroup Genlist
19266     */
19267    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19268    /**
19269     * Set a different @b style for a given genlist item's tooltip.
19270     *
19271     * @param item genlist item with tooltip set
19272     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19273     * "default", @c "transparent", etc)
19274     *
19275     * Tooltips can have <b>alternate styles</b> to be displayed on,
19276     * which are defined by the theme set on Elementary. This function
19277     * works analogously as elm_object_tooltip_style_set(), but here
19278     * applied only to genlist item objects. The default style for
19279     * tooltips is @c "default".
19280     *
19281     * @note before you set a style you should define a tooltip with
19282     *       elm_genlist_item_tooltip_content_cb_set() or
19283     *       elm_genlist_item_tooltip_text_set()
19284     *
19285     * @see elm_genlist_item_tooltip_style_get()
19286     *
19287     * @ingroup Genlist
19288     */
19289    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19290    /**
19291     * Get the style set a given genlist item's tooltip.
19292     *
19293     * @param item genlist item with tooltip already set on.
19294     * @return style the theme style in use, which defaults to
19295     *         "default". If the object does not have a tooltip set,
19296     *         then @c NULL is returned.
19297     *
19298     * @see elm_genlist_item_tooltip_style_set() for more details
19299     *
19300     * @ingroup Genlist
19301     */
19302    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19303    /**
19304     * @brief Disable size restrictions on an object's tooltip
19305     * @param item The tooltip's anchor object
19306     * @param disable If EINA_TRUE, size restrictions are disabled
19307     * @return EINA_FALSE on failure, EINA_TRUE on success
19308     *
19309     * This function allows a tooltip to expand beyond its parant window's canvas.
19310     * It will instead be limited only by the size of the display.
19311     */
19312    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19313    /**
19314     * @brief Retrieve size restriction state of an object's tooltip
19315     * @param item The tooltip's anchor object
19316     * @return If EINA_TRUE, size restrictions are disabled
19317     *
19318     * This function returns whether a tooltip is allowed to expand beyond
19319     * its parant window's canvas.
19320     * It will instead be limited only by the size of the display.
19321     */
19322    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19323    /**
19324     * Set the type of mouse pointer/cursor decoration to be shown,
19325     * when the mouse pointer is over the given genlist widget item
19326     *
19327     * @param item genlist item to customize cursor on
19328     * @param cursor the cursor type's name
19329     *
19330     * This function works analogously as elm_object_cursor_set(), but
19331     * here the cursor's changing area is restricted to the item's
19332     * area, and not the whole widget's. Note that that item cursors
19333     * have precedence over widget cursors, so that a mouse over @p
19334     * item will always show cursor @p type.
19335     *
19336     * If this function is called twice for an object, a previously set
19337     * cursor will be unset on the second call.
19338     *
19339     * @see elm_object_cursor_set()
19340     * @see elm_genlist_item_cursor_get()
19341     * @see elm_genlist_item_cursor_unset()
19342     *
19343     * @ingroup Genlist
19344     */
19345    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19346    /**
19347     * Get the type of mouse pointer/cursor decoration set to be shown,
19348     * when the mouse pointer is over the given genlist widget item
19349     *
19350     * @param item genlist item with custom cursor set
19351     * @return the cursor type's name or @c NULL, if no custom cursors
19352     * were set to @p item (and on errors)
19353     *
19354     * @see elm_object_cursor_get()
19355     * @see elm_genlist_item_cursor_set() for more details
19356     * @see elm_genlist_item_cursor_unset()
19357     *
19358     * @ingroup Genlist
19359     */
19360    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19361    /**
19362     * Unset any custom mouse pointer/cursor decoration set to be
19363     * shown, when the mouse pointer is over the given genlist widget
19364     * item, thus making it show the @b default cursor again.
19365     *
19366     * @param item a genlist item
19367     *
19368     * Use this call to undo any custom settings on this item's cursor
19369     * decoration, bringing it back to defaults (no custom style set).
19370     *
19371     * @see elm_object_cursor_unset()
19372     * @see elm_genlist_item_cursor_set() for more details
19373     *
19374     * @ingroup Genlist
19375     */
19376    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19377    /**
19378     * Set a different @b style for a given custom cursor set for a
19379     * genlist item.
19380     *
19381     * @param item genlist item with custom cursor set
19382     * @param style the <b>theme style</b> to use (e.g. @c "default",
19383     * @c "transparent", etc)
19384     *
19385     * This function only makes sense when one is using custom mouse
19386     * cursor decorations <b>defined in a theme file</b> , which can
19387     * have, given a cursor name/type, <b>alternate styles</b> on
19388     * it. It works analogously as elm_object_cursor_style_set(), but
19389     * here applied only to genlist item objects.
19390     *
19391     * @warning Before you set a cursor style you should have defined a
19392     *       custom cursor previously on the item, with
19393     *       elm_genlist_item_cursor_set()
19394     *
19395     * @see elm_genlist_item_cursor_engine_only_set()
19396     * @see elm_genlist_item_cursor_style_get()
19397     *
19398     * @ingroup Genlist
19399     */
19400    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19401    /**
19402     * Get the current @b style set for a given genlist item's custom
19403     * cursor
19404     *
19405     * @param item genlist item with custom cursor set.
19406     * @return style the cursor style in use. If the object does not
19407     *         have a cursor set, then @c NULL is returned.
19408     *
19409     * @see elm_genlist_item_cursor_style_set() for more details
19410     *
19411     * @ingroup Genlist
19412     */
19413    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19414    /**
19415     * Set if the (custom) cursor for a given genlist item should be
19416     * searched in its theme, also, or should only rely on the
19417     * rendering engine.
19418     *
19419     * @param item item with custom (custom) cursor already set on
19420     * @param engine_only Use @c EINA_TRUE to have cursors looked for
19421     * only on those provided by the rendering engine, @c EINA_FALSE to
19422     * have them searched on the widget's theme, as well.
19423     *
19424     * @note This call is of use only if you've set a custom cursor
19425     * for genlist items, with elm_genlist_item_cursor_set().
19426     *
19427     * @note By default, cursors will only be looked for between those
19428     * provided by the rendering engine.
19429     *
19430     * @ingroup Genlist
19431     */
19432    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19433    /**
19434     * Get if the (custom) cursor for a given genlist item is being
19435     * searched in its theme, also, or is only relying on the rendering
19436     * engine.
19437     *
19438     * @param item a genlist item
19439     * @return @c EINA_TRUE, if cursors are being looked for only on
19440     * those provided by the rendering engine, @c EINA_FALSE if they
19441     * are being searched on the widget's theme, as well.
19442     *
19443     * @see elm_genlist_item_cursor_engine_only_set(), for more details
19444     *
19445     * @ingroup Genlist
19446     */
19447    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19448    /**
19449     * Update the contents of all realized items.
19450     *
19451     * @param obj The genlist object.
19452     *
19453     * This updates all realized items by calling all the item class functions again
19454     * to get the icons, labels and states. Use this when the original
19455     * item data has changed and the changes are desired to be reflected.
19456     *
19457     * To update just one item, use elm_genlist_item_update().
19458     *
19459     * @see elm_genlist_realized_items_get()
19460     * @see elm_genlist_item_update()
19461     *
19462     * @ingroup Genlist
19463     */
19464    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19465    /**
19466     * Activate a genlist mode on an item
19467     *
19468     * @param item The genlist item
19469     * @param mode Mode name
19470     * @param mode_set Boolean to define set or unset mode.
19471     *
19472     * A genlist mode is a different way of selecting an item. Once a mode is
19473     * activated on an item, any other selected item is immediately unselected.
19474     * This feature provides an easy way of implementing a new kind of animation
19475     * for selecting an item, without having to entirely rewrite the item style
19476     * theme. However, the elm_genlist_selected_* API can't be used to get what
19477     * item is activate for a mode.
19478     *
19479     * The current item style will still be used, but applying a genlist mode to
19480     * an item will select it using a different kind of animation.
19481     *
19482     * The current active item for a mode can be found by
19483     * elm_genlist_mode_item_get().
19484     *
19485     * The characteristics of genlist mode are:
19486     * - Only one mode can be active at any time, and for only one item.
19487     * - Genlist handles deactivating other items when one item is activated.
19488     * - A mode is defined in the genlist theme (edc), and more modes can easily
19489     *   be added.
19490     * - A mode style and the genlist item style are different things. They
19491     *   can be combined to provide a default style to the item, with some kind
19492     *   of animation for that item when the mode is activated.
19493     *
19494     * When a mode is activated on an item, a new view for that item is created.
19495     * The theme of this mode defines the animation that will be used to transit
19496     * the item from the old view to the new view. This second (new) view will be
19497     * active for that item while the mode is active on the item, and will be
19498     * destroyed after the mode is totally deactivated from that item.
19499     *
19500     * @see elm_genlist_mode_get()
19501     * @see elm_genlist_mode_item_get()
19502     *
19503     * @ingroup Genlist
19504     */
19505    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19506    /**
19507     * Get the last (or current) genlist mode used.
19508     *
19509     * @param obj The genlist object
19510     *
19511     * This function just returns the name of the last used genlist mode. It will
19512     * be the current mode if it's still active.
19513     *
19514     * @see elm_genlist_item_mode_set()
19515     * @see elm_genlist_mode_item_get()
19516     *
19517     * @ingroup Genlist
19518     */
19519    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19520    /**
19521     * Get active genlist mode item
19522     *
19523     * @param obj The genlist object
19524     * @return The active item for that current mode. Or @c NULL if no item is
19525     * activated with any mode.
19526     *
19527     * This function returns the item that was activated with a mode, by the
19528     * function elm_genlist_item_mode_set().
19529     *
19530     * @see elm_genlist_item_mode_set()
19531     * @see elm_genlist_mode_get()
19532     *
19533     * @ingroup Genlist
19534     */
19535    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19536
19537    /**
19538     * Set reorder mode
19539     *
19540     * @param obj The genlist object
19541     * @param reorder_mode The reorder mode
19542     * (EINA_TRUE = on, EINA_FALSE = off)
19543     *
19544     * @ingroup Genlist
19545     */
19546    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19547
19548    /**
19549     * Get the reorder mode
19550     *
19551     * @param obj The genlist object
19552     * @return The reorder mode
19553     * (EINA_TRUE = on, EINA_FALSE = off)
19554     *
19555     * @ingroup Genlist
19556     */
19557    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19558
19559    /**
19560     * @}
19561     */
19562
19563    /**
19564     * @defgroup Check Check
19565     *
19566     * @image html img/widget/check/preview-00.png
19567     * @image latex img/widget/check/preview-00.eps
19568     * @image html img/widget/check/preview-01.png
19569     * @image latex img/widget/check/preview-01.eps
19570     * @image html img/widget/check/preview-02.png
19571     * @image latex img/widget/check/preview-02.eps
19572     *
19573     * @brief The check widget allows for toggling a value between true and
19574     * false.
19575     *
19576     * Check objects are a lot like radio objects in layout and functionality
19577     * except they do not work as a group, but independently and only toggle the
19578     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19579     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19580     * returns the current state. For convenience, like the radio objects, you
19581     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19582     * for it to modify.
19583     *
19584     * Signals that you can add callbacks for are:
19585     * "changed" - This is called whenever the user changes the state of one of
19586     *             the check object(event_info is NULL).
19587     *
19588     * @ref tutorial_check should give you a firm grasp of how to use this widget.
19589     * @{
19590     */
19591    /**
19592     * @brief Add a new Check object
19593     *
19594     * @param parent The parent object
19595     * @return The new object or NULL if it cannot be created
19596     */
19597    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19598    /**
19599     * @brief Set the text label of the check object
19600     *
19601     * @param obj The check object
19602     * @param label The text label string in UTF-8
19603     *
19604     * @deprecated use elm_object_text_set() instead.
19605     */
19606    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19607    /**
19608     * @brief Get the text label of the check object
19609     *
19610     * @param obj The check object
19611     * @return The text label string in UTF-8
19612     *
19613     * @deprecated use elm_object_text_get() instead.
19614     */
19615    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19616    /**
19617     * @brief Set the icon object of the check object
19618     *
19619     * @param obj The check object
19620     * @param icon The icon object
19621     *
19622     * Once the icon object is set, a previously set one will be deleted.
19623     * If you want to keep that old content object, use the
19624     * elm_check_icon_unset() function.
19625     */
19626    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19627    /**
19628     * @brief Get the icon object of the check object
19629     *
19630     * @param obj The check object
19631     * @return The icon object
19632     */
19633    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19634    /**
19635     * @brief Unset the icon used for the check object
19636     *
19637     * @param obj The check object
19638     * @return The icon object that was being used
19639     *
19640     * Unparent and return the icon object which was set for this widget.
19641     */
19642    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19643    /**
19644     * @brief Set the on/off state of the check object
19645     *
19646     * @param obj The check object
19647     * @param state The state to use (1 == on, 0 == off)
19648     *
19649     * This sets the state of the check. If set
19650     * with elm_check_state_pointer_set() the state of that variable is also
19651     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19652     */
19653    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19654    /**
19655     * @brief Get the state of the check object
19656     *
19657     * @param obj The check object
19658     * @return The boolean state
19659     */
19660    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19661    /**
19662     * @brief Set a convenience pointer to a boolean to change
19663     *
19664     * @param obj The check object
19665     * @param statep Pointer to the boolean to modify
19666     *
19667     * This sets a pointer to a boolean, that, in addition to the check objects
19668     * state will also be modified directly. To stop setting the object pointed
19669     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19670     * then when this is called, the check objects state will also be modified to
19671     * reflect the value of the boolean @p statep points to, just like calling
19672     * elm_check_state_set().
19673     */
19674    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19675    EINA_DEPRECATED EAPI void         elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
19676    EINA_DEPRECATED EAPI void         elm_check_states_labels_get(const Evas_Object *obj, const char **ontext, const char **offtext) EINA_ARG_NONNULL(1,2,3);
19677
19678    /**
19679     * @}
19680     */
19681
19682    /**
19683     * @defgroup Radio Radio
19684     *
19685     * @image html img/widget/radio/preview-00.png
19686     * @image latex img/widget/radio/preview-00.eps
19687     *
19688     * @brief Radio is a widget that allows for 1 or more options to be displayed
19689     * and have the user choose only 1 of them.
19690     *
19691     * A radio object contains an indicator, an optional Label and an optional
19692     * icon object. While it's possible to have a group of only one radio they,
19693     * are normally used in groups of 2 or more. To add a radio to a group use
19694     * elm_radio_group_add(). The radio object(s) will select from one of a set
19695     * of integer values, so any value they are configuring needs to be mapped to
19696     * a set of integers. To configure what value that radio object represents,
19697     * use  elm_radio_state_value_set() to set the integer it represents. To set
19698     * the value the whole group(which one is currently selected) is to indicate
19699     * use elm_radio_value_set() on any group member, and to get the groups value
19700     * use elm_radio_value_get(). For convenience the radio objects are also able
19701     * to directly set an integer(int) to the value that is selected. To specify
19702     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19703     * The radio objects will modify this directly. That implies the pointer must
19704     * point to valid memory for as long as the radio objects exist.
19705     *
19706     * Signals that you can add callbacks for are:
19707     * @li changed - This is called whenever the user changes the state of one of
19708     * the radio objects within the group of radio objects that work together.
19709     *
19710     * @ref tutorial_radio show most of this API in action.
19711     * @{
19712     */
19713    /**
19714     * @brief Add a new radio to the parent
19715     *
19716     * @param parent The parent object
19717     * @return The new object or NULL if it cannot be created
19718     */
19719    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19720    /**
19721     * @brief Set the text label of the radio object
19722     *
19723     * @param obj The radio object
19724     * @param label The text label string in UTF-8
19725     *
19726     * @deprecated use elm_object_text_set() instead.
19727     */
19728    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19729    /**
19730     * @brief Get the text label of the radio object
19731     *
19732     * @param obj The radio object
19733     * @return The text label string in UTF-8
19734     *
19735     * @deprecated use elm_object_text_set() instead.
19736     */
19737    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19738    /**
19739     * @brief Set the icon object of the radio object
19740     *
19741     * @param obj The radio object
19742     * @param icon The icon object
19743     *
19744     * Once the icon object is set, a previously set one will be deleted. If you
19745     * want to keep that old content object, use the elm_radio_icon_unset()
19746     * function.
19747     */
19748    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19749    /**
19750     * @brief Get the icon object of the radio object
19751     *
19752     * @param obj The radio object
19753     * @return The icon object
19754     *
19755     * @see elm_radio_icon_set()
19756     */
19757    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19758    /**
19759     * @brief Unset the icon used for the radio object
19760     *
19761     * @param obj The radio object
19762     * @return The icon object that was being used
19763     *
19764     * Unparent and return the icon object which was set for this widget.
19765     *
19766     * @see elm_radio_icon_set()
19767     */
19768    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19769    /**
19770     * @brief Add this radio to a group of other radio objects
19771     *
19772     * @param obj The radio object
19773     * @param group Any object whose group the @p obj is to join.
19774     *
19775     * Radio objects work in groups. Each member should have a different integer
19776     * value assigned. In order to have them work as a group, they need to know
19777     * about each other. This adds the given radio object to the group of which
19778     * the group object indicated is a member.
19779     */
19780    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19781    /**
19782     * @brief Set the integer value that this radio object represents
19783     *
19784     * @param obj The radio object
19785     * @param value The value to use if this radio object is selected
19786     *
19787     * This sets the value of the radio.
19788     */
19789    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19790    /**
19791     * @brief Get the integer value that this radio object represents
19792     *
19793     * @param obj The radio object
19794     * @return The value used if this radio object is selected
19795     *
19796     * This gets the value of the radio.
19797     *
19798     * @see elm_radio_value_set()
19799     */
19800    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19801    /**
19802     * @brief Set the value of the radio.
19803     *
19804     * @param obj The radio object
19805     * @param value The value to use for the group
19806     *
19807     * This sets the value of the radio group and will also set the value if
19808     * pointed to, to the value supplied, but will not call any callbacks.
19809     */
19810    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19811    /**
19812     * @brief Get the state of the radio object
19813     *
19814     * @param obj The radio object
19815     * @return The integer state
19816     */
19817    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19818    /**
19819     * @brief Set a convenience pointer to a integer to change
19820     *
19821     * @param obj The radio object
19822     * @param valuep Pointer to the integer to modify
19823     *
19824     * This sets a pointer to a integer, that, in addition to the radio objects
19825     * state will also be modified directly. To stop setting the object pointed
19826     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19827     * when this is called, the radio objects state will also be modified to
19828     * reflect the value of the integer valuep points to, just like calling
19829     * elm_radio_value_set().
19830     */
19831    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19832    /**
19833     * @}
19834     */
19835
19836    /**
19837     * @defgroup Pager Pager
19838     *
19839     * @image html img/widget/pager/preview-00.png
19840     * @image latex img/widget/pager/preview-00.eps
19841     *
19842     * @brief Widget that allows flipping between 1 or more “pages” of objects.
19843     *
19844     * The flipping between “pages” of objects is animated. All content in pager
19845     * is kept in a stack, the last content to be added will be on the top of the
19846     * stack(be visible).
19847     *
19848     * Objects can be pushed or popped from the stack or deleted as normal.
19849     * Pushes and pops will animate (and a pop will delete the object once the
19850     * animation is finished). Any object already in the pager can be promoted to
19851     * the top(from its current stacking position) through the use of
19852     * elm_pager_content_promote(). Objects are pushed to the top with
19853     * elm_pager_content_push() and when the top item is no longer wanted, simply
19854     * pop it with elm_pager_content_pop() and it will also be deleted. If an
19855     * object is no longer needed and is not the top item, just delete it as
19856     * normal. You can query which objects are the top and bottom with
19857     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
19858     *
19859     * Signals that you can add callbacks for are:
19860     * "hide,finished" - when the previous page is hided
19861     *
19862     * This widget has the following styles available:
19863     * @li default
19864     * @li fade
19865     * @li fade_translucide
19866     * @li fade_invisible
19867     * @note This styles affect only the flipping animations, the appearance when
19868     * not animating is unaffected by styles.
19869     *
19870     * @ref tutorial_pager gives a good overview of the usage of the API.
19871     * @{
19872     */
19873    /**
19874     * Add a new pager to the parent
19875     *
19876     * @param parent The parent object
19877     * @return The new object or NULL if it cannot be created
19878     *
19879     * @ingroup Pager
19880     */
19881    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19882    /**
19883     * @brief Push an object to the top of the pager stack (and show it).
19884     *
19885     * @param obj The pager object
19886     * @param content The object to push
19887     *
19888     * The object pushed becomes a child of the pager, it will be controlled and
19889     * deleted when the pager is deleted.
19890     *
19891     * @note If the content is already in the stack use
19892     * elm_pager_content_promote().
19893     * @warning Using this function on @p content already in the stack results in
19894     * undefined behavior.
19895     */
19896    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19897    /**
19898     * @brief Pop the object that is on top of the stack
19899     *
19900     * @param obj The pager object
19901     *
19902     * This pops the object that is on the top(visible) of the pager, makes it
19903     * disappear, then deletes the object. The object that was underneath it on
19904     * the stack will become visible.
19905     */
19906    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
19907    /**
19908     * @brief Moves an object already in the pager stack to the top of the stack.
19909     *
19910     * @param obj The pager object
19911     * @param content The object to promote
19912     *
19913     * This will take the @p content and move it to the top of the stack as
19914     * if it had been pushed there.
19915     *
19916     * @note If the content isn't already in the stack use
19917     * elm_pager_content_push().
19918     * @warning Using this function on @p content not already in the stack
19919     * results in undefined behavior.
19920     */
19921    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19922    /**
19923     * @brief Return the object at the bottom of the pager stack
19924     *
19925     * @param obj The pager object
19926     * @return The bottom object or NULL if none
19927     */
19928    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19929    /**
19930     * @brief  Return the object at the top of the pager stack
19931     *
19932     * @param obj The pager object
19933     * @return The top object or NULL if none
19934     */
19935    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19936
19937    /**
19938     * @}
19939     */
19940
19941    /**
19942     * @defgroup Slideshow Slideshow
19943     *
19944     * @image html img/widget/slideshow/preview-00.png
19945     * @image latex img/widget/slideshow/preview-00.eps
19946     *
19947     * This widget, as the name indicates, is a pre-made image
19948     * slideshow panel, with API functions acting on (child) image
19949     * items presentation. Between those actions, are:
19950     * - advance to next/previous image
19951     * - select the style of image transition animation
19952     * - set the exhibition time for each image
19953     * - start/stop the slideshow
19954     *
19955     * The transition animations are defined in the widget's theme,
19956     * consequently new animations can be added without having to
19957     * update the widget's code.
19958     *
19959     * @section Slideshow_Items Slideshow items
19960     *
19961     * For slideshow items, just like for @ref Genlist "genlist" ones,
19962     * the user defines a @b classes, specifying functions that will be
19963     * called on the item's creation and deletion times.
19964     *
19965     * The #Elm_Slideshow_Item_Class structure contains the following
19966     * members:
19967     *
19968     * - @c func.get - When an item is displayed, this function is
19969     *   called, and it's where one should create the item object, de
19970     *   facto. For example, the object can be a pure Evas image object
19971     *   or an Elementary @ref Photocam "photocam" widget. See
19972     *   #SlideshowItemGetFunc.
19973     * - @c func.del - When an item is no more displayed, this function
19974     *   is called, where the user must delete any data associated to
19975     *   the item. See #SlideshowItemDelFunc.
19976     *
19977     * @section Slideshow_Caching Slideshow caching
19978     *
19979     * The slideshow provides facilities to have items adjacent to the
19980     * one being displayed <b>already "realized"</b> (i.e. loaded) for
19981     * you, so that the system does not have to decode image data
19982     * anymore at the time it has to actually switch images on its
19983     * viewport. The user is able to set the numbers of items to be
19984     * cached @b before and @b after the current item, in the widget's
19985     * item list.
19986     *
19987     * Smart events one can add callbacks for are:
19988     *
19989     * - @c "changed" - when the slideshow switches its view to a new
19990     *   item
19991     *
19992     * List of examples for the slideshow widget:
19993     * @li @ref slideshow_example
19994     */
19995
19996    /**
19997     * @addtogroup Slideshow
19998     * @{
19999     */
20000
20001    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20002    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20003    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
20004    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20005    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20006
20007    /**
20008     * @struct _Elm_Slideshow_Item_Class
20009     *
20010     * Slideshow item class definition. See @ref Slideshow_Items for
20011     * field details.
20012     */
20013    struct _Elm_Slideshow_Item_Class
20014      {
20015         struct _Elm_Slideshow_Item_Class_Func
20016           {
20017              SlideshowItemGetFunc get;
20018              SlideshowItemDelFunc del;
20019           } func;
20020      }; /**< #Elm_Slideshow_Item_Class member definitions */
20021
20022    /**
20023     * Add a new slideshow widget to the given parent Elementary
20024     * (container) object
20025     *
20026     * @param parent The parent object
20027     * @return A new slideshow widget handle or @c NULL, on errors
20028     *
20029     * This function inserts a new slideshow widget on the canvas.
20030     *
20031     * @ingroup Slideshow
20032     */
20033    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20034
20035    /**
20036     * Add (append) a new item in a given slideshow widget.
20037     *
20038     * @param obj The slideshow object
20039     * @param itc The item class for the item
20040     * @param data The item's data
20041     * @return A handle to the item added or @c NULL, on errors
20042     *
20043     * Add a new item to @p obj's internal list of items, appending it.
20044     * The item's class must contain the function really fetching the
20045     * image object to show for this item, which could be an Evas image
20046     * object or an Elementary photo, for example. The @p data
20047     * parameter is going to be passed to both class functions of the
20048     * item.
20049     *
20050     * @see #Elm_Slideshow_Item_Class
20051     * @see elm_slideshow_item_sorted_insert()
20052     *
20053     * @ingroup Slideshow
20054     */
20055    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20056
20057    /**
20058     * Insert a new item into the given slideshow widget, using the @p func
20059     * function to sort items (by item handles).
20060     *
20061     * @param obj The slideshow object
20062     * @param itc The item class for the item
20063     * @param data The item's data
20064     * @param func The comparing function to be used to sort slideshow
20065     * items <b>by #Elm_Slideshow_Item item handles</b>
20066     * @return Returns The slideshow item handle, on success, or
20067     * @c NULL, on errors
20068     *
20069     * Add a new item to @p obj's internal list of items, in a position
20070     * determined by the @p func comparing function. The item's class
20071     * must contain the function really fetching the image object to
20072     * show for this item, which could be an Evas image object or an
20073     * Elementary photo, for example. The @p data parameter is going to
20074     * be passed to both class functions of the item.
20075     *
20076     * @see #Elm_Slideshow_Item_Class
20077     * @see elm_slideshow_item_add()
20078     *
20079     * @ingroup Slideshow
20080     */
20081    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);
20082
20083    /**
20084     * Display a given slideshow widget's item, programmatically.
20085     *
20086     * @param obj The slideshow object
20087     * @param item The item to display on @p obj's viewport
20088     *
20089     * The change between the current item and @p item will use the
20090     * transition @p obj is set to use (@see
20091     * elm_slideshow_transition_set()).
20092     *
20093     * @ingroup Slideshow
20094     */
20095    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20096
20097    /**
20098     * Slide to the @b next item, in a given slideshow widget
20099     *
20100     * @param obj The slideshow object
20101     *
20102     * The sliding animation @p obj is set to use will be the
20103     * transition effect used, after this call is issued.
20104     *
20105     * @note If the end of the slideshow's internal list of items is
20106     * reached, it'll wrap around to the list's beginning, again.
20107     *
20108     * @ingroup Slideshow
20109     */
20110    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20111
20112    /**
20113     * Slide to the @b previous item, in a given slideshow widget
20114     *
20115     * @param obj The slideshow object
20116     *
20117     * The sliding animation @p obj is set to use will be the
20118     * transition effect used, after this call is issued.
20119     *
20120     * @note If the beginning of the slideshow's internal list of items
20121     * is reached, it'll wrap around to the list's end, again.
20122     *
20123     * @ingroup Slideshow
20124     */
20125    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20126
20127    /**
20128     * Returns the list of sliding transition/effect names available, for a
20129     * given slideshow widget.
20130     *
20131     * @param obj The slideshow object
20132     * @return The list of transitions (list of @b stringshared strings
20133     * as data)
20134     *
20135     * The transitions, which come from @p obj's theme, must be an EDC
20136     * data item named @c "transitions" on the theme file, with (prefix)
20137     * names of EDC programs actually implementing them.
20138     *
20139     * The available transitions for slideshows on the default theme are:
20140     * - @c "fade" - the current item fades out, while the new one
20141     *   fades in to the slideshow's viewport.
20142     * - @c "black_fade" - the current item fades to black, and just
20143     *   then, the new item will fade in.
20144     * - @c "horizontal" - the current item slides horizontally, until
20145     *   it gets out of the slideshow's viewport, while the new item
20146     *   comes from the left to take its place.
20147     * - @c "vertical" - the current item slides vertically, until it
20148     *   gets out of the slideshow's viewport, while the new item comes
20149     *   from the bottom to take its place.
20150     * - @c "square" - the new item starts to appear from the middle of
20151     *   the current one, but with a tiny size, growing until its
20152     *   target (full) size and covering the old one.
20153     *
20154     * @warning The stringshared strings get no new references
20155     * exclusive to the user grabbing the list, here, so if you'd like
20156     * to use them out of this call's context, you'd better @c
20157     * eina_stringshare_ref() them.
20158     *
20159     * @see elm_slideshow_transition_set()
20160     *
20161     * @ingroup Slideshow
20162     */
20163    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20164
20165    /**
20166     * Set the current slide transition/effect in use for a given
20167     * slideshow widget
20168     *
20169     * @param obj The slideshow object
20170     * @param transition The new transition's name string
20171     *
20172     * If @p transition is implemented in @p obj's theme (i.e., is
20173     * contained in the list returned by
20174     * elm_slideshow_transitions_get()), this new sliding effect will
20175     * be used on the widget.
20176     *
20177     * @see elm_slideshow_transitions_get() for more details
20178     *
20179     * @ingroup Slideshow
20180     */
20181    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20182
20183    /**
20184     * Get the current slide transition/effect in use for a given
20185     * slideshow widget
20186     *
20187     * @param obj The slideshow object
20188     * @return The current transition's name
20189     *
20190     * @see elm_slideshow_transition_set() for more details
20191     *
20192     * @ingroup Slideshow
20193     */
20194    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20195
20196    /**
20197     * Set the interval between each image transition on a given
20198     * slideshow widget, <b>and start the slideshow, itself</b>
20199     *
20200     * @param obj The slideshow object
20201     * @param timeout The new displaying timeout for images
20202     *
20203     * After this call, the slideshow widget will start cycling its
20204     * view, sequentially and automatically, with the images of the
20205     * items it has. The time between each new image displayed is going
20206     * to be @p timeout, in @b seconds. If a different timeout was set
20207     * previously and an slideshow was in progress, it will continue
20208     * with the new time between transitions, after this call.
20209     *
20210     * @note A value less than or equal to 0 on @p timeout will disable
20211     * the widget's internal timer, thus halting any slideshow which
20212     * could be happening on @p obj.
20213     *
20214     * @see elm_slideshow_timeout_get()
20215     *
20216     * @ingroup Slideshow
20217     */
20218    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20219
20220    /**
20221     * Get the interval set for image transitions on a given slideshow
20222     * widget.
20223     *
20224     * @param obj The slideshow object
20225     * @return Returns the timeout set on it
20226     *
20227     * @see elm_slideshow_timeout_set() for more details
20228     *
20229     * @ingroup Slideshow
20230     */
20231    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20232
20233    /**
20234     * Set if, after a slideshow is started, for a given slideshow
20235     * widget, its items should be displayed cyclically or not.
20236     *
20237     * @param obj The slideshow object
20238     * @param loop Use @c EINA_TRUE to make it cycle through items or
20239     * @c EINA_FALSE for it to stop at the end of @p obj's internal
20240     * list of items
20241     *
20242     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20243     * ignore what is set by this functions, i.e., they'll @b always
20244     * cycle through items. This affects only the "automatic"
20245     * slideshow, as set by elm_slideshow_timeout_set().
20246     *
20247     * @see elm_slideshow_loop_get()
20248     *
20249     * @ingroup Slideshow
20250     */
20251    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20252
20253    /**
20254     * Get if, after a slideshow is started, for a given slideshow
20255     * widget, its items are to be displayed cyclically or not.
20256     *
20257     * @param obj The slideshow object
20258     * @return @c EINA_TRUE, if the items in @p obj will be cycled
20259     * through or @c EINA_FALSE, otherwise
20260     *
20261     * @see elm_slideshow_loop_set() for more details
20262     *
20263     * @ingroup Slideshow
20264     */
20265    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20266
20267    /**
20268     * Remove all items from a given slideshow widget
20269     *
20270     * @param obj The slideshow object
20271     *
20272     * This removes (and deletes) all items in @p obj, leaving it
20273     * empty.
20274     *
20275     * @see elm_slideshow_item_del(), to remove just one item.
20276     *
20277     * @ingroup Slideshow
20278     */
20279    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20280
20281    /**
20282     * Get the internal list of items in a given slideshow widget.
20283     *
20284     * @param obj The slideshow object
20285     * @return The list of items (#Elm_Slideshow_Item as data) or
20286     * @c NULL on errors.
20287     *
20288     * This list is @b not to be modified in any way and must not be
20289     * freed. Use the list members with functions like
20290     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20291     *
20292     * @warning This list is only valid until @p obj object's internal
20293     * items list is changed. It should be fetched again with another
20294     * call to this function when changes happen.
20295     *
20296     * @ingroup Slideshow
20297     */
20298    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20299
20300    /**
20301     * Delete a given item from a slideshow widget.
20302     *
20303     * @param item The slideshow item
20304     *
20305     * @ingroup Slideshow
20306     */
20307    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20308
20309    /**
20310     * Return the data associated with a given slideshow item
20311     *
20312     * @param item The slideshow item
20313     * @return Returns the data associated to this item
20314     *
20315     * @ingroup Slideshow
20316     */
20317    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20318
20319    /**
20320     * Returns the currently displayed item, in a given slideshow widget
20321     *
20322     * @param obj The slideshow object
20323     * @return A handle to the item being displayed in @p obj or
20324     * @c NULL, if none is (and on errors)
20325     *
20326     * @ingroup Slideshow
20327     */
20328    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20329
20330    /**
20331     * Get the real Evas object created to implement the view of a
20332     * given slideshow item
20333     *
20334     * @param item The slideshow item.
20335     * @return the Evas object implementing this item's view.
20336     *
20337     * This returns the actual Evas object used to implement the
20338     * specified slideshow item's view. This may be @c NULL, as it may
20339     * not have been created or may have been deleted, at any time, by
20340     * the slideshow. <b>Do not modify this object</b> (move, resize,
20341     * show, hide, etc.), as the slideshow is controlling it. This
20342     * function is for querying, emitting custom signals or hooking
20343     * lower level callbacks for events on that object. Do not delete
20344     * this object under any circumstances.
20345     *
20346     * @see elm_slideshow_item_data_get()
20347     *
20348     * @ingroup Slideshow
20349     */
20350    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20351
20352    /**
20353     * Get the the item, in a given slideshow widget, placed at
20354     * position @p nth, in its internal items list
20355     *
20356     * @param obj The slideshow object
20357     * @param nth The number of the item to grab a handle to (0 being
20358     * the first)
20359     * @return The item stored in @p obj at position @p nth or @c NULL,
20360     * if there's no item with that index (and on errors)
20361     *
20362     * @ingroup Slideshow
20363     */
20364    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20365
20366    /**
20367     * Set the current slide layout in use for a given slideshow widget
20368     *
20369     * @param obj The slideshow object
20370     * @param layout The new layout's name string
20371     *
20372     * If @p layout is implemented in @p obj's theme (i.e., is contained
20373     * in the list returned by elm_slideshow_layouts_get()), this new
20374     * images layout will be used on the widget.
20375     *
20376     * @see elm_slideshow_layouts_get() for more details
20377     *
20378     * @ingroup Slideshow
20379     */
20380    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20381
20382    /**
20383     * Get the current slide layout in use for a given slideshow widget
20384     *
20385     * @param obj The slideshow object
20386     * @return The current layout's name
20387     *
20388     * @see elm_slideshow_layout_set() for more details
20389     *
20390     * @ingroup Slideshow
20391     */
20392    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20393
20394    /**
20395     * Returns the list of @b layout names available, for a given
20396     * slideshow widget.
20397     *
20398     * @param obj The slideshow object
20399     * @return The list of layouts (list of @b stringshared strings
20400     * as data)
20401     *
20402     * Slideshow layouts will change how the widget is to dispose each
20403     * image item in its viewport, with regard to cropping, scaling,
20404     * etc.
20405     *
20406     * The layouts, which come from @p obj's theme, must be an EDC
20407     * data item name @c "layouts" on the theme file, with (prefix)
20408     * names of EDC programs actually implementing them.
20409     *
20410     * The available layouts for slideshows on the default theme are:
20411     * - @c "fullscreen" - item images with original aspect, scaled to
20412     *   touch top and down slideshow borders or, if the image's heigh
20413     *   is not enough, left and right slideshow borders.
20414     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20415     *   one, but always leaving 10% of the slideshow's dimensions of
20416     *   distance between the item image's borders and the slideshow
20417     *   borders, for each axis.
20418     *
20419     * @warning The stringshared strings get no new references
20420     * exclusive to the user grabbing the list, here, so if you'd like
20421     * to use them out of this call's context, you'd better @c
20422     * eina_stringshare_ref() them.
20423     *
20424     * @see elm_slideshow_layout_set()
20425     *
20426     * @ingroup Slideshow
20427     */
20428    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20429
20430    /**
20431     * Set the number of items to cache, on a given slideshow widget,
20432     * <b>before the current item</b>
20433     *
20434     * @param obj The slideshow object
20435     * @param count Number of items to cache before the current one
20436     *
20437     * The default value for this property is @c 2. See
20438     * @ref Slideshow_Caching "slideshow caching" for more details.
20439     *
20440     * @see elm_slideshow_cache_before_get()
20441     *
20442     * @ingroup Slideshow
20443     */
20444    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20445
20446    /**
20447     * Retrieve the number of items to cache, on a given slideshow widget,
20448     * <b>before the current item</b>
20449     *
20450     * @param obj The slideshow object
20451     * @return The number of items set to be cached before the current one
20452     *
20453     * @see elm_slideshow_cache_before_set() for more details
20454     *
20455     * @ingroup Slideshow
20456     */
20457    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20458
20459    /**
20460     * Set the number of items to cache, on a given slideshow widget,
20461     * <b>after the current item</b>
20462     *
20463     * @param obj The slideshow object
20464     * @param count Number of items to cache after the current one
20465     *
20466     * The default value for this property is @c 2. See
20467     * @ref Slideshow_Caching "slideshow caching" for more details.
20468     *
20469     * @see elm_slideshow_cache_after_get()
20470     *
20471     * @ingroup Slideshow
20472     */
20473    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20474
20475    /**
20476     * Retrieve the number of items to cache, on a given slideshow widget,
20477     * <b>after the current item</b>
20478     *
20479     * @param obj The slideshow object
20480     * @return The number of items set to be cached after the current one
20481     *
20482     * @see elm_slideshow_cache_after_set() for more details
20483     *
20484     * @ingroup Slideshow
20485     */
20486    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20487
20488    /**
20489     * Get the number of items stored in a given slideshow widget
20490     *
20491     * @param obj The slideshow object
20492     * @return The number of items on @p obj, at the moment of this call
20493     *
20494     * @ingroup Slideshow
20495     */
20496    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20497
20498    /**
20499     * @}
20500     */
20501
20502    /**
20503     * @defgroup Fileselector File Selector
20504     *
20505     * @image html img/widget/fileselector/preview-00.png
20506     * @image latex img/widget/fileselector/preview-00.eps
20507     *
20508     * A file selector is a widget that allows a user to navigate
20509     * through a file system, reporting file selections back via its
20510     * API.
20511     *
20512     * It contains shortcut buttons for home directory (@c ~) and to
20513     * jump one directory upwards (..), as well as cancel/ok buttons to
20514     * confirm/cancel a given selection. After either one of those two
20515     * former actions, the file selector will issue its @c "done" smart
20516     * callback.
20517     *
20518     * There's a text entry on it, too, showing the name of the current
20519     * selection. There's the possibility of making it editable, so it
20520     * is useful on file saving dialogs on applications, where one
20521     * gives a file name to save contents to, in a given directory in
20522     * the system. This custom file name will be reported on the @c
20523     * "done" smart callback (explained in sequence).
20524     *
20525     * Finally, it has a view to display file system items into in two
20526     * possible forms:
20527     * - list
20528     * - grid
20529     *
20530     * If Elementary is built with support of the Ethumb thumbnailing
20531     * library, the second form of view will display preview thumbnails
20532     * of files which it supports.
20533     *
20534     * Smart callbacks one can register to:
20535     *
20536     * - @c "selected" - the user has clicked on a file (when not in
20537     *      folders-only mode) or directory (when in folders-only mode)
20538     * - @c "directory,open" - the list has been populated with new
20539     *      content (@c event_info is a pointer to the directory's
20540     *      path, a @b stringshared string)
20541     * - @c "done" - the user has clicked on the "ok" or "cancel"
20542     *      buttons (@c event_info is a pointer to the selection's
20543     *      path, a @b stringshared string)
20544     *
20545     * Here is an example on its usage:
20546     * @li @ref fileselector_example
20547     */
20548
20549    /**
20550     * @addtogroup Fileselector
20551     * @{
20552     */
20553
20554    /**
20555     * Defines how a file selector widget is to layout its contents
20556     * (file system entries).
20557     */
20558    typedef enum _Elm_Fileselector_Mode
20559      {
20560         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20561         ELM_FILESELECTOR_GRID, /**< layout as a grid */
20562         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20563      } Elm_Fileselector_Mode;
20564
20565    /**
20566     * Add a new file selector widget to the given parent Elementary
20567     * (container) object
20568     *
20569     * @param parent The parent object
20570     * @return a new file selector widget handle or @c NULL, on errors
20571     *
20572     * This function inserts a new file selector widget on the canvas.
20573     *
20574     * @ingroup Fileselector
20575     */
20576    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20577
20578    /**
20579     * Enable/disable the file name entry box where the user can type
20580     * in a name for a file, in a given file selector widget
20581     *
20582     * @param obj The file selector object
20583     * @param is_save @c EINA_TRUE to make the file selector a "saving
20584     * dialog", @c EINA_FALSE otherwise
20585     *
20586     * Having the entry editable is useful on file saving dialogs on
20587     * applications, where one gives a file name to save contents to,
20588     * in a given directory in the system. This custom file name will
20589     * be reported on the @c "done" smart callback.
20590     *
20591     * @see elm_fileselector_is_save_get()
20592     *
20593     * @ingroup Fileselector
20594     */
20595    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20596
20597    /**
20598     * Get whether the given file selector is in "saving dialog" mode
20599     *
20600     * @param obj The file selector object
20601     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20602     * mode, @c EINA_FALSE otherwise (and on errors)
20603     *
20604     * @see elm_fileselector_is_save_set() for more details
20605     *
20606     * @ingroup Fileselector
20607     */
20608    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20609
20610    /**
20611     * Enable/disable folder-only view for a given file selector widget
20612     *
20613     * @param obj The file selector object
20614     * @param only @c EINA_TRUE to make @p obj only display
20615     * directories, @c EINA_FALSE to make files to be displayed in it
20616     * too
20617     *
20618     * If enabled, the widget's view will only display folder items,
20619     * naturally.
20620     *
20621     * @see elm_fileselector_folder_only_get()
20622     *
20623     * @ingroup Fileselector
20624     */
20625    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20626
20627    /**
20628     * Get whether folder-only view is set for a given file selector
20629     * widget
20630     *
20631     * @param obj The file selector object
20632     * @return only @c EINA_TRUE if @p obj is only displaying
20633     * directories, @c EINA_FALSE if files are being displayed in it
20634     * too (and on errors)
20635     *
20636     * @see elm_fileselector_folder_only_get()
20637     *
20638     * @ingroup Fileselector
20639     */
20640    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20641
20642    /**
20643     * Enable/disable the "ok" and "cancel" buttons on a given file
20644     * selector widget
20645     *
20646     * @param obj The file selector object
20647     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20648     *
20649     * @note A file selector without those buttons will never emit the
20650     * @c "done" smart event, and is only usable if one is just hooking
20651     * to the other two events.
20652     *
20653     * @see elm_fileselector_buttons_ok_cancel_get()
20654     *
20655     * @ingroup Fileselector
20656     */
20657    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20658
20659    /**
20660     * Get whether the "ok" and "cancel" buttons on a given file
20661     * selector widget are being shown.
20662     *
20663     * @param obj The file selector object
20664     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20665     * otherwise (and on errors)
20666     *
20667     * @see elm_fileselector_buttons_ok_cancel_set() for more details
20668     *
20669     * @ingroup Fileselector
20670     */
20671    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20672
20673    /**
20674     * Enable/disable a tree view in the given file selector widget,
20675     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20676     *
20677     * @param obj The file selector object
20678     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20679     * disable
20680     *
20681     * In a tree view, arrows are created on the sides of directories,
20682     * allowing them to expand in place.
20683     *
20684     * @note If it's in other mode, the changes made by this function
20685     * will only be visible when one switches back to "list" mode.
20686     *
20687     * @see elm_fileselector_expandable_get()
20688     *
20689     * @ingroup Fileselector
20690     */
20691    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20692
20693    /**
20694     * Get whether tree view is enabled for the given file selector
20695     * widget
20696     *
20697     * @param obj The file selector object
20698     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20699     * otherwise (and or errors)
20700     *
20701     * @see elm_fileselector_expandable_set() for more details
20702     *
20703     * @ingroup Fileselector
20704     */
20705    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20706
20707    /**
20708     * Set, programmatically, the @b directory that a given file
20709     * selector widget will display contents from
20710     *
20711     * @param obj The file selector object
20712     * @param path The path to display in @p obj
20713     *
20714     * This will change the @b directory that @p obj is displaying. It
20715     * will also clear the text entry area on the @p obj object, which
20716     * displays select files' names.
20717     *
20718     * @see elm_fileselector_path_get()
20719     *
20720     * @ingroup Fileselector
20721     */
20722    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20723
20724    /**
20725     * Get the parent directory's path that a given file selector
20726     * widget is displaying
20727     *
20728     * @param obj The file selector object
20729     * @return The (full) path of the directory the file selector is
20730     * displaying, a @b stringshared string
20731     *
20732     * @see elm_fileselector_path_set()
20733     *
20734     * @ingroup Fileselector
20735     */
20736    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20737
20738    /**
20739     * Set, programmatically, the currently selected file/directory in
20740     * the given file selector widget
20741     *
20742     * @param obj The file selector object
20743     * @param path The (full) path to a file or directory
20744     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20745     * latter case occurs if the directory or file pointed to do not
20746     * exist.
20747     *
20748     * @see elm_fileselector_selected_get()
20749     *
20750     * @ingroup Fileselector
20751     */
20752    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20753
20754    /**
20755     * Get the currently selected item's (full) path, in the given file
20756     * selector widget
20757     *
20758     * @param obj The file selector object
20759     * @return The absolute path of the selected item, a @b
20760     * stringshared string
20761     *
20762     * @note Custom editions on @p obj object's text entry, if made,
20763     * will appear on the return string of this function, naturally.
20764     *
20765     * @see elm_fileselector_selected_set() for more details
20766     *
20767     * @ingroup Fileselector
20768     */
20769    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20770
20771    /**
20772     * Set the mode in which a given file selector widget will display
20773     * (layout) file system entries in its view
20774     *
20775     * @param obj The file selector object
20776     * @param mode The mode of the fileselector, being it one of
20777     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20778     * first one, naturally, will display the files in a list. The
20779     * latter will make the widget to display its entries in a grid
20780     * form.
20781     *
20782     * @note By using elm_fileselector_expandable_set(), the user may
20783     * trigger a tree view for that list.
20784     *
20785     * @note If Elementary is built with support of the Ethumb
20786     * thumbnailing library, the second form of view will display
20787     * preview thumbnails of files which it supports. You must have
20788     * elm_need_ethumb() called in your Elementary for thumbnailing to
20789     * work, though.
20790     *
20791     * @see elm_fileselector_expandable_set().
20792     * @see elm_fileselector_mode_get().
20793     *
20794     * @ingroup Fileselector
20795     */
20796    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20797
20798    /**
20799     * Get the mode in which a given file selector widget is displaying
20800     * (layouting) file system entries in its view
20801     *
20802     * @param obj The fileselector object
20803     * @return The mode in which the fileselector is at
20804     *
20805     * @see elm_fileselector_mode_set() for more details
20806     *
20807     * @ingroup Fileselector
20808     */
20809    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20810
20811    /**
20812     * @}
20813     */
20814
20815    /**
20816     * @defgroup Progressbar Progress bar
20817     *
20818     * The progress bar is a widget for visually representing the
20819     * progress status of a given job/task.
20820     *
20821     * A progress bar may be horizontal or vertical. It may display an
20822     * icon besides it, as well as primary and @b units labels. The
20823     * former is meant to label the widget as a whole, while the
20824     * latter, which is formatted with floating point values (and thus
20825     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20826     * units"</c>), is meant to label the widget's <b>progress
20827     * value</b>. Label, icon and unit strings/objects are @b optional
20828     * for progress bars.
20829     *
20830     * A progress bar may be @b inverted, in which state it gets its
20831     * values inverted, with high values being on the left or top and
20832     * low values on the right or bottom, as opposed to normally have
20833     * the low values on the former and high values on the latter,
20834     * respectively, for horizontal and vertical modes.
20835     *
20836     * The @b span of the progress, as set by
20837     * elm_progressbar_span_size_set(), is its length (horizontally or
20838     * vertically), unless one puts size hints on the widget to expand
20839     * on desired directions, by any container. That length will be
20840     * scaled by the object or applications scaling factor. At any
20841     * point code can query the progress bar for its value with
20842     * elm_progressbar_value_get().
20843     *
20844     * Available widget styles for progress bars:
20845     * - @c "default"
20846     * - @c "wheel" (simple style, no text, no progression, only
20847     *      "pulse" effect is available)
20848     *
20849     * Here is an example on its usage:
20850     * @li @ref progressbar_example
20851     */
20852
20853    /**
20854     * Add a new progress bar widget to the given parent Elementary
20855     * (container) object
20856     *
20857     * @param parent The parent object
20858     * @return a new progress bar widget handle or @c NULL, on errors
20859     *
20860     * This function inserts a new progress bar widget on the canvas.
20861     *
20862     * @ingroup Progressbar
20863     */
20864    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20865
20866    /**
20867     * Set whether a given progress bar widget is at "pulsing mode" or
20868     * not.
20869     *
20870     * @param obj The progress bar object
20871     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
20872     * @c EINA_FALSE to put it back to its default one
20873     *
20874     * By default, progress bars will display values from the low to
20875     * high value boundaries. There are, though, contexts in which the
20876     * state of progression of a given task is @b unknown.  For those,
20877     * one can set a progress bar widget to a "pulsing state", to give
20878     * the user an idea that some computation is being held, but
20879     * without exact progress values. In the default theme it will
20880     * animate its bar with the contents filling in constantly and back
20881     * to non-filled, in a loop. To start and stop this pulsing
20882     * animation, one has to explicitly call elm_progressbar_pulse().
20883     *
20884     * @see elm_progressbar_pulse_get()
20885     * @see elm_progressbar_pulse()
20886     *
20887     * @ingroup Progressbar
20888     */
20889    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
20890
20891    /**
20892     * Get whether a given progress bar widget is at "pulsing mode" or
20893     * not.
20894     *
20895     * @param obj The progress bar object
20896     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
20897     * if it's in the default one (and on errors)
20898     *
20899     * @ingroup Progressbar
20900     */
20901    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20902
20903    /**
20904     * Start/stop a given progress bar "pulsing" animation, if its
20905     * under that mode
20906     *
20907     * @param obj The progress bar object
20908     * @param state @c EINA_TRUE, to @b start the pulsing animation,
20909     * @c EINA_FALSE to @b stop it
20910     *
20911     * @note This call won't do anything if @p obj is not under "pulsing mode".
20912     *
20913     * @see elm_progressbar_pulse_set() for more details.
20914     *
20915     * @ingroup Progressbar
20916     */
20917    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20918
20919    /**
20920     * Set the progress value (in percentage) on a given progress bar
20921     * widget
20922     *
20923     * @param obj The progress bar object
20924     * @param val The progress value (@b must be between @c 0.0 and @c
20925     * 1.0)
20926     *
20927     * Use this call to set progress bar levels.
20928     *
20929     * @note If you passes a value out of the specified range for @p
20930     * val, it will be interpreted as the @b closest of the @b boundary
20931     * values in the range.
20932     *
20933     * @ingroup Progressbar
20934     */
20935    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20936
20937    /**
20938     * Get the progress value (in percentage) on a given progress bar
20939     * widget
20940     *
20941     * @param obj The progress bar object
20942     * @return The value of the progressbar
20943     *
20944     * @see elm_progressbar_value_set() for more details
20945     *
20946     * @ingroup Progressbar
20947     */
20948    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20949
20950    /**
20951     * Set the label of a given progress bar widget
20952     *
20953     * @param obj The progress bar object
20954     * @param label The text label string, in UTF-8
20955     *
20956     * @ingroup Progressbar
20957     * @deprecated use elm_object_text_set() instead.
20958     */
20959    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20960
20961    /**
20962     * Get the label of a given progress bar widget
20963     *
20964     * @param obj The progressbar object
20965     * @return The text label string, in UTF-8
20966     *
20967     * @ingroup Progressbar
20968     * @deprecated use elm_object_text_set() instead.
20969     */
20970    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20971
20972    /**
20973     * Set the icon object of a given progress bar widget
20974     *
20975     * @param obj The progress bar object
20976     * @param icon The icon object
20977     *
20978     * Use this call to decorate @p obj with an icon next to it.
20979     *
20980     * @note Once the icon object is set, a previously set one will be
20981     * deleted. If you want to keep that old content object, use the
20982     * elm_progressbar_icon_unset() function.
20983     *
20984     * @see elm_progressbar_icon_get()
20985     *
20986     * @ingroup Progressbar
20987     */
20988    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20989
20990    /**
20991     * Retrieve the icon object set for a given progress bar widget
20992     *
20993     * @param obj The progress bar object
20994     * @return The icon object's handle, if @p obj had one set, or @c NULL,
20995     * otherwise (and on errors)
20996     *
20997     * @see elm_progressbar_icon_set() for more details
20998     *
20999     * @ingroup Progressbar
21000     */
21001    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21002
21003    /**
21004     * Unset an icon set on a given progress bar widget
21005     *
21006     * @param obj The progress bar object
21007     * @return The icon object that was being used, if any was set, or
21008     * @c NULL, otherwise (and on errors)
21009     *
21010     * This call will unparent and return the icon object which was set
21011     * for this widget, previously, on success.
21012     *
21013     * @see elm_progressbar_icon_set() for more details
21014     *
21015     * @ingroup Progressbar
21016     */
21017    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21018
21019    /**
21020     * Set the (exact) length of the bar region of a given progress bar
21021     * widget
21022     *
21023     * @param obj The progress bar object
21024     * @param size The length of the progress bar's bar region
21025     *
21026     * This sets the minimum width (when in horizontal mode) or height
21027     * (when in vertical mode) of the actual bar area of the progress
21028     * bar @p obj. This in turn affects the object's minimum size. Use
21029     * this when you're not setting other size hints expanding on the
21030     * given direction (like weight and alignment hints) and you would
21031     * like it to have a specific size.
21032     *
21033     * @note Icon, label and unit text around @p obj will require their
21034     * own space, which will make @p obj to require more the @p size,
21035     * actually.
21036     *
21037     * @see elm_progressbar_span_size_get()
21038     *
21039     * @ingroup Progressbar
21040     */
21041    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21042
21043    /**
21044     * Get the length set for the bar region of a given progress bar
21045     * widget
21046     *
21047     * @param obj The progress bar object
21048     * @return The length of the progress bar's bar region
21049     *
21050     * If that size was not set previously, with
21051     * elm_progressbar_span_size_set(), this call will return @c 0.
21052     *
21053     * @ingroup Progressbar
21054     */
21055    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21056
21057    /**
21058     * Set the format string for a given progress bar widget's units
21059     * label
21060     *
21061     * @param obj The progress bar object
21062     * @param format The format string for @p obj's units label
21063     *
21064     * If @c NULL is passed on @p format, it will make @p obj's units
21065     * area to be hidden completely. If not, it'll set the <b>format
21066     * string</b> for the units label's @b text. The units label is
21067     * provided a floating point value, so the units text is up display
21068     * at most one floating point falue. Note that the units label is
21069     * optional. Use a format string such as "%1.2f meters" for
21070     * example.
21071     *
21072     * @note The default format string for a progress bar is an integer
21073     * percentage, as in @c "%.0f %%".
21074     *
21075     * @see elm_progressbar_unit_format_get()
21076     *
21077     * @ingroup Progressbar
21078     */
21079    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21080
21081    /**
21082     * Retrieve the format string set for a given progress bar widget's
21083     * units label
21084     *
21085     * @param obj The progress bar object
21086     * @return The format set string for @p obj's units label or
21087     * @c NULL, if none was set (and on errors)
21088     *
21089     * @see elm_progressbar_unit_format_set() for more details
21090     *
21091     * @ingroup Progressbar
21092     */
21093    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21094
21095    /**
21096     * Set the orientation of a given progress bar widget
21097     *
21098     * @param obj The progress bar object
21099     * @param horizontal Use @c EINA_TRUE to make @p obj to be
21100     * @b horizontal, @c EINA_FALSE to make it @b vertical
21101     *
21102     * Use this function to change how your progress bar is to be
21103     * disposed: vertically or horizontally.
21104     *
21105     * @see elm_progressbar_horizontal_get()
21106     *
21107     * @ingroup Progressbar
21108     */
21109    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21110
21111    /**
21112     * Retrieve the orientation of a given progress bar widget
21113     *
21114     * @param obj The progress bar object
21115     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21116     * @c EINA_FALSE if it's @b vertical (and on errors)
21117     *
21118     * @see elm_progressbar_horizontal_set() for more details
21119     *
21120     * @ingroup Progressbar
21121     */
21122    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21123
21124    /**
21125     * Invert a given progress bar widget's displaying values order
21126     *
21127     * @param obj The progress bar object
21128     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21129     * @c EINA_FALSE to bring it back to default, non-inverted values.
21130     *
21131     * A progress bar may be @b inverted, in which state it gets its
21132     * values inverted, with high values being on the left or top and
21133     * low values on the right or bottom, as opposed to normally have
21134     * the low values on the former and high values on the latter,
21135     * respectively, for horizontal and vertical modes.
21136     *
21137     * @see elm_progressbar_inverted_get()
21138     *
21139     * @ingroup Progressbar
21140     */
21141    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21142
21143    /**
21144     * Get whether a given progress bar widget's displaying values are
21145     * inverted or not
21146     *
21147     * @param obj The progress bar object
21148     * @return @c EINA_TRUE, if @p obj has inverted values,
21149     * @c EINA_FALSE otherwise (and on errors)
21150     *
21151     * @see elm_progressbar_inverted_set() for more details
21152     *
21153     * @ingroup Progressbar
21154     */
21155    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21156
21157    /**
21158     * @defgroup Separator Separator
21159     *
21160     * @brief Separator is a very thin object used to separate other objects.
21161     *
21162     * A separator can be vertical or horizontal.
21163     *
21164     * @ref tutorial_separator is a good example of how to use a separator.
21165     * @{
21166     */
21167    /**
21168     * @brief Add a separator object to @p parent
21169     *
21170     * @param parent The parent object
21171     *
21172     * @return The separator object, or NULL upon failure
21173     */
21174    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21175    /**
21176     * @brief Set the horizontal mode of a separator object
21177     *
21178     * @param obj The separator object
21179     * @param horizontal If true, the separator is horizontal
21180     */
21181    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21182    /**
21183     * @brief Get the horizontal mode of a separator object
21184     *
21185     * @param obj The separator object
21186     * @return If true, the separator is horizontal
21187     *
21188     * @see elm_separator_horizontal_set()
21189     */
21190    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21191    /**
21192     * @}
21193     */
21194
21195    /**
21196     * @defgroup Spinner Spinner
21197     * @ingroup Elementary
21198     *
21199     * @image html img/widget/spinner/preview-00.png
21200     * @image latex img/widget/spinner/preview-00.eps
21201     *
21202     * A spinner is a widget which allows the user to increase or decrease
21203     * numeric values using arrow buttons, or edit values directly, clicking
21204     * over it and typing the new value.
21205     *
21206     * By default the spinner will not wrap and has a label
21207     * of "%.0f" (just showing the integer value of the double).
21208     *
21209     * A spinner has a label that is formatted with floating
21210     * point values and thus accepts a printf-style format string, like
21211     * “%1.2f units”.
21212     *
21213     * It also allows specific values to be replaced by pre-defined labels.
21214     *
21215     * Smart callbacks one can register to:
21216     *
21217     * - "changed" - Whenever the spinner value is changed.
21218     * - "delay,changed" - A short time after the value is changed by the user.
21219     *    This will be called only when the user stops dragging for a very short
21220     *    period or when they release their finger/mouse, so it avoids possibly
21221     *    expensive reactions to the value change.
21222     *
21223     * Available styles for it:
21224     * - @c "default";
21225     * - @c "vertical": up/down buttons at the right side and text left aligned.
21226     *
21227     * Here is an example on its usage:
21228     * @ref spinner_example
21229     */
21230
21231    /**
21232     * @addtogroup Spinner
21233     * @{
21234     */
21235
21236    /**
21237     * Add a new spinner widget to the given parent Elementary
21238     * (container) object.
21239     *
21240     * @param parent The parent object.
21241     * @return a new spinner widget handle or @c NULL, on errors.
21242     *
21243     * This function inserts a new spinner widget on the canvas.
21244     *
21245     * @ingroup Spinner
21246     *
21247     */
21248    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21249
21250    /**
21251     * Set the format string of the displayed label.
21252     *
21253     * @param obj The spinner object.
21254     * @param fmt The format string for the label display.
21255     *
21256     * If @c NULL, this sets the format to "%.0f". If not it sets the format
21257     * string for the label text. The label text is provided a floating point
21258     * value, so the label text can display up to 1 floating point value.
21259     * Note that this is optional.
21260     *
21261     * Use a format string such as "%1.2f meters" for example, and it will
21262     * display values like: "3.14 meters" for a value equal to 3.14159.
21263     *
21264     * Default is "%0.f".
21265     *
21266     * @see elm_spinner_label_format_get()
21267     *
21268     * @ingroup Spinner
21269     */
21270    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21271
21272    /**
21273     * Get the label format of the spinner.
21274     *
21275     * @param obj The spinner object.
21276     * @return The text label format string in UTF-8.
21277     *
21278     * @see elm_spinner_label_format_set() for details.
21279     *
21280     * @ingroup Spinner
21281     */
21282    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21283
21284    /**
21285     * Set the minimum and maximum values for the spinner.
21286     *
21287     * @param obj The spinner object.
21288     * @param min The minimum value.
21289     * @param max The maximum value.
21290     *
21291     * Define the allowed range of values to be selected by the user.
21292     *
21293     * If actual value is less than @p min, it will be updated to @p min. If it
21294     * is bigger then @p max, will be updated to @p max. Actual value can be
21295     * get with elm_spinner_value_get().
21296     *
21297     * By default, min is equal to 0, and max is equal to 100.
21298     *
21299     * @warning Maximum must be greater than minimum.
21300     *
21301     * @see elm_spinner_min_max_get()
21302     *
21303     * @ingroup Spinner
21304     */
21305    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21306
21307    /**
21308     * Get the minimum and maximum values of the spinner.
21309     *
21310     * @param obj The spinner object.
21311     * @param min Pointer where to store the minimum value.
21312     * @param max Pointer where to store the maximum value.
21313     *
21314     * @note If only one value is needed, the other pointer can be passed
21315     * as @c NULL.
21316     *
21317     * @see elm_spinner_min_max_set() for details.
21318     *
21319     * @ingroup Spinner
21320     */
21321    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21322
21323    /**
21324     * Set the step used to increment or decrement the spinner value.
21325     *
21326     * @param obj The spinner object.
21327     * @param step The step value.
21328     *
21329     * This value will be incremented or decremented to the displayed value.
21330     * It will be incremented while the user keep right or top arrow pressed,
21331     * and will be decremented while the user keep left or bottom arrow pressed.
21332     *
21333     * The interval to increment / decrement can be set with
21334     * elm_spinner_interval_set().
21335     *
21336     * By default step value is equal to 1.
21337     *
21338     * @see elm_spinner_step_get()
21339     *
21340     * @ingroup Spinner
21341     */
21342    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21343
21344    /**
21345     * Get the step used to increment or decrement the spinner value.
21346     *
21347     * @param obj The spinner object.
21348     * @return The step value.
21349     *
21350     * @see elm_spinner_step_get() for more details.
21351     *
21352     * @ingroup Spinner
21353     */
21354    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21355
21356    /**
21357     * Set the value the spinner displays.
21358     *
21359     * @param obj The spinner object.
21360     * @param val The value to be displayed.
21361     *
21362     * Value will be presented on the label following format specified with
21363     * elm_spinner_format_set().
21364     *
21365     * @warning The value must to be between min and max values. This values
21366     * are set by elm_spinner_min_max_set().
21367     *
21368     * @see elm_spinner_value_get().
21369     * @see elm_spinner_format_set().
21370     * @see elm_spinner_min_max_set().
21371     *
21372     * @ingroup Spinner
21373     */
21374    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21375
21376    /**
21377     * Get the value displayed by the spinner.
21378     *
21379     * @param obj The spinner object.
21380     * @return The value displayed.
21381     *
21382     * @see elm_spinner_value_set() for details.
21383     *
21384     * @ingroup Spinner
21385     */
21386    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21387
21388    /**
21389     * Set whether the spinner should wrap when it reaches its
21390     * minimum or maximum value.
21391     *
21392     * @param obj The spinner object.
21393     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21394     * disable it.
21395     *
21396     * Disabled by default. If disabled, when the user tries to increment the
21397     * value,
21398     * but displayed value plus step value is bigger than maximum value,
21399     * the spinner
21400     * won't allow it. The same happens when the user tries to decrement it,
21401     * but the value less step is less than minimum value.
21402     *
21403     * When wrap is enabled, in such situations it will allow these changes,
21404     * but will get the value that would be less than minimum and subtracts
21405     * from maximum. Or add the value that would be more than maximum to
21406     * the minimum.
21407     *
21408     * E.g.:
21409     * @li min value = 10
21410     * @li max value = 50
21411     * @li step value = 20
21412     * @li displayed value = 20
21413     *
21414     * When the user decrement value (using left or bottom arrow), it will
21415     * displays @c 40, because max - (min - (displayed - step)) is
21416     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21417     *
21418     * @see elm_spinner_wrap_get().
21419     *
21420     * @ingroup Spinner
21421     */
21422    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21423
21424    /**
21425     * Get whether the spinner should wrap when it reaches its
21426     * minimum or maximum value.
21427     *
21428     * @param obj The spinner object
21429     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21430     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21431     *
21432     * @see elm_spinner_wrap_set() for details.
21433     *
21434     * @ingroup Spinner
21435     */
21436    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21437
21438    /**
21439     * Set whether the spinner can be directly edited by the user or not.
21440     *
21441     * @param obj The spinner object.
21442     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21443     * don't allow users to edit it directly.
21444     *
21445     * Spinner objects can have edition @b disabled, in which state they will
21446     * be changed only by arrows.
21447     * Useful for contexts
21448     * where you don't want your users to interact with it writting the value.
21449     * Specially
21450     * when using special values, the user can see real value instead
21451     * of special label on edition.
21452     *
21453     * It's enabled by default.
21454     *
21455     * @see elm_spinner_editable_get()
21456     *
21457     * @ingroup Spinner
21458     */
21459    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21460
21461    /**
21462     * Get whether the spinner can be directly edited by the user or not.
21463     *
21464     * @param obj The spinner object.
21465     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21466     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21467     *
21468     * @see elm_spinner_editable_set() for details.
21469     *
21470     * @ingroup Spinner
21471     */
21472    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21473
21474    /**
21475     * Set a special string to display in the place of the numerical value.
21476     *
21477     * @param obj The spinner object.
21478     * @param value The value to be replaced.
21479     * @param label The label to be used.
21480     *
21481     * It's useful for cases when a user should select an item that is
21482     * better indicated by a label than a value. For example, weekdays or months.
21483     *
21484     * E.g.:
21485     * @code
21486     * sp = elm_spinner_add(win);
21487     * elm_spinner_min_max_set(sp, 1, 3);
21488     * elm_spinner_special_value_add(sp, 1, "January");
21489     * elm_spinner_special_value_add(sp, 2, "February");
21490     * elm_spinner_special_value_add(sp, 3, "March");
21491     * evas_object_show(sp);
21492     * @endcode
21493     *
21494     * @ingroup Spinner
21495     */
21496    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21497
21498    /**
21499     * Set the interval on time updates for an user mouse button hold
21500     * on spinner widgets' arrows.
21501     *
21502     * @param obj The spinner object.
21503     * @param interval The (first) interval value in seconds.
21504     *
21505     * This interval value is @b decreased while the user holds the
21506     * mouse pointer either incrementing or decrementing spinner's value.
21507     *
21508     * This helps the user to get to a given value distant from the
21509     * current one easier/faster, as it will start to change quicker and
21510     * quicker on mouse button holds.
21511     *
21512     * The calculation for the next change interval value, starting from
21513     * the one set with this call, is the previous interval divided by
21514     * @c 1.05, so it decreases a little bit.
21515     *
21516     * The default starting interval value for automatic changes is
21517     * @c 0.85 seconds.
21518     *
21519     * @see elm_spinner_interval_get()
21520     *
21521     * @ingroup Spinner
21522     */
21523    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21524
21525    /**
21526     * Get the interval on time updates for an user mouse button hold
21527     * on spinner widgets' arrows.
21528     *
21529     * @param obj The spinner object.
21530     * @return The (first) interval value, in seconds, set on it.
21531     *
21532     * @see elm_spinner_interval_set() for more details.
21533     *
21534     * @ingroup Spinner
21535     */
21536    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21537
21538    /**
21539     * @}
21540     */
21541
21542    /**
21543     * @defgroup Index Index
21544     *
21545     * @image html img/widget/index/preview-00.png
21546     * @image latex img/widget/index/preview-00.eps
21547     *
21548     * An index widget gives you an index for fast access to whichever
21549     * group of other UI items one might have. It's a list of text
21550     * items (usually letters, for alphabetically ordered access).
21551     *
21552     * Index widgets are by default hidden and just appear when the
21553     * user clicks over it's reserved area in the canvas. In its
21554     * default theme, it's an area one @ref Fingers "finger" wide on
21555     * the right side of the index widget's container.
21556     *
21557     * When items on the index are selected, smart callbacks get
21558     * called, so that its user can make other container objects to
21559     * show a given area or child object depending on the index item
21560     * selected. You'd probably be using an index together with @ref
21561     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21562     * "general grids".
21563     *
21564     * Smart events one  can add callbacks for are:
21565     * - @c "changed" - When the selected index item changes. @c
21566     *      event_info is the selected item's data pointer.
21567     * - @c "delay,changed" - When the selected index item changes, but
21568     *      after a small idling period. @c event_info is the selected
21569     *      item's data pointer.
21570     * - @c "selected" - When the user releases a mouse button and
21571     *      selects an item. @c event_info is the selected item's data
21572     *      pointer.
21573     * - @c "level,up" - when the user moves a finger from the first
21574     *      level to the second level
21575     * - @c "level,down" - when the user moves a finger from the second
21576     *      level to the first level
21577     *
21578     * The @c "delay,changed" event is so that it'll wait a small time
21579     * before actually reporting those events and, moreover, just the
21580     * last event happening on those time frames will actually be
21581     * reported.
21582     *
21583     * Here are some examples on its usage:
21584     * @li @ref index_example_01
21585     * @li @ref index_example_02
21586     */
21587
21588    /**
21589     * @addtogroup Index
21590     * @{
21591     */
21592
21593    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21594
21595    /**
21596     * Add a new index widget to the given parent Elementary
21597     * (container) object
21598     *
21599     * @param parent The parent object
21600     * @return a new index widget handle or @c NULL, on errors
21601     *
21602     * This function inserts a new index widget on the canvas.
21603     *
21604     * @ingroup Index
21605     */
21606    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21607
21608    /**
21609     * Set whether a given index widget is or not visible,
21610     * programatically.
21611     *
21612     * @param obj The index object
21613     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21614     *
21615     * Not to be confused with visible as in @c evas_object_show() --
21616     * visible with regard to the widget's auto hiding feature.
21617     *
21618     * @see elm_index_active_get()
21619     *
21620     * @ingroup Index
21621     */
21622    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21623
21624    /**
21625     * Get whether a given index widget is currently visible or not.
21626     *
21627     * @param obj The index object
21628     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21629     *
21630     * @see elm_index_active_set() for more details
21631     *
21632     * @ingroup Index
21633     */
21634    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21635
21636    /**
21637     * Set the items level for a given index widget.
21638     *
21639     * @param obj The index object.
21640     * @param level @c 0 or @c 1, the currently implemented levels.
21641     *
21642     * @see elm_index_item_level_get()
21643     *
21644     * @ingroup Index
21645     */
21646    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21647
21648    /**
21649     * Get the items level set for a given index widget.
21650     *
21651     * @param obj The index object.
21652     * @return @c 0 or @c 1, which are the levels @p obj might be at.
21653     *
21654     * @see elm_index_item_level_set() for more information
21655     *
21656     * @ingroup Index
21657     */
21658    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21659
21660    /**
21661     * Returns the last selected item's data, for a given index widget.
21662     *
21663     * @param obj The index object.
21664     * @return The item @b data associated to the last selected item on
21665     * @p obj (or @c NULL, on errors).
21666     *
21667     * @warning The returned value is @b not an #Elm_Index_Item item
21668     * handle, but the data associated to it (see the @c item parameter
21669     * in elm_index_item_append(), as an example).
21670     *
21671     * @ingroup Index
21672     */
21673    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21674
21675    /**
21676     * Append a new item on a given index widget.
21677     *
21678     * @param obj The index object.
21679     * @param letter Letter under which the item should be indexed
21680     * @param item The item data to set for the index's item
21681     *
21682     * Despite the most common usage of the @p letter argument is for
21683     * single char strings, one could use arbitrary strings as index
21684     * entries.
21685     *
21686     * @c item will be the pointer returned back on @c "changed", @c
21687     * "delay,changed" and @c "selected" smart events.
21688     *
21689     * @ingroup Index
21690     */
21691    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21692
21693    /**
21694     * Prepend a new item on a given index widget.
21695     *
21696     * @param obj The index object.
21697     * @param letter Letter under which the item should be indexed
21698     * @param item The item data to set for the index's item
21699     *
21700     * Despite the most common usage of the @p letter argument is for
21701     * single char strings, one could use arbitrary strings as index
21702     * entries.
21703     *
21704     * @c item will be the pointer returned back on @c "changed", @c
21705     * "delay,changed" and @c "selected" smart events.
21706     *
21707     * @ingroup Index
21708     */
21709    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21710
21711    /**
21712     * Append a new item, on a given index widget, <b>after the item
21713     * having @p relative as data</b>.
21714     *
21715     * @param obj The index object.
21716     * @param letter Letter under which the item should be indexed
21717     * @param item The item data to set for the index's item
21718     * @param relative The item data of the index item to be the
21719     * predecessor of this new one
21720     *
21721     * Despite the most common usage of the @p letter argument is for
21722     * single char strings, one could use arbitrary strings as index
21723     * entries.
21724     *
21725     * @c item will be the pointer returned back on @c "changed", @c
21726     * "delay,changed" and @c "selected" smart events.
21727     *
21728     * @note If @p relative is @c NULL or if it's not found to be data
21729     * set on any previous item on @p obj, this function will behave as
21730     * elm_index_item_append().
21731     *
21732     * @ingroup Index
21733     */
21734    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21735
21736    /**
21737     * Prepend a new item, on a given index widget, <b>after the item
21738     * having @p relative as data</b>.
21739     *
21740     * @param obj The index object.
21741     * @param letter Letter under which the item should be indexed
21742     * @param item The item data to set for the index's item
21743     * @param relative The item data of the index item to be the
21744     * successor of this new one
21745     *
21746     * Despite the most common usage of the @p letter argument is for
21747     * single char strings, one could use arbitrary strings as index
21748     * entries.
21749     *
21750     * @c item will be the pointer returned back on @c "changed", @c
21751     * "delay,changed" and @c "selected" smart events.
21752     *
21753     * @note If @p relative is @c NULL or if it's not found to be data
21754     * set on any previous item on @p obj, this function will behave as
21755     * elm_index_item_prepend().
21756     *
21757     * @ingroup Index
21758     */
21759    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21760
21761    /**
21762     * Insert a new item into the given index widget, using @p cmp_func
21763     * function to sort items (by item handles).
21764     *
21765     * @param obj The index object.
21766     * @param letter Letter under which the item should be indexed
21767     * @param item The item data to set for the index's item
21768     * @param cmp_func The comparing function to be used to sort index
21769     * items <b>by #Elm_Index_Item item handles</b>
21770     * @param cmp_data_func A @b fallback function to be called for the
21771     * sorting of index items <b>by item data</b>). It will be used
21772     * when @p cmp_func returns @c 0 (equality), which means an index
21773     * item with provided item data already exists. To decide which
21774     * data item should be pointed to by the index item in question, @p
21775     * cmp_data_func will be used. If @p cmp_data_func returns a
21776     * non-negative value, the previous index item data will be
21777     * replaced by the given @p item pointer. If the previous data need
21778     * to be freed, it should be done by the @p cmp_data_func function,
21779     * because all references to it will be lost. If this function is
21780     * not provided (@c NULL is given), index items will be @b
21781     * duplicated, if @p cmp_func returns @c 0.
21782     *
21783     * Despite the most common usage of the @p letter argument is for
21784     * single char strings, one could use arbitrary strings as index
21785     * entries.
21786     *
21787     * @c item will be the pointer returned back on @c "changed", @c
21788     * "delay,changed" and @c "selected" smart events.
21789     *
21790     * @ingroup Index
21791     */
21792    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);
21793
21794    /**
21795     * Remove an item from a given index widget, <b>to be referenced by
21796     * it's data value</b>.
21797     *
21798     * @param obj The index object
21799     * @param item The item's data pointer for the item to be removed
21800     * from @p obj
21801     *
21802     * If a deletion callback is set, via elm_index_item_del_cb_set(),
21803     * that callback function will be called by this one.
21804     *
21805     * @warning The item to be removed from @p obj will be found via
21806     * its item data pointer, and not by an #Elm_Index_Item handle.
21807     *
21808     * @ingroup Index
21809     */
21810    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21811
21812    /**
21813     * Find a given index widget's item, <b>using item data</b>.
21814     *
21815     * @param obj The index object
21816     * @param item The item data pointed to by the desired index item
21817     * @return The index item handle, if found, or @c NULL otherwise
21818     *
21819     * @ingroup Index
21820     */
21821    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21822
21823    /**
21824     * Removes @b all items from a given index widget.
21825     *
21826     * @param obj The index object.
21827     *
21828     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21829     * that callback function will be called for each item in @p obj.
21830     *
21831     * @ingroup Index
21832     */
21833    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21834
21835    /**
21836     * Go to a given items level on a index widget
21837     *
21838     * @param obj The index object
21839     * @param level The index level (one of @c 0 or @c 1)
21840     *
21841     * @ingroup Index
21842     */
21843    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21844
21845    /**
21846     * Return the data associated with a given index widget item
21847     *
21848     * @param it The index widget item handle
21849     * @return The data associated with @p it
21850     *
21851     * @see elm_index_item_data_set()
21852     *
21853     * @ingroup Index
21854     */
21855    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21856
21857    /**
21858     * Set the data associated with a given index widget item
21859     *
21860     * @param it The index widget item handle
21861     * @param data The new data pointer to set to @p it
21862     *
21863     * This sets new item data on @p it.
21864     *
21865     * @warning The old data pointer won't be touched by this function, so
21866     * the user had better to free that old data himself/herself.
21867     *
21868     * @ingroup Index
21869     */
21870    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
21871
21872    /**
21873     * Set the function to be called when a given index widget item is freed.
21874     *
21875     * @param it The item to set the callback on
21876     * @param func The function to call on the item's deletion
21877     *
21878     * When called, @p func will have both @c data and @c event_info
21879     * arguments with the @p it item's data value and, naturally, the
21880     * @c obj argument with a handle to the parent index widget.
21881     *
21882     * @ingroup Index
21883     */
21884    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
21885
21886    /**
21887     * Get the letter (string) set on a given index widget item.
21888     *
21889     * @param it The index item handle
21890     * @return The letter string set on @p it
21891     *
21892     * @ingroup Index
21893     */
21894    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21895
21896    /**
21897     * @}
21898     */
21899
21900    /**
21901     * @defgroup Photocam Photocam
21902     *
21903     * @image html img/widget/photocam/preview-00.png
21904     * @image latex img/widget/photocam/preview-00.eps
21905     *
21906     * This is a widget specifically for displaying high-resolution digital
21907     * camera photos giving speedy feedback (fast load), low memory footprint
21908     * and zooming and panning as well as fitting logic. It is entirely focused
21909     * on jpeg images, and takes advantage of properties of the jpeg format (via
21910     * evas loader features in the jpeg loader).
21911     *
21912     * Signals that you can add callbacks for are:
21913     * @li "clicked" - This is called when a user has clicked the photo without
21914     *                 dragging around.
21915     * @li "press" - This is called when a user has pressed down on the photo.
21916     * @li "longpressed" - This is called when a user has pressed down on the
21917     *                     photo for a long time without dragging around.
21918     * @li "clicked,double" - This is called when a user has double-clicked the
21919     *                        photo.
21920     * @li "load" - Photo load begins.
21921     * @li "loaded" - This is called when the image file load is complete for the
21922     *                first view (low resolution blurry version).
21923     * @li "load,detail" - Photo detailed data load begins.
21924     * @li "loaded,detail" - This is called when the image file load is complete
21925     *                      for the detailed image data (full resolution needed).
21926     * @li "zoom,start" - Zoom animation started.
21927     * @li "zoom,stop" - Zoom animation stopped.
21928     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
21929     * @li "scroll" - the content has been scrolled (moved)
21930     * @li "scroll,anim,start" - scrolling animation has started
21931     * @li "scroll,anim,stop" - scrolling animation has stopped
21932     * @li "scroll,drag,start" - dragging the contents around has started
21933     * @li "scroll,drag,stop" - dragging the contents around has stopped
21934     *
21935     * @ref tutorial_photocam shows the API in action.
21936     * @{
21937     */
21938    /**
21939     * @brief Types of zoom available.
21940     */
21941    typedef enum _Elm_Photocam_Zoom_Mode
21942      {
21943         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
21944         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
21945         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
21946         ELM_PHOTOCAM_ZOOM_MODE_LAST
21947      } Elm_Photocam_Zoom_Mode;
21948    /**
21949     * @brief Add a new Photocam object
21950     *
21951     * @param parent The parent object
21952     * @return The new object or NULL if it cannot be created
21953     */
21954    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21955    /**
21956     * @brief Set the photo file to be shown
21957     *
21958     * @param obj The photocam object
21959     * @param file The photo file
21960     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
21961     *
21962     * This sets (and shows) the specified file (with a relative or absolute
21963     * path) and will return a load error (same error that
21964     * evas_object_image_load_error_get() will return). The image will change and
21965     * adjust its size at this point and begin a background load process for this
21966     * photo that at some time in the future will be displayed at the full
21967     * quality needed.
21968     */
21969    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
21970    /**
21971     * @brief Returns the path of the current image file
21972     *
21973     * @param obj The photocam object
21974     * @return Returns the path
21975     *
21976     * @see elm_photocam_file_set()
21977     */
21978    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21979    /**
21980     * @brief Set the zoom level of the photo
21981     *
21982     * @param obj The photocam object
21983     * @param zoom The zoom level to set
21984     *
21985     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
21986     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
21987     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
21988     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
21989     * 16, 32, etc.).
21990     */
21991    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
21992    /**
21993     * @brief Get the zoom level of the photo
21994     *
21995     * @param obj The photocam object
21996     * @return The current zoom level
21997     *
21998     * This returns the current zoom level of the photocam object. Note that if
21999     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22000     * (which is the default), the zoom level may be changed at any time by the
22001     * photocam object itself to account for photo size and photocam viewpoer
22002     * size.
22003     *
22004     * @see elm_photocam_zoom_set()
22005     * @see elm_photocam_zoom_mode_set()
22006     */
22007    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22008    /**
22009     * @brief Set the zoom mode
22010     *
22011     * @param obj The photocam object
22012     * @param mode The desired mode
22013     *
22014     * This sets the zoom mode to manual or one of several automatic levels.
22015     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22016     * elm_photocam_zoom_set() and will stay at that level until changed by code
22017     * or until zoom mode is changed. This is the default mode. The Automatic
22018     * modes will allow the photocam object to automatically adjust zoom mode
22019     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22020     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22021     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22022     * pixels within the frame are left unfilled.
22023     */
22024    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22025    /**
22026     * @brief Get the zoom mode
22027     *
22028     * @param obj The photocam object
22029     * @return The current zoom mode
22030     *
22031     * This gets the current zoom mode of the photocam object.
22032     *
22033     * @see elm_photocam_zoom_mode_set()
22034     */
22035    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22036    /**
22037     * @brief Get the current image pixel width and height
22038     *
22039     * @param obj The photocam object
22040     * @param w A pointer to the width return
22041     * @param h A pointer to the height return
22042     *
22043     * This gets the current photo pixel width and height (for the original).
22044     * The size will be returned in the integers @p w and @p h that are pointed
22045     * to.
22046     */
22047    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22048    /**
22049     * @brief Get the area of the image that is currently shown
22050     *
22051     * @param obj
22052     * @param x A pointer to the X-coordinate of region
22053     * @param y A pointer to the Y-coordinate of region
22054     * @param w A pointer to the width
22055     * @param h A pointer to the height
22056     *
22057     * @see elm_photocam_image_region_show()
22058     * @see elm_photocam_image_region_bring_in()
22059     */
22060    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22061    /**
22062     * @brief Set the viewed portion of the image
22063     *
22064     * @param obj The photocam object
22065     * @param x X-coordinate of region in image original pixels
22066     * @param y Y-coordinate of region in image original pixels
22067     * @param w Width of region in image original pixels
22068     * @param h Height of region in image original pixels
22069     *
22070     * This shows the region of the image without using animation.
22071     */
22072    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22073    /**
22074     * @brief Bring in the viewed portion of the image
22075     *
22076     * @param obj The photocam object
22077     * @param x X-coordinate of region in image original pixels
22078     * @param y Y-coordinate of region in image original pixels
22079     * @param w Width of region in image original pixels
22080     * @param h Height of region in image original pixels
22081     *
22082     * This shows the region of the image using animation.
22083     */
22084    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22085    /**
22086     * @brief Set the paused state for photocam
22087     *
22088     * @param obj The photocam object
22089     * @param paused The pause state to set
22090     *
22091     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22092     * photocam. The default is off. This will stop zooming using animation on
22093     * zoom levels changes and change instantly. This will stop any existing
22094     * animations that are running.
22095     */
22096    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22097    /**
22098     * @brief Get the paused state for photocam
22099     *
22100     * @param obj The photocam object
22101     * @return The current paused state
22102     *
22103     * This gets the current paused state for the photocam object.
22104     *
22105     * @see elm_photocam_paused_set()
22106     */
22107    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22108    /**
22109     * @brief Get the internal low-res image used for photocam
22110     *
22111     * @param obj The photocam object
22112     * @return The internal image object handle, or NULL if none exists
22113     *
22114     * This gets the internal image object inside photocam. Do not modify it. It
22115     * is for inspection only, and hooking callbacks to. Nothing else. It may be
22116     * deleted at any time as well.
22117     */
22118    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22119    /**
22120     * @brief Set the photocam scrolling bouncing.
22121     *
22122     * @param obj The photocam object
22123     * @param h_bounce bouncing for horizontal
22124     * @param v_bounce bouncing for vertical
22125     */
22126    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22127    /**
22128     * @brief Get the photocam scrolling bouncing.
22129     *
22130     * @param obj The photocam object
22131     * @param h_bounce bouncing for horizontal
22132     * @param v_bounce bouncing for vertical
22133     *
22134     * @see elm_photocam_bounce_set()
22135     */
22136    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22137    /**
22138     * @}
22139     */
22140
22141    /**
22142     * @defgroup Map Map
22143     * @ingroup Elementary
22144     *
22145     * @image html img/widget/map/preview-00.png
22146     * @image latex img/widget/map/preview-00.eps
22147     *
22148     * This is a widget specifically for displaying a map. It uses basically
22149     * OpenStreetMap provider http://www.openstreetmap.org/,
22150     * but custom providers can be added.
22151     *
22152     * It supports some basic but yet nice features:
22153     * @li zoom and scroll
22154     * @li markers with content to be displayed when user clicks over it
22155     * @li group of markers
22156     * @li routes
22157     *
22158     * Smart callbacks one can listen to:
22159     *
22160     * - "clicked" - This is called when a user has clicked the map without
22161     *   dragging around.
22162     * - "press" - This is called when a user has pressed down on the map.
22163     * - "longpressed" - This is called when a user has pressed down on the map
22164     *   for a long time without dragging around.
22165     * - "clicked,double" - This is called when a user has double-clicked
22166     *   the map.
22167     * - "load,detail" - Map detailed data load begins.
22168     * - "loaded,detail" - This is called when all currently visible parts of
22169     *   the map are loaded.
22170     * - "zoom,start" - Zoom animation started.
22171     * - "zoom,stop" - Zoom animation stopped.
22172     * - "zoom,change" - Zoom changed when using an auto zoom mode.
22173     * - "scroll" - the content has been scrolled (moved).
22174     * - "scroll,anim,start" - scrolling animation has started.
22175     * - "scroll,anim,stop" - scrolling animation has stopped.
22176     * - "scroll,drag,start" - dragging the contents around has started.
22177     * - "scroll,drag,stop" - dragging the contents around has stopped.
22178     * - "downloaded" - This is called when all currently required map images
22179     *   are downloaded.
22180     * - "route,load" - This is called when route request begins.
22181     * - "route,loaded" - This is called when route request ends.
22182     * - "name,load" - This is called when name request begins.
22183     * - "name,loaded- This is called when name request ends.
22184     *
22185     * Available style for map widget:
22186     * - @c "default"
22187     *
22188     * Available style for markers:
22189     * - @c "radio"
22190     * - @c "radio2"
22191     * - @c "empty"
22192     *
22193     * Available style for marker bubble:
22194     * - @c "default"
22195     *
22196     * List of examples:
22197     * @li @ref map_example_01
22198     * @li @ref map_example_02
22199     * @li @ref map_example_03
22200     */
22201
22202    /**
22203     * @addtogroup Map
22204     * @{
22205     */
22206
22207    /**
22208     * @enum _Elm_Map_Zoom_Mode
22209     * @typedef Elm_Map_Zoom_Mode
22210     *
22211     * Set map's zoom behavior. It can be set to manual or automatic.
22212     *
22213     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22214     *
22215     * Values <b> don't </b> work as bitmask, only one can be choosen.
22216     *
22217     * @note Valid sizes are 2^zoom, consequently the map may be smaller
22218     * than the scroller view.
22219     *
22220     * @see elm_map_zoom_mode_set()
22221     * @see elm_map_zoom_mode_get()
22222     *
22223     * @ingroup Map
22224     */
22225    typedef enum _Elm_Map_Zoom_Mode
22226      {
22227         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22228         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22229         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22230         ELM_MAP_ZOOM_MODE_LAST
22231      } Elm_Map_Zoom_Mode;
22232
22233    /**
22234     * @enum _Elm_Map_Route_Sources
22235     * @typedef Elm_Map_Route_Sources
22236     *
22237     * Set route service to be used. By default used source is
22238     * #ELM_MAP_ROUTE_SOURCE_YOURS.
22239     *
22240     * @see elm_map_route_source_set()
22241     * @see elm_map_route_source_get()
22242     *
22243     * @ingroup Map
22244     */
22245    typedef enum _Elm_Map_Route_Sources
22246      {
22247         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22248         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. */
22249         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22250         ELM_MAP_ROUTE_SOURCE_LAST
22251      } Elm_Map_Route_Sources;
22252
22253    typedef enum _Elm_Map_Name_Sources
22254      {
22255         ELM_MAP_NAME_SOURCE_NOMINATIM,
22256         ELM_MAP_NAME_SOURCE_LAST
22257      } Elm_Map_Name_Sources;
22258
22259    /**
22260     * @enum _Elm_Map_Route_Type
22261     * @typedef Elm_Map_Route_Type
22262     *
22263     * Set type of transport used on route.
22264     *
22265     * @see elm_map_route_add()
22266     *
22267     * @ingroup Map
22268     */
22269    typedef enum _Elm_Map_Route_Type
22270      {
22271         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22272         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22273         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22274         ELM_MAP_ROUTE_TYPE_LAST
22275      } Elm_Map_Route_Type;
22276
22277    /**
22278     * @enum _Elm_Map_Route_Method
22279     * @typedef Elm_Map_Route_Method
22280     *
22281     * Set the routing method, what should be priorized, time or distance.
22282     *
22283     * @see elm_map_route_add()
22284     *
22285     * @ingroup Map
22286     */
22287    typedef enum _Elm_Map_Route_Method
22288      {
22289         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22290         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22291         ELM_MAP_ROUTE_METHOD_LAST
22292      } Elm_Map_Route_Method;
22293
22294    typedef enum _Elm_Map_Name_Method
22295      {
22296         ELM_MAP_NAME_METHOD_SEARCH,
22297         ELM_MAP_NAME_METHOD_REVERSE,
22298         ELM_MAP_NAME_METHOD_LAST
22299      } Elm_Map_Name_Method;
22300
22301    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(). */
22302    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(). */
22303    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(). */
22304    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(). */
22305    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
22306    typedef struct _Elm_Map_Track           Elm_Map_Track;
22307
22308    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. */
22309    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22310    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22311    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22312
22313    typedef char        *(*ElmMapModuleSourceFunc) (void);
22314    typedef int          (*ElmMapModuleZoomMinFunc) (void);
22315    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
22316    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22317    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
22318    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22319    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22320    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22321    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22322
22323    /**
22324     * Add a new map widget to the given parent Elementary (container) object.
22325     *
22326     * @param parent The parent object.
22327     * @return a new map widget handle or @c NULL, on errors.
22328     *
22329     * This function inserts a new map widget on the canvas.
22330     *
22331     * @ingroup Map
22332     */
22333    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22334
22335    /**
22336     * Set the zoom level of the map.
22337     *
22338     * @param obj The map object.
22339     * @param zoom The zoom level to set.
22340     *
22341     * This sets the zoom level.
22342     *
22343     * It will respect limits defined by elm_map_source_zoom_min_set() and
22344     * elm_map_source_zoom_max_set().
22345     *
22346     * By default these values are 0 (world map) and 18 (maximum zoom).
22347     *
22348     * This function should be used when zoom mode is set to
22349     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22350     * with elm_map_zoom_mode_set().
22351     *
22352     * @see elm_map_zoom_mode_set().
22353     * @see elm_map_zoom_get().
22354     *
22355     * @ingroup Map
22356     */
22357    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22358
22359    /**
22360     * Get the zoom level of the map.
22361     *
22362     * @param obj The map object.
22363     * @return The current zoom level.
22364     *
22365     * This returns the current zoom level of the map object.
22366     *
22367     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22368     * (which is the default), the zoom level may be changed at any time by the
22369     * map object itself to account for map size and map viewport size.
22370     *
22371     * @see elm_map_zoom_set() for details.
22372     *
22373     * @ingroup Map
22374     */
22375    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22376
22377    /**
22378     * Set the zoom mode used by the map object.
22379     *
22380     * @param obj The map object.
22381     * @param mode The zoom mode of the map, being it one of
22382     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22383     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22384     *
22385     * This sets the zoom mode to manual or one of the automatic levels.
22386     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22387     * elm_map_zoom_set() and will stay at that level until changed by code
22388     * or until zoom mode is changed. This is the default mode.
22389     *
22390     * The Automatic modes will allow the map object to automatically
22391     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22392     * adjust zoom so the map fits inside the scroll frame with no pixels
22393     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22394     * ensure no pixels within the frame are left unfilled. Do not forget that
22395     * the valid sizes are 2^zoom, consequently the map may be smaller than
22396     * the scroller view.
22397     *
22398     * @see elm_map_zoom_set()
22399     *
22400     * @ingroup Map
22401     */
22402    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22403
22404    /**
22405     * Get the zoom mode used by the map object.
22406     *
22407     * @param obj The map object.
22408     * @return The zoom mode of the map, being it one of
22409     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22410     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22411     *
22412     * This function returns the current zoom mode used by the map object.
22413     *
22414     * @see elm_map_zoom_mode_set() for more details.
22415     *
22416     * @ingroup Map
22417     */
22418    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22419
22420    /**
22421     * Get the current coordinates of the map.
22422     *
22423     * @param obj The map object.
22424     * @param lon Pointer where to store longitude.
22425     * @param lat Pointer where to store latitude.
22426     *
22427     * This gets the current center coordinates of the map object. It can be
22428     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22429     *
22430     * @see elm_map_geo_region_bring_in()
22431     * @see elm_map_geo_region_show()
22432     *
22433     * @ingroup Map
22434     */
22435    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22436
22437    /**
22438     * Animatedly bring in given coordinates to the center of the map.
22439     *
22440     * @param obj The map object.
22441     * @param lon Longitude to center at.
22442     * @param lat Latitude to center at.
22443     *
22444     * This causes map to jump to the given @p lat and @p lon coordinates
22445     * and show it (by scrolling) in the center of the viewport, if it is not
22446     * already centered. This will use animation to do so and take a period
22447     * of time to complete.
22448     *
22449     * @see elm_map_geo_region_show() for a function to avoid animation.
22450     * @see elm_map_geo_region_get()
22451     *
22452     * @ingroup Map
22453     */
22454    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22455
22456    /**
22457     * Show the given coordinates at the center of the map, @b immediately.
22458     *
22459     * @param obj The map object.
22460     * @param lon Longitude to center at.
22461     * @param lat Latitude to center at.
22462     *
22463     * This causes map to @b redraw its viewport's contents to the
22464     * region contining the given @p lat and @p lon, that will be moved to the
22465     * center of the map.
22466     *
22467     * @see elm_map_geo_region_bring_in() for a function to move with animation.
22468     * @see elm_map_geo_region_get()
22469     *
22470     * @ingroup Map
22471     */
22472    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22473
22474    /**
22475     * Pause or unpause the map.
22476     *
22477     * @param obj The map object.
22478     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22479     * to unpause it.
22480     *
22481     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22482     * for map.
22483     *
22484     * The default is off.
22485     *
22486     * This will stop zooming using animation, changing zoom levels will
22487     * change instantly. This will stop any existing animations that are running.
22488     *
22489     * @see elm_map_paused_get()
22490     *
22491     * @ingroup Map
22492     */
22493    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22494
22495    /**
22496     * Get a value whether map is paused or not.
22497     *
22498     * @param obj The map object.
22499     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22500     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22501     *
22502     * This gets the current paused state for the map object.
22503     *
22504     * @see elm_map_paused_set() for details.
22505     *
22506     * @ingroup Map
22507     */
22508    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22509
22510    /**
22511     * Set to show markers during zoom level changes or not.
22512     *
22513     * @param obj The map object.
22514     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22515     * to show them.
22516     *
22517     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22518     * for map.
22519     *
22520     * The default is off.
22521     *
22522     * This will stop zooming using animation, changing zoom levels will
22523     * change instantly. This will stop any existing animations that are running.
22524     *
22525     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22526     * for the markers.
22527     *
22528     * The default  is off.
22529     *
22530     * Enabling it will force the map to stop displaying the markers during
22531     * zoom level changes. Set to on if you have a large number of markers.
22532     *
22533     * @see elm_map_paused_markers_get()
22534     *
22535     * @ingroup Map
22536     */
22537    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22538
22539    /**
22540     * Get a value whether markers will be displayed on zoom level changes or not
22541     *
22542     * @param obj The map object.
22543     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22544     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22545     *
22546     * This gets the current markers paused state for the map object.
22547     *
22548     * @see elm_map_paused_markers_set() for details.
22549     *
22550     * @ingroup Map
22551     */
22552    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22553
22554    /**
22555     * Get the information of downloading status.
22556     *
22557     * @param obj The map object.
22558     * @param try_num Pointer where to store number of tiles being downloaded.
22559     * @param finish_num Pointer where to store number of tiles successfully
22560     * downloaded.
22561     *
22562     * This gets the current downloading status for the map object, the number
22563     * of tiles being downloaded and the number of tiles already downloaded.
22564     *
22565     * @ingroup Map
22566     */
22567    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22568
22569    /**
22570     * Convert a pixel coordinate (x,y) into a geographic coordinate
22571     * (longitude, latitude).
22572     *
22573     * @param obj The map object.
22574     * @param x the coordinate.
22575     * @param y the coordinate.
22576     * @param size the size in pixels of the map.
22577     * The map is a square and generally his size is : pow(2.0, zoom)*256.
22578     * @param lon Pointer where to store the longitude that correspond to x.
22579     * @param lat Pointer where to store the latitude that correspond to y.
22580     *
22581     * @note Origin pixel point is the top left corner of the viewport.
22582     * Map zoom and size are taken on account.
22583     *
22584     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22585     *
22586     * @ingroup Map
22587     */
22588    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);
22589
22590    /**
22591     * Convert a geographic coordinate (longitude, latitude) into a pixel
22592     * coordinate (x, y).
22593     *
22594     * @param obj The map object.
22595     * @param lon the longitude.
22596     * @param lat the latitude.
22597     * @param size the size in pixels of the map. The map is a square
22598     * and generally his size is : pow(2.0, zoom)*256.
22599     * @param x Pointer where to store the horizontal pixel coordinate that
22600     * correspond to the longitude.
22601     * @param y Pointer where to store the vertical pixel coordinate that
22602     * correspond to the latitude.
22603     *
22604     * @note Origin pixel point is the top left corner of the viewport.
22605     * Map zoom and size are taken on account.
22606     *
22607     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22608     *
22609     * @ingroup Map
22610     */
22611    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);
22612
22613    /**
22614     * Convert a geographic coordinate (longitude, latitude) into a name
22615     * (address).
22616     *
22617     * @param obj The map object.
22618     * @param lon the longitude.
22619     * @param lat the latitude.
22620     * @return name A #Elm_Map_Name handle for this coordinate.
22621     *
22622     * To get the string for this address, elm_map_name_address_get()
22623     * should be used.
22624     *
22625     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22626     *
22627     * @ingroup Map
22628     */
22629    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22630
22631    /**
22632     * Convert a name (address) into a geographic coordinate
22633     * (longitude, latitude).
22634     *
22635     * @param obj The map object.
22636     * @param name The address.
22637     * @return name A #Elm_Map_Name handle for this address.
22638     *
22639     * To get the longitude and latitude, elm_map_name_region_get()
22640     * should be used.
22641     *
22642     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22643     *
22644     * @ingroup Map
22645     */
22646    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22647
22648    /**
22649     * Convert a pixel coordinate into a rotated pixel coordinate.
22650     *
22651     * @param obj The map object.
22652     * @param x horizontal coordinate of the point to rotate.
22653     * @param y vertical coordinate of the point to rotate.
22654     * @param cx rotation's center horizontal position.
22655     * @param cy rotation's center vertical position.
22656     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22657     * @param xx Pointer where to store rotated x.
22658     * @param yy Pointer where to store rotated y.
22659     *
22660     * @ingroup Map
22661     */
22662    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);
22663
22664    /**
22665     * Add a new marker to the map object.
22666     *
22667     * @param obj The map object.
22668     * @param lon The longitude of the marker.
22669     * @param lat The latitude of the marker.
22670     * @param clas The class, to use when marker @b isn't grouped to others.
22671     * @param clas_group The class group, to use when marker is grouped to others
22672     * @param data The data passed to the callbacks.
22673     *
22674     * @return The created marker or @c NULL upon failure.
22675     *
22676     * A marker will be created and shown in a specific point of the map, defined
22677     * by @p lon and @p lat.
22678     *
22679     * It will be displayed using style defined by @p class when this marker
22680     * is displayed alone (not grouped). A new class can be created with
22681     * elm_map_marker_class_new().
22682     *
22683     * If the marker is grouped to other markers, it will be displayed with
22684     * style defined by @p class_group. Markers with the same group are grouped
22685     * if they are close. A new group class can be created with
22686     * elm_map_marker_group_class_new().
22687     *
22688     * Markers created with this method can be deleted with
22689     * elm_map_marker_remove().
22690     *
22691     * A marker can have associated content to be displayed by a bubble,
22692     * when a user click over it, as well as an icon. These objects will
22693     * be fetch using class' callback functions.
22694     *
22695     * @see elm_map_marker_class_new()
22696     * @see elm_map_marker_group_class_new()
22697     * @see elm_map_marker_remove()
22698     *
22699     * @ingroup Map
22700     */
22701    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);
22702
22703    /**
22704     * Set the maximum numbers of markers' content to be displayed in a group.
22705     *
22706     * @param obj The map object.
22707     * @param max The maximum numbers of items displayed in a bubble.
22708     *
22709     * A bubble will be displayed when the user clicks over the group,
22710     * and will place the content of markers that belong to this group
22711     * inside it.
22712     *
22713     * A group can have a long list of markers, consequently the creation
22714     * of the content of the bubble can be very slow.
22715     *
22716     * In order to avoid this, a maximum number of items is displayed
22717     * in a bubble.
22718     *
22719     * By default this number is 30.
22720     *
22721     * Marker with the same group class are grouped if they are close.
22722     *
22723     * @see elm_map_marker_add()
22724     *
22725     * @ingroup Map
22726     */
22727    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22728
22729    /**
22730     * Remove a marker from the map.
22731     *
22732     * @param marker The marker to remove.
22733     *
22734     * @see elm_map_marker_add()
22735     *
22736     * @ingroup Map
22737     */
22738    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22739
22740    /**
22741     * Get the current coordinates of the marker.
22742     *
22743     * @param marker marker.
22744     * @param lat Pointer where to store the marker's latitude.
22745     * @param lon Pointer where to store the marker's longitude.
22746     *
22747     * These values are set when adding markers, with function
22748     * elm_map_marker_add().
22749     *
22750     * @see elm_map_marker_add()
22751     *
22752     * @ingroup Map
22753     */
22754    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22755
22756    /**
22757     * Animatedly bring in given marker to the center of the map.
22758     *
22759     * @param marker The marker to center at.
22760     *
22761     * This causes map to jump to the given @p marker's coordinates
22762     * and show it (by scrolling) in the center of the viewport, if it is not
22763     * already centered. This will use animation to do so and take a period
22764     * of time to complete.
22765     *
22766     * @see elm_map_marker_show() for a function to avoid animation.
22767     * @see elm_map_marker_region_get()
22768     *
22769     * @ingroup Map
22770     */
22771    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22772
22773    /**
22774     * Show the given marker at the center of the map, @b immediately.
22775     *
22776     * @param marker The marker to center at.
22777     *
22778     * This causes map to @b redraw its viewport's contents to the
22779     * region contining the given @p marker's coordinates, that will be
22780     * moved to the center of the map.
22781     *
22782     * @see elm_map_marker_bring_in() for a function to move with animation.
22783     * @see elm_map_markers_list_show() if more than one marker need to be
22784     * displayed.
22785     * @see elm_map_marker_region_get()
22786     *
22787     * @ingroup Map
22788     */
22789    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22790
22791    /**
22792     * Move and zoom the map to display a list of markers.
22793     *
22794     * @param markers A list of #Elm_Map_Marker handles.
22795     *
22796     * The map will be centered on the center point of the markers in the list.
22797     * Then the map will be zoomed in order to fit the markers using the maximum
22798     * zoom which allows display of all the markers.
22799     *
22800     * @warning All the markers should belong to the same map object.
22801     *
22802     * @see elm_map_marker_show() to show a single marker.
22803     * @see elm_map_marker_bring_in()
22804     *
22805     * @ingroup Map
22806     */
22807    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22808
22809    /**
22810     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22811     *
22812     * @param marker The marker wich content should be returned.
22813     * @return Return the evas object if it exists, else @c NULL.
22814     *
22815     * To set callback function #ElmMapMarkerGetFunc for the marker class,
22816     * elm_map_marker_class_get_cb_set() should be used.
22817     *
22818     * This content is what will be inside the bubble that will be displayed
22819     * when an user clicks over the marker.
22820     *
22821     * This returns the actual Evas object used to be placed inside
22822     * the bubble. This may be @c NULL, as it may
22823     * not have been created or may have been deleted, at any time, by
22824     * the map. <b>Do not modify this object</b> (move, resize,
22825     * show, hide, etc.), as the map is controlling it. This
22826     * function is for querying, emitting custom signals or hooking
22827     * lower level callbacks for events on that object. Do not delete
22828     * this object under any circumstances.
22829     *
22830     * @ingroup Map
22831     */
22832    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22833
22834    /**
22835     * Update the marker
22836     *
22837     * @param marker The marker to be updated.
22838     *
22839     * If a content is set to this marker, it will call function to delete it,
22840     * #ElmMapMarkerDelFunc, and then will fetch the content again with
22841     * #ElmMapMarkerGetFunc.
22842     *
22843     * These functions are set for the marker class with
22844     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
22845     *
22846     * @ingroup Map
22847     */
22848    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22849
22850    /**
22851     * Close all the bubbles opened by the user.
22852     *
22853     * @param obj The map object.
22854     *
22855     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
22856     * when the user clicks on a marker.
22857     *
22858     * This functions is set for the marker class with
22859     * elm_map_marker_class_get_cb_set().
22860     *
22861     * @ingroup Map
22862     */
22863    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
22864
22865    /**
22866     * Create a new group class.
22867     *
22868     * @param obj The map object.
22869     * @return Returns the new group class.
22870     *
22871     * Each marker must be associated to a group class. Markers in the same
22872     * group are grouped if they are close.
22873     *
22874     * The group class defines the style of the marker when a marker is grouped
22875     * to others markers. When it is alone, another class will be used.
22876     *
22877     * A group class will need to be provided when creating a marker with
22878     * elm_map_marker_add().
22879     *
22880     * Some properties and functions can be set by class, as:
22881     * - style, with elm_map_group_class_style_set()
22882     * - data - to be associated to the group class. It can be set using
22883     *   elm_map_group_class_data_set().
22884     * - min zoom to display markers, set with
22885     *   elm_map_group_class_zoom_displayed_set().
22886     * - max zoom to group markers, set using
22887     *   elm_map_group_class_zoom_grouped_set().
22888     * - visibility - set if markers will be visible or not, set with
22889     *   elm_map_group_class_hide_set().
22890     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
22891     *   It can be set using elm_map_group_class_icon_cb_set().
22892     *
22893     * @see elm_map_marker_add()
22894     * @see elm_map_group_class_style_set()
22895     * @see elm_map_group_class_data_set()
22896     * @see elm_map_group_class_zoom_displayed_set()
22897     * @see elm_map_group_class_zoom_grouped_set()
22898     * @see elm_map_group_class_hide_set()
22899     * @see elm_map_group_class_icon_cb_set()
22900     *
22901     * @ingroup Map
22902     */
22903    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22904
22905    /**
22906     * Set the marker's style of a group class.
22907     *
22908     * @param clas The group class.
22909     * @param style The style to be used by markers.
22910     *
22911     * Each marker must be associated to a group class, and will use the style
22912     * defined by such class when grouped to other markers.
22913     *
22914     * The following styles are provided by default theme:
22915     * @li @c radio - blue circle
22916     * @li @c radio2 - green circle
22917     * @li @c empty
22918     *
22919     * @see elm_map_group_class_new() for more details.
22920     * @see elm_map_marker_add()
22921     *
22922     * @ingroup Map
22923     */
22924    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22925
22926    /**
22927     * Set the icon callback function of a group class.
22928     *
22929     * @param clas The group class.
22930     * @param icon_get The callback function that will return the icon.
22931     *
22932     * Each marker must be associated to a group class, and it can display a
22933     * custom icon. The function @p icon_get must return this icon.
22934     *
22935     * @see elm_map_group_class_new() for more details.
22936     * @see elm_map_marker_add()
22937     *
22938     * @ingroup Map
22939     */
22940    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22941
22942    /**
22943     * Set the data associated to the group class.
22944     *
22945     * @param clas The group class.
22946     * @param data The new user data.
22947     *
22948     * This data will be passed for callback functions, like icon get callback,
22949     * that can be set with elm_map_group_class_icon_cb_set().
22950     *
22951     * If a data was previously set, the object will lose the pointer for it,
22952     * so if needs to be freed, you must do it yourself.
22953     *
22954     * @see elm_map_group_class_new() for more details.
22955     * @see elm_map_group_class_icon_cb_set()
22956     * @see elm_map_marker_add()
22957     *
22958     * @ingroup Map
22959     */
22960    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
22961
22962    /**
22963     * Set the minimum zoom from where the markers are displayed.
22964     *
22965     * @param clas The group class.
22966     * @param zoom The minimum zoom.
22967     *
22968     * Markers only will be displayed when the map is displayed at @p zoom
22969     * or bigger.
22970     *
22971     * @see elm_map_group_class_new() for more details.
22972     * @see elm_map_marker_add()
22973     *
22974     * @ingroup Map
22975     */
22976    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22977
22978    /**
22979     * Set the zoom from where the markers are no more grouped.
22980     *
22981     * @param clas The group class.
22982     * @param zoom The maximum zoom.
22983     *
22984     * Markers only will be grouped when the map is displayed at
22985     * less than @p zoom.
22986     *
22987     * @see elm_map_group_class_new() for more details.
22988     * @see elm_map_marker_add()
22989     *
22990     * @ingroup Map
22991     */
22992    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22993
22994    /**
22995     * Set if the markers associated to the group class @clas are hidden or not.
22996     *
22997     * @param clas The group class.
22998     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
22999     * to show them.
23000     *
23001     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23002     * is to show them.
23003     *
23004     * @ingroup Map
23005     */
23006    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23007
23008    /**
23009     * Create a new marker class.
23010     *
23011     * @param obj The map object.
23012     * @return Returns the new group class.
23013     *
23014     * Each marker must be associated to a class.
23015     *
23016     * The marker class defines the style of the marker when a marker is
23017     * displayed alone, i.e., not grouped to to others markers. When grouped
23018     * it will use group class style.
23019     *
23020     * A marker class will need to be provided when creating a marker with
23021     * elm_map_marker_add().
23022     *
23023     * Some properties and functions can be set by class, as:
23024     * - style, with elm_map_marker_class_style_set()
23025     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23026     *   It can be set using elm_map_marker_class_icon_cb_set().
23027     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23028     *   Set using elm_map_marker_class_get_cb_set().
23029     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23030     *   Set using elm_map_marker_class_del_cb_set().
23031     *
23032     * @see elm_map_marker_add()
23033     * @see elm_map_marker_class_style_set()
23034     * @see elm_map_marker_class_icon_cb_set()
23035     * @see elm_map_marker_class_get_cb_set()
23036     * @see elm_map_marker_class_del_cb_set()
23037     *
23038     * @ingroup Map
23039     */
23040    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23041
23042    /**
23043     * Set the marker's style of a marker class.
23044     *
23045     * @param clas The marker class.
23046     * @param style The style to be used by markers.
23047     *
23048     * Each marker must be associated to a marker class, and will use the style
23049     * defined by such class when alone, i.e., @b not grouped to other markers.
23050     *
23051     * The following styles are provided by default theme:
23052     * @li @c radio
23053     * @li @c radio2
23054     * @li @c empty
23055     *
23056     * @see elm_map_marker_class_new() for more details.
23057     * @see elm_map_marker_add()
23058     *
23059     * @ingroup Map
23060     */
23061    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23062
23063    /**
23064     * Set the icon callback function of a marker class.
23065     *
23066     * @param clas The marker class.
23067     * @param icon_get The callback function that will return the icon.
23068     *
23069     * Each marker must be associated to a marker class, and it can display a
23070     * custom icon. The function @p icon_get must return this icon.
23071     *
23072     * @see elm_map_marker_class_new() for more details.
23073     * @see elm_map_marker_add()
23074     *
23075     * @ingroup Map
23076     */
23077    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23078
23079    /**
23080     * Set the bubble content callback function of a marker class.
23081     *
23082     * @param clas The marker class.
23083     * @param get The callback function that will return the content.
23084     *
23085     * Each marker must be associated to a marker class, and it can display a
23086     * a content on a bubble that opens when the user click over the marker.
23087     * The function @p get must return this content object.
23088     *
23089     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23090     * can be used.
23091     *
23092     * @see elm_map_marker_class_new() for more details.
23093     * @see elm_map_marker_class_del_cb_set()
23094     * @see elm_map_marker_add()
23095     *
23096     * @ingroup Map
23097     */
23098    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23099
23100    /**
23101     * Set the callback function used to delete bubble content of a marker class.
23102     *
23103     * @param clas The marker class.
23104     * @param del The callback function that will delete the content.
23105     *
23106     * Each marker must be associated to a marker class, and it can display a
23107     * a content on a bubble that opens when the user click over the marker.
23108     * The function to return such content can be set with
23109     * elm_map_marker_class_get_cb_set().
23110     *
23111     * If this content must be freed, a callback function need to be
23112     * set for that task with this function.
23113     *
23114     * If this callback is defined it will have to delete (or not) the
23115     * object inside, but if the callback is not defined the object will be
23116     * destroyed with evas_object_del().
23117     *
23118     * @see elm_map_marker_class_new() for more details.
23119     * @see elm_map_marker_class_get_cb_set()
23120     * @see elm_map_marker_add()
23121     *
23122     * @ingroup Map
23123     */
23124    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23125
23126    /**
23127     * Get the list of available sources.
23128     *
23129     * @param obj The map object.
23130     * @return The source names list.
23131     *
23132     * It will provide a list with all available sources, that can be set as
23133     * current source with elm_map_source_name_set(), or get with
23134     * elm_map_source_name_get().
23135     *
23136     * Available sources:
23137     * @li "Mapnik"
23138     * @li "Osmarender"
23139     * @li "CycleMap"
23140     * @li "Maplint"
23141     *
23142     * @see elm_map_source_name_set() for more details.
23143     * @see elm_map_source_name_get()
23144     *
23145     * @ingroup Map
23146     */
23147    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23148
23149    /**
23150     * Set the source of the map.
23151     *
23152     * @param obj The map object.
23153     * @param source The source to be used.
23154     *
23155     * Map widget retrieves images that composes the map from a web service.
23156     * This web service can be set with this method.
23157     *
23158     * A different service can return a different maps with different
23159     * information and it can use different zoom values.
23160     *
23161     * The @p source_name need to match one of the names provided by
23162     * elm_map_source_names_get().
23163     *
23164     * The current source can be get using elm_map_source_name_get().
23165     *
23166     * @see elm_map_source_names_get()
23167     * @see elm_map_source_name_get()
23168     *
23169     *
23170     * @ingroup Map
23171     */
23172    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23173
23174    /**
23175     * Get the name of currently used source.
23176     *
23177     * @param obj The map object.
23178     * @return Returns the name of the source in use.
23179     *
23180     * @see elm_map_source_name_set() for more details.
23181     *
23182     * @ingroup Map
23183     */
23184    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23185
23186    /**
23187     * Set the source of the route service to be used by the map.
23188     *
23189     * @param obj The map object.
23190     * @param source The route service to be used, being it one of
23191     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23192     * and #ELM_MAP_ROUTE_SOURCE_ORS.
23193     *
23194     * Each one has its own algorithm, so the route retrieved may
23195     * differ depending on the source route. Now, only the default is working.
23196     *
23197     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23198     * http://www.yournavigation.org/.
23199     *
23200     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23201     * assumptions. Its routing core is based on Contraction Hierarchies.
23202     *
23203     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23204     *
23205     * @see elm_map_route_source_get().
23206     *
23207     * @ingroup Map
23208     */
23209    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23210
23211    /**
23212     * Get the current route source.
23213     *
23214     * @param obj The map object.
23215     * @return The source of the route service used by the map.
23216     *
23217     * @see elm_map_route_source_set() for details.
23218     *
23219     * @ingroup Map
23220     */
23221    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23222
23223    /**
23224     * Set the minimum zoom of the source.
23225     *
23226     * @param obj The map object.
23227     * @param zoom New minimum zoom value to be used.
23228     *
23229     * By default, it's 0.
23230     *
23231     * @ingroup Map
23232     */
23233    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23234
23235    /**
23236     * Get the minimum zoom of the source.
23237     *
23238     * @param obj The map object.
23239     * @return Returns the minimum zoom of the source.
23240     *
23241     * @see elm_map_source_zoom_min_set() for details.
23242     *
23243     * @ingroup Map
23244     */
23245    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23246
23247    /**
23248     * Set the maximum zoom of the source.
23249     *
23250     * @param obj The map object.
23251     * @param zoom New maximum zoom value to be used.
23252     *
23253     * By default, it's 18.
23254     *
23255     * @ingroup Map
23256     */
23257    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23258
23259    /**
23260     * Get the maximum zoom of the source.
23261     *
23262     * @param obj The map object.
23263     * @return Returns the maximum zoom of the source.
23264     *
23265     * @see elm_map_source_zoom_min_set() for details.
23266     *
23267     * @ingroup Map
23268     */
23269    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23270
23271    /**
23272     * Set the user agent used by the map object to access routing services.
23273     *
23274     * @param obj The map object.
23275     * @param user_agent The user agent to be used by the map.
23276     *
23277     * User agent is a client application implementing a network protocol used
23278     * in communications within a client–server distributed computing system
23279     *
23280     * The @p user_agent identification string will transmitted in a header
23281     * field @c User-Agent.
23282     *
23283     * @see elm_map_user_agent_get()
23284     *
23285     * @ingroup Map
23286     */
23287    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23288
23289    /**
23290     * Get the user agent used by the map object.
23291     *
23292     * @param obj The map object.
23293     * @return The user agent identification string used by the map.
23294     *
23295     * @see elm_map_user_agent_set() for details.
23296     *
23297     * @ingroup Map
23298     */
23299    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23300
23301    /**
23302     * Add a new route to the map object.
23303     *
23304     * @param obj The map object.
23305     * @param type The type of transport to be considered when tracing a route.
23306     * @param method The routing method, what should be priorized.
23307     * @param flon The start longitude.
23308     * @param flat The start latitude.
23309     * @param tlon The destination longitude.
23310     * @param tlat The destination latitude.
23311     *
23312     * @return The created route or @c NULL upon failure.
23313     *
23314     * A route will be traced by point on coordinates (@p flat, @p flon)
23315     * to point on coordinates (@p tlat, @p tlon), using the route service
23316     * set with elm_map_route_source_set().
23317     *
23318     * It will take @p type on consideration to define the route,
23319     * depending if the user will be walking or driving, the route may vary.
23320     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23321     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23322     *
23323     * Another parameter is what the route should priorize, the minor distance
23324     * or the less time to be spend on the route. So @p method should be one
23325     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23326     *
23327     * Routes created with this method can be deleted with
23328     * elm_map_route_remove(), colored with elm_map_route_color_set(),
23329     * and distance can be get with elm_map_route_distance_get().
23330     *
23331     * @see elm_map_route_remove()
23332     * @see elm_map_route_color_set()
23333     * @see elm_map_route_distance_get()
23334     * @see elm_map_route_source_set()
23335     *
23336     * @ingroup Map
23337     */
23338    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);
23339
23340    /**
23341     * Remove a route from the map.
23342     *
23343     * @param route The route to remove.
23344     *
23345     * @see elm_map_route_add()
23346     *
23347     * @ingroup Map
23348     */
23349    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23350
23351    /**
23352     * Set the route color.
23353     *
23354     * @param route The route object.
23355     * @param r Red channel value, from 0 to 255.
23356     * @param g Green channel value, from 0 to 255.
23357     * @param b Blue channel value, from 0 to 255.
23358     * @param a Alpha channel value, from 0 to 255.
23359     *
23360     * It uses an additive color model, so each color channel represents
23361     * how much of each primary colors must to be used. 0 represents
23362     * ausence of this color, so if all of the three are set to 0,
23363     * the color will be black.
23364     *
23365     * These component values should be integers in the range 0 to 255,
23366     * (single 8-bit byte).
23367     *
23368     * This sets the color used for the route. By default, it is set to
23369     * solid red (r = 255, g = 0, b = 0, a = 255).
23370     *
23371     * For alpha channel, 0 represents completely transparent, and 255, opaque.
23372     *
23373     * @see elm_map_route_color_get()
23374     *
23375     * @ingroup Map
23376     */
23377    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23378
23379    /**
23380     * Get the route color.
23381     *
23382     * @param route The route object.
23383     * @param r Pointer where to store the red channel value.
23384     * @param g Pointer where to store the green channel value.
23385     * @param b Pointer where to store the blue channel value.
23386     * @param a Pointer where to store the alpha channel value.
23387     *
23388     * @see elm_map_route_color_set() for details.
23389     *
23390     * @ingroup Map
23391     */
23392    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23393
23394    /**
23395     * Get the route distance in kilometers.
23396     *
23397     * @param route The route object.
23398     * @return The distance of route (unit : km).
23399     *
23400     * @ingroup Map
23401     */
23402    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23403
23404    /**
23405     * Get the information of route nodes.
23406     *
23407     * @param route The route object.
23408     * @return Returns a string with the nodes of route.
23409     *
23410     * @ingroup Map
23411     */
23412    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23413
23414    /**
23415     * Get the information of route waypoint.
23416     *
23417     * @param route the route object.
23418     * @return Returns a string with information about waypoint of route.
23419     *
23420     * @ingroup Map
23421     */
23422    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23423
23424    /**
23425     * Get the address of the name.
23426     *
23427     * @param name The name handle.
23428     * @return Returns the address string of @p name.
23429     *
23430     * This gets the coordinates of the @p name, created with one of the
23431     * conversion functions.
23432     *
23433     * @see elm_map_utils_convert_name_into_coord()
23434     * @see elm_map_utils_convert_coord_into_name()
23435     *
23436     * @ingroup Map
23437     */
23438    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23439
23440    /**
23441     * Get the current coordinates of the name.
23442     *
23443     * @param name The name handle.
23444     * @param lat Pointer where to store the latitude.
23445     * @param lon Pointer where to store The longitude.
23446     *
23447     * This gets the coordinates of the @p name, created with one of the
23448     * conversion functions.
23449     *
23450     * @see elm_map_utils_convert_name_into_coord()
23451     * @see elm_map_utils_convert_coord_into_name()
23452     *
23453     * @ingroup Map
23454     */
23455    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23456
23457    /**
23458     * Remove a name from the map.
23459     *
23460     * @param name The name to remove.
23461     *
23462     * Basically the struct handled by @p name will be freed, so convertions
23463     * between address and coordinates will be lost.
23464     *
23465     * @see elm_map_utils_convert_name_into_coord()
23466     * @see elm_map_utils_convert_coord_into_name()
23467     *
23468     * @ingroup Map
23469     */
23470    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23471
23472    /**
23473     * Rotate the map.
23474     *
23475     * @param obj The map object.
23476     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23477     * @param cx Rotation's center horizontal position.
23478     * @param cy Rotation's center vertical position.
23479     *
23480     * @see elm_map_rotate_get()
23481     *
23482     * @ingroup Map
23483     */
23484    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23485
23486    /**
23487     * Get the rotate degree of the map
23488     *
23489     * @param obj The map object
23490     * @param degree Pointer where to store degrees from 0.0 to 360.0
23491     * to rotate arount Z axis.
23492     * @param cx Pointer where to store rotation's center horizontal position.
23493     * @param cy Pointer where to store rotation's center vertical position.
23494     *
23495     * @see elm_map_rotate_set() to set map rotation.
23496     *
23497     * @ingroup Map
23498     */
23499    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);
23500
23501    /**
23502     * Enable or disable mouse wheel to be used to zoom in / out the map.
23503     *
23504     * @param obj The map object.
23505     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23506     * to enable it.
23507     *
23508     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23509     *
23510     * It's disabled by default.
23511     *
23512     * @see elm_map_wheel_disabled_get()
23513     *
23514     * @ingroup Map
23515     */
23516    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23517
23518    /**
23519     * Get a value whether mouse wheel is enabled or not.
23520     *
23521     * @param obj The map object.
23522     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23523     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23524     *
23525     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23526     *
23527     * @see elm_map_wheel_disabled_set() for details.
23528     *
23529     * @ingroup Map
23530     */
23531    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23532
23533 #ifdef ELM_EMAP
23534    /**
23535     * Add a track on the map
23536     *
23537     * @param obj The map object.
23538     * @param emap The emap route object.
23539     * @return The route object. This is an elm object of type Route.
23540     *
23541     * @see elm_route_add() for details.
23542     *
23543     * @ingroup Map
23544     */
23545    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23546 #endif
23547
23548    /**
23549     * Remove a track from the map
23550     *
23551     * @param obj The map object.
23552     * @param route The track to remove.
23553     *
23554     * @ingroup Map
23555     */
23556    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23557
23558    /**
23559     * @}
23560     */
23561
23562    /* Route */
23563    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23564 #ifdef ELM_EMAP
23565    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23566 #endif
23567    EAPI double elm_route_lon_min_get(Evas_Object *obj);
23568    EAPI double elm_route_lat_min_get(Evas_Object *obj);
23569    EAPI double elm_route_lon_max_get(Evas_Object *obj);
23570    EAPI double elm_route_lat_max_get(Evas_Object *obj);
23571
23572
23573    /**
23574     * @defgroup Panel Panel
23575     *
23576     * @image html img/widget/panel/preview-00.png
23577     * @image latex img/widget/panel/preview-00.eps
23578     *
23579     * @brief A panel is a type of animated container that contains subobjects.
23580     * It can be expanded or contracted by clicking the button on it's edge.
23581     *
23582     * Orientations are as follows:
23583     * @li ELM_PANEL_ORIENT_TOP
23584     * @li ELM_PANEL_ORIENT_LEFT
23585     * @li ELM_PANEL_ORIENT_RIGHT
23586     *
23587     * @ref tutorial_panel shows one way to use this widget.
23588     * @{
23589     */
23590    typedef enum _Elm_Panel_Orient
23591      {
23592         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23593         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23594         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23595         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23596      } Elm_Panel_Orient;
23597    /**
23598     * @brief Adds a panel object
23599     *
23600     * @param parent The parent object
23601     *
23602     * @return The panel object, or NULL on failure
23603     */
23604    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23605    /**
23606     * @brief Sets the orientation of the panel
23607     *
23608     * @param parent The parent object
23609     * @param orient The panel orientation. Can be one of the following:
23610     * @li ELM_PANEL_ORIENT_TOP
23611     * @li ELM_PANEL_ORIENT_LEFT
23612     * @li ELM_PANEL_ORIENT_RIGHT
23613     *
23614     * Sets from where the panel will (dis)appear.
23615     */
23616    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23617    /**
23618     * @brief Get the orientation of the panel.
23619     *
23620     * @param obj The panel object
23621     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23622     */
23623    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23624    /**
23625     * @brief Set the content of the panel.
23626     *
23627     * @param obj The panel object
23628     * @param content The panel content
23629     *
23630     * Once the content object is set, a previously set one will be deleted.
23631     * If you want to keep that old content object, use the
23632     * elm_panel_content_unset() function.
23633     */
23634    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23635    /**
23636     * @brief Get the content of the panel.
23637     *
23638     * @param obj The panel object
23639     * @return The content that is being used
23640     *
23641     * Return the content object which is set for this widget.
23642     *
23643     * @see elm_panel_content_set()
23644     */
23645    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23646    /**
23647     * @brief Unset the content of the panel.
23648     *
23649     * @param obj The panel object
23650     * @return The content that was being used
23651     *
23652     * Unparent and return the content object which was set for this widget.
23653     *
23654     * @see elm_panel_content_set()
23655     */
23656    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23657    /**
23658     * @brief Set the state of the panel.
23659     *
23660     * @param obj The panel object
23661     * @param hidden If true, the panel will run the animation to contract
23662     */
23663    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23664    /**
23665     * @brief Get the state of the panel.
23666     *
23667     * @param obj The panel object
23668     * @param hidden If true, the panel is in the "hide" state
23669     */
23670    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23671    /**
23672     * @brief Toggle the hidden state of the panel from code
23673     *
23674     * @param obj The panel object
23675     */
23676    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23677    /**
23678     * @}
23679     */
23680
23681    /**
23682     * @defgroup Panes Panes
23683     * @ingroup Elementary
23684     *
23685     * @image html img/widget/panes/preview-00.png
23686     * @image latex img/widget/panes/preview-00.eps width=\textwidth
23687     *
23688     * @image html img/panes.png
23689     * @image latex img/panes.eps width=\textwidth
23690     *
23691     * The panes adds a dragable bar between two contents. When dragged
23692     * this bar will resize contents size.
23693     *
23694     * Panes can be displayed vertically or horizontally, and contents
23695     * size proportion can be customized (homogeneous by default).
23696     *
23697     * Smart callbacks one can listen to:
23698     * - "press" - The panes has been pressed (button wasn't released yet).
23699     * - "unpressed" - The panes was released after being pressed.
23700     * - "clicked" - The panes has been clicked>
23701     * - "clicked,double" - The panes has been double clicked
23702     *
23703     * Available styles for it:
23704     * - @c "default"
23705     *
23706     * Here is an example on its usage:
23707     * @li @ref panes_example
23708     */
23709
23710    /**
23711     * @addtogroup Panes
23712     * @{
23713     */
23714
23715    /**
23716     * Add a new panes widget to the given parent Elementary
23717     * (container) object.
23718     *
23719     * @param parent The parent object.
23720     * @return a new panes widget handle or @c NULL, on errors.
23721     *
23722     * This function inserts a new panes widget on the canvas.
23723     *
23724     * @ingroup Panes
23725     */
23726    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23727
23728    /**
23729     * Set the left content of the panes widget.
23730     *
23731     * @param obj The panes object.
23732     * @param content The new left content object.
23733     *
23734     * Once the content object is set, a previously set one will be deleted.
23735     * If you want to keep that old content object, use the
23736     * elm_panes_content_left_unset() function.
23737     *
23738     * If panes is displayed vertically, left content will be displayed at
23739     * top.
23740     *
23741     * @see elm_panes_content_left_get()
23742     * @see elm_panes_content_right_set() to set content on the other side.
23743     *
23744     * @ingroup Panes
23745     */
23746    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23747
23748    /**
23749     * Set the right content of the panes widget.
23750     *
23751     * @param obj The panes object.
23752     * @param content The new right content object.
23753     *
23754     * Once the content object is set, a previously set one will be deleted.
23755     * If you want to keep that old content object, use the
23756     * elm_panes_content_right_unset() function.
23757     *
23758     * If panes is displayed vertically, left content will be displayed at
23759     * bottom.
23760     *
23761     * @see elm_panes_content_right_get()
23762     * @see elm_panes_content_left_set() to set content on the other side.
23763     *
23764     * @ingroup Panes
23765     */
23766    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23767
23768    /**
23769     * Get the left content of the panes.
23770     *
23771     * @param obj The panes object.
23772     * @return The left content object that is being used.
23773     *
23774     * Return the left content object which is set for this widget.
23775     *
23776     * @see elm_panes_content_left_set() for details.
23777     *
23778     * @ingroup Panes
23779     */
23780    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23781
23782    /**
23783     * Get the right content of the panes.
23784     *
23785     * @param obj The panes object
23786     * @return The right content object that is being used
23787     *
23788     * Return the right content object which is set for this widget.
23789     *
23790     * @see elm_panes_content_right_set() for details.
23791     *
23792     * @ingroup Panes
23793     */
23794    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23795
23796    /**
23797     * Unset the left content used for the panes.
23798     *
23799     * @param obj The panes object.
23800     * @return The left content object that was being used.
23801     *
23802     * Unparent and return the left content object which was set for this widget.
23803     *
23804     * @see elm_panes_content_left_set() for details.
23805     * @see elm_panes_content_left_get().
23806     *
23807     * @ingroup Panes
23808     */
23809    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23810
23811    /**
23812     * Unset the right content used for the panes.
23813     *
23814     * @param obj The panes object.
23815     * @return The right content object that was being used.
23816     *
23817     * Unparent and return the right content object which was set for this
23818     * widget.
23819     *
23820     * @see elm_panes_content_right_set() for details.
23821     * @see elm_panes_content_right_get().
23822     *
23823     * @ingroup Panes
23824     */
23825    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23826
23827    /**
23828     * Get the size proportion of panes widget's left side.
23829     *
23830     * @param obj The panes object.
23831     * @return float value between 0.0 and 1.0 representing size proportion
23832     * of left side.
23833     *
23834     * @see elm_panes_content_left_size_set() for more details.
23835     *
23836     * @ingroup Panes
23837     */
23838    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23839
23840    /**
23841     * Set the size proportion of panes widget's left side.
23842     *
23843     * @param obj The panes object.
23844     * @param size Value between 0.0 and 1.0 representing size proportion
23845     * of left side.
23846     *
23847     * By default it's homogeneous, i.e., both sides have the same size.
23848     *
23849     * If something different is required, it can be set with this function.
23850     * For example, if the left content should be displayed over
23851     * 75% of the panes size, @p size should be passed as @c 0.75.
23852     * This way, right content will be resized to 25% of panes size.
23853     *
23854     * If displayed vertically, left content is displayed at top, and
23855     * right content at bottom.
23856     *
23857     * @note This proportion will change when user drags the panes bar.
23858     *
23859     * @see elm_panes_content_left_size_get()
23860     *
23861     * @ingroup Panes
23862     */
23863    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
23864
23865   /**
23866    * Set the orientation of a given panes widget.
23867    *
23868    * @param obj The panes object.
23869    * @param horizontal Use @c EINA_TRUE to make @p obj to be
23870    * @b horizontal, @c EINA_FALSE to make it @b vertical.
23871    *
23872    * Use this function to change how your panes is to be
23873    * disposed: vertically or horizontally.
23874    *
23875    * By default it's displayed horizontally.
23876    *
23877    * @see elm_panes_horizontal_get()
23878    *
23879    * @ingroup Panes
23880    */
23881    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
23882
23883    /**
23884     * Retrieve the orientation of a given panes widget.
23885     *
23886     * @param obj The panes object.
23887     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
23888     * @c EINA_FALSE if it's @b vertical (and on errors).
23889     *
23890     * @see elm_panes_horizontal_set() for more details.
23891     *
23892     * @ingroup Panes
23893     */
23894    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23895    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
23896    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23897
23898    /**
23899     * @}
23900     */
23901
23902    /**
23903     * @defgroup Flip Flip
23904     *
23905     * @image html img/widget/flip/preview-00.png
23906     * @image latex img/widget/flip/preview-00.eps
23907     *
23908     * This widget holds 2 content objects(Evas_Object): one on the front and one
23909     * on the back. It allows you to flip from front to back and vice-versa using
23910     * various animations.
23911     *
23912     * If either the front or back contents are not set the flip will treat that
23913     * as transparent. So if you wore to set the front content but not the back,
23914     * and then call elm_flip_go() you would see whatever is below the flip.
23915     *
23916     * For a list of supported animations see elm_flip_go().
23917     *
23918     * Signals that you can add callbacks for are:
23919     * "animate,begin" - when a flip animation was started
23920     * "animate,done" - when a flip animation is finished
23921     *
23922     * @ref tutorial_flip show how to use most of the API.
23923     *
23924     * @{
23925     */
23926    typedef enum _Elm_Flip_Mode
23927      {
23928         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
23929         ELM_FLIP_ROTATE_X_CENTER_AXIS,
23930         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
23931         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
23932         ELM_FLIP_CUBE_LEFT,
23933         ELM_FLIP_CUBE_RIGHT,
23934         ELM_FLIP_CUBE_UP,
23935         ELM_FLIP_CUBE_DOWN,
23936         ELM_FLIP_PAGE_LEFT,
23937         ELM_FLIP_PAGE_RIGHT,
23938         ELM_FLIP_PAGE_UP,
23939         ELM_FLIP_PAGE_DOWN
23940      } Elm_Flip_Mode;
23941    typedef enum _Elm_Flip_Interaction
23942      {
23943         ELM_FLIP_INTERACTION_NONE,
23944         ELM_FLIP_INTERACTION_ROTATE,
23945         ELM_FLIP_INTERACTION_CUBE,
23946         ELM_FLIP_INTERACTION_PAGE
23947      } Elm_Flip_Interaction;
23948    typedef enum _Elm_Flip_Direction
23949      {
23950         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
23951         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
23952         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
23953         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
23954      } Elm_Flip_Direction;
23955    /**
23956     * @brief Add a new flip to the parent
23957     *
23958     * @param parent The parent object
23959     * @return The new object or NULL if it cannot be created
23960     */
23961    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23962    /**
23963     * @brief Set the front content of the flip widget.
23964     *
23965     * @param obj The flip object
23966     * @param content The new front content object
23967     *
23968     * Once the content object is set, a previously set one will be deleted.
23969     * If you want to keep that old content object, use the
23970     * elm_flip_content_front_unset() function.
23971     */
23972    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23973    /**
23974     * @brief Set the back content of the flip widget.
23975     *
23976     * @param obj The flip object
23977     * @param content The new back content object
23978     *
23979     * Once the content object is set, a previously set one will be deleted.
23980     * If you want to keep that old content object, use the
23981     * elm_flip_content_back_unset() function.
23982     */
23983    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23984    /**
23985     * @brief Get the front content used for the flip
23986     *
23987     * @param obj The flip object
23988     * @return The front content object that is being used
23989     *
23990     * Return the front content object which is set for this widget.
23991     */
23992    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23993    /**
23994     * @brief Get the back content used for the flip
23995     *
23996     * @param obj The flip object
23997     * @return The back content object that is being used
23998     *
23999     * Return the back content object which is set for this widget.
24000     */
24001    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24002    /**
24003     * @brief Unset the front content used for the flip
24004     *
24005     * @param obj The flip object
24006     * @return The front content object that was being used
24007     *
24008     * Unparent and return the front content object which was set for this widget.
24009     */
24010    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24011    /**
24012     * @brief Unset the back content used for the flip
24013     *
24014     * @param obj The flip object
24015     * @return The back content object that was being used
24016     *
24017     * Unparent and return the back content object which was set for this widget.
24018     */
24019    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24020    /**
24021     * @brief Get flip front visibility state
24022     *
24023     * @param obj The flip objct
24024     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24025     * showing.
24026     */
24027    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24028    /**
24029     * @brief Set flip perspective
24030     *
24031     * @param obj The flip object
24032     * @param foc The coordinate to set the focus on
24033     * @param x The X coordinate
24034     * @param y The Y coordinate
24035     *
24036     * @warning This function currently does nothing.
24037     */
24038    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24039    /**
24040     * @brief Runs the flip animation
24041     *
24042     * @param obj The flip object
24043     * @param mode The mode type
24044     *
24045     * Flips the front and back contents using the @p mode animation. This
24046     * efectively hides the currently visible content and shows the hidden one.
24047     *
24048     * There a number of possible animations to use for the flipping:
24049     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24050     * around a horizontal axis in the middle of its height, the other content
24051     * is shown as the other side of the flip.
24052     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24053     * around a vertical axis in the middle of its width, the other content is
24054     * shown as the other side of the flip.
24055     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24056     * around a diagonal axis in the middle of its width, the other content is
24057     * shown as the other side of the flip.
24058     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24059     * around a diagonal axis in the middle of its height, the other content is
24060     * shown as the other side of the flip.
24061     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24062     * as if the flip was a cube, the other content is show as the right face of
24063     * the cube.
24064     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24065     * right as if the flip was a cube, the other content is show as the left
24066     * face of the cube.
24067     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24068     * flip was a cube, the other content is show as the bottom face of the cube.
24069     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24070     * the flip was a cube, the other content is show as the upper face of the
24071     * cube.
24072     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24073     * if the flip was a book, the other content is shown as the page below that.
24074     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24075     * as if the flip was a book, the other content is shown as the page below
24076     * that.
24077     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24078     * flip was a book, the other content is shown as the page below that.
24079     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24080     * flip was a book, the other content is shown as the page below that.
24081     *
24082     * @image html elm_flip.png
24083     * @image latex elm_flip.eps width=\textwidth
24084     */
24085    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24086    /**
24087     * @brief Set the interactive flip mode
24088     *
24089     * @param obj The flip object
24090     * @param mode The interactive flip mode to use
24091     *
24092     * This sets if the flip should be interactive (allow user to click and
24093     * drag a side of the flip to reveal the back page and cause it to flip).
24094     * By default a flip is not interactive. You may also need to set which
24095     * sides of the flip are "active" for flipping and how much space they use
24096     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24097     * and elm_flip_interacton_direction_hitsize_set()
24098     *
24099     * The four avilable mode of interaction are:
24100     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24101     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24102     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24103     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24104     *
24105     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24106     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24107     * happen, those can only be acheived with elm_flip_go();
24108     */
24109    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24110    /**
24111     * @brief Get the interactive flip mode
24112     *
24113     * @param obj The flip object
24114     * @return The interactive flip mode
24115     *
24116     * Returns the interactive flip mode set by elm_flip_interaction_set()
24117     */
24118    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24119    /**
24120     * @brief Set which directions of the flip respond to interactive flip
24121     *
24122     * @param obj The flip object
24123     * @param dir The direction to change
24124     * @param enabled If that direction is enabled or not
24125     *
24126     * By default all directions are disabled, so you may want to enable the
24127     * desired directions for flipping if you need interactive flipping. You must
24128     * call this function once for each direction that should be enabled.
24129     *
24130     * @see elm_flip_interaction_set()
24131     */
24132    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24133    /**
24134     * @brief Get the enabled state of that flip direction
24135     *
24136     * @param obj The flip object
24137     * @param dir The direction to check
24138     * @return If that direction is enabled or not
24139     *
24140     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24141     *
24142     * @see elm_flip_interaction_set()
24143     */
24144    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24145    /**
24146     * @brief Set the amount of the flip that is sensitive to interactive flip
24147     *
24148     * @param obj The flip object
24149     * @param dir The direction to modify
24150     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24151     *
24152     * Set the amount of the flip that is sensitive to interactive flip, with 0
24153     * representing no area in the flip and 1 representing the entire flip. There
24154     * is however a consideration to be made in that the area will never be
24155     * smaller than the finger size set(as set in your Elementary configuration).
24156     *
24157     * @see elm_flip_interaction_set()
24158     */
24159    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24160    /**
24161     * @brief Get the amount of the flip that is sensitive to interactive flip
24162     *
24163     * @param obj The flip object
24164     * @param dir The direction to check
24165     * @return The size set for that direction
24166     *
24167     * Returns the amount os sensitive area set by
24168     * elm_flip_interacton_direction_hitsize_set().
24169     */
24170    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24171    /**
24172     * @}
24173     */
24174
24175    /* scrolledentry */
24176    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24177    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24178    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24179    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24180    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24181    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24182    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24183    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24184    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24185    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24186    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24187    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24188    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24189    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24190    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24191    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24192    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24193    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24194    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24195    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24196    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24197    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24198    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24199    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24200    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24201    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24202    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24203    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24204    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24205    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24206    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24207    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24208    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24209    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24210    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24211    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);
24212    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24213    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24214    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);
24215    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24216    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);
24217    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24218    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24219    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24220    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24221    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24222    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24223    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24224    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24225    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);
24226    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);
24227    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);
24228    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);
24229    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);
24230    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);
24231    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24232    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24233    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24234    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24235    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24236    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24237    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24238
24239    /**
24240     * @defgroup Conformant Conformant
24241     * @ingroup Elementary
24242     *
24243     * @image html img/widget/conformant/preview-00.png
24244     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24245     *
24246     * @image html img/conformant.png
24247     * @image latex img/conformant.eps width=\textwidth
24248     *
24249     * The aim is to provide a widget that can be used in elementary apps to
24250     * account for space taken up by the indicator, virtual keypad & softkey
24251     * windows when running the illume2 module of E17.
24252     *
24253     * So conformant content will be sized and positioned considering the
24254     * space required for such stuff, and when they popup, as a keyboard
24255     * shows when an entry is selected, conformant content won't change.
24256     *
24257     * Available styles for it:
24258     * - @c "default"
24259     *
24260     * See how to use this widget in this example:
24261     * @ref conformant_example
24262     */
24263
24264    /**
24265     * @addtogroup Conformant
24266     * @{
24267     */
24268
24269    /**
24270     * Add a new conformant widget to the given parent Elementary
24271     * (container) object.
24272     *
24273     * @param parent The parent object.
24274     * @return A new conformant widget handle or @c NULL, on errors.
24275     *
24276     * This function inserts a new conformant widget on the canvas.
24277     *
24278     * @ingroup Conformant
24279     */
24280    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24281
24282    /**
24283     * Set the content of the conformant widget.
24284     *
24285     * @param obj The conformant object.
24286     * @param content The content to be displayed by the conformant.
24287     *
24288     * Content will be sized and positioned considering the space required
24289     * to display a virtual keyboard. So it won't fill all the conformant
24290     * size. This way is possible to be sure that content won't resize
24291     * or be re-positioned after the keyboard is displayed.
24292     *
24293     * Once the content object is set, a previously set one will be deleted.
24294     * If you want to keep that old content object, use the
24295     * elm_conformat_content_unset() function.
24296     *
24297     * @see elm_conformant_content_unset()
24298     * @see elm_conformant_content_get()
24299     *
24300     * @ingroup Conformant
24301     */
24302    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24303
24304    /**
24305     * Get the content of the conformant widget.
24306     *
24307     * @param obj The conformant object.
24308     * @return The content that is being used.
24309     *
24310     * Return the content object which is set for this widget.
24311     * It won't be unparent from conformant. For that, use
24312     * elm_conformant_content_unset().
24313     *
24314     * @see elm_conformant_content_set() for more details.
24315     * @see elm_conformant_content_unset()
24316     *
24317     * @ingroup Conformant
24318     */
24319    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24320
24321    /**
24322     * Unset the content of the conformant widget.
24323     *
24324     * @param obj The conformant object.
24325     * @return The content that was being used.
24326     *
24327     * Unparent and return the content object which was set for this widget.
24328     *
24329     * @see elm_conformant_content_set() for more details.
24330     *
24331     * @ingroup Conformant
24332     */
24333    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24334
24335    /**
24336     * Returns the Evas_Object that represents the content area.
24337     *
24338     * @param obj The conformant object.
24339     * @return The content area of the widget.
24340     *
24341     * @ingroup Conformant
24342     */
24343    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24344
24345    /**
24346     * @}
24347     */
24348
24349    /**
24350     * @defgroup Mapbuf Mapbuf
24351     * @ingroup Elementary
24352     *
24353     * @image html img/widget/mapbuf/preview-00.png
24354     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24355     *
24356     * This holds one content object and uses an Evas Map of transformation
24357     * points to be later used with this content. So the content will be
24358     * moved, resized, etc as a single image. So it will improve performance
24359     * when you have a complex interafce, with a lot of elements, and will
24360     * need to resize or move it frequently (the content object and its
24361     * children).
24362     *
24363     * See how to use this widget in this example:
24364     * @ref mapbuf_example
24365     */
24366
24367    /**
24368     * @addtogroup Mapbuf
24369     * @{
24370     */
24371
24372    /**
24373     * Add a new mapbuf widget to the given parent Elementary
24374     * (container) object.
24375     *
24376     * @param parent The parent object.
24377     * @return A new mapbuf widget handle or @c NULL, on errors.
24378     *
24379     * This function inserts a new mapbuf widget on the canvas.
24380     *
24381     * @ingroup Mapbuf
24382     */
24383    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24384
24385    /**
24386     * Set the content of the mapbuf.
24387     *
24388     * @param obj The mapbuf object.
24389     * @param content The content that will be filled in this mapbuf object.
24390     *
24391     * Once the content object is set, a previously set one will be deleted.
24392     * If you want to keep that old content object, use the
24393     * elm_mapbuf_content_unset() function.
24394     *
24395     * To enable map, elm_mapbuf_enabled_set() should be used.
24396     *
24397     * @ingroup Mapbuf
24398     */
24399    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24400
24401    /**
24402     * Get the content of the mapbuf.
24403     *
24404     * @param obj The mapbuf object.
24405     * @return The content that is being used.
24406     *
24407     * Return the content object which is set for this widget.
24408     *
24409     * @see elm_mapbuf_content_set() for details.
24410     *
24411     * @ingroup Mapbuf
24412     */
24413    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24414
24415    /**
24416     * Unset the content of the mapbuf.
24417     *
24418     * @param obj The mapbuf object.
24419     * @return The content that was being used.
24420     *
24421     * Unparent and return the content object which was set for this widget.
24422     *
24423     * @see elm_mapbuf_content_set() for details.
24424     *
24425     * @ingroup Mapbuf
24426     */
24427    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24428
24429    /**
24430     * Enable or disable the map.
24431     *
24432     * @param obj The mapbuf object.
24433     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24434     *
24435     * This enables the map that is set or disables it. On enable, the object
24436     * geometry will be saved, and the new geometry will change (position and
24437     * size) to reflect the map geometry set.
24438     *
24439     * Also, when enabled, alpha and smooth states will be used, so if the
24440     * content isn't solid, alpha should be enabled, for example, otherwise
24441     * a black retangle will fill the content.
24442     *
24443     * When disabled, the stored map will be freed and geometry prior to
24444     * enabling the map will be restored.
24445     *
24446     * It's disabled by default.
24447     *
24448     * @see elm_mapbuf_alpha_set()
24449     * @see elm_mapbuf_smooth_set()
24450     *
24451     * @ingroup Mapbuf
24452     */
24453    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24454
24455    /**
24456     * Get a value whether map is enabled or not.
24457     *
24458     * @param obj The mapbuf object.
24459     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24460     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24461     *
24462     * @see elm_mapbuf_enabled_set() for details.
24463     *
24464     * @ingroup Mapbuf
24465     */
24466    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24467
24468    /**
24469     * Enable or disable smooth map rendering.
24470     *
24471     * @param obj The mapbuf object.
24472     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24473     * to disable it.
24474     *
24475     * This sets smoothing for map rendering. If the object is a type that has
24476     * its own smoothing settings, then both the smooth settings for this object
24477     * and the map must be turned off.
24478     *
24479     * By default smooth maps are enabled.
24480     *
24481     * @ingroup Mapbuf
24482     */
24483    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24484
24485    /**
24486     * Get a value whether smooth map rendering is enabled or not.
24487     *
24488     * @param obj The mapbuf object.
24489     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24490     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24491     *
24492     * @see elm_mapbuf_smooth_set() for details.
24493     *
24494     * @ingroup Mapbuf
24495     */
24496    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24497
24498    /**
24499     * Set or unset alpha flag for map rendering.
24500     *
24501     * @param obj The mapbuf object.
24502     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24503     * to disable it.
24504     *
24505     * This sets alpha flag for map rendering. If the object is a type that has
24506     * its own alpha settings, then this will take precedence. Only image objects
24507     * have this currently. It stops alpha blending of the map area, and is
24508     * useful if you know the object and/or all sub-objects is 100% solid.
24509     *
24510     * Alpha is enabled by default.
24511     *
24512     * @ingroup Mapbuf
24513     */
24514    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24515
24516    /**
24517     * Get a value whether alpha blending is enabled or not.
24518     *
24519     * @param obj The mapbuf object.
24520     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24521     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24522     *
24523     * @see elm_mapbuf_alpha_set() for details.
24524     *
24525     * @ingroup Mapbuf
24526     */
24527    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24528
24529    /**
24530     * @}
24531     */
24532
24533    /**
24534     * @defgroup Flipselector Flip Selector
24535     *
24536     * @image html img/widget/flipselector/preview-00.png
24537     * @image latex img/widget/flipselector/preview-00.eps
24538     *
24539     * A flip selector is a widget to show a set of @b text items, one
24540     * at a time, with the same sheet switching style as the @ref Clock
24541     * "clock" widget, when one changes the current displaying sheet
24542     * (thus, the "flip" in the name).
24543     *
24544     * User clicks to flip sheets which are @b held for some time will
24545     * make the flip selector to flip continuosly and automatically for
24546     * the user. The interval between flips will keep growing in time,
24547     * so that it helps the user to reach an item which is distant from
24548     * the current selection.
24549     *
24550     * Smart callbacks one can register to:
24551     * - @c "selected" - when the widget's selected text item is changed
24552     * - @c "overflowed" - when the widget's current selection is changed
24553     *   from the first item in its list to the last
24554     * - @c "underflowed" - when the widget's current selection is changed
24555     *   from the last item in its list to the first
24556     *
24557     * Available styles for it:
24558     * - @c "default"
24559     *
24560     * Here is an example on its usage:
24561     * @li @ref flipselector_example
24562     */
24563
24564    /**
24565     * @addtogroup Flipselector
24566     * @{
24567     */
24568
24569    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24570
24571    /**
24572     * Add a new flip selector widget to the given parent Elementary
24573     * (container) widget
24574     *
24575     * @param parent The parent object
24576     * @return a new flip selector widget handle or @c NULL, on errors
24577     *
24578     * This function inserts a new flip selector widget on the canvas.
24579     *
24580     * @ingroup Flipselector
24581     */
24582    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24583
24584    /**
24585     * Programmatically select the next item of a flip selector widget
24586     *
24587     * @param obj The flipselector object
24588     *
24589     * @note The selection will be animated. Also, if it reaches the
24590     * end of its list of member items, it will continue with the first
24591     * one onwards.
24592     *
24593     * @ingroup Flipselector
24594     */
24595    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24596
24597    /**
24598     * Programmatically select the previous item of a flip selector
24599     * widget
24600     *
24601     * @param obj The flipselector object
24602     *
24603     * @note The selection will be animated.  Also, if it reaches the
24604     * beginning of its list of member items, it will continue with the
24605     * last one backwards.
24606     *
24607     * @ingroup Flipselector
24608     */
24609    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24610
24611    /**
24612     * Append a (text) item to a flip selector widget
24613     *
24614     * @param obj The flipselector object
24615     * @param label The (text) label of the new item
24616     * @param func Convenience callback function to take place when
24617     * item is selected
24618     * @param data Data passed to @p func, above
24619     * @return A handle to the item added or @c NULL, on errors
24620     *
24621     * The widget's list of labels to show will be appended with the
24622     * given value. If the user wishes so, a callback function pointer
24623     * can be passed, which will get called when this same item is
24624     * selected.
24625     *
24626     * @note The current selection @b won't be modified by appending an
24627     * element to the list.
24628     *
24629     * @note The maximum length of the text label is going to be
24630     * determined <b>by the widget's theme</b>. Strings larger than
24631     * that value are going to be @b truncated.
24632     *
24633     * @ingroup Flipselector
24634     */
24635    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24636
24637    /**
24638     * Prepend a (text) item to a flip selector widget
24639     *
24640     * @param obj The flipselector object
24641     * @param label The (text) label of the new item
24642     * @param func Convenience callback function to take place when
24643     * item is selected
24644     * @param data Data passed to @p func, above
24645     * @return A handle to the item added or @c NULL, on errors
24646     *
24647     * The widget's list of labels to show will be prepended with the
24648     * given value. If the user wishes so, a callback function pointer
24649     * can be passed, which will get called when this same item is
24650     * selected.
24651     *
24652     * @note The current selection @b won't be modified by prepending
24653     * an element to the list.
24654     *
24655     * @note The maximum length of the text label is going to be
24656     * determined <b>by the widget's theme</b>. Strings larger than
24657     * that value are going to be @b truncated.
24658     *
24659     * @ingroup Flipselector
24660     */
24661    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24662
24663    /**
24664     * Get the internal list of items in a given flip selector widget.
24665     *
24666     * @param obj The flipselector object
24667     * @return The list of items (#Elm_Flipselector_Item as data) or
24668     * @c NULL on errors.
24669     *
24670     * This list is @b not to be modified in any way and must not be
24671     * freed. Use the list members with functions like
24672     * elm_flipselector_item_label_set(),
24673     * elm_flipselector_item_label_get(),
24674     * elm_flipselector_item_del(),
24675     * elm_flipselector_item_selected_get(),
24676     * elm_flipselector_item_selected_set().
24677     *
24678     * @warning This list is only valid until @p obj object's internal
24679     * items list is changed. It should be fetched again with another
24680     * call to this function when changes happen.
24681     *
24682     * @ingroup Flipselector
24683     */
24684    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24685
24686    /**
24687     * Get the first item in the given flip selector widget's list of
24688     * items.
24689     *
24690     * @param obj The flipselector object
24691     * @return The first item or @c NULL, if it has no items (and on
24692     * errors)
24693     *
24694     * @see elm_flipselector_item_append()
24695     * @see elm_flipselector_last_item_get()
24696     *
24697     * @ingroup Flipselector
24698     */
24699    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24700
24701    /**
24702     * Get the last item in the given flip selector widget's list of
24703     * items.
24704     *
24705     * @param obj The flipselector object
24706     * @return The last item or @c NULL, if it has no items (and on
24707     * errors)
24708     *
24709     * @see elm_flipselector_item_prepend()
24710     * @see elm_flipselector_first_item_get()
24711     *
24712     * @ingroup Flipselector
24713     */
24714    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24715
24716    /**
24717     * Get the currently selected item in a flip selector widget.
24718     *
24719     * @param obj The flipselector object
24720     * @return The selected item or @c NULL, if the widget has no items
24721     * (and on erros)
24722     *
24723     * @ingroup Flipselector
24724     */
24725    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24726
24727    /**
24728     * Set whether a given flip selector widget's item should be the
24729     * currently selected one.
24730     *
24731     * @param item The flip selector item
24732     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24733     *
24734     * This sets whether @p item is or not the selected (thus, under
24735     * display) one. If @p item is different than one under display,
24736     * the latter will be unselected. If the @p item is set to be
24737     * unselected, on the other hand, the @b first item in the widget's
24738     * internal members list will be the new selected one.
24739     *
24740     * @see elm_flipselector_item_selected_get()
24741     *
24742     * @ingroup Flipselector
24743     */
24744    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24745
24746    /**
24747     * Get whether a given flip selector widget's item is the currently
24748     * selected one.
24749     *
24750     * @param item The flip selector item
24751     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24752     * (or on errors).
24753     *
24754     * @see elm_flipselector_item_selected_set()
24755     *
24756     * @ingroup Flipselector
24757     */
24758    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24759
24760    /**
24761     * Delete a given item from a flip selector widget.
24762     *
24763     * @param item The item to delete
24764     *
24765     * @ingroup Flipselector
24766     */
24767    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24768
24769    /**
24770     * Get the label of a given flip selector widget's item.
24771     *
24772     * @param item The item to get label from
24773     * @return The text label of @p item or @c NULL, on errors
24774     *
24775     * @see elm_flipselector_item_label_set()
24776     *
24777     * @ingroup Flipselector
24778     */
24779    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24780
24781    /**
24782     * Set the label of a given flip selector widget's item.
24783     *
24784     * @param item The item to set label on
24785     * @param label The text label string, in UTF-8 encoding
24786     *
24787     * @see elm_flipselector_item_label_get()
24788     *
24789     * @ingroup Flipselector
24790     */
24791    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24792
24793    /**
24794     * Gets the item before @p item in a flip selector widget's
24795     * internal list of items.
24796     *
24797     * @param item The item to fetch previous from
24798     * @return The item before the @p item, in its parent's list. If
24799     *         there is no previous item for @p item or there's an
24800     *         error, @c NULL is returned.
24801     *
24802     * @see elm_flipselector_item_next_get()
24803     *
24804     * @ingroup Flipselector
24805     */
24806    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24807
24808    /**
24809     * Gets the item after @p item in a flip selector widget's
24810     * internal list of items.
24811     *
24812     * @param item The item to fetch next from
24813     * @return The item after the @p item, in its parent's list. If
24814     *         there is no next item for @p item or there's an
24815     *         error, @c NULL is returned.
24816     *
24817     * @see elm_flipselector_item_next_get()
24818     *
24819     * @ingroup Flipselector
24820     */
24821    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24822
24823    /**
24824     * Set the interval on time updates for an user mouse button hold
24825     * on a flip selector widget.
24826     *
24827     * @param obj The flip selector object
24828     * @param interval The (first) interval value in seconds
24829     *
24830     * This interval value is @b decreased while the user holds the
24831     * mouse pointer either flipping up or flipping doww a given flip
24832     * selector.
24833     *
24834     * This helps the user to get to a given item distant from the
24835     * current one easier/faster, as it will start to flip quicker and
24836     * quicker on mouse button holds.
24837     *
24838     * The calculation for the next flip interval value, starting from
24839     * the one set with this call, is the previous interval divided by
24840     * 1.05, so it decreases a little bit.
24841     *
24842     * The default starting interval value for automatic flips is
24843     * @b 0.85 seconds.
24844     *
24845     * @see elm_flipselector_interval_get()
24846     *
24847     * @ingroup Flipselector
24848     */
24849    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24850
24851    /**
24852     * Get the interval on time updates for an user mouse button hold
24853     * on a flip selector widget.
24854     *
24855     * @param obj The flip selector object
24856     * @return The (first) interval value, in seconds, set on it
24857     *
24858     * @see elm_flipselector_interval_set() for more details
24859     *
24860     * @ingroup Flipselector
24861     */
24862    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24863    /**
24864     * @}
24865     */
24866
24867    /**
24868     * @addtogroup Calendar
24869     * @{
24870     */
24871
24872    /**
24873     * @enum _Elm_Calendar_Mark_Repeat
24874     * @typedef Elm_Calendar_Mark_Repeat
24875     *
24876     * Event periodicity, used to define if a mark should be repeated
24877     * @b beyond event's day. It's set when a mark is added.
24878     *
24879     * So, for a mark added to 13th May with periodicity set to WEEKLY,
24880     * there will be marks every week after this date. Marks will be displayed
24881     * at 13th, 20th, 27th, 3rd June ...
24882     *
24883     * Values don't work as bitmask, only one can be choosen.
24884     *
24885     * @see elm_calendar_mark_add()
24886     *
24887     * @ingroup Calendar
24888     */
24889    typedef enum _Elm_Calendar_Mark_Repeat
24890      {
24891         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
24892         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
24893         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
24894         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*/
24895         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. */
24896      } Elm_Calendar_Mark_Repeat;
24897
24898    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(). */
24899
24900    /**
24901     * Add a new calendar widget to the given parent Elementary
24902     * (container) object.
24903     *
24904     * @param parent The parent object.
24905     * @return a new calendar widget handle or @c NULL, on errors.
24906     *
24907     * This function inserts a new calendar widget on the canvas.
24908     *
24909     * @ref calendar_example_01
24910     *
24911     * @ingroup Calendar
24912     */
24913    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24914
24915    /**
24916     * Get weekdays names displayed by the calendar.
24917     *
24918     * @param obj The calendar object.
24919     * @return Array of seven strings to be used as weekday names.
24920     *
24921     * By default, weekdays abbreviations get from system are displayed:
24922     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24923     * The first string is related to Sunday, the second to Monday...
24924     *
24925     * @see elm_calendar_weekdays_name_set()
24926     *
24927     * @ref calendar_example_05
24928     *
24929     * @ingroup Calendar
24930     */
24931    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24932
24933    /**
24934     * Set weekdays names to be displayed by the calendar.
24935     *
24936     * @param obj The calendar object.
24937     * @param weekdays Array of seven strings to be used as weekday names.
24938     * @warning It must have 7 elements, or it will access invalid memory.
24939     * @warning The strings must be NULL terminated ('@\0').
24940     *
24941     * By default, weekdays abbreviations get from system are displayed:
24942     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24943     *
24944     * The first string should be related to Sunday, the second to Monday...
24945     *
24946     * The usage should be like this:
24947     * @code
24948     *   const char *weekdays[] =
24949     *   {
24950     *      "Sunday", "Monday", "Tuesday", "Wednesday",
24951     *      "Thursday", "Friday", "Saturday"
24952     *   };
24953     *   elm_calendar_weekdays_names_set(calendar, weekdays);
24954     * @endcode
24955     *
24956     * @see elm_calendar_weekdays_name_get()
24957     *
24958     * @ref calendar_example_02
24959     *
24960     * @ingroup Calendar
24961     */
24962    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
24963
24964    /**
24965     * Set the minimum and maximum values for the year
24966     *
24967     * @param obj The calendar object
24968     * @param min The minimum year, greater than 1901;
24969     * @param max The maximum year;
24970     *
24971     * Maximum must be greater than minimum, except if you don't wan't to set
24972     * maximum year.
24973     * Default values are 1902 and -1.
24974     *
24975     * If the maximum year is a negative value, it will be limited depending
24976     * on the platform architecture (year 2037 for 32 bits);
24977     *
24978     * @see elm_calendar_min_max_year_get()
24979     *
24980     * @ref calendar_example_03
24981     *
24982     * @ingroup Calendar
24983     */
24984    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
24985
24986    /**
24987     * Get the minimum and maximum values for the year
24988     *
24989     * @param obj The calendar object.
24990     * @param min The minimum year.
24991     * @param max The maximum year.
24992     *
24993     * Default values are 1902 and -1.
24994     *
24995     * @see elm_calendar_min_max_year_get() for more details.
24996     *
24997     * @ref calendar_example_05
24998     *
24999     * @ingroup Calendar
25000     */
25001    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25002
25003    /**
25004     * Enable or disable day selection
25005     *
25006     * @param obj The calendar object.
25007     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25008     * disable it.
25009     *
25010     * Enabled by default. If disabled, the user still can select months,
25011     * but not days. Selected days are highlighted on calendar.
25012     * It should be used if you won't need such selection for the widget usage.
25013     *
25014     * When a day is selected, or month is changed, smart callbacks for
25015     * signal "changed" will be called.
25016     *
25017     * @see elm_calendar_day_selection_enable_get()
25018     *
25019     * @ref calendar_example_04
25020     *
25021     * @ingroup Calendar
25022     */
25023    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25024
25025    /**
25026     * Get a value whether day selection is enabled or not.
25027     *
25028     * @see elm_calendar_day_selection_enable_set() for details.
25029     *
25030     * @param obj The calendar object.
25031     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25032     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25033     *
25034     * @ref calendar_example_05
25035     *
25036     * @ingroup Calendar
25037     */
25038    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25039
25040
25041    /**
25042     * Set selected date to be highlighted on calendar.
25043     *
25044     * @param obj The calendar object.
25045     * @param selected_time A @b tm struct to represent the selected date.
25046     *
25047     * Set the selected date, changing the displayed month if needed.
25048     * Selected date changes when the user goes to next/previous month or
25049     * select a day pressing over it on calendar.
25050     *
25051     * @see elm_calendar_selected_time_get()
25052     *
25053     * @ref calendar_example_04
25054     *
25055     * @ingroup Calendar
25056     */
25057    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25058
25059    /**
25060     * Get selected date.
25061     *
25062     * @param obj The calendar object
25063     * @param selected_time A @b tm struct to point to selected date
25064     * @return EINA_FALSE means an error ocurred and returned time shouldn't
25065     * be considered.
25066     *
25067     * Get date selected by the user or set by function
25068     * elm_calendar_selected_time_set().
25069     * Selected date changes when the user goes to next/previous month or
25070     * select a day pressing over it on calendar.
25071     *
25072     * @see elm_calendar_selected_time_get()
25073     *
25074     * @ref calendar_example_05
25075     *
25076     * @ingroup Calendar
25077     */
25078    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25079
25080    /**
25081     * Set a function to format the string that will be used to display
25082     * month and year;
25083     *
25084     * @param obj The calendar object
25085     * @param format_function Function to set the month-year string given
25086     * the selected date
25087     *
25088     * By default it uses strftime with "%B %Y" format string.
25089     * It should allocate the memory that will be used by the string,
25090     * that will be freed by the widget after usage.
25091     * A pointer to the string and a pointer to the time struct will be provided.
25092     *
25093     * Example:
25094     * @code
25095     * static char *
25096     * _format_month_year(struct tm *selected_time)
25097     * {
25098     *    char buf[32];
25099     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25100     *    return strdup(buf);
25101     * }
25102     *
25103     * elm_calendar_format_function_set(calendar, _format_month_year);
25104     * @endcode
25105     *
25106     * @ref calendar_example_02
25107     *
25108     * @ingroup Calendar
25109     */
25110    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25111
25112    /**
25113     * Add a new mark to the calendar
25114     *
25115     * @param obj The calendar object
25116     * @param mark_type A string used to define the type of mark. It will be
25117     * emitted to the theme, that should display a related modification on these
25118     * days representation.
25119     * @param mark_time A time struct to represent the date of inclusion of the
25120     * mark. For marks that repeats it will just be displayed after the inclusion
25121     * date in the calendar.
25122     * @param repeat Repeat the event following this periodicity. Can be a unique
25123     * mark (that don't repeat), daily, weekly, monthly or annually.
25124     * @return The created mark or @p NULL upon failure.
25125     *
25126     * Add a mark that will be drawn in the calendar respecting the insertion
25127     * time and periodicity. It will emit the type as signal to the widget theme.
25128     * Default theme supports "holiday" and "checked", but it can be extended.
25129     *
25130     * It won't immediately update the calendar, drawing the marks.
25131     * For this, call elm_calendar_marks_draw(). However, when user selects
25132     * next or previous month calendar forces marks drawn.
25133     *
25134     * Marks created with this method can be deleted with
25135     * elm_calendar_mark_del().
25136     *
25137     * Example
25138     * @code
25139     * struct tm selected_time;
25140     * time_t current_time;
25141     *
25142     * current_time = time(NULL) + 5 * 84600;
25143     * localtime_r(&current_time, &selected_time);
25144     * elm_calendar_mark_add(cal, "holiday", selected_time,
25145     *     ELM_CALENDAR_ANNUALLY);
25146     *
25147     * current_time = time(NULL) + 1 * 84600;
25148     * localtime_r(&current_time, &selected_time);
25149     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25150     *
25151     * elm_calendar_marks_draw(cal);
25152     * @endcode
25153     *
25154     * @see elm_calendar_marks_draw()
25155     * @see elm_calendar_mark_del()
25156     *
25157     * @ref calendar_example_06
25158     *
25159     * @ingroup Calendar
25160     */
25161    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);
25162
25163    /**
25164     * Delete mark from the calendar.
25165     *
25166     * @param mark The mark to be deleted.
25167     *
25168     * If deleting all calendar marks is required, elm_calendar_marks_clear()
25169     * should be used instead of getting marks list and deleting each one.
25170     *
25171     * @see elm_calendar_mark_add()
25172     *
25173     * @ref calendar_example_06
25174     *
25175     * @ingroup Calendar
25176     */
25177    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25178
25179    /**
25180     * Remove all calendar's marks
25181     *
25182     * @param obj The calendar object.
25183     *
25184     * @see elm_calendar_mark_add()
25185     * @see elm_calendar_mark_del()
25186     *
25187     * @ingroup Calendar
25188     */
25189    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25190
25191
25192    /**
25193     * Get a list of all the calendar marks.
25194     *
25195     * @param obj The calendar object.
25196     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25197     *
25198     * @see elm_calendar_mark_add()
25199     * @see elm_calendar_mark_del()
25200     * @see elm_calendar_marks_clear()
25201     *
25202     * @ingroup Calendar
25203     */
25204    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25205
25206    /**
25207     * Draw calendar marks.
25208     *
25209     * @param obj The calendar object.
25210     *
25211     * Should be used after adding, removing or clearing marks.
25212     * It will go through the entire marks list updating the calendar.
25213     * If lots of marks will be added, add all the marks and then call
25214     * this function.
25215     *
25216     * When the month is changed, i.e. user selects next or previous month,
25217     * marks will be drawed.
25218     *
25219     * @see elm_calendar_mark_add()
25220     * @see elm_calendar_mark_del()
25221     * @see elm_calendar_marks_clear()
25222     *
25223     * @ref calendar_example_06
25224     *
25225     * @ingroup Calendar
25226     */
25227    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25228
25229    /**
25230     * Set a day text color to the same that represents Saturdays.
25231     *
25232     * @param obj The calendar object.
25233     * @param pos The text position. Position is the cell counter, from left
25234     * to right, up to down. It starts on 0 and ends on 41.
25235     *
25236     * @deprecated use elm_calendar_mark_add() instead like:
25237     *
25238     * @code
25239     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25240     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25241     * @endcode
25242     *
25243     * @see elm_calendar_mark_add()
25244     *
25245     * @ingroup Calendar
25246     */
25247    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25248
25249    /**
25250     * Set a day text color to the same that represents Sundays.
25251     *
25252     * @param obj The calendar object.
25253     * @param pos The text position. Position is the cell counter, from left
25254     * to right, up to down. It starts on 0 and ends on 41.
25255
25256     * @deprecated use elm_calendar_mark_add() instead like:
25257     *
25258     * @code
25259     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25260     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25261     * @endcode
25262     *
25263     * @see elm_calendar_mark_add()
25264     *
25265     * @ingroup Calendar
25266     */
25267    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25268
25269    /**
25270     * Set a day text color to the same that represents Weekdays.
25271     *
25272     * @param obj The calendar object
25273     * @param pos The text position. Position is the cell counter, from left
25274     * to right, up to down. It starts on 0 and ends on 41.
25275     *
25276     * @deprecated use elm_calendar_mark_add() instead like:
25277     *
25278     * @code
25279     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25280     *
25281     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25282     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25283     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25284     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25285     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25286     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25287     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25288     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25289     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25290     * @endcode
25291     *
25292     * @see elm_calendar_mark_add()
25293     *
25294     * @ingroup Calendar
25295     */
25296    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25297
25298    /**
25299     * Set the interval on time updates for an user mouse button hold
25300     * on calendar widgets' month selection.
25301     *
25302     * @param obj The calendar object
25303     * @param interval The (first) interval value in seconds
25304     *
25305     * This interval value is @b decreased while the user holds the
25306     * mouse pointer either selecting next or previous month.
25307     *
25308     * This helps the user to get to a given month distant from the
25309     * current one easier/faster, as it will start to change quicker and
25310     * quicker on mouse button holds.
25311     *
25312     * The calculation for the next change interval value, starting from
25313     * the one set with this call, is the previous interval divided by
25314     * 1.05, so it decreases a little bit.
25315     *
25316     * The default starting interval value for automatic changes is
25317     * @b 0.85 seconds.
25318     *
25319     * @see elm_calendar_interval_get()
25320     *
25321     * @ingroup Calendar
25322     */
25323    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25324
25325    /**
25326     * Get the interval on time updates for an user mouse button hold
25327     * on calendar widgets' month selection.
25328     *
25329     * @param obj The calendar object
25330     * @return The (first) interval value, in seconds, set on it
25331     *
25332     * @see elm_calendar_interval_set() for more details
25333     *
25334     * @ingroup Calendar
25335     */
25336    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25337
25338    /**
25339     * @}
25340     */
25341
25342    /**
25343     * @defgroup Diskselector Diskselector
25344     * @ingroup Elementary
25345     *
25346     * @image html img/widget/diskselector/preview-00.png
25347     * @image latex img/widget/diskselector/preview-00.eps
25348     *
25349     * A diskselector is a kind of list widget. It scrolls horizontally,
25350     * and can contain label and icon objects. Three items are displayed
25351     * with the selected one in the middle.
25352     *
25353     * It can act like a circular list with round mode and labels can be
25354     * reduced for a defined length for side items.
25355     *
25356     * Smart callbacks one can listen to:
25357     * - "selected" - when item is selected, i.e. scroller stops.
25358     *
25359     * Available styles for it:
25360     * - @c "default"
25361     *
25362     * List of examples:
25363     * @li @ref diskselector_example_01
25364     * @li @ref diskselector_example_02
25365     */
25366
25367    /**
25368     * @addtogroup Diskselector
25369     * @{
25370     */
25371
25372    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(). */
25373
25374    /**
25375     * Add a new diskselector widget to the given parent Elementary
25376     * (container) object.
25377     *
25378     * @param parent The parent object.
25379     * @return a new diskselector widget handle or @c NULL, on errors.
25380     *
25381     * This function inserts a new diskselector widget on the canvas.
25382     *
25383     * @ingroup Diskselector
25384     */
25385    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25386
25387    /**
25388     * Enable or disable round mode.
25389     *
25390     * @param obj The diskselector object.
25391     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25392     * disable it.
25393     *
25394     * Disabled by default. If round mode is enabled the items list will
25395     * work like a circle list, so when the user reaches the last item,
25396     * the first one will popup.
25397     *
25398     * @see elm_diskselector_round_get()
25399     *
25400     * @ingroup Diskselector
25401     */
25402    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25403
25404    /**
25405     * Get a value whether round mode is enabled or not.
25406     *
25407     * @see elm_diskselector_round_set() for details.
25408     *
25409     * @param obj The diskselector object.
25410     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25411     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25412     *
25413     * @ingroup Diskselector
25414     */
25415    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25416
25417    /**
25418     * Get the side labels max length.
25419     *
25420     * @deprecated use elm_diskselector_side_label_length_get() instead:
25421     *
25422     * @param obj The diskselector object.
25423     * @return The max length defined for side labels, or 0 if not a valid
25424     * diskselector.
25425     *
25426     * @ingroup Diskselector
25427     */
25428    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25429
25430    /**
25431     * Set the side labels max length.
25432     *
25433     * @deprecated use elm_diskselector_side_label_length_set() instead:
25434     *
25435     * @param obj The diskselector object.
25436     * @param len The max length defined for side labels.
25437     *
25438     * @ingroup Diskselector
25439     */
25440    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25441
25442    /**
25443     * Get the side labels max length.
25444     *
25445     * @see elm_diskselector_side_label_length_set() for details.
25446     *
25447     * @param obj The diskselector object.
25448     * @return The max length defined for side labels, or 0 if not a valid
25449     * diskselector.
25450     *
25451     * @ingroup Diskselector
25452     */
25453    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25454
25455    /**
25456     * Set the side labels max length.
25457     *
25458     * @param obj The diskselector object.
25459     * @param len The max length defined for side labels.
25460     *
25461     * Length is the number of characters of items' label that will be
25462     * visible when it's set on side positions. It will just crop
25463     * the string after defined size. E.g.:
25464     *
25465     * An item with label "January" would be displayed on side position as
25466     * "Jan" if max length is set to 3, or "Janu", if this property
25467     * is set to 4.
25468     *
25469     * When it's selected, the entire label will be displayed, except for
25470     * width restrictions. In this case label will be cropped and "..."
25471     * will be concatenated.
25472     *
25473     * Default side label max length is 3.
25474     *
25475     * This property will be applyed over all items, included before or
25476     * later this function call.
25477     *
25478     * @ingroup Diskselector
25479     */
25480    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25481
25482    /**
25483     * Set the number of items to be displayed.
25484     *
25485     * @param obj The diskselector object.
25486     * @param num The number of items the diskselector will display.
25487     *
25488     * Default value is 3, and also it's the minimun. If @p num is less
25489     * than 3, it will be set to 3.
25490     *
25491     * Also, it can be set on theme, using data item @c display_item_num
25492     * on group "elm/diskselector/item/X", where X is style set.
25493     * E.g.:
25494     *
25495     * group { name: "elm/diskselector/item/X";
25496     * data {
25497     *     item: "display_item_num" "5";
25498     *     }
25499     *
25500     * @ingroup Diskselector
25501     */
25502    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25503
25504    /**
25505     * Get the number of items in the diskselector object.
25506     *
25507     * @param obj The diskselector object.
25508     *
25509     * @ingroup Diskselector
25510     */
25511    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25512
25513    /**
25514     * Set bouncing behaviour when the scrolled content reaches an edge.
25515     *
25516     * Tell the internal scroller object whether it should bounce or not
25517     * when it reaches the respective edges for each axis.
25518     *
25519     * @param obj The diskselector object.
25520     * @param h_bounce Whether to bounce or not in the horizontal axis.
25521     * @param v_bounce Whether to bounce or not in the vertical axis.
25522     *
25523     * @see elm_scroller_bounce_set()
25524     *
25525     * @ingroup Diskselector
25526     */
25527    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25528
25529    /**
25530     * Get the bouncing behaviour of the internal scroller.
25531     *
25532     * Get whether the internal scroller should bounce when the edge of each
25533     * axis is reached scrolling.
25534     *
25535     * @param obj The diskselector object.
25536     * @param h_bounce Pointer where to store the bounce state of the horizontal
25537     * axis.
25538     * @param v_bounce Pointer where to store the bounce state of the vertical
25539     * axis.
25540     *
25541     * @see elm_scroller_bounce_get()
25542     * @see elm_diskselector_bounce_set()
25543     *
25544     * @ingroup Diskselector
25545     */
25546    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25547
25548    /**
25549     * Get the scrollbar policy.
25550     *
25551     * @see elm_diskselector_scroller_policy_get() for details.
25552     *
25553     * @param obj The diskselector object.
25554     * @param policy_h Pointer where to store horizontal scrollbar policy.
25555     * @param policy_v Pointer where to store vertical scrollbar policy.
25556     *
25557     * @ingroup Diskselector
25558     */
25559    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);
25560
25561    /**
25562     * Set the scrollbar policy.
25563     *
25564     * @param obj The diskselector object.
25565     * @param policy_h Horizontal scrollbar policy.
25566     * @param policy_v Vertical scrollbar policy.
25567     *
25568     * This sets the scrollbar visibility policy for the given scroller.
25569     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25570     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25571     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25572     * This applies respectively for the horizontal and vertical scrollbars.
25573     *
25574     * The both are disabled by default, i.e., are set to
25575     * #ELM_SCROLLER_POLICY_OFF.
25576     *
25577     * @ingroup Diskselector
25578     */
25579    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25580
25581    /**
25582     * Remove all diskselector's items.
25583     *
25584     * @param obj The diskselector object.
25585     *
25586     * @see elm_diskselector_item_del()
25587     * @see elm_diskselector_item_append()
25588     *
25589     * @ingroup Diskselector
25590     */
25591    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25592
25593    /**
25594     * Get a list of all the diskselector items.
25595     *
25596     * @param obj The diskselector object.
25597     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25598     * or @c NULL on failure.
25599     *
25600     * @see elm_diskselector_item_append()
25601     * @see elm_diskselector_item_del()
25602     * @see elm_diskselector_clear()
25603     *
25604     * @ingroup Diskselector
25605     */
25606    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25607
25608    /**
25609     * Appends a new item to the diskselector object.
25610     *
25611     * @param obj The diskselector object.
25612     * @param label The label of the diskselector item.
25613     * @param icon The icon object to use at left side of the item. An
25614     * icon can be any Evas object, but usually it is an icon created
25615     * with elm_icon_add().
25616     * @param func The function to call when the item is selected.
25617     * @param data The data to associate with the item for related callbacks.
25618     *
25619     * @return The created item or @c NULL upon failure.
25620     *
25621     * A new item will be created and appended to the diskselector, i.e., will
25622     * be set as last item. Also, if there is no selected item, it will
25623     * be selected. This will always happens for the first appended item.
25624     *
25625     * If no icon is set, label will be centered on item position, otherwise
25626     * the icon will be placed at left of the label, that will be shifted
25627     * to the right.
25628     *
25629     * Items created with this method can be deleted with
25630     * elm_diskselector_item_del().
25631     *
25632     * Associated @p data can be properly freed when item is deleted if a
25633     * callback function is set with elm_diskselector_item_del_cb_set().
25634     *
25635     * If a function is passed as argument, it will be called everytime this item
25636     * is selected, i.e., the user stops the diskselector with this
25637     * item on center position. If such function isn't needed, just passing
25638     * @c NULL as @p func is enough. The same should be done for @p data.
25639     *
25640     * Simple example (with no function callback or data associated):
25641     * @code
25642     * disk = elm_diskselector_add(win);
25643     * ic = elm_icon_add(win);
25644     * elm_icon_file_set(ic, "path/to/image", NULL);
25645     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25646     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25647     * @endcode
25648     *
25649     * @see elm_diskselector_item_del()
25650     * @see elm_diskselector_item_del_cb_set()
25651     * @see elm_diskselector_clear()
25652     * @see elm_icon_add()
25653     *
25654     * @ingroup Diskselector
25655     */
25656    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);
25657
25658
25659    /**
25660     * Delete them item from the diskselector.
25661     *
25662     * @param it The item of diskselector to be deleted.
25663     *
25664     * If deleting all diskselector items is required, elm_diskselector_clear()
25665     * should be used instead of getting items list and deleting each one.
25666     *
25667     * @see elm_diskselector_clear()
25668     * @see elm_diskselector_item_append()
25669     * @see elm_diskselector_item_del_cb_set()
25670     *
25671     * @ingroup Diskselector
25672     */
25673    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25674
25675    /**
25676     * Set the function called when a diskselector item is freed.
25677     *
25678     * @param it The item to set the callback on
25679     * @param func The function called
25680     *
25681     * If there is a @p func, then it will be called prior item's memory release.
25682     * That will be called with the following arguments:
25683     * @li item's data;
25684     * @li item's Evas object;
25685     * @li item itself;
25686     *
25687     * This way, a data associated to a diskselector item could be properly
25688     * freed.
25689     *
25690     * @ingroup Diskselector
25691     */
25692    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25693
25694    /**
25695     * Get the data associated to the item.
25696     *
25697     * @param it The diskselector item
25698     * @return The data associated to @p it
25699     *
25700     * The return value is a pointer to data associated to @p item when it was
25701     * created, with function elm_diskselector_item_append(). If no data
25702     * was passed as argument, it will return @c NULL.
25703     *
25704     * @see elm_diskselector_item_append()
25705     *
25706     * @ingroup Diskselector
25707     */
25708    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25709
25710    /**
25711     * Set the icon associated to the item.
25712     *
25713     * @param it The diskselector item
25714     * @param icon The icon object to associate with @p it
25715     *
25716     * The icon object to use at left side of the item. An
25717     * icon can be any Evas object, but usually it is an icon created
25718     * with elm_icon_add().
25719     *
25720     * Once the icon object is set, a previously set one will be deleted.
25721     * @warning Setting the same icon for two items will cause the icon to
25722     * dissapear from the first item.
25723     *
25724     * If an icon was passed as argument on item creation, with function
25725     * elm_diskselector_item_append(), it will be already
25726     * associated to the item.
25727     *
25728     * @see elm_diskselector_item_append()
25729     * @see elm_diskselector_item_icon_get()
25730     *
25731     * @ingroup Diskselector
25732     */
25733    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25734
25735    /**
25736     * Get the icon associated to the item.
25737     *
25738     * @param it The diskselector item
25739     * @return The icon associated to @p it
25740     *
25741     * The return value is a pointer to the icon associated to @p item when it was
25742     * created, with function elm_diskselector_item_append(), or later
25743     * with function elm_diskselector_item_icon_set. If no icon
25744     * was passed as argument, it will return @c NULL.
25745     *
25746     * @see elm_diskselector_item_append()
25747     * @see elm_diskselector_item_icon_set()
25748     *
25749     * @ingroup Diskselector
25750     */
25751    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25752
25753    /**
25754     * Set the label of item.
25755     *
25756     * @param it The item of diskselector.
25757     * @param label The label of item.
25758     *
25759     * The label to be displayed by the item.
25760     *
25761     * If no icon is set, label will be centered on item position, otherwise
25762     * the icon will be placed at left of the label, that will be shifted
25763     * to the right.
25764     *
25765     * An item with label "January" would be displayed on side position as
25766     * "Jan" if max length is set to 3 with function
25767     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25768     * is set to 4.
25769     *
25770     * When this @p item is selected, the entire label will be displayed,
25771     * except for width restrictions.
25772     * In this case label will be cropped and "..." will be concatenated,
25773     * but only for display purposes. It will keep the entire string, so
25774     * if diskselector is resized the remaining characters will be displayed.
25775     *
25776     * If a label was passed as argument on item creation, with function
25777     * elm_diskselector_item_append(), it will be already
25778     * displayed by the item.
25779     *
25780     * @see elm_diskselector_side_label_lenght_set()
25781     * @see elm_diskselector_item_label_get()
25782     * @see elm_diskselector_item_append()
25783     *
25784     * @ingroup Diskselector
25785     */
25786    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25787
25788    /**
25789     * Get the label of item.
25790     *
25791     * @param it The item of diskselector.
25792     * @return The label of item.
25793     *
25794     * The return value is a pointer to the label associated to @p item when it was
25795     * created, with function elm_diskselector_item_append(), or later
25796     * with function elm_diskselector_item_label_set. If no label
25797     * was passed as argument, it will return @c NULL.
25798     *
25799     * @see elm_diskselector_item_label_set() for more details.
25800     * @see elm_diskselector_item_append()
25801     *
25802     * @ingroup Diskselector
25803     */
25804    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25805
25806    /**
25807     * Get the selected item.
25808     *
25809     * @param obj The diskselector object.
25810     * @return The selected diskselector item.
25811     *
25812     * The selected item can be unselected with function
25813     * elm_diskselector_item_selected_set(), and the first item of
25814     * diskselector will be selected.
25815     *
25816     * The selected item always will be centered on diskselector, with
25817     * full label displayed, i.e., max lenght set to side labels won't
25818     * apply on the selected item. More details on
25819     * elm_diskselector_side_label_length_set().
25820     *
25821     * @ingroup Diskselector
25822     */
25823    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25824
25825    /**
25826     * Set the selected state of an item.
25827     *
25828     * @param it The diskselector item
25829     * @param selected The selected state
25830     *
25831     * This sets the selected state of the given item @p it.
25832     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25833     *
25834     * If a new item is selected the previosly selected will be unselected.
25835     * Previoulsy selected item can be get with function
25836     * elm_diskselector_selected_item_get().
25837     *
25838     * If the item @p it is unselected, the first item of diskselector will
25839     * be selected.
25840     *
25841     * Selected items will be visible on center position of diskselector.
25842     * So if it was on another position before selected, or was invisible,
25843     * diskselector will animate items until the selected item reaches center
25844     * position.
25845     *
25846     * @see elm_diskselector_item_selected_get()
25847     * @see elm_diskselector_selected_item_get()
25848     *
25849     * @ingroup Diskselector
25850     */
25851    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25852
25853    /*
25854     * Get whether the @p item is selected or not.
25855     *
25856     * @param it The diskselector item.
25857     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
25858     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
25859     *
25860     * @see elm_diskselector_selected_item_set() for details.
25861     * @see elm_diskselector_item_selected_get()
25862     *
25863     * @ingroup Diskselector
25864     */
25865    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25866
25867    /**
25868     * Get the first item of the diskselector.
25869     *
25870     * @param obj The diskselector object.
25871     * @return The first item, or @c NULL if none.
25872     *
25873     * The list of items follows append order. So it will return the first
25874     * item appended to the widget that wasn't deleted.
25875     *
25876     * @see elm_diskselector_item_append()
25877     * @see elm_diskselector_items_get()
25878     *
25879     * @ingroup Diskselector
25880     */
25881    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25882
25883    /**
25884     * Get the last item of the diskselector.
25885     *
25886     * @param obj The diskselector object.
25887     * @return The last item, or @c NULL if none.
25888     *
25889     * The list of items follows append order. So it will return last first
25890     * item appended to the widget that wasn't deleted.
25891     *
25892     * @see elm_diskselector_item_append()
25893     * @see elm_diskselector_items_get()
25894     *
25895     * @ingroup Diskselector
25896     */
25897    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25898
25899    /**
25900     * Get the item before @p item in diskselector.
25901     *
25902     * @param it The diskselector item.
25903     * @return The item before @p item, or @c NULL if none or on failure.
25904     *
25905     * The list of items follows append order. So it will return item appended
25906     * just before @p item and that wasn't deleted.
25907     *
25908     * If it is the first item, @c NULL will be returned.
25909     * First item can be get by elm_diskselector_first_item_get().
25910     *
25911     * @see elm_diskselector_item_append()
25912     * @see elm_diskselector_items_get()
25913     *
25914     * @ingroup Diskselector
25915     */
25916    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25917
25918    /**
25919     * Get the item after @p item in diskselector.
25920     *
25921     * @param it The diskselector item.
25922     * @return The item after @p item, or @c NULL if none or on failure.
25923     *
25924     * The list of items follows append order. So it will return item appended
25925     * just after @p item and that wasn't deleted.
25926     *
25927     * If it is the last item, @c NULL will be returned.
25928     * Last item can be get by elm_diskselector_last_item_get().
25929     *
25930     * @see elm_diskselector_item_append()
25931     * @see elm_diskselector_items_get()
25932     *
25933     * @ingroup Diskselector
25934     */
25935    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25936
25937    /**
25938     * Set the text to be shown in the diskselector item.
25939     *
25940     * @param item Target item
25941     * @param text The text to set in the content
25942     *
25943     * Setup the text as tooltip to object. The item can have only one tooltip,
25944     * so any previous tooltip data is removed.
25945     *
25946     * @see elm_object_tooltip_text_set() for more details.
25947     *
25948     * @ingroup Diskselector
25949     */
25950    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
25951
25952    /**
25953     * Set the content to be shown in the tooltip item.
25954     *
25955     * Setup the tooltip to item. The item can have only one tooltip,
25956     * so any previous tooltip data is removed. @p func(with @p data) will
25957     * be called every time that need show the tooltip and it should
25958     * return a valid Evas_Object. This object is then managed fully by
25959     * tooltip system and is deleted when the tooltip is gone.
25960     *
25961     * @param item the diskselector item being attached a tooltip.
25962     * @param func the function used to create the tooltip contents.
25963     * @param data what to provide to @a func as callback data/context.
25964     * @param del_cb called when data is not needed anymore, either when
25965     *        another callback replaces @p func, the tooltip is unset with
25966     *        elm_diskselector_item_tooltip_unset() or the owner @a item
25967     *        dies. This callback receives as the first parameter the
25968     *        given @a data, and @c event_info is the item.
25969     *
25970     * @see elm_object_tooltip_content_cb_set() for more details.
25971     *
25972     * @ingroup Diskselector
25973     */
25974    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);
25975
25976    /**
25977     * Unset tooltip from item.
25978     *
25979     * @param item diskselector item to remove previously set tooltip.
25980     *
25981     * Remove tooltip from item. The callback provided as del_cb to
25982     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
25983     * it is not used anymore.
25984     *
25985     * @see elm_object_tooltip_unset() for more details.
25986     * @see elm_diskselector_item_tooltip_content_cb_set()
25987     *
25988     * @ingroup Diskselector
25989     */
25990    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25991
25992
25993    /**
25994     * Sets a different style for this item tooltip.
25995     *
25996     * @note before you set a style you should define a tooltip with
25997     *       elm_diskselector_item_tooltip_content_cb_set() or
25998     *       elm_diskselector_item_tooltip_text_set()
25999     *
26000     * @param item diskselector item with tooltip already set.
26001     * @param style the theme style to use (default, transparent, ...)
26002     *
26003     * @see elm_object_tooltip_style_set() for more details.
26004     *
26005     * @ingroup Diskselector
26006     */
26007    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26008
26009    /**
26010     * Get the style for this item tooltip.
26011     *
26012     * @param item diskselector item with tooltip already set.
26013     * @return style the theme style in use, defaults to "default". If the
26014     *         object does not have a tooltip set, then NULL is returned.
26015     *
26016     * @see elm_object_tooltip_style_get() for more details.
26017     * @see elm_diskselector_item_tooltip_style_set()
26018     *
26019     * @ingroup Diskselector
26020     */
26021    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26022
26023    /**
26024     * Set the cursor to be shown when mouse is over the diskselector item
26025     *
26026     * @param item Target item
26027     * @param cursor the cursor name to be used.
26028     *
26029     * @see elm_object_cursor_set() for more details.
26030     *
26031     * @ingroup Diskselector
26032     */
26033    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26034
26035    /**
26036     * Get the cursor to be shown when mouse is over the diskselector item
26037     *
26038     * @param item diskselector item with cursor already set.
26039     * @return the cursor name.
26040     *
26041     * @see elm_object_cursor_get() for more details.
26042     * @see elm_diskselector_cursor_set()
26043     *
26044     * @ingroup Diskselector
26045     */
26046    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26047
26048
26049    /**
26050     * Unset the cursor to be shown when mouse is over the diskselector item
26051     *
26052     * @param item Target item
26053     *
26054     * @see elm_object_cursor_unset() for more details.
26055     * @see elm_diskselector_cursor_set()
26056     *
26057     * @ingroup Diskselector
26058     */
26059    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26060
26061    /**
26062     * Sets a different style for this item cursor.
26063     *
26064     * @note before you set a style you should define a cursor with
26065     *       elm_diskselector_item_cursor_set()
26066     *
26067     * @param item diskselector item with cursor already set.
26068     * @param style the theme style to use (default, transparent, ...)
26069     *
26070     * @see elm_object_cursor_style_set() for more details.
26071     *
26072     * @ingroup Diskselector
26073     */
26074    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26075
26076
26077    /**
26078     * Get the style for this item cursor.
26079     *
26080     * @param item diskselector item with cursor already set.
26081     * @return style the theme style in use, defaults to "default". If the
26082     *         object does not have a cursor set, then @c NULL is returned.
26083     *
26084     * @see elm_object_cursor_style_get() for more details.
26085     * @see elm_diskselector_item_cursor_style_set()
26086     *
26087     * @ingroup Diskselector
26088     */
26089    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26090
26091
26092    /**
26093     * Set if the cursor set should be searched on the theme or should use
26094     * the provided by the engine, only.
26095     *
26096     * @note before you set if should look on theme you should define a cursor
26097     * with elm_diskselector_item_cursor_set().
26098     * By default it will only look for cursors provided by the engine.
26099     *
26100     * @param item widget item with cursor already set.
26101     * @param engine_only boolean to define if cursors set with
26102     * elm_diskselector_item_cursor_set() should be searched only
26103     * between cursors provided by the engine or searched on widget's
26104     * theme as well.
26105     *
26106     * @see elm_object_cursor_engine_only_set() for more details.
26107     *
26108     * @ingroup Diskselector
26109     */
26110    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26111
26112    /**
26113     * Get the cursor engine only usage for this item cursor.
26114     *
26115     * @param item widget item with cursor already set.
26116     * @return engine_only boolean to define it cursors should be looked only
26117     * between the provided by the engine or searched on widget's theme as well.
26118     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26119     *
26120     * @see elm_object_cursor_engine_only_get() for more details.
26121     * @see elm_diskselector_item_cursor_engine_only_set()
26122     *
26123     * @ingroup Diskselector
26124     */
26125    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26126
26127    /**
26128     * @}
26129     */
26130
26131    /**
26132     * @defgroup Colorselector Colorselector
26133     *
26134     * @{
26135     *
26136     * @image html img/widget/colorselector/preview-00.png
26137     * @image latex img/widget/colorselector/preview-00.eps
26138     *
26139     * @brief Widget for user to select a color.
26140     *
26141     * Signals that you can add callbacks for are:
26142     * "changed" - When the color value changes(event_info is NULL).
26143     *
26144     * See @ref tutorial_colorselector.
26145     */
26146    /**
26147     * @brief Add a new colorselector to the parent
26148     *
26149     * @param parent The parent object
26150     * @return The new object or NULL if it cannot be created
26151     *
26152     * @ingroup Colorselector
26153     */
26154    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26155    /**
26156     * Set a color for the colorselector
26157     *
26158     * @param obj   Colorselector object
26159     * @param r     r-value of color
26160     * @param g     g-value of color
26161     * @param b     b-value of color
26162     * @param a     a-value of color
26163     *
26164     * @ingroup Colorselector
26165     */
26166    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26167    /**
26168     * Get a color from the colorselector
26169     *
26170     * @param obj   Colorselector object
26171     * @param r     integer pointer for r-value of color
26172     * @param g     integer pointer for g-value of color
26173     * @param b     integer pointer for b-value of color
26174     * @param a     integer pointer for a-value of color
26175     *
26176     * @ingroup Colorselector
26177     */
26178    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26179    /**
26180     * @}
26181     */
26182
26183    /**
26184     * @defgroup Ctxpopup Ctxpopup
26185     *
26186     * @image html img/widget/ctxpopup/preview-00.png
26187     * @image latex img/widget/ctxpopup/preview-00.eps
26188     *
26189     * @brief Context popup widet.
26190     *
26191     * A ctxpopup is a widget that, when shown, pops up a list of items.
26192     * It automatically chooses an area inside its parent object's view
26193     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26194     * optimally fit into it. In the default theme, it will also point an
26195     * arrow to it's top left position at the time one shows it. Ctxpopup
26196     * items have a label and/or an icon. It is intended for a small
26197     * number of items (hence the use of list, not genlist).
26198     *
26199     * @note Ctxpopup is a especialization of @ref Hover.
26200     *
26201     * Signals that you can add callbacks for are:
26202     * "dismissed" - the ctxpopup was dismissed
26203     *
26204     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26205     * @{
26206     */
26207    typedef enum _Elm_Ctxpopup_Direction
26208      {
26209         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26210                                           area */
26211         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26212                                            the clicked area */
26213         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26214                                           the clicked area */
26215         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26216                                         area */
26217         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26218      } Elm_Ctxpopup_Direction;
26219
26220    /**
26221     * @brief Add a new Ctxpopup object to the parent.
26222     *
26223     * @param parent Parent object
26224     * @return New object or @c NULL, if it cannot be created
26225     */
26226    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26227    /**
26228     * @brief Set the Ctxpopup's parent
26229     *
26230     * @param obj The ctxpopup object
26231     * @param area The parent to use
26232     *
26233     * Set the parent object.
26234     *
26235     * @note elm_ctxpopup_add() will automatically call this function
26236     * with its @c parent argument.
26237     *
26238     * @see elm_ctxpopup_add()
26239     * @see elm_hover_parent_set()
26240     */
26241    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26242    /**
26243     * @brief Get the Ctxpopup's parent
26244     *
26245     * @param obj The ctxpopup object
26246     *
26247     * @see elm_ctxpopup_hover_parent_set() for more information
26248     */
26249    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26250    /**
26251     * @brief Clear all items in the given ctxpopup object.
26252     *
26253     * @param obj Ctxpopup object
26254     */
26255    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26256    /**
26257     * @brief Change the ctxpopup's orientation to horizontal or vertical.
26258     *
26259     * @param obj Ctxpopup object
26260     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26261     */
26262    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26263    /**
26264     * @brief Get the value of current ctxpopup object's orientation.
26265     *
26266     * @param obj Ctxpopup object
26267     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26268     *
26269     * @see elm_ctxpopup_horizontal_set()
26270     */
26271    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26272    /**
26273     * @brief Add a new item to a ctxpopup object.
26274     *
26275     * @param obj Ctxpopup object
26276     * @param icon Icon to be set on new item
26277     * @param label The Label of the new item
26278     * @param func Convenience function called when item selected
26279     * @param data Data passed to @p func
26280     * @return A handle to the item added or @c NULL, on errors
26281     *
26282     * @warning Ctxpopup can't hold both an item list and a content at the same
26283     * time. When an item is added, any previous content will be removed.
26284     *
26285     * @see elm_ctxpopup_content_set()
26286     */
26287    Elm_Object_Item *elm_ctxpopup_item_append(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
26288    /**
26289     * @brief Delete the given item in a ctxpopup object.
26290     *
26291     * @param it Ctxpopup item to be deleted
26292     *
26293     * @see elm_ctxpopup_item_append()
26294     */
26295    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26296    /**
26297     * @brief Set the ctxpopup item's state as disabled or enabled.
26298     *
26299     * @param it Ctxpopup item to be enabled/disabled
26300     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26301     *
26302     * When disabled the item is greyed out to indicate it's state.
26303     */
26304    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26305    /**
26306     * @brief Get the ctxpopup item's disabled/enabled state.
26307     *
26308     * @param it Ctxpopup item to be enabled/disabled
26309     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26310     *
26311     * @see elm_ctxpopup_item_disabled_set()
26312     */
26313    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26314    /**
26315     * @brief Get the icon object for the given ctxpopup item.
26316     *
26317     * @param it Ctxpopup item
26318     * @return icon object or @c NULL, if the item does not have icon or an error
26319     * occurred
26320     *
26321     * @see elm_ctxpopup_item_append()
26322     * @see elm_ctxpopup_item_icon_set()
26323     */
26324    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26325    /**
26326     * @brief Sets the side icon associated with the ctxpopup item
26327     *
26328     * @param it Ctxpopup item
26329     * @param icon Icon object to be set
26330     *
26331     * Once the icon object is set, a previously set one will be deleted.
26332     * @warning Setting the same icon for two items will cause the icon to
26333     * dissapear from the first item.
26334     *
26335     * @see elm_ctxpopup_item_append()
26336     */
26337    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26338    /**
26339     * @brief Get the label for the given ctxpopup item.
26340     *
26341     * @param it Ctxpopup item
26342     * @return label string or @c NULL, if the item does not have label or an
26343     * error occured
26344     *
26345     * @see elm_ctxpopup_item_append()
26346     * @see elm_ctxpopup_item_label_set()
26347     */
26348    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26349    /**
26350     * @brief (Re)set the label on the given ctxpopup item.
26351     *
26352     * @param it Ctxpopup item
26353     * @param label String to set as label
26354     */
26355    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26356    /**
26357     * @brief Set an elm widget as the content of the ctxpopup.
26358     *
26359     * @param obj Ctxpopup object
26360     * @param content Content to be swallowed
26361     *
26362     * If the content object is already set, a previous one will bedeleted. If
26363     * you want to keep that old content object, use the
26364     * elm_ctxpopup_content_unset() function.
26365     *
26366     * @deprecated use elm_object_content_set()
26367     *
26368     * @warning Ctxpopup can't hold both a item list and a content at the same
26369     * time. When a content is set, any previous items will be removed.
26370     */
26371    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26372    /**
26373     * @brief Unset the ctxpopup content
26374     *
26375     * @param obj Ctxpopup object
26376     * @return The content that was being used
26377     *
26378     * Unparent and return the content object which was set for this widget.
26379     *
26380     * @deprecated use elm_object_content_unset()
26381     *
26382     * @see elm_ctxpopup_content_set()
26383     */
26384    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26385    /**
26386     * @brief Set the direction priority of a ctxpopup.
26387     *
26388     * @param obj Ctxpopup object
26389     * @param first 1st priority of direction
26390     * @param second 2nd priority of direction
26391     * @param third 3th priority of direction
26392     * @param fourth 4th priority of direction
26393     *
26394     * This functions gives a chance to user to set the priority of ctxpopup
26395     * showing direction. This doesn't guarantee the ctxpopup will appear in the
26396     * requested direction.
26397     *
26398     * @see Elm_Ctxpopup_Direction
26399     */
26400    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);
26401    /**
26402     * @brief Get the direction priority of a ctxpopup.
26403     *
26404     * @param obj Ctxpopup object
26405     * @param first 1st priority of direction to be returned
26406     * @param second 2nd priority of direction to be returned
26407     * @param third 3th priority of direction to be returned
26408     * @param fourth 4th priority of direction to be returned
26409     *
26410     * @see elm_ctxpopup_direction_priority_set() for more information.
26411     */
26412    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);
26413
26414    /**
26415     * @brief Get the current direction of a ctxpopup.
26416     *
26417     * @param obj Ctxpopup object
26418     * @return current direction of a ctxpopup
26419     *
26420     * @warning Once the ctxpopup showed up, the direction would be determined
26421     */
26422    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26423
26424    /**
26425     * @}
26426     */
26427
26428    /* transit */
26429    /**
26430     *
26431     * @defgroup Transit Transit
26432     * @ingroup Elementary
26433     *
26434     * Transit is designed to apply various animated transition effects to @c
26435     * Evas_Object, such like translation, rotation, etc. For using these
26436     * effects, create an @ref Elm_Transit and add the desired transition effects.
26437     *
26438     * Once the effects are added into transit, they will be automatically
26439     * managed (their callback will be called until the duration is ended, and
26440     * they will be deleted on completion).
26441     *
26442     * Example:
26443     * @code
26444     * Elm_Transit *trans = elm_transit_add();
26445     * elm_transit_object_add(trans, obj);
26446     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26447     * elm_transit_duration_set(transit, 1);
26448     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26449     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26450     * elm_transit_repeat_times_set(transit, 3);
26451     * @endcode
26452     *
26453     * Some transition effects are used to change the properties of objects. They
26454     * are:
26455     * @li @ref elm_transit_effect_translation_add
26456     * @li @ref elm_transit_effect_color_add
26457     * @li @ref elm_transit_effect_rotation_add
26458     * @li @ref elm_transit_effect_wipe_add
26459     * @li @ref elm_transit_effect_zoom_add
26460     * @li @ref elm_transit_effect_resizing_add
26461     *
26462     * Other transition effects are used to make one object disappear and another
26463     * object appear on its old place. These effects are:
26464     *
26465     * @li @ref elm_transit_effect_flip_add
26466     * @li @ref elm_transit_effect_resizable_flip_add
26467     * @li @ref elm_transit_effect_fade_add
26468     * @li @ref elm_transit_effect_blend_add
26469     *
26470     * It's also possible to make a transition chain with @ref
26471     * elm_transit_chain_transit_add.
26472     *
26473     * @warning We strongly recommend to use elm_transit just when edje can not do
26474     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26475     * animations can be manipulated inside the theme.
26476     *
26477     * List of examples:
26478     * @li @ref transit_example_01_explained
26479     * @li @ref transit_example_02_explained
26480     * @li @ref transit_example_03_c
26481     * @li @ref transit_example_04_c
26482     *
26483     * @{
26484     */
26485
26486    /**
26487     * @enum Elm_Transit_Tween_Mode
26488     *
26489     * The type of acceleration used in the transition.
26490     */
26491    typedef enum
26492      {
26493         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26494         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26495                                              over time, then decrease again
26496                                              and stop slowly */
26497         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26498                                              speed over time */
26499         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26500                                             over time */
26501      } Elm_Transit_Tween_Mode;
26502
26503    /**
26504     * @enum Elm_Transit_Effect_Flip_Axis
26505     *
26506     * The axis where flip effect should be applied.
26507     */
26508    typedef enum
26509      {
26510         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26511         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26512      } Elm_Transit_Effect_Flip_Axis;
26513    /**
26514     * @enum Elm_Transit_Effect_Wipe_Dir
26515     *
26516     * The direction where the wipe effect should occur.
26517     */
26518    typedef enum
26519      {
26520         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26521         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26522         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26523         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26524      } Elm_Transit_Effect_Wipe_Dir;
26525    /** @enum Elm_Transit_Effect_Wipe_Type
26526     *
26527     * Whether the wipe effect should show or hide the object.
26528     */
26529    typedef enum
26530      {
26531         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26532                                              animation */
26533         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26534                                             animation */
26535      } Elm_Transit_Effect_Wipe_Type;
26536
26537    /**
26538     * @typedef Elm_Transit
26539     *
26540     * The Transit created with elm_transit_add(). This type has the information
26541     * about the objects which the transition will be applied, and the
26542     * transition effects that will be used. It also contains info about
26543     * duration, number of repetitions, auto-reverse, etc.
26544     */
26545    typedef struct _Elm_Transit Elm_Transit;
26546    typedef void Elm_Transit_Effect;
26547    /**
26548     * @typedef Elm_Transit_Effect_Transition_Cb
26549     *
26550     * Transition callback called for this effect on each transition iteration.
26551     */
26552    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26553    /**
26554     * Elm_Transit_Effect_End_Cb
26555     *
26556     * Transition callback called for this effect when the transition is over.
26557     */
26558    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26559
26560    /**
26561     * Elm_Transit_Del_Cb
26562     *
26563     * A callback called when the transit is deleted.
26564     */
26565    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26566
26567    /**
26568     * Add new transit.
26569     *
26570     * @note Is not necessary to delete the transit object, it will be deleted at
26571     * the end of its operation.
26572     * @note The transit will start playing when the program enter in the main loop, is not
26573     * necessary to give a start to the transit.
26574     *
26575     * @return The transit object.
26576     *
26577     * @ingroup Transit
26578     */
26579    EAPI Elm_Transit                *elm_transit_add(void);
26580
26581    /**
26582     * Stops the animation and delete the @p transit object.
26583     *
26584     * Call this function if you wants to stop the animation before the duration
26585     * time. Make sure the @p transit object is still alive with
26586     * elm_transit_del_cb_set() function.
26587     * All added effects will be deleted, calling its repective data_free_cb
26588     * functions. The function setted by elm_transit_del_cb_set() will be called.
26589     *
26590     * @see elm_transit_del_cb_set()
26591     *
26592     * @param transit The transit object to be deleted.
26593     *
26594     * @ingroup Transit
26595     * @warning Just call this function if you are sure the transit is alive.
26596     */
26597    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26598
26599    /**
26600     * Add a new effect to the transit.
26601     *
26602     * @note The cb function and the data are the key to the effect. If you try to
26603     * add an already added effect, nothing is done.
26604     * @note After the first addition of an effect in @p transit, if its
26605     * effect list become empty again, the @p transit will be killed by
26606     * elm_transit_del(transit) function.
26607     *
26608     * Exemple:
26609     * @code
26610     * Elm_Transit *transit = elm_transit_add();
26611     * elm_transit_effect_add(transit,
26612     *                        elm_transit_effect_blend_op,
26613     *                        elm_transit_effect_blend_context_new(),
26614     *                        elm_transit_effect_blend_context_free);
26615     * @endcode
26616     *
26617     * @param transit The transit object.
26618     * @param transition_cb The operation function. It is called when the
26619     * animation begins, it is the function that actually performs the animation.
26620     * It is called with the @p data, @p transit and the time progression of the
26621     * animation (a double value between 0.0 and 1.0).
26622     * @param effect The context data of the effect.
26623     * @param end_cb The function to free the context data, it will be called
26624     * at the end of the effect, it must finalize the animation and free the
26625     * @p data.
26626     *
26627     * @ingroup Transit
26628     * @warning The transit free the context data at the and of the transition with
26629     * the data_free_cb function, do not use the context data in another transit.
26630     */
26631    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);
26632
26633    /**
26634     * Delete an added effect.
26635     *
26636     * This function will remove the effect from the @p transit, calling the
26637     * data_free_cb to free the @p data.
26638     *
26639     * @see elm_transit_effect_add()
26640     *
26641     * @note If the effect is not found, nothing is done.
26642     * @note If the effect list become empty, this function will call
26643     * elm_transit_del(transit), that is, it will kill the @p transit.
26644     *
26645     * @param transit The transit object.
26646     * @param transition_cb The operation function.
26647     * @param effect The context data of the effect.
26648     *
26649     * @ingroup Transit
26650     */
26651    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);
26652
26653    /**
26654     * Add new object to apply the effects.
26655     *
26656     * @note After the first addition of an object in @p transit, if its
26657     * object list become empty again, the @p transit will be killed by
26658     * elm_transit_del(transit) function.
26659     * @note If the @p obj belongs to another transit, the @p obj will be
26660     * removed from it and it will only belong to the @p transit. If the old
26661     * transit stays without objects, it will die.
26662     * @note When you add an object into the @p transit, its state from
26663     * evas_object_pass_events_get(obj) is saved, and it is applied when the
26664     * transit ends, if you change this state whith evas_object_pass_events_set()
26665     * after add the object, this state will change again when @p transit stops to
26666     * run.
26667     *
26668     * @param transit The transit object.
26669     * @param obj Object to be animated.
26670     *
26671     * @ingroup Transit
26672     * @warning It is not allowed to add a new object after transit begins to go.
26673     */
26674    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26675
26676    /**
26677     * Removes an added object from the transit.
26678     *
26679     * @note If the @p obj is not in the @p transit, nothing is done.
26680     * @note If the list become empty, this function will call
26681     * elm_transit_del(transit), that is, it will kill the @p transit.
26682     *
26683     * @param transit The transit object.
26684     * @param obj Object to be removed from @p transit.
26685     *
26686     * @ingroup Transit
26687     * @warning It is not allowed to remove objects after transit begins to go.
26688     */
26689    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26690
26691    /**
26692     * Get the objects of the transit.
26693     *
26694     * @param transit The transit object.
26695     * @return a Eina_List with the objects from the transit.
26696     *
26697     * @ingroup Transit
26698     */
26699    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26700
26701    /**
26702     * Enable/disable keeping up the objects states.
26703     * If it is not kept, the objects states will be reset when transition ends.
26704     *
26705     * @note @p transit can not be NULL.
26706     * @note One state includes geometry, color, map data.
26707     *
26708     * @param transit The transit object.
26709     * @param state_keep Keeping or Non Keeping.
26710     *
26711     * @ingroup Transit
26712     */
26713    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26714
26715    /**
26716     * Get a value whether the objects states will be reset or not.
26717     *
26718     * @note @p transit can not be NULL
26719     *
26720     * @see elm_transit_objects_final_state_keep_set()
26721     *
26722     * @param transit The transit object.
26723     * @return EINA_TRUE means the states of the objects will be reset.
26724     * If @p transit is NULL, EINA_FALSE is returned
26725     *
26726     * @ingroup Transit
26727     */
26728    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26729
26730    /**
26731     * Set the event enabled when transit is operating.
26732     *
26733     * If @p enabled is EINA_TRUE, the objects of the transit will receives
26734     * events from mouse and keyboard during the animation.
26735     * @note When you add an object with elm_transit_object_add(), its state from
26736     * evas_object_pass_events_get(obj) is saved, and it is applied when the
26737     * transit ends, if you change this state with evas_object_pass_events_set()
26738     * after adding the object, this state will change again when @p transit stops
26739     * to run.
26740     *
26741     * @param transit The transit object.
26742     * @param enabled Events are received when enabled is @c EINA_TRUE, and
26743     * ignored otherwise.
26744     *
26745     * @ingroup Transit
26746     */
26747    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26748
26749    /**
26750     * Get the value of event enabled status.
26751     *
26752     * @see elm_transit_event_enabled_set()
26753     *
26754     * @param transit The Transit object
26755     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26756     * EINA_FALSE is returned
26757     *
26758     * @ingroup Transit
26759     */
26760    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26761
26762    /**
26763     * Set the user-callback function when the transit is deleted.
26764     *
26765     * @note Using this function twice will overwrite the first function setted.
26766     * @note the @p transit object will be deleted after call @p cb function.
26767     *
26768     * @param transit The transit object.
26769     * @param cb Callback function pointer. This function will be called before
26770     * the deletion of the transit.
26771     * @param data Callback funtion user data. It is the @p op parameter.
26772     *
26773     * @ingroup Transit
26774     */
26775    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26776
26777    /**
26778     * Set reverse effect automatically.
26779     *
26780     * If auto reverse is setted, after running the effects with the progress
26781     * parameter from 0 to 1, it will call the effecs again with the progress
26782     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26783     * where the duration was setted with the function elm_transit_add and
26784     * the repeat with the function elm_transit_repeat_times_set().
26785     *
26786     * @param transit The transit object.
26787     * @param reverse EINA_TRUE means the auto_reverse is on.
26788     *
26789     * @ingroup Transit
26790     */
26791    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26792
26793    /**
26794     * Get if the auto reverse is on.
26795     *
26796     * @see elm_transit_auto_reverse_set()
26797     *
26798     * @param transit The transit object.
26799     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
26800     * EINA_FALSE is returned
26801     *
26802     * @ingroup Transit
26803     */
26804    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26805
26806    /**
26807     * Set the transit repeat count. Effect will be repeated by repeat count.
26808     *
26809     * This function sets the number of repetition the transit will run after
26810     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
26811     * If the @p repeat is a negative number, it will repeat infinite times.
26812     *
26813     * @note If this function is called during the transit execution, the transit
26814     * will run @p repeat times, ignoring the times it already performed.
26815     *
26816     * @param transit The transit object
26817     * @param repeat Repeat count
26818     *
26819     * @ingroup Transit
26820     */
26821    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
26822
26823    /**
26824     * Get the transit repeat count.
26825     *
26826     * @see elm_transit_repeat_times_set()
26827     *
26828     * @param transit The Transit object.
26829     * @return The repeat count. If @p transit is NULL
26830     * 0 is returned
26831     *
26832     * @ingroup Transit
26833     */
26834    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26835
26836    /**
26837     * Set the transit animation acceleration type.
26838     *
26839     * This function sets the tween mode of the transit that can be:
26840     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
26841     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
26842     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
26843     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
26844     *
26845     * @param transit The transit object.
26846     * @param tween_mode The tween type.
26847     *
26848     * @ingroup Transit
26849     */
26850    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
26851
26852    /**
26853     * Get the transit animation acceleration type.
26854     *
26855     * @note @p transit can not be NULL
26856     *
26857     * @param transit The transit object.
26858     * @return The tween type. If @p transit is NULL
26859     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
26860     *
26861     * @ingroup Transit
26862     */
26863    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26864
26865    /**
26866     * Set the transit animation time
26867     *
26868     * @note @p transit can not be NULL
26869     *
26870     * @param transit The transit object.
26871     * @param duration The animation time.
26872     *
26873     * @ingroup Transit
26874     */
26875    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
26876
26877    /**
26878     * Get the transit animation time
26879     *
26880     * @note @p transit can not be NULL
26881     *
26882     * @param transit The transit object.
26883     *
26884     * @return The transit animation time.
26885     *
26886     * @ingroup Transit
26887     */
26888    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26889
26890    /**
26891     * Starts the transition.
26892     * Once this API is called, the transit begins to measure the time.
26893     *
26894     * @note @p transit can not be NULL
26895     *
26896     * @param transit The transit object.
26897     *
26898     * @ingroup Transit
26899     */
26900    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26901
26902    /**
26903     * Pause/Resume the transition.
26904     *
26905     * If you call elm_transit_go again, the transit will be started from the
26906     * beginning, and will be unpaused.
26907     *
26908     * @note @p transit can not be NULL
26909     *
26910     * @param transit The transit object.
26911     * @param paused Whether the transition should be paused or not.
26912     *
26913     * @ingroup Transit
26914     */
26915    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
26916
26917    /**
26918     * Get the value of paused status.
26919     *
26920     * @see elm_transit_paused_set()
26921     *
26922     * @note @p transit can not be NULL
26923     *
26924     * @param transit The transit object.
26925     * @return EINA_TRUE means transition is paused. If @p transit is NULL
26926     * EINA_FALSE is returned
26927     *
26928     * @ingroup Transit
26929     */
26930    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26931
26932    /**
26933     * Get the time progression of the animation (a double value between 0.0 and 1.0).
26934     *
26935     * The value returned is a fraction (current time / total time). It
26936     * represents the progression position relative to the total.
26937     *
26938     * @note @p transit can not be NULL
26939     *
26940     * @param transit The transit object.
26941     *
26942     * @return The time progression value. If @p transit is NULL
26943     * 0 is returned
26944     *
26945     * @ingroup Transit
26946     */
26947    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26948
26949    /**
26950     * Makes the chain relationship between two transits.
26951     *
26952     * @note @p transit can not be NULL. Transit would have multiple chain transits.
26953     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
26954     *
26955     * @param transit The transit object.
26956     * @param chain_transit The chain transit object. This transit will be operated
26957     *        after transit is done.
26958     *
26959     * This function adds @p chain_transit transition to a chain after the @p
26960     * transit, and will be started as soon as @p transit ends. See @ref
26961     * transit_example_02_explained for a full example.
26962     *
26963     * @ingroup Transit
26964     */
26965    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
26966
26967    /**
26968     * Cut off the chain relationship between two transits.
26969     *
26970     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
26971     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
26972     *
26973     * @param transit The transit object.
26974     * @param chain_transit The chain transit object.
26975     *
26976     * This function remove the @p chain_transit transition from the @p transit.
26977     *
26978     * @ingroup Transit
26979     */
26980    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
26981
26982    /**
26983     * Get the current chain transit list.
26984     *
26985     * @note @p transit can not be NULL.
26986     *
26987     * @param transit The transit object.
26988     * @return chain transit list.
26989     *
26990     * @ingroup Transit
26991     */
26992    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
26993
26994    /**
26995     * Add the Resizing Effect to Elm_Transit.
26996     *
26997     * @note This API is one of the facades. It creates resizing effect context
26998     * and add it's required APIs to elm_transit_effect_add.
26999     *
27000     * @see elm_transit_effect_add()
27001     *
27002     * @param transit Transit object.
27003     * @param from_w Object width size when effect begins.
27004     * @param from_h Object height size when effect begins.
27005     * @param to_w Object width size when effect ends.
27006     * @param to_h Object height size when effect ends.
27007     * @return Resizing effect context data.
27008     *
27009     * @ingroup Transit
27010     */
27011    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);
27012
27013    /**
27014     * Add the Translation Effect to Elm_Transit.
27015     *
27016     * @note This API is one of the facades. It creates translation effect context
27017     * and add it's required APIs to elm_transit_effect_add.
27018     *
27019     * @see elm_transit_effect_add()
27020     *
27021     * @param transit Transit object.
27022     * @param from_dx X Position variation when effect begins.
27023     * @param from_dy Y Position variation when effect begins.
27024     * @param to_dx X Position variation when effect ends.
27025     * @param to_dy Y Position variation when effect ends.
27026     * @return Translation effect context data.
27027     *
27028     * @ingroup Transit
27029     * @warning It is highly recommended just create a transit with this effect when
27030     * the window that the objects of the transit belongs has already been created.
27031     * This is because this effect needs the geometry information about the objects,
27032     * and if the window was not created yet, it can get a wrong information.
27033     */
27034    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);
27035
27036    /**
27037     * Add the Zoom Effect to Elm_Transit.
27038     *
27039     * @note This API is one of the facades. It creates zoom effect context
27040     * and add it's required APIs to elm_transit_effect_add.
27041     *
27042     * @see elm_transit_effect_add()
27043     *
27044     * @param transit Transit object.
27045     * @param from_rate Scale rate when effect begins (1 is current rate).
27046     * @param to_rate Scale rate when effect ends.
27047     * @return Zoom effect context data.
27048     *
27049     * @ingroup Transit
27050     * @warning It is highly recommended just create a transit with this effect when
27051     * the window that the objects of the transit belongs has already been created.
27052     * This is because this effect needs the geometry information about the objects,
27053     * and if the window was not created yet, it can get a wrong information.
27054     */
27055    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27056
27057    /**
27058     * Add the Flip Effect to Elm_Transit.
27059     *
27060     * @note This API is one of the facades. It creates flip effect context
27061     * and add it's required APIs to elm_transit_effect_add.
27062     * @note This effect is applied to each pair of objects in the order they are listed
27063     * in the transit list of objects. The first object in the pair will be the
27064     * "front" object and the second will be the "back" object.
27065     *
27066     * @see elm_transit_effect_add()
27067     *
27068     * @param transit Transit object.
27069     * @param axis Flipping Axis(X or Y).
27070     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27071     * @return Flip effect context data.
27072     *
27073     * @ingroup Transit
27074     * @warning It is highly recommended just create a transit with this effect when
27075     * the window that the objects of the transit belongs has already been created.
27076     * This is because this effect needs the geometry information about the objects,
27077     * and if the window was not created yet, it can get a wrong information.
27078     */
27079    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27080
27081    /**
27082     * Add the Resizable Flip Effect to Elm_Transit.
27083     *
27084     * @note This API is one of the facades. It creates resizable flip effect context
27085     * and add it's required APIs to elm_transit_effect_add.
27086     * @note This effect is applied to each pair of objects in the order they are listed
27087     * in the transit list of objects. The first object in the pair will be the
27088     * "front" object and the second will be the "back" object.
27089     *
27090     * @see elm_transit_effect_add()
27091     *
27092     * @param transit Transit object.
27093     * @param axis Flipping Axis(X or Y).
27094     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27095     * @return Resizable flip effect context data.
27096     *
27097     * @ingroup Transit
27098     * @warning It is highly recommended just create a transit with this effect when
27099     * the window that the objects of the transit belongs has already been created.
27100     * This is because this effect needs the geometry information about the objects,
27101     * and if the window was not created yet, it can get a wrong information.
27102     */
27103    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27104
27105    /**
27106     * Add the Wipe Effect to Elm_Transit.
27107     *
27108     * @note This API is one of the facades. It creates wipe effect context
27109     * and add it's required APIs to elm_transit_effect_add.
27110     *
27111     * @see elm_transit_effect_add()
27112     *
27113     * @param transit Transit object.
27114     * @param type Wipe type. Hide or show.
27115     * @param dir Wipe Direction.
27116     * @return Wipe effect context data.
27117     *
27118     * @ingroup Transit
27119     * @warning It is highly recommended just create a transit with this effect when
27120     * the window that the objects of the transit belongs has already been created.
27121     * This is because this effect needs the geometry information about the objects,
27122     * and if the window was not created yet, it can get a wrong information.
27123     */
27124    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27125
27126    /**
27127     * Add the Color Effect to Elm_Transit.
27128     *
27129     * @note This API is one of the facades. It creates color effect context
27130     * and add it's required APIs to elm_transit_effect_add.
27131     *
27132     * @see elm_transit_effect_add()
27133     *
27134     * @param transit        Transit object.
27135     * @param  from_r        RGB R when effect begins.
27136     * @param  from_g        RGB G when effect begins.
27137     * @param  from_b        RGB B when effect begins.
27138     * @param  from_a        RGB A when effect begins.
27139     * @param  to_r          RGB R when effect ends.
27140     * @param  to_g          RGB G when effect ends.
27141     * @param  to_b          RGB B when effect ends.
27142     * @param  to_a          RGB A when effect ends.
27143     * @return               Color effect context data.
27144     *
27145     * @ingroup Transit
27146     */
27147    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);
27148
27149    /**
27150     * Add the Fade Effect to Elm_Transit.
27151     *
27152     * @note This API is one of the facades. It creates fade effect context
27153     * and add it's required APIs to elm_transit_effect_add.
27154     * @note This effect is applied to each pair of objects in the order they are listed
27155     * in the transit list of objects. The first object in the pair will be the
27156     * "before" object and the second will be the "after" object.
27157     *
27158     * @see elm_transit_effect_add()
27159     *
27160     * @param transit Transit object.
27161     * @return Fade effect context data.
27162     *
27163     * @ingroup Transit
27164     * @warning It is highly recommended just create a transit with this effect when
27165     * the window that the objects of the transit belongs has already been created.
27166     * This is because this effect needs the color information about the objects,
27167     * and if the window was not created yet, it can get a wrong information.
27168     */
27169    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27170
27171    /**
27172     * Add the Blend Effect to Elm_Transit.
27173     *
27174     * @note This API is one of the facades. It creates blend effect context
27175     * and add it's required APIs to elm_transit_effect_add.
27176     * @note This effect is applied to each pair of objects in the order they are listed
27177     * in the transit list of objects. The first object in the pair will be the
27178     * "before" object and the second will be the "after" object.
27179     *
27180     * @see elm_transit_effect_add()
27181     *
27182     * @param transit Transit object.
27183     * @return Blend effect context data.
27184     *
27185     * @ingroup Transit
27186     * @warning It is highly recommended just create a transit with this effect when
27187     * the window that the objects of the transit belongs has already been created.
27188     * This is because this effect needs the color information about the objects,
27189     * and if the window was not created yet, it can get a wrong information.
27190     */
27191    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27192
27193    /**
27194     * Add the Rotation Effect to Elm_Transit.
27195     *
27196     * @note This API is one of the facades. It creates rotation effect context
27197     * and add it's required APIs to elm_transit_effect_add.
27198     *
27199     * @see elm_transit_effect_add()
27200     *
27201     * @param transit Transit object.
27202     * @param from_degree Degree when effect begins.
27203     * @param to_degree Degree when effect is ends.
27204     * @return Rotation effect context data.
27205     *
27206     * @ingroup Transit
27207     * @warning It is highly recommended just create a transit with this effect when
27208     * the window that the objects of the transit belongs has already been created.
27209     * This is because this effect needs the geometry information about the objects,
27210     * and if the window was not created yet, it can get a wrong information.
27211     */
27212    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27213
27214    /**
27215     * Add the ImageAnimation Effect to Elm_Transit.
27216     *
27217     * @note This API is one of the facades. It creates image animation effect context
27218     * and add it's required APIs to elm_transit_effect_add.
27219     * The @p images parameter is a list images paths. This list and
27220     * its contents will be deleted at the end of the effect by
27221     * elm_transit_effect_image_animation_context_free() function.
27222     *
27223     * Example:
27224     * @code
27225     * char buf[PATH_MAX];
27226     * Eina_List *images = NULL;
27227     * Elm_Transit *transi = elm_transit_add();
27228     *
27229     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27230     * images = eina_list_append(images, eina_stringshare_add(buf));
27231     *
27232     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27233     * images = eina_list_append(images, eina_stringshare_add(buf));
27234     * elm_transit_effect_image_animation_add(transi, images);
27235     *
27236     * @endcode
27237     *
27238     * @see elm_transit_effect_add()
27239     *
27240     * @param transit Transit object.
27241     * @param images Eina_List of images file paths. This list and
27242     * its contents will be deleted at the end of the effect by
27243     * elm_transit_effect_image_animation_context_free() function.
27244     * @return Image Animation effect context data.
27245     *
27246     * @ingroup Transit
27247     */
27248    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27249    /**
27250     * @}
27251     */
27252
27253    typedef struct _Elm_Store                      Elm_Store;
27254    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
27255    typedef struct _Elm_Store_Item                 Elm_Store_Item;
27256    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
27257    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
27258    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27259    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
27260    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
27261    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
27262    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
27263    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
27264
27265    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27266    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27267    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27268    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27269
27270    typedef enum
27271      {
27272         ELM_STORE_ITEM_MAPPING_NONE = 0,
27273         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27274         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27275         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27276         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27277         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27278         // can add more here as needed by common apps
27279         ELM_STORE_ITEM_MAPPING_LAST
27280      } Elm_Store_Item_Mapping_Type;
27281
27282    struct _Elm_Store_Item_Mapping_Icon
27283      {
27284         // FIXME: allow edje file icons
27285         int                   w, h;
27286         Elm_Icon_Lookup_Order lookup_order;
27287         Eina_Bool             standard_name : 1;
27288         Eina_Bool             no_scale : 1;
27289         Eina_Bool             smooth : 1;
27290         Eina_Bool             scale_up : 1;
27291         Eina_Bool             scale_down : 1;
27292      };
27293
27294    struct _Elm_Store_Item_Mapping_Empty
27295      {
27296         Eina_Bool             dummy;
27297      };
27298
27299    struct _Elm_Store_Item_Mapping_Photo
27300      {
27301         int                   size;
27302      };
27303
27304    struct _Elm_Store_Item_Mapping_Custom
27305      {
27306         Elm_Store_Item_Mapping_Cb func;
27307      };
27308
27309    struct _Elm_Store_Item_Mapping
27310      {
27311         Elm_Store_Item_Mapping_Type     type;
27312         const char                     *part;
27313         int                             offset;
27314         union
27315           {
27316              Elm_Store_Item_Mapping_Empty  empty;
27317              Elm_Store_Item_Mapping_Icon   icon;
27318              Elm_Store_Item_Mapping_Photo  photo;
27319              Elm_Store_Item_Mapping_Custom custom;
27320              // add more types here
27321           } details;
27322      };
27323
27324    struct _Elm_Store_Item_Info
27325      {
27326         Elm_Genlist_Item_Class       *item_class;
27327         const Elm_Store_Item_Mapping *mapping;
27328         void                         *data;
27329         char                         *sort_id;
27330      };
27331
27332    struct _Elm_Store_Item_Info_Filesystem
27333      {
27334         Elm_Store_Item_Info  base;
27335         char                *path;
27336      };
27337
27338 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27339 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27340
27341    EAPI void                    elm_store_free(Elm_Store *st);
27342
27343    EAPI Elm_Store              *elm_store_filesystem_new(void);
27344    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27345    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27346    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27347
27348    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27349
27350    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27351    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27352    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27353    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27354    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27355    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27356
27357    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27358    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27359    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27360    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27361    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27362    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27363    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27364
27365    /**
27366     * @defgroup SegmentControl SegmentControl
27367     * @ingroup Elementary
27368     *
27369     * @image html img/widget/segment_control/preview-00.png
27370     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27371     *
27372     * @image html img/segment_control.png
27373     * @image latex img/segment_control.eps width=\textwidth
27374     *
27375     * Segment control widget is a horizontal control made of multiple segment
27376     * items, each segment item functioning similar to discrete two state button.
27377     * A segment control groups the items together and provides compact
27378     * single button with multiple equal size segments.
27379     *
27380     * Segment item size is determined by base widget
27381     * size and the number of items added.
27382     * Only one segment item can be at selected state. A segment item can display
27383     * combination of Text and any Evas_Object like Images or other widget.
27384     *
27385     * Smart callbacks one can listen to:
27386     * - "changed" - When the user clicks on a segment item which is not
27387     *   previously selected and get selected. The event_info parameter is the
27388     *   segment item index.
27389     *
27390     * Available styles for it:
27391     * - @c "default"
27392     *
27393     * Here is an example on its usage:
27394     * @li @ref segment_control_example
27395     */
27396
27397    /**
27398     * @addtogroup SegmentControl
27399     * @{
27400     */
27401
27402    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27403
27404    /**
27405     * Add a new segment control widget to the given parent Elementary
27406     * (container) object.
27407     *
27408     * @param parent The parent object.
27409     * @return a new segment control widget handle or @c NULL, on errors.
27410     *
27411     * This function inserts a new segment control widget on the canvas.
27412     *
27413     * @ingroup SegmentControl
27414     */
27415    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27416
27417    /**
27418     * Append a new item to the segment control object.
27419     *
27420     * @param obj The segment control object.
27421     * @param icon The icon object to use for the left side of the item. An
27422     * icon can be any Evas object, but usually it is an icon created
27423     * with elm_icon_add().
27424     * @param label The label of the item.
27425     *        Note that, NULL is different from empty string "".
27426     * @return The created item or @c NULL upon failure.
27427     *
27428     * A new item will be created and appended to the segment control, i.e., will
27429     * be set as @b last item.
27430     *
27431     * If it should be inserted at another position,
27432     * elm_segment_control_item_insert_at() should be used instead.
27433     *
27434     * Items created with this function can be deleted with function
27435     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27436     *
27437     * @note @p label set to @c NULL is different from empty string "".
27438     * If an item
27439     * only has icon, it will be displayed bigger and centered. If it has
27440     * icon and label, even that an empty string, icon will be smaller and
27441     * positioned at left.
27442     *
27443     * Simple example:
27444     * @code
27445     * sc = elm_segment_control_add(win);
27446     * ic = elm_icon_add(win);
27447     * elm_icon_file_set(ic, "path/to/image", NULL);
27448     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27449     * elm_segment_control_item_add(sc, ic, "label");
27450     * evas_object_show(sc);
27451     * @endcode
27452     *
27453     * @see elm_segment_control_item_insert_at()
27454     * @see elm_segment_control_item_del()
27455     *
27456     * @ingroup SegmentControl
27457     */
27458    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27459
27460    /**
27461     * Insert a new item to the segment control object at specified position.
27462     *
27463     * @param obj The segment control object.
27464     * @param icon The icon object to use for the left side of the item. An
27465     * icon can be any Evas object, but usually it is an icon created
27466     * with elm_icon_add().
27467     * @param label The label of the item.
27468     * @param index Item position. Value should be between 0 and items count.
27469     * @return The created item or @c NULL upon failure.
27470
27471     * Index values must be between @c 0, when item will be prepended to
27472     * segment control, and items count, that can be get with
27473     * elm_segment_control_item_count_get(), case when item will be appended
27474     * to segment control, just like elm_segment_control_item_add().
27475     *
27476     * Items created with this function can be deleted with function
27477     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27478     *
27479     * @note @p label set to @c NULL is different from empty string "".
27480     * If an item
27481     * only has icon, it will be displayed bigger and centered. If it has
27482     * icon and label, even that an empty string, icon will be smaller and
27483     * positioned at left.
27484     *
27485     * @see elm_segment_control_item_add()
27486     * @see elm_segment_control_item_count_get()
27487     * @see elm_segment_control_item_del()
27488     *
27489     * @ingroup SegmentControl
27490     */
27491    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);
27492
27493    /**
27494     * Remove a segment control item from its parent, deleting it.
27495     *
27496     * @param it The item to be removed.
27497     *
27498     * Items can be added with elm_segment_control_item_add() or
27499     * elm_segment_control_item_insert_at().
27500     *
27501     * @ingroup SegmentControl
27502     */
27503    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27504
27505    /**
27506     * Remove a segment control item at given index from its parent,
27507     * deleting it.
27508     *
27509     * @param obj The segment control object.
27510     * @param index The position of the segment control item to be deleted.
27511     *
27512     * Items can be added with elm_segment_control_item_add() or
27513     * elm_segment_control_item_insert_at().
27514     *
27515     * @ingroup SegmentControl
27516     */
27517    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27518
27519    /**
27520     * Get the Segment items count from segment control.
27521     *
27522     * @param obj The segment control object.
27523     * @return Segment items count.
27524     *
27525     * It will just return the number of items added to segment control @p obj.
27526     *
27527     * @ingroup SegmentControl
27528     */
27529    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27530
27531    /**
27532     * Get the item placed at specified index.
27533     *
27534     * @param obj The segment control object.
27535     * @param index The index of the segment item.
27536     * @return The segment control item or @c NULL on failure.
27537     *
27538     * Index is the position of an item in segment control widget. Its
27539     * range is from @c 0 to <tt> count - 1 </tt>.
27540     * Count is the number of items, that can be get with
27541     * elm_segment_control_item_count_get().
27542     *
27543     * @ingroup SegmentControl
27544     */
27545    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27546
27547    /**
27548     * Get the label of item.
27549     *
27550     * @param obj The segment control object.
27551     * @param index The index of the segment item.
27552     * @return The label of the item at @p index.
27553     *
27554     * The return value is a pointer to the label associated to the item when
27555     * it was created, with function elm_segment_control_item_add(), or later
27556     * with function elm_segment_control_item_label_set. If no label
27557     * was passed as argument, it will return @c NULL.
27558     *
27559     * @see elm_segment_control_item_label_set() for more details.
27560     * @see elm_segment_control_item_add()
27561     *
27562     * @ingroup SegmentControl
27563     */
27564    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27565
27566    /**
27567     * Set the label of item.
27568     *
27569     * @param it The item of segment control.
27570     * @param text The label of item.
27571     *
27572     * The label to be displayed by the item.
27573     * Label will be at right of the icon (if set).
27574     *
27575     * If a label was passed as argument on item creation, with function
27576     * elm_control_segment_item_add(), it will be already
27577     * displayed by the item.
27578     *
27579     * @see elm_segment_control_item_label_get()
27580     * @see elm_segment_control_item_add()
27581     *
27582     * @ingroup SegmentControl
27583     */
27584    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27585
27586    /**
27587     * Get the icon associated to the item.
27588     *
27589     * @param obj The segment control object.
27590     * @param index The index of the segment item.
27591     * @return The left side icon associated to the item at @p index.
27592     *
27593     * The return value is a pointer to the icon associated to the item when
27594     * it was created, with function elm_segment_control_item_add(), or later
27595     * with function elm_segment_control_item_icon_set(). If no icon
27596     * was passed as argument, it will return @c NULL.
27597     *
27598     * @see elm_segment_control_item_add()
27599     * @see elm_segment_control_item_icon_set()
27600     *
27601     * @ingroup SegmentControl
27602     */
27603    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27604
27605    /**
27606     * Set the icon associated to the item.
27607     *
27608     * @param it The segment control item.
27609     * @param icon The icon object to associate with @p it.
27610     *
27611     * The icon object to use at left side of the item. An
27612     * icon can be any Evas object, but usually it is an icon created
27613     * with elm_icon_add().
27614     *
27615     * Once the icon object is set, a previously set one will be deleted.
27616     * @warning Setting the same icon for two items will cause the icon to
27617     * dissapear from the first item.
27618     *
27619     * If an icon was passed as argument on item creation, with function
27620     * elm_segment_control_item_add(), it will be already
27621     * associated to the item.
27622     *
27623     * @see elm_segment_control_item_add()
27624     * @see elm_segment_control_item_icon_get()
27625     *
27626     * @ingroup SegmentControl
27627     */
27628    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27629
27630    /**
27631     * Get the index of an item.
27632     *
27633     * @param it The segment control item.
27634     * @return The position of item in segment control widget.
27635     *
27636     * Index is the position of an item in segment control widget. Its
27637     * range is from @c 0 to <tt> count - 1 </tt>.
27638     * Count is the number of items, that can be get with
27639     * elm_segment_control_item_count_get().
27640     *
27641     * @ingroup SegmentControl
27642     */
27643    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27644
27645    /**
27646     * Get the base object of the item.
27647     *
27648     * @param it The segment control item.
27649     * @return The base object associated with @p it.
27650     *
27651     * Base object is the @c Evas_Object that represents that item.
27652     *
27653     * @ingroup SegmentControl
27654     */
27655    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27656
27657    /**
27658     * Get the selected item.
27659     *
27660     * @param obj The segment control object.
27661     * @return The selected item or @c NULL if none of segment items is
27662     * selected.
27663     *
27664     * The selected item can be unselected with function
27665     * elm_segment_control_item_selected_set().
27666     *
27667     * The selected item always will be highlighted on segment control.
27668     *
27669     * @ingroup SegmentControl
27670     */
27671    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27672
27673    /**
27674     * Set the selected state of an item.
27675     *
27676     * @param it The segment control item
27677     * @param select The selected state
27678     *
27679     * This sets the selected state of the given item @p it.
27680     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27681     *
27682     * If a new item is selected the previosly selected will be unselected.
27683     * Previoulsy selected item can be get with function
27684     * elm_segment_control_item_selected_get().
27685     *
27686     * The selected item always will be highlighted on segment control.
27687     *
27688     * @see elm_segment_control_item_selected_get()
27689     *
27690     * @ingroup SegmentControl
27691     */
27692    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27693
27694    /**
27695     * @}
27696     */
27697
27698    /**
27699     * @defgroup Grid Grid
27700     *
27701     * The grid is a grid layout widget that lays out a series of children as a
27702     * fixed "grid" of widgets using a given percentage of the grid width and
27703     * height each using the child object.
27704     *
27705     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27706     * widgets size itself. The default is 100 x 100, so that means the
27707     * position and sizes of children will effectively be percentages (0 to 100)
27708     * of the width or height of the grid widget
27709     *
27710     * @{
27711     */
27712
27713    /**
27714     * Add a new grid to the parent
27715     *
27716     * @param parent The parent object
27717     * @return The new object or NULL if it cannot be created
27718     *
27719     * @ingroup Grid
27720     */
27721    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27722
27723    /**
27724     * Set the virtual size of the grid
27725     *
27726     * @param obj The grid object
27727     * @param w The virtual width of the grid
27728     * @param h The virtual height of the grid
27729     *
27730     * @ingroup Grid
27731     */
27732    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
27733
27734    /**
27735     * Get the virtual size of the grid
27736     *
27737     * @param obj The grid object
27738     * @param w Pointer to integer to store the virtual width of the grid
27739     * @param h Pointer to integer to store the virtual height of the grid
27740     *
27741     * @ingroup Grid
27742     */
27743    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27744
27745    /**
27746     * Pack child at given position and size
27747     *
27748     * @param obj The grid object
27749     * @param subobj The child to pack
27750     * @param x The virtual x coord at which to pack it
27751     * @param y The virtual y coord at which to pack it
27752     * @param w The virtual width at which to pack it
27753     * @param h The virtual height at which to pack it
27754     *
27755     * @ingroup Grid
27756     */
27757    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27758
27759    /**
27760     * Unpack a child from a grid object
27761     *
27762     * @param obj The grid object
27763     * @param subobj The child to unpack
27764     *
27765     * @ingroup Grid
27766     */
27767    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27768
27769    /**
27770     * Faster way to remove all child objects from a grid object.
27771     *
27772     * @param obj The grid object
27773     * @param clear If true, it will delete just removed children
27774     *
27775     * @ingroup Grid
27776     */
27777    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
27778
27779    /**
27780     * Set packing of an existing child at to position and size
27781     *
27782     * @param subobj The child to set packing of
27783     * @param x The virtual x coord at which to pack it
27784     * @param y The virtual y coord at which to pack it
27785     * @param w The virtual width at which to pack it
27786     * @param h The virtual height at which to pack it
27787     *
27788     * @ingroup Grid
27789     */
27790    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
27791
27792    /**
27793     * get packing of a child
27794     *
27795     * @param subobj The child to query
27796     * @param x Pointer to integer to store the virtual x coord
27797     * @param y Pointer to integer to store the virtual y coord
27798     * @param w Pointer to integer to store the virtual width
27799     * @param h Pointer to integer to store the virtual height
27800     *
27801     * @ingroup Grid
27802     */
27803    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
27804
27805    /**
27806     * @}
27807     */
27808
27809    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
27810    EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
27811    EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
27812    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
27813    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
27814    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
27815
27816    /**
27817     * @defgroup Video Video
27818     *
27819     * @addtogroup Video
27820     * @{
27821     *
27822     * Elementary comes with two object that help design application that need
27823     * to display video. The main one, Elm_Video, display a video by using Emotion.
27824     * It does embedded the video inside an Edje object, so you can do some
27825     * animation depending on the video state change. It does also implement a
27826     * ressource management policy to remove this burden from the application writer.
27827     *
27828     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
27829     * It take care of updating its content according to Emotion event and provide a
27830     * way to theme itself. It also does automatically raise the priority of the
27831     * linked Elm_Video so it will use the video decoder if available. It also does
27832     * activate the remember function on the linked Elm_Video object.
27833     *
27834     * Signals that you can add callback for are :
27835     *
27836     * "forward,clicked" - the user clicked the forward button.
27837     * "info,clicked" - the user clicked the info button.
27838     * "next,clicked" - the user clicked the next button.
27839     * "pause,clicked" - the user clicked the pause button.
27840     * "play,clicked" - the user clicked the play button.
27841     * "prev,clicked" - the user clicked the prev button.
27842     * "rewind,clicked" - the user clicked the rewind button.
27843     * "stop,clicked" - the user clicked the stop button.
27844     */
27845
27846    /**
27847     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
27848     *
27849     * @param parent The parent object
27850     * @return a new player widget handle or @c NULL, on errors.
27851     *
27852     * This function inserts a new player widget on the canvas.
27853     *
27854     * @see elm_player_video_set()
27855     *
27856     * @ingroup Video
27857     */
27858    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
27859
27860    /**
27861     * @brief Link a Elm_Payer with an Elm_Video object.
27862     *
27863     * @param player the Elm_Player object.
27864     * @param video The Elm_Video object.
27865     *
27866     * This mean that action on the player widget will affect the
27867     * video object and the state of the video will be reflected in
27868     * the player itself.
27869     *
27870     * @see elm_player_add()
27871     * @see elm_video_add()
27872     *
27873     * @ingroup Video
27874     */
27875    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
27876
27877    /**
27878     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
27879     *
27880     * @param parent The parent object
27881     * @return a new video widget handle or @c NULL, on errors.
27882     *
27883     * This function inserts a new video widget on the canvas.
27884     *
27885     * @seeelm_video_file_set()
27886     * @see elm_video_uri_set()
27887     *
27888     * @ingroup Video
27889     */
27890    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
27891
27892    /**
27893     * @brief Define the file that will be the video source.
27894     *
27895     * @param video The video object to define the file for.
27896     * @param filename The file to target.
27897     *
27898     * This function will explicitly define a filename as a source
27899     * for the video of the Elm_Video object.
27900     *
27901     * @see elm_video_uri_set()
27902     * @see elm_video_add()
27903     * @see elm_player_add()
27904     *
27905     * @ingroup Video
27906     */
27907    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
27908
27909    /**
27910     * @brief Define the uri that will be the video source.
27911     *
27912     * @param video The video object to define the file for.
27913     * @param uri The uri to target.
27914     *
27915     * This function will define an uri as a source for the video of the
27916     * Elm_Video object. URI could be remote source of video, like http:// or local source
27917     * like for example WebCam who are most of the time v4l2:// (but that depend and
27918     * you should use Emotion API to request and list the available Webcam on your system).
27919     *
27920     * @see elm_video_file_set()
27921     * @see elm_video_add()
27922     * @see elm_player_add()
27923     *
27924     * @ingroup Video
27925     */
27926    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
27927
27928    /**
27929     * @brief Get the underlying Emotion object.
27930     *
27931     * @param video The video object to proceed the request on.
27932     * @return the underlying Emotion object.
27933     *
27934     * @ingroup Video
27935     */
27936    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
27937
27938    /**
27939     * @brief Start to play the video
27940     *
27941     * @param video The video object to proceed the request on.
27942     *
27943     * Start to play the video and cancel all suspend state.
27944     *
27945     * @ingroup Video
27946     */
27947    EAPI void elm_video_play(Evas_Object *video);
27948
27949    /**
27950     * @brief Pause the video
27951     *
27952     * @param video The video object to proceed the request on.
27953     *
27954     * Pause the video and start a timer to trigger suspend mode.
27955     *
27956     * @ingroup Video
27957     */
27958    EAPI void elm_video_pause(Evas_Object *video);
27959
27960    /**
27961     * @brief Stop the video
27962     *
27963     * @param video The video object to proceed the request on.
27964     *
27965     * Stop the video and put the emotion in deep sleep mode.
27966     *
27967     * @ingroup Video
27968     */
27969    EAPI void elm_video_stop(Evas_Object *video);
27970
27971    /**
27972     * @brief Is the video actually playing.
27973     *
27974     * @param video The video object to proceed the request on.
27975     * @return EINA_TRUE if the video is actually playing.
27976     *
27977     * You should consider watching event on the object instead of polling
27978     * the object state.
27979     *
27980     * @ingroup Video
27981     */
27982    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
27983
27984    /**
27985     * @brief Is it possible to seek inside the video.
27986     *
27987     * @param video The video object to proceed the request on.
27988     * @return EINA_TRUE if is possible to seek inside the video.
27989     *
27990     * @ingroup Video
27991     */
27992    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
27993
27994    /**
27995     * @brief Is the audio muted.
27996     *
27997     * @param video The video object to proceed the request on.
27998     * @return EINA_TRUE if the audio is muted.
27999     *
28000     * @ingroup Video
28001     */
28002    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
28003
28004    /**
28005     * @brief Change the mute state of the Elm_Video object.
28006     *
28007     * @param video The video object to proceed the request on.
28008     * @param mute The new mute state.
28009     *
28010     * @ingroup Video
28011     */
28012    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28013
28014    /**
28015     * @brief Get the audio level of the current video.
28016     *
28017     * @param video The video object to proceed the request on.
28018     * @return the current audio level.
28019     *
28020     * @ingroup Video
28021     */
28022    EAPI double elm_video_audio_level_get(Evas_Object *video);
28023
28024    /**
28025     * @brief Set the audio level of anElm_Video object.
28026     *
28027     * @param video The video object to proceed the request on.
28028     * @param volume The new audio volume.
28029     *
28030     * @ingroup Video
28031     */
28032    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28033
28034    EAPI double elm_video_play_position_get(Evas_Object *video);
28035    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28036    EAPI double elm_video_play_length_get(Evas_Object *video);
28037    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28038    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
28039    EAPI const char *elm_video_title_get(Evas_Object *video);
28040    /**
28041     * @}
28042     */
28043
28044    /**
28045     * @defgroup Naviframe Naviframe
28046     * @ingroup Elementary
28047     *
28048     * @brief Naviframe is a kind of view manager for the applications.
28049     *
28050     * Naviframe provides functions to switch different pages with stack
28051     * mechanism. It means if one page(item) needs to be changed to the new one,
28052     * then naviframe would push the new page to it's internal stack. Of course,
28053     * it can be back to the previous page by popping the top page. Naviframe
28054     * provides some transition effect while the pages are switching (same as
28055     * pager).
28056     *
28057     * Since each item could keep the different styles, users could keep the
28058     * same look & feel for the pages or different styles for the items in it's
28059     * application.
28060     *
28061     * Signals that you can add callback for are:
28062     *
28063     * @li "transition,finished" - When the transition is finished in changing
28064     *     the item
28065     * @li "title,clicked" - User clicked title area
28066     *
28067     * Default contents parts for the naviframe items that you can use for are:
28068     *
28069     * @li "elm.swallow.content" - The main content of the page
28070     * @li "elm.swallow.prev_btn" - The button to go to the previous page
28071     * @li "elm.swallow.next_btn" - The button to go to the next page
28072     *
28073     * Default text parts of naviframe items that you can be used are:
28074     *
28075     * @li "elm.text.title" - The title label in the title area
28076     *
28077     * @ref tutorial_naviframe gives a good overview of the usage of the API.
28078     */
28079
28080    /**
28081     * @addtogroup Naviframe
28082     * @{
28083     */
28084
28085    /**
28086     * @brief Add a new Naviframe object to the parent.
28087     *
28088     * @param parent Parent object
28089     * @return New object or @c NULL, if it cannot be created
28090     *
28091     * @ingroup Naviframe
28092     */
28093    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28094    /**
28095     * @brief Push a new item to the top of the naviframe stack (and show it).
28096     *
28097     * @param obj The naviframe object
28098     * @param title_label The label in the title area. The name of the title
28099     *        label part is "elm.text.title"
28100     * @param prev_btn The button to go to the previous item. If it is NULL,
28101     *        then naviframe will create a back button automatically. The name of
28102     *        the prev_btn part is "elm.swallow.prev_btn"
28103     * @param next_btn The button to go to the next item. Or It could be just an
28104     *        extra function button. The name of the next_btn part is
28105     *        "elm.swallow.next_btn"
28106     * @param content The main content object. The name of content part is
28107     *        "elm.swallow.content"
28108     * @param item_style The current item style name. @c NULL would be default.
28109     * @return The created item or @c NULL upon failure.
28110     *
28111     * The item pushed becomes one page of the naviframe, this item will be
28112     * deleted when it is popped.
28113     *
28114     * @see also elm_naviframe_item_style_set()
28115     *
28116     * The following styles are available for this item:
28117     * @li @c "default"
28118     *
28119     * @ingroup Naviframe
28120     */
28121    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);
28122    /**
28123     * @brief Pop an item that is on top of the stack
28124     *
28125     * @param obj The naviframe object
28126     * @return @c NULL or the content object(if the
28127     *         elm_naviframe_content_preserve_on_pop_get is true).
28128     *
28129     * This pops an item that is on the top(visible) of the naviframe, makes it
28130     * disappear, then deletes the item. The item that was underneath it on the
28131     * stack will become visible.
28132     *
28133     * @see also elm_naviframe_content_preserve_on_pop_get()
28134     *
28135     * @ingroup Naviframe
28136     */
28137    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28138    /**
28139     * @brief Pop the items between the top and the above one on the given item.
28140     *
28141     * @param it The naviframe item
28142     *
28143     * @ingroup Naviframe
28144     */
28145    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28146    /**
28147     * @brief Delete the given item instantly.
28148     *
28149     * @param it The naviframe item
28150     *
28151     * This just deletes the given item from the naviframe item list instantly.
28152     * So this would not emit any signals for view transitions but just change
28153     * the current view if the given item is a top one.
28154     *
28155     * @ingroup Naviframe
28156     */
28157    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28158    /**
28159     * @brief preserve the content objects when items are popped.
28160     *
28161     * @param obj The naviframe object
28162     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28163     *
28164     * @see also elm_naviframe_content_preserve_on_pop_get()
28165     *
28166     * @ingroup Naviframe
28167     */
28168    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28169    /**
28170     * @brief Get a value whether preserve mode is enabled or not.
28171     *
28172     * @param obj The naviframe object
28173     * @return If @c EINA_TRUE, preserve mode is enabled
28174     *
28175     * @see also elm_naviframe_content_preserve_on_pop_set()
28176     *
28177     * @ingroup Naviframe
28178     */
28179    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28180    /**
28181     * @brief Get a top item on the naviframe stack
28182     *
28183     * @param obj The naviframe object
28184     * @return The top item on the naviframe stack or @c NULL, if the stack is
28185     *         empty
28186     *
28187     * @ingroup Naviframe
28188     */
28189    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28190    /**
28191     * @brief Get a bottom item on the naviframe stack
28192     *
28193     * @param obj The naviframe object
28194     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28195     *         empty
28196     *
28197     * @ingroup Naviframe
28198     */
28199    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28200    /**
28201     * @brief Set an item style
28202     *
28203     * @param obj The naviframe item
28204     * @param item_style The current item style name. @c NULL would be default
28205     *
28206     * The following styles are available for this item:
28207     * @li @c "default"
28208     *
28209     * @see also elm_naviframe_item_style_get()
28210     *
28211     * @ingroup Naviframe
28212     */
28213    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28214    /**
28215     * @brief Get an item style
28216     *
28217     * @param obj The naviframe item
28218     * @return The current item style name
28219     *
28220     * @see also elm_naviframe_item_style_set()
28221     *
28222     * @ingroup Naviframe
28223     */
28224    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28225    /**
28226     * @brief Show/Hide the title area
28227     *
28228     * @param it The naviframe item
28229     * @param visible If @c EINA_TRUE, title area will be visible, hidden
28230     *        otherwise
28231     *
28232     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
28233     *
28234     * @see also elm_naviframe_item_title_visible_get()
28235     *
28236     * @ingroup Naviframe
28237     */
28238    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28239    /**
28240     * @brief Get a value whether title area is visible or not.
28241     *
28242     * @param it The naviframe item
28243     * @return If @c EINA_TRUE, title area is visible
28244     *
28245     * @see also elm_naviframe_item_title_visible_set()
28246     *
28247     * @ingroup Naviframe
28248     */
28249    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28250
28251    /**
28252     * @brief Set creating prev button automatically or not
28253     *
28254     * @param obj The naviframe object
28255     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28256     *        be created internally when you pass the @c NULL to the prev_btn
28257     *        parameter in elm_naviframe_item_push
28258     *
28259     * @see also elm_naviframe_item_push()
28260     */
28261    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28262    /**
28263     * @brief Get a value whether prev button(back button) will be auto pushed or
28264     *        not.
28265     *
28266     * @param obj The naviframe object
28267     * @return If @c EINA_TRUE, prev button will be auto pushed.
28268     *
28269     * @see also elm_naviframe_item_push()
28270     *           elm_naviframe_prev_btn_auto_pushed_set()
28271     */
28272    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
28273
28274    /**
28275     * @}
28276     */
28277
28278 #ifdef __cplusplus
28279 }
28280 #endif
28281
28282 #endif