0489b1dff78e0f9b5fa57d8edd313743ad8a983d
[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.8.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 (hello) and title (Hello)
199    win = elm_win_util_standard_add("hello", "Hello");
200    // when the user clicks "close" on a window there is a request to delete
201    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
202
203    // add a box object - default is vertical. a box holds children in a row,
204    // either horizontally or vertically. nothing more.
205    box = elm_box_add(win);
206    // make the box hotizontal
207    elm_box_horizontal_set(box, EINA_TRUE);
208    // add object as a resize object for the window (controls window minimum
209    // size as well as gets resized if window is resized)
210    elm_win_resize_object_add(win, box);
211    evas_object_show(box);
212
213    // add a label widget, set the text and put it in the pad frame
214    lab = elm_label_add(win);
215    // set default text of the label
216    elm_object_text_set(lab, "Hello out there world!");
217    // pack the label at the end of the box
218    elm_box_pack_end(box, lab);
219    evas_object_show(lab);
220
221    // add an ok button
222    btn = elm_button_add(win);
223    // set default text of button to "OK"
224    elm_object_text_set(btn, "OK");
225    // pack the button at the end of the box
226    elm_box_pack_end(box, btn);
227    evas_object_show(btn);
228    // call on_done when button is clicked
229    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
230
231    // now we are done, show the window
232    evas_object_show(win);
233
234    // run the mainloop and process events and callbacks
235    elm_run();
236    return 0;
237 }
238 ELM_MAIN()
239 @endcode
240    *
241    */
242
243 /**
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
271 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@gmail.com>
288 @author Thierry el Borgi <thierry@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
290 @author Chanwook Jung <joey.jung@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
293 @author Kim Yunhan <spbear@gmail.com>
294
295 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
296 contact with the developers and maintainers.
297  */
298
299 #ifndef ELEMENTARY_H
300 #define ELEMENTARY_H
301
302 /**
303  * @file Elementary.h
304  * @brief Elementary's API
305  *
306  * Elementary API.
307  */
308
309 @ELM_UNIX_DEF@ ELM_UNIX
310 @ELM_WIN32_DEF@ ELM_WIN32
311 @ELM_WINCE_DEF@ ELM_WINCE
312 @ELM_EDBUS_DEF@ ELM_EDBUS
313 @ELM_EFREET_DEF@ ELM_EFREET
314 @ELM_ETHUMB_DEF@ ELM_ETHUMB
315 @ELM_WEB_DEF@ ELM_WEB
316 @ELM_EMAP_DEF@ ELM_EMAP
317 @ELM_DEBUG_DEF@ ELM_DEBUG
318 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
319 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
320
321 /* Standard headers for standard system calls etc. */
322 #include <stdio.h>
323 #include <stdlib.h>
324 #include <unistd.h>
325 #include <string.h>
326 #include <sys/types.h>
327 #include <sys/stat.h>
328 #include <sys/time.h>
329 #include <sys/param.h>
330 #include <dlfcn.h>
331 #include <math.h>
332 #include <fnmatch.h>
333 #include <limits.h>
334 #include <ctype.h>
335 #include <time.h>
336 #include <dirent.h>
337 #include <pwd.h>
338 #include <errno.h>
339
340 #ifdef ELM_UNIX
341 # include <locale.h>
342 # ifdef ELM_LIBINTL_H
343 #  include <libintl.h>
344 # endif
345 # include <signal.h>
346 # include <grp.h>
347 # include <glob.h>
348 #endif
349
350 #ifdef ELM_ALLOCA_H
351 # include <alloca.h>
352 #endif
353
354 #if defined (ELM_WIN32) || defined (ELM_WINCE)
355 # include <malloc.h>
356 # ifndef alloca
357 #  define alloca _alloca
358 # endif
359 #endif
360
361
362 /* EFL headers */
363 #include <Eina.h>
364 #include <Eet.h>
365 #include <Evas.h>
366 #include <Evas_GL.h>
367 #include <Ecore.h>
368 #include <Ecore_Evas.h>
369 #include <Ecore_File.h>
370 #include <Ecore_IMF.h>
371 #include <Ecore_Con.h>
372 #include <Edje.h>
373
374 #ifdef ELM_EDBUS
375 # include <E_DBus.h>
376 #endif
377
378 #ifdef ELM_EFREET
379 # include <Efreet.h>
380 # include <Efreet_Mime.h>
381 # include <Efreet_Trash.h>
382 #endif
383
384 #ifdef ELM_ETHUMB
385 # include <Ethumb_Client.h>
386 #endif
387
388 #ifdef ELM_EMAP
389 # include <EMap.h>
390 #endif
391
392 #ifdef EAPI
393 # undef EAPI
394 #endif
395
396 #ifdef _WIN32
397 # ifdef ELEMENTARY_BUILD
398 #  ifdef DLL_EXPORT
399 #   define EAPI __declspec(dllexport)
400 #  else
401 #   define EAPI
402 #  endif /* ! DLL_EXPORT */
403 # else
404 #  define EAPI __declspec(dllimport)
405 # endif /* ! EFL_EVAS_BUILD */
406 #else
407 # ifdef __GNUC__
408 #  if __GNUC__ >= 4
409 #   define EAPI __attribute__ ((visibility("default")))
410 #  else
411 #   define EAPI
412 #  endif
413 # else
414 #  define EAPI
415 # endif
416 #endif /* ! _WIN32 */
417
418 #ifdef _WIN32
419 # define EAPI_MAIN
420 #else
421 # define EAPI_MAIN EAPI
422 #endif
423
424 /* allow usage from c++ */
425 #ifdef __cplusplus
426 extern "C" {
427 #endif
428
429 #define ELM_VERSION_MAJOR @VMAJ@
430 #define ELM_VERSION_MINOR @VMIN@
431
432    typedef struct _Elm_Version
433      {
434         int major;
435         int minor;
436         int micro;
437         int revision;
438      } Elm_Version;
439
440    EAPI extern Elm_Version *elm_version;
441
442 /* handy macros */
443 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
444 #define ELM_PI 3.14159265358979323846
445
446    /**
447     * @defgroup General General
448     *
449     * @brief General Elementary API. Functions that don't relate to
450     * Elementary objects specifically.
451     *
452     * Here are documented functions which init/shutdown the library,
453     * that apply to generic Elementary objects, that deal with
454     * configuration, et cetera.
455     *
456     * @ref general_functions_example_page "This" example contemplates
457     * some of these functions.
458     */
459
460    /**
461     * @addtogroup General
462     * @{
463     */
464
465   /**
466    * Defines couple of standard Evas_Object layers to be used
467    * with evas_object_layer_set().
468    *
469    * @note whenever extending with new values, try to keep some padding
470    *       to siblings so there is room for further extensions.
471    */
472   typedef enum _Elm_Object_Layer
473     {
474        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
475        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
476        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
477        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
478        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
479        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
480     } Elm_Object_Layer;
481
482 /**************************************************************************/
483    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
484
485    /**
486     * Emitted when the application has reconfigured elementary settings due
487     * to an external configuration tool asking it to.
488     */
489    EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
490
491    /**
492     * Emitted when any Elementary's policy value is changed.
493     */
494    EAPI extern int ELM_EVENT_POLICY_CHANGED;
495
496    /**
497     * @typedef Elm_Event_Policy_Changed
498     *
499     * Data on the event when an Elementary policy has changed
500     */
501     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
502
503    /**
504     * @struct _Elm_Event_Policy_Changed
505     *
506     * Data on the event when an Elementary policy has changed
507     */
508     struct _Elm_Event_Policy_Changed
509      {
510         unsigned int policy; /**< the policy identifier */
511         int          new_value; /**< value the policy had before the change */
512         int          old_value; /**< new value the policy got */
513     };
514
515    /**
516     * Policy identifiers.
517     */
518     typedef enum _Elm_Policy
519     {
520         ELM_POLICY_QUIT, /**< under which circumstances the application
521                           * should quit automatically. @see
522                           * Elm_Policy_Quit.
523                           */
524         ELM_POLICY_LAST
525     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
526  */
527
528    typedef enum _Elm_Policy_Quit
529      {
530         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
531                                    * automatically */
532         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
533                                             * application's last
534                                             * window is closed */
535      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
536
537    typedef enum _Elm_Focus_Direction
538      {
539         ELM_FOCUS_PREVIOUS,
540         ELM_FOCUS_NEXT
541      } Elm_Focus_Direction;
542
543    typedef enum _Elm_Text_Format
544      {
545         ELM_TEXT_FORMAT_PLAIN_UTF8,
546         ELM_TEXT_FORMAT_MARKUP_UTF8
547      } Elm_Text_Format;
548
549    /**
550     * Line wrapping types.
551     */
552    typedef enum _Elm_Wrap_Type
553      {
554         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
555         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
556         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
557         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
558         ELM_WRAP_LAST
559      } Elm_Wrap_Type;
560
561    typedef enum
562      {
563         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
564         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
565         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
566         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
567         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
568         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
569         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
570         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
571         ELM_INPUT_PANEL_LAYOUT_INVALID
572      } Elm_Input_Panel_Layout;
573
574    typedef enum
575      {
576         ELM_AUTOCAPITAL_TYPE_NONE,
577         ELM_AUTOCAPITAL_TYPE_WORD,
578         ELM_AUTOCAPITAL_TYPE_SENTENCE,
579         ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
580      } Elm_Autocapital_Type;
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     * Adds a window object with standard setup
3804     *
3805     * @param name The name of the window
3806     * @param title The title for the window
3807     *
3808     * This creates a window like elm_win_add() but also puts in a standard
3809     * background with elm_bg_add(), as well as setting the window title to
3810     * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3811     * as the parent widget.
3812     * 
3813     * @return The created object, or NULL on failure
3814     *
3815     * @see elm_win_add()
3816     */
3817    EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3818    /**
3819     * Add @p subobj as a resize object of window @p obj.
3820     *
3821     *
3822     * Setting an object as a resize object of the window means that the
3823     * @p subobj child's size and position will be controlled by the window
3824     * directly. That is, the object will be resized to match the window size
3825     * and should never be moved or resized manually by the developer.
3826     *
3827     * In addition, resize objects of the window control what the minimum size
3828     * of it will be, as well as whether it can or not be resized by the user.
3829     *
3830     * For the end user to be able to resize a window by dragging the handles
3831     * or borders provided by the Window Manager, or using any other similar
3832     * mechanism, all of the resize objects in the window should have their
3833     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3834     *
3835     * @param obj The window object
3836     * @param subobj The resize object to add
3837     */
3838    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3839    /**
3840     * Delete @p subobj as a resize object of window @p obj.
3841     *
3842     * This function removes the object @p subobj from the resize objects of
3843     * the window @p obj. It will not delete the object itself, which will be
3844     * left unmanaged and should be deleted by the developer, manually handled
3845     * or set as child of some other container.
3846     *
3847     * @param obj The window object
3848     * @param subobj The resize object to add
3849     */
3850    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3851    /**
3852     * Set the title of the window
3853     *
3854     * @param obj The window object
3855     * @param title The title to set
3856     */
3857    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3858    /**
3859     * Get the title of the window
3860     *
3861     * The returned string is an internal one and should not be freed or
3862     * modified. It will also be rendered invalid if a new title is set or if
3863     * the window is destroyed.
3864     *
3865     * @param obj The window object
3866     * @return The title
3867     */
3868    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3869    /**
3870     * Set the window's autodel state.
3871     *
3872     * When closing the window in any way outside of the program control, like
3873     * pressing the X button in the titlebar or using a command from the
3874     * Window Manager, a "delete,request" signal is emitted to indicate that
3875     * this event occurred and the developer can take any action, which may
3876     * include, or not, destroying the window object.
3877     *
3878     * When the @p autodel parameter is set, the window will be automatically
3879     * destroyed when this event occurs, after the signal is emitted.
3880     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3881     * and is up to the program to do so when it's required.
3882     *
3883     * @param obj The window object
3884     * @param autodel If true, the window will automatically delete itself when
3885     * closed
3886     */
3887    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3888    /**
3889     * Get the window's autodel state.
3890     *
3891     * @param obj The window object
3892     * @return If the window will automatically delete itself when closed
3893     *
3894     * @see elm_win_autodel_set()
3895     */
3896    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3897    /**
3898     * Activate a window object.
3899     *
3900     * This function sends a request to the Window Manager to activate the
3901     * window pointed by @p obj. If honored by the WM, the window will receive
3902     * the keyboard focus.
3903     *
3904     * @note This is just a request that a Window Manager may ignore, so calling
3905     * this function does not ensure in any way that the window will be the
3906     * active one after it.
3907     *
3908     * @param obj The window object
3909     */
3910    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3911    /**
3912     * Lower a window object.
3913     *
3914     * Places the window pointed by @p obj at the bottom of the stack, so that
3915     * no other window is covered by it.
3916     *
3917     * If elm_win_override_set() is not set, the Window Manager may ignore this
3918     * request.
3919     *
3920     * @param obj The window object
3921     */
3922    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3923    /**
3924     * Raise a window object.
3925     *
3926     * Places the window pointed by @p obj at the top of the stack, so that it's
3927     * not covered by any other window.
3928     *
3929     * If elm_win_override_set() is not set, the Window Manager may ignore this
3930     * request.
3931     *
3932     * @param obj The window object
3933     */
3934    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3935    /**
3936     * Set the borderless state of a window.
3937     *
3938     * This function requests the Window Manager to not draw any decoration
3939     * around the window.
3940     *
3941     * @param obj The window object
3942     * @param borderless If true, the window is borderless
3943     */
3944    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3945    /**
3946     * Get the borderless state of a window.
3947     *
3948     * @param obj The window object
3949     * @return If true, the window is borderless
3950     */
3951    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3952    /**
3953     * Set the shaped state of a window.
3954     *
3955     * Shaped windows, when supported, will render the parts of the window that
3956     * has no content, transparent.
3957     *
3958     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3959     * background object or cover the entire window in any other way, or the
3960     * parts of the canvas that have no data will show framebuffer artifacts.
3961     *
3962     * @param obj The window object
3963     * @param shaped If true, the window is shaped
3964     *
3965     * @see elm_win_alpha_set()
3966     */
3967    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3968    /**
3969     * Get the shaped state of a window.
3970     *
3971     * @param obj The window object
3972     * @return If true, the window is shaped
3973     *
3974     * @see elm_win_shaped_set()
3975     */
3976    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3977    /**
3978     * Set the alpha channel state of a window.
3979     *
3980     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3981     * possibly making parts of the window completely or partially transparent.
3982     * This is also subject to the underlying system supporting it, like for
3983     * example, running under a compositing manager. If no compositing is
3984     * available, enabling this option will instead fallback to using shaped
3985     * windows, with elm_win_shaped_set().
3986     *
3987     * @param obj The window object
3988     * @param alpha If true, the window has an alpha channel
3989     *
3990     * @see elm_win_alpha_set()
3991     */
3992    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3993    /**
3994     * Get the transparency state of a window.
3995     *
3996     * @param obj The window object
3997     * @return If true, the window is transparent
3998     *
3999     * @see elm_win_transparent_set()
4000     */
4001    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4002    /**
4003     * Set the transparency state of a window.
4004     *
4005     * Use elm_win_alpha_set() instead.
4006     *
4007     * @param obj The window object
4008     * @param transparent If true, the window is transparent
4009     *
4010     * @see elm_win_alpha_set()
4011     */
4012    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4013    /**
4014     * Get the alpha channel state of a window.
4015     *
4016     * @param obj The window object
4017     * @return If true, the window has an alpha channel
4018     */
4019    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4020    /**
4021     * Set the override state of a window.
4022     *
4023     * A window with @p override set to EINA_TRUE will not be managed by the
4024     * Window Manager. This means that no decorations of any kind will be shown
4025     * for it, moving and resizing must be handled by the application, as well
4026     * as the window visibility.
4027     *
4028     * This should not be used for normal windows, and even for not so normal
4029     * ones, it should only be used when there's a good reason and with a lot
4030     * of care. Mishandling override windows may result situations that
4031     * disrupt the normal workflow of the end user.
4032     *
4033     * @param obj The window object
4034     * @param override If true, the window is overridden
4035     */
4036    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4037    /**
4038     * Get the override state of a window.
4039     *
4040     * @param obj The window object
4041     * @return If true, the window is overridden
4042     *
4043     * @see elm_win_override_set()
4044     */
4045    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4046    /**
4047     * Set the fullscreen state of a window.
4048     *
4049     * @param obj The window object
4050     * @param fullscreen If true, the window is fullscreen
4051     */
4052    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4053    /**
4054     * Get the fullscreen state of a window.
4055     *
4056     * @param obj The window object
4057     * @return If true, the window is fullscreen
4058     */
4059    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4060    /**
4061     * Set the maximized state of a window.
4062     *
4063     * @param obj The window object
4064     * @param maximized If true, the window is maximized
4065     */
4066    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4067    /**
4068     * Get the maximized state of a window.
4069     *
4070     * @param obj The window object
4071     * @return If true, the window is maximized
4072     */
4073    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4074    /**
4075     * Set the iconified state of a window.
4076     *
4077     * @param obj The window object
4078     * @param iconified If true, the window is iconified
4079     */
4080    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4081    /**
4082     * Get the iconified state of a window.
4083     *
4084     * @param obj The window object
4085     * @return If true, the window is iconified
4086     */
4087    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4088    /**
4089     * Set the layer of the window.
4090     *
4091     * What this means exactly will depend on the underlying engine used.
4092     *
4093     * In the case of X11 backed engines, the value in @p layer has the
4094     * following meanings:
4095     * @li < 3: The window will be placed below all others.
4096     * @li > 5: The window will be placed above all others.
4097     * @li other: The window will be placed in the default layer.
4098     *
4099     * @param obj The window object
4100     * @param layer The layer of the window
4101     */
4102    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4103    /**
4104     * Get the layer of the window.
4105     *
4106     * @param obj The window object
4107     * @return The layer of the window
4108     *
4109     * @see elm_win_layer_set()
4110     */
4111    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4112    /**
4113     * Set the rotation of the window.
4114     *
4115     * Most engines only work with multiples of 90.
4116     *
4117     * This function is used to set the orientation of the window @p obj to
4118     * match that of the screen. The window itself will be resized to adjust
4119     * to the new geometry of its contents. If you want to keep the window size,
4120     * see elm_win_rotation_with_resize_set().
4121     *
4122     * @param obj The window object
4123     * @param rotation The rotation of the window, in degrees (0-360),
4124     * counter-clockwise.
4125     */
4126    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4127    /**
4128     * Rotates the window and resizes it.
4129     *
4130     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4131     * that they fit inside the current window geometry.
4132     *
4133     * @param obj The window object
4134     * @param layer The rotation of the window in degrees (0-360),
4135     * counter-clockwise.
4136     */
4137    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4138    /**
4139     * Get the rotation of the window.
4140     *
4141     * @param obj The window object
4142     * @return The rotation of the window in degrees (0-360)
4143     *
4144     * @see elm_win_rotation_set()
4145     * @see elm_win_rotation_with_resize_set()
4146     */
4147    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4148    /**
4149     * Set the sticky state of the window.
4150     *
4151     * Hints the Window Manager that the window in @p obj should be left fixed
4152     * at its position even when the virtual desktop it's on moves or changes.
4153     *
4154     * @param obj The window object
4155     * @param sticky If true, the window's sticky state is enabled
4156     */
4157    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4158    /**
4159     * Get the sticky state of the window.
4160     *
4161     * @param obj The window object
4162     * @return If true, the window's sticky state is enabled
4163     *
4164     * @see elm_win_sticky_set()
4165     */
4166    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4167    /**
4168     * Set if this window is an illume conformant window
4169     *
4170     * @param obj The window object
4171     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4172     */
4173    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4174    /**
4175     * Get if this window is an illume conformant window
4176     *
4177     * @param obj The window object
4178     * @return A boolean if this window is illume conformant or not
4179     */
4180    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4181    /**
4182     * Set a window to be an illume quickpanel window
4183     *
4184     * By default window objects are not quickpanel windows.
4185     *
4186     * @param obj The window object
4187     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4188     */
4189    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4190    /**
4191     * Get if this window is a quickpanel or not
4192     *
4193     * @param obj The window object
4194     * @return A boolean if this window is a quickpanel or not
4195     */
4196    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4197    /**
4198     * Set the major priority of a quickpanel window
4199     *
4200     * @param obj The window object
4201     * @param priority The major priority for this quickpanel
4202     */
4203    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4204    /**
4205     * Get the major priority of a quickpanel window
4206     *
4207     * @param obj The window object
4208     * @return The major priority of this quickpanel
4209     */
4210    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4211    /**
4212     * Set the minor priority of a quickpanel window
4213     *
4214     * @param obj The window object
4215     * @param priority The minor priority for this quickpanel
4216     */
4217    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4218    /**
4219     * Get the minor priority of a quickpanel window
4220     *
4221     * @param obj The window object
4222     * @return The minor priority of this quickpanel
4223     */
4224    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4225    /**
4226     * Set which zone this quickpanel should appear in
4227     *
4228     * @param obj The window object
4229     * @param zone The requested zone for this quickpanel
4230     */
4231    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4232    /**
4233     * Get which zone this quickpanel should appear in
4234     *
4235     * @param obj The window object
4236     * @return The requested zone for this quickpanel
4237     */
4238    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4239    /**
4240     * Set the window to be skipped by keyboard focus
4241     *
4242     * This sets the window to be skipped by normal keyboard input. This means
4243     * a window manager will be asked to not focus this window as well as omit
4244     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4245     *
4246     * Call this and enable it on a window BEFORE you show it for the first time,
4247     * otherwise it may have no effect.
4248     *
4249     * Use this for windows that have only output information or might only be
4250     * interacted with by the mouse or fingers, and never for typing input.
4251     * Be careful that this may have side-effects like making the window
4252     * non-accessible in some cases unless the window is specially handled. Use
4253     * this with care.
4254     *
4255     * @param obj The window object
4256     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4257     */
4258    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4259    /**
4260     * Send a command to the windowing environment
4261     *
4262     * This is intended to work in touchscreen or small screen device
4263     * environments where there is a more simplistic window management policy in
4264     * place. This uses the window object indicated to select which part of the
4265     * environment to control (the part that this window lives in), and provides
4266     * a command and an optional parameter structure (use NULL for this if not
4267     * needed).
4268     *
4269     * @param obj The window object that lives in the environment to control
4270     * @param command The command to send
4271     * @param params Optional parameters for the command
4272     */
4273    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4274    /**
4275     * Get the inlined image object handle
4276     *
4277     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4278     * then the window is in fact an evas image object inlined in the parent
4279     * canvas. You can get this object (be careful to not manipulate it as it
4280     * is under control of elementary), and use it to do things like get pixel
4281     * data, save the image to a file, etc.
4282     *
4283     * @param obj The window object to get the inlined image from
4284     * @return The inlined image object, or NULL if none exists
4285     */
4286    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4287    /**
4288     * Set the enabled status for the focus highlight in a window
4289     *
4290     * This function will enable or disable the focus highlight only for the
4291     * given window, regardless of the global setting for it
4292     *
4293     * @param obj The window where to enable the highlight
4294     * @param enabled The enabled value for the highlight
4295     */
4296    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4297    /**
4298     * Get the enabled value of the focus highlight for this window
4299     *
4300     * @param obj The window in which to check if the focus highlight is enabled
4301     *
4302     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4303     */
4304    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4305    /**
4306     * Set the style for the focus highlight on this window
4307     *
4308     * Sets the style to use for theming the highlight of focused objects on
4309     * the given window. If @p style is NULL, the default will be used.
4310     *
4311     * @param obj The window where to set the style
4312     * @param style The style to set
4313     */
4314    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4315    /**
4316     * Get the style set for the focus highlight object
4317     *
4318     * Gets the style set for this windows highilght object, or NULL if none
4319     * is set.
4320     *
4321     * @param obj The window to retrieve the highlights style from
4322     *
4323     * @return The style set or NULL if none was. Default is used in that case.
4324     */
4325    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4326    /*...
4327     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4328     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4329     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4330     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4331     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4332     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4333     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4334     *
4335     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4336     * (blank mouse, private mouse obj, defaultmouse)
4337     *
4338     */
4339    /**
4340     * Sets the keyboard mode of the window.
4341     *
4342     * @param obj The window object
4343     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4344     */
4345    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4346    /**
4347     * Gets the keyboard mode of the window.
4348     *
4349     * @param obj The window object
4350     * @return The mode, one of #Elm_Win_Keyboard_Mode
4351     */
4352    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4353    /**
4354     * Sets whether the window is a keyboard.
4355     *
4356     * @param obj The window object
4357     * @param is_keyboard If true, the window is a virtual keyboard
4358     */
4359    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4360    /**
4361     * Gets whether the window is a keyboard.
4362     *
4363     * @param obj The window object
4364     * @return If the window is a virtual keyboard
4365     */
4366    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4367
4368    /**
4369     * Get the screen position of a window.
4370     *
4371     * @param obj The window object
4372     * @param x The int to store the x coordinate to
4373     * @param y The int to store the y coordinate to
4374     */
4375    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4376    /**
4377     * @}
4378     */
4379
4380    /**
4381     * @defgroup Inwin Inwin
4382     *
4383     * @image html img/widget/inwin/preview-00.png
4384     * @image latex img/widget/inwin/preview-00.eps
4385     * @image html img/widget/inwin/preview-01.png
4386     * @image latex img/widget/inwin/preview-01.eps
4387     * @image html img/widget/inwin/preview-02.png
4388     * @image latex img/widget/inwin/preview-02.eps
4389     *
4390     * An inwin is a window inside a window that is useful for a quick popup.
4391     * It does not hover.
4392     *
4393     * It works by creating an object that will occupy the entire window, so it
4394     * must be created using an @ref Win "elm_win" as parent only. The inwin
4395     * object can be hidden or restacked below every other object if it's
4396     * needed to show what's behind it without destroying it. If this is done,
4397     * the elm_win_inwin_activate() function can be used to bring it back to
4398     * full visibility again.
4399     *
4400     * There are three styles available in the default theme. These are:
4401     * @li default: The inwin is sized to take over most of the window it's
4402     * placed in.
4403     * @li minimal: The size of the inwin will be the minimum necessary to show
4404     * its contents.
4405     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4406     * possible, but it's sized vertically the most it needs to fit its\
4407     * contents.
4408     *
4409     * Some examples of Inwin can be found in the following:
4410     * @li @ref inwin_example_01
4411     *
4412     * @{
4413     */
4414    /**
4415     * Adds an inwin to the current window
4416     *
4417     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4418     * Never call this function with anything other than the top-most window
4419     * as its parameter, unless you are fond of undefined behavior.
4420     *
4421     * After creating the object, the widget will set itself as resize object
4422     * for the window with elm_win_resize_object_add(), so when shown it will
4423     * appear to cover almost the entire window (how much of it depends on its
4424     * content and the style used). It must not be added into other container
4425     * objects and it needs not be moved or resized manually.
4426     *
4427     * @param parent The parent object
4428     * @return The new object or NULL if it cannot be created
4429     */
4430    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4431    /**
4432     * Activates an inwin object, ensuring its visibility
4433     *
4434     * This function will make sure that the inwin @p obj is completely visible
4435     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4436     * to the front. It also sets the keyboard focus to it, which will be passed
4437     * onto its content.
4438     *
4439     * The object's theme will also receive the signal "elm,action,show" with
4440     * source "elm".
4441     *
4442     * @param obj The inwin to activate
4443     */
4444    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4445    /**
4446     * Set the content of an inwin object.
4447     *
4448     * Once the content object is set, a previously set one will be deleted.
4449     * If you want to keep that old content object, use the
4450     * elm_win_inwin_content_unset() function.
4451     *
4452     * @param obj The inwin object
4453     * @param content The object to set as content
4454     */
4455    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4456    /**
4457     * Get the content of an inwin object.
4458     *
4459     * Return the content object which is set for this widget.
4460     *
4461     * The returned object is valid as long as the inwin is still alive and no
4462     * other content is set on it. Deleting the object will notify the inwin
4463     * about it and this one will be left empty.
4464     *
4465     * If you need to remove an inwin's content to be reused somewhere else,
4466     * see elm_win_inwin_content_unset().
4467     *
4468     * @param obj The inwin object
4469     * @return The content that is being used
4470     */
4471    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4472    /**
4473     * Unset the content of an inwin object.
4474     *
4475     * Unparent and return the content object which was set for this widget.
4476     *
4477     * @param obj The inwin object
4478     * @return The content that was being used
4479     */
4480    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4481    /**
4482     * @}
4483     */
4484    /* X specific calls - won't work on non-x engines (return 0) */
4485
4486    /**
4487     * Get the Ecore_X_Window of an Evas_Object
4488     *
4489     * @param obj The object
4490     *
4491     * @return The Ecore_X_Window of @p obj
4492     *
4493     * @ingroup Win
4494     */
4495    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4496
4497    /* smart callbacks called:
4498     * "delete,request" - the user requested to delete the window
4499     * "focus,in" - window got focus
4500     * "focus,out" - window lost focus
4501     * "moved" - window that holds the canvas was moved
4502     */
4503
4504    /**
4505     * @defgroup Bg Bg
4506     *
4507     * @image html img/widget/bg/preview-00.png
4508     * @image latex img/widget/bg/preview-00.eps
4509     *
4510     * @brief Background object, used for setting a solid color, image or Edje
4511     * group as background to a window or any container object.
4512     *
4513     * The bg object is used for setting a solid background to a window or
4514     * packing into any container object. It works just like an image, but has
4515     * some properties useful to a background, like setting it to tiled,
4516     * centered, scaled or stretched.
4517     * 
4518     * Default contents parts of the bg widget that you can use for are:
4519     * @li "elm.swallow.content" - overlay of the bg
4520     *
4521     * Here is some sample code using it:
4522     * @li @ref bg_01_example_page
4523     * @li @ref bg_02_example_page
4524     * @li @ref bg_03_example_page
4525     */
4526
4527    /* bg */
4528    typedef enum _Elm_Bg_Option
4529      {
4530         ELM_BG_OPTION_CENTER,  /**< center the background */
4531         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4532         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4533         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4534      } Elm_Bg_Option;
4535
4536    /**
4537     * Add a new background to the parent
4538     *
4539     * @param parent The parent object
4540     * @return The new object or NULL if it cannot be created
4541     *
4542     * @ingroup Bg
4543     */
4544    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4545
4546    /**
4547     * Set the file (image or edje) used for the background
4548     *
4549     * @param obj The bg object
4550     * @param file The file path
4551     * @param group Optional key (group in Edje) within the file
4552     *
4553     * This sets the image file used in the background object. The image (or edje)
4554     * will be stretched (retaining aspect if its an image file) to completely fill
4555     * the bg object. This may mean some parts are not visible.
4556     *
4557     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4558     * even if @p file is NULL.
4559     *
4560     * @ingroup Bg
4561     */
4562    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4563
4564    /**
4565     * Get the file (image or edje) used for the background
4566     *
4567     * @param obj The bg object
4568     * @param file The file path
4569     * @param group Optional key (group in Edje) within the file
4570     *
4571     * @ingroup Bg
4572     */
4573    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4574
4575    /**
4576     * Set the option used for the background image
4577     *
4578     * @param obj The bg object
4579     * @param option The desired background option (TILE, SCALE)
4580     *
4581     * This sets the option used for manipulating the display of the background
4582     * image. The image can be tiled or scaled.
4583     *
4584     * @ingroup Bg
4585     */
4586    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4587
4588    /**
4589     * Get the option used for the background image
4590     *
4591     * @param obj The bg object
4592     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4593     *
4594     * @ingroup Bg
4595     */
4596    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4597    /**
4598     * Set the option used for the background color
4599     *
4600     * @param obj The bg object
4601     * @param r
4602     * @param g
4603     * @param b
4604     *
4605     * This sets the color used for the background rectangle. Its range goes
4606     * from 0 to 255.
4607     *
4608     * @ingroup Bg
4609     */
4610    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4611    /**
4612     * Get the option used for the background color
4613     *
4614     * @param obj The bg object
4615     * @param r
4616     * @param g
4617     * @param b
4618     *
4619     * @ingroup Bg
4620     */
4621    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4622
4623    /**
4624     * Set the overlay object used for the background object.
4625     *
4626     * @param obj The bg object
4627     * @param overlay The overlay object
4628     *
4629     * This provides a way for elm_bg to have an 'overlay' that will be on top
4630     * of the bg. Once the over object is set, a previously set one will be
4631     * deleted, even if you set the new one to NULL. If you want to keep that
4632     * old content object, use the elm_bg_overlay_unset() function.
4633     *
4634     * @ingroup Bg
4635     */
4636
4637    EINA_DEPRECATED EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4638
4639    /**
4640     * Get the overlay object used for the background object.
4641     *
4642     * @param obj The bg object
4643     * @return The content that is being used
4644     *
4645     * Return the content object which is set for this widget
4646     *
4647     * @ingroup Bg
4648     */
4649    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4650
4651    /**
4652     * Get the overlay object used for the background object.
4653     *
4654     * @param obj The bg object
4655     * @return The content that was being used
4656     *
4657     * Unparent and return the overlay object which was set for this widget
4658     *
4659     * @ingroup Bg
4660     */
4661    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4662
4663    /**
4664     * Set the size of the pixmap representation of the image.
4665     *
4666     * This option just makes sense if an image is going to be set in the bg.
4667     *
4668     * @param obj The bg object
4669     * @param w The new width of the image pixmap representation.
4670     * @param h The new height of the image pixmap representation.
4671     *
4672     * This function sets a new size for pixmap representation of the given bg
4673     * image. It allows the image to be loaded already in the specified size,
4674     * reducing the memory usage and load time when loading a big image with load
4675     * size set to a smaller size.
4676     *
4677     * NOTE: this is just a hint, the real size of the pixmap may differ
4678     * depending on the type of image being loaded, being bigger than requested.
4679     *
4680     * @ingroup Bg
4681     */
4682    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4683    /* smart callbacks called:
4684     */
4685
4686    /**
4687     * @defgroup Icon Icon
4688     *
4689     * @image html img/widget/icon/preview-00.png
4690     * @image latex img/widget/icon/preview-00.eps
4691     *
4692     * An object that provides standard icon images (delete, edit, arrows, etc.)
4693     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4694     *
4695     * The icon image requested can be in the elementary theme, or in the
4696     * freedesktop.org paths. It's possible to set the order of preference from
4697     * where the image will be used.
4698     *
4699     * This API is very similar to @ref Image, but with ready to use images.
4700     *
4701     * Default images provided by the theme are described below.
4702     *
4703     * The first list contains icons that were first intended to be used in
4704     * toolbars, but can be used in many other places too:
4705     * @li home
4706     * @li close
4707     * @li apps
4708     * @li arrow_up
4709     * @li arrow_down
4710     * @li arrow_left
4711     * @li arrow_right
4712     * @li chat
4713     * @li clock
4714     * @li delete
4715     * @li edit
4716     * @li refresh
4717     * @li folder
4718     * @li file
4719     *
4720     * Now some icons that were designed to be used in menus (but again, you can
4721     * use them anywhere else):
4722     * @li menu/home
4723     * @li menu/close
4724     * @li menu/apps
4725     * @li menu/arrow_up
4726     * @li menu/arrow_down
4727     * @li menu/arrow_left
4728     * @li menu/arrow_right
4729     * @li menu/chat
4730     * @li menu/clock
4731     * @li menu/delete
4732     * @li menu/edit
4733     * @li menu/refresh
4734     * @li menu/folder
4735     * @li menu/file
4736     *
4737     * And here we have some media player specific icons:
4738     * @li media_player/forward
4739     * @li media_player/info
4740     * @li media_player/next
4741     * @li media_player/pause
4742     * @li media_player/play
4743     * @li media_player/prev
4744     * @li media_player/rewind
4745     * @li media_player/stop
4746     *
4747     * Signals that you can add callbacks for are:
4748     *
4749     * "clicked" - This is called when a user has clicked the icon
4750     *
4751     * An example of usage for this API follows:
4752     * @li @ref tutorial_icon
4753     */
4754
4755    /**
4756     * @addtogroup Icon
4757     * @{
4758     */
4759
4760    typedef enum _Elm_Icon_Type
4761      {
4762         ELM_ICON_NONE,
4763         ELM_ICON_FILE,
4764         ELM_ICON_STANDARD
4765      } Elm_Icon_Type;
4766    /**
4767     * @enum _Elm_Icon_Lookup_Order
4768     * @typedef Elm_Icon_Lookup_Order
4769     *
4770     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4771     * theme, FDO paths, or both?
4772     *
4773     * @ingroup Icon
4774     */
4775    typedef enum _Elm_Icon_Lookup_Order
4776      {
4777         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4778         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4779         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4780         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4781      } Elm_Icon_Lookup_Order;
4782
4783    /**
4784     * Add a new icon object to the parent.
4785     *
4786     * @param parent The parent object
4787     * @return The new object or NULL if it cannot be created
4788     *
4789     * @see elm_icon_file_set()
4790     *
4791     * @ingroup Icon
4792     */
4793    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4794    /**
4795     * Set the file that will be used as icon.
4796     *
4797     * @param obj The icon object
4798     * @param file The path to file that will be used as icon image
4799     * @param group The group that the icon belongs to 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     * @see elm_icon_file_get()
4807     *
4808     * @ingroup Icon
4809     */
4810    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4811    /**
4812     * Set a location in memory to be used as an icon
4813     *
4814     * @param obj The icon object
4815     * @param img The binary data that will be used as an image
4816     * @param size The size of binary data @p img
4817     * @param format Optional format of @p img to pass to the image loader
4818     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4819     *
4820     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4821     *
4822     * @note The icon image set by this function can be changed by
4823     * elm_icon_standard_set().
4824     *
4825     * @ingroup Icon
4826     */
4827    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);
4828    /**
4829     * Get the file that will be used as icon.
4830     *
4831     * @param obj The icon object
4832     * @param file The path to file that will be used as the icon image
4833     * @param group The group that the icon belongs to, in edje file
4834     *
4835     * @see elm_icon_file_set()
4836     *
4837     * @ingroup Icon
4838     */
4839    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4840    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4841    /**
4842     * Set the icon by icon standards names.
4843     *
4844     * @param obj The icon object
4845     * @param name The icon name
4846     *
4847     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4848     *
4849     * For example, freedesktop.org defines standard icon names such as "home",
4850     * "network", etc. There can be different icon sets to match those icon
4851     * keys. The @p name given as parameter is one of these "keys", and will be
4852     * used to look in the freedesktop.org paths and elementary theme. One can
4853     * change the lookup order with elm_icon_order_lookup_set().
4854     *
4855     * If name is not found in any of the expected locations and it is the
4856     * absolute path of an image file, this image will be used.
4857     *
4858     * @note The icon image set by this function can be changed by
4859     * elm_icon_file_set().
4860     *
4861     * @see elm_icon_standard_get()
4862     * @see elm_icon_file_set()
4863     *
4864     * @ingroup Icon
4865     */
4866    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4867    /**
4868     * Get the icon name set by icon standard names.
4869     *
4870     * @param obj The icon object
4871     * @return The icon name
4872     *
4873     * If the icon image was set using elm_icon_file_set() instead of
4874     * elm_icon_standard_set(), then this function will return @c NULL.
4875     *
4876     * @see elm_icon_standard_set()
4877     *
4878     * @ingroup Icon
4879     */
4880    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4881    /**
4882     * Set the smooth scaling for an icon object.
4883     *
4884     * @param obj The icon object
4885     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4886     * otherwise. Default is @c EINA_TRUE.
4887     *
4888     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4889     * scaling provides a better resulting image, but is slower.
4890     *
4891     * The smooth scaling should be disabled when making animations that change
4892     * the icon size, since they will be faster. Animations that don't require
4893     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4894     * is already scaled, since the scaled icon image will be cached).
4895     *
4896     * @see elm_icon_smooth_get()
4897     *
4898     * @ingroup Icon
4899     */
4900    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4901    /**
4902     * Get whether smooth scaling is enabled for an icon object.
4903     *
4904     * @param obj The icon object
4905     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4906     *
4907     * @see elm_icon_smooth_set()
4908     *
4909     * @ingroup Icon
4910     */
4911    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4912    /**
4913     * Disable scaling of this object.
4914     *
4915     * @param obj The icon object.
4916     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4917     * otherwise. Default is @c EINA_FALSE.
4918     *
4919     * This function disables scaling of the icon object through the function
4920     * elm_object_scale_set(). However, this does not affect the object
4921     * size/resize in any way. For that effect, take a look at
4922     * elm_icon_scale_set().
4923     *
4924     * @see elm_icon_no_scale_get()
4925     * @see elm_icon_scale_set()
4926     * @see elm_object_scale_set()
4927     *
4928     * @ingroup Icon
4929     */
4930    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4931    /**
4932     * Get whether scaling is disabled on the object.
4933     *
4934     * @param obj The icon object
4935     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4936     *
4937     * @see elm_icon_no_scale_set()
4938     *
4939     * @ingroup Icon
4940     */
4941    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4942    /**
4943     * Set if the object is (up/down) resizable.
4944     *
4945     * @param obj The icon object
4946     * @param scale_up A bool to set if the object is resizable up. Default is
4947     * @c EINA_TRUE.
4948     * @param scale_down A bool to set if the object is resizable down. Default
4949     * is @c EINA_TRUE.
4950     *
4951     * This function limits the icon object resize ability. If @p scale_up is set to
4952     * @c EINA_FALSE, the object can't have its height or width resized to a value
4953     * higher than the original icon size. Same is valid for @p scale_down.
4954     *
4955     * @see elm_icon_scale_get()
4956     *
4957     * @ingroup Icon
4958     */
4959    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4960    /**
4961     * Get if the object is (up/down) resizable.
4962     *
4963     * @param obj The icon object
4964     * @param scale_up A bool to set if the object is resizable up
4965     * @param scale_down A bool to set if the object is resizable down
4966     *
4967     * @see elm_icon_scale_set()
4968     *
4969     * @ingroup Icon
4970     */
4971    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4972    /**
4973     * Get the object's image size
4974     *
4975     * @param obj The icon object
4976     * @param w A pointer to store the width in
4977     * @param h A pointer to store the height in
4978     *
4979     * @ingroup Icon
4980     */
4981    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4982    /**
4983     * Set if the icon fill the entire object area.
4984     *
4985     * @param obj The icon object
4986     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4987     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4988     *
4989     * When the icon object is resized to a different aspect ratio from the
4990     * original icon image, the icon image will still keep its aspect. This flag
4991     * tells how the image should fill the object's area. They are: keep the
4992     * entire icon inside the limits of height and width of the object (@p
4993     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4994     * of the object, and the icon will fill the entire object (@p fill_outside
4995     * is @c EINA_TRUE).
4996     *
4997     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4998     * retain property to false. Thus, the icon image will always keep its
4999     * original aspect ratio.
5000     *
5001     * @see elm_icon_fill_outside_get()
5002     * @see elm_image_fill_outside_set()
5003     *
5004     * @ingroup Icon
5005     */
5006    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5007    /**
5008     * Get if the object is filled outside.
5009     *
5010     * @param obj The icon object
5011     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5012     *
5013     * @see elm_icon_fill_outside_set()
5014     *
5015     * @ingroup Icon
5016     */
5017    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5018    /**
5019     * Set the prescale size for the icon.
5020     *
5021     * @param obj The icon object
5022     * @param size The prescale size. This value is used for both width and
5023     * height.
5024     *
5025     * This function sets a new size for pixmap representation of the given
5026     * icon. It allows the icon to be loaded already in the specified size,
5027     * reducing the memory usage and load time when loading a big icon with load
5028     * size set to a smaller size.
5029     *
5030     * It's equivalent to the elm_bg_load_size_set() function for bg.
5031     *
5032     * @note this is just a hint, the real size of the pixmap may differ
5033     * depending on the type of icon being loaded, being bigger than requested.
5034     *
5035     * @see elm_icon_prescale_get()
5036     * @see elm_bg_load_size_set()
5037     *
5038     * @ingroup Icon
5039     */
5040    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5041    /**
5042     * Get the prescale size for the icon.
5043     *
5044     * @param obj The icon object
5045     * @return The prescale size
5046     *
5047     * @see elm_icon_prescale_set()
5048     *
5049     * @ingroup Icon
5050     */
5051    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5052    /**
5053     * Sets the icon lookup order used by elm_icon_standard_set().
5054     *
5055     * @param obj The icon object
5056     * @param order The icon lookup order (can be one of
5057     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5058     * or ELM_ICON_LOOKUP_THEME)
5059     *
5060     * @see elm_icon_order_lookup_get()
5061     * @see Elm_Icon_Lookup_Order
5062     *
5063     * @ingroup Icon
5064     */
5065    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5066    /**
5067     * Gets the icon lookup order.
5068     *
5069     * @param obj The icon object
5070     * @return The icon lookup order
5071     *
5072     * @see elm_icon_order_lookup_set()
5073     * @see Elm_Icon_Lookup_Order
5074     *
5075     * @ingroup Icon
5076     */
5077    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5078    /**
5079     * Get if the icon supports animation or not.
5080     *
5081     * @param obj The icon object
5082     * @return @c EINA_TRUE if the icon supports animation,
5083     *         @c EINA_FALSE otherwise.
5084     *
5085     * Return if this elm icon's image can be animated. Currently Evas only
5086     * supports gif animation. If the return value is EINA_FALSE, other
5087     * elm_icon_animated_XXX APIs won't work.
5088     * @ingroup Icon
5089     */
5090    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5091    /**
5092     * Set animation mode of the icon.
5093     *
5094     * @param obj The icon object
5095     * @param anim @c EINA_TRUE if the object do animation job,
5096     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5097     *
5098     * Since the default animation mode is set to EINA_FALSE, 
5099     * the icon is shown without animation.
5100     * This might be desirable when the application developer wants to show
5101     * a snapshot of the animated icon.
5102     * Set it to EINA_TRUE when the icon needs to be animated.
5103     * @ingroup Icon
5104     */
5105    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5106    /**
5107     * Get animation mode of the icon.
5108     *
5109     * @param obj The icon object
5110     * @return The animation mode of the icon object
5111     * @see elm_icon_animated_set
5112     * @ingroup Icon
5113     */
5114    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5115    /**
5116     * Set animation play mode of the icon.
5117     *
5118     * @param obj The icon object
5119     * @param play @c EINA_TRUE the object play animation images,
5120     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5121     *
5122     * To play elm icon's animation, set play to EINA_TURE.
5123     * For example, you make gif player using this set/get API and click event.
5124     *
5125     * 1. Click event occurs
5126     * 2. Check play flag using elm_icon_animaged_play_get
5127     * 3. If elm icon was playing, set play to EINA_FALSE.
5128     *    Then animation will be stopped and vice versa
5129     * @ingroup Icon
5130     */
5131    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5132    /**
5133     * Get animation play mode of the icon.
5134     *
5135     * @param obj The icon object
5136     * @return The play mode of the icon object
5137     *
5138     * @see elm_icon_animated_play_get
5139     * @ingroup Icon
5140     */
5141    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5142
5143    /**
5144     * @}
5145     */
5146
5147    /**
5148     * @defgroup Image Image
5149     *
5150     * @image html img/widget/image/preview-00.png
5151     * @image latex img/widget/image/preview-00.eps
5152
5153     *
5154     * An object that allows one to load an image file to it. It can be used
5155     * anywhere like any other elementary widget.
5156     *
5157     * This widget provides most of the functionality provided from @ref Bg or @ref
5158     * Icon, but with a slightly different API (use the one that fits better your
5159     * needs).
5160     *
5161     * The features not provided by those two other image widgets are:
5162     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5163     * @li change the object orientation with elm_image_orient_set();
5164     * @li and turning the image editable with elm_image_editable_set().
5165     *
5166     * Signals that you can add callbacks for are:
5167     *
5168     * @li @c "clicked" - This is called when a user has clicked the image
5169     *
5170     * An example of usage for this API follows:
5171     * @li @ref tutorial_image
5172     */
5173
5174    /**
5175     * @addtogroup Image
5176     * @{
5177     */
5178
5179    /**
5180     * @enum _Elm_Image_Orient
5181     * @typedef Elm_Image_Orient
5182     *
5183     * Possible orientation options for elm_image_orient_set().
5184     *
5185     * @image html elm_image_orient_set.png
5186     * @image latex elm_image_orient_set.eps width=\textwidth
5187     *
5188     * @ingroup Image
5189     */
5190    typedef enum _Elm_Image_Orient
5191      {
5192         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5193         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5194         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5195         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5196         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5197         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5198         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5199         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5200      } Elm_Image_Orient;
5201
5202    /**
5203     * Add a new image to the parent.
5204     *
5205     * @param parent The parent object
5206     * @return The new object or NULL if it cannot be created
5207     *
5208     * @see elm_image_file_set()
5209     *
5210     * @ingroup Image
5211     */
5212    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5213    /**
5214     * Set the file that will be used as image.
5215     *
5216     * @param obj The image object
5217     * @param file The path to file that will be used as image
5218     * @param group The group that the image belongs in edje file (if it's an
5219     * edje image)
5220     *
5221     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5222     *
5223     * @see elm_image_file_get()
5224     *
5225     * @ingroup Image
5226     */
5227    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5228    /**
5229     * Get the file that will be used as image.
5230     *
5231     * @param obj The image object
5232     * @param file The path to file
5233     * @param group The group that the image belongs in edje file
5234     *
5235     * @see elm_image_file_set()
5236     *
5237     * @ingroup Image
5238     */
5239    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5240    /**
5241     * Set the smooth effect for an image.
5242     *
5243     * @param obj The image object
5244     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5245     * otherwise. Default is @c EINA_TRUE.
5246     *
5247     * Set the scaling algorithm to be used when scaling the image. Smooth
5248     * scaling provides a better resulting image, but is slower.
5249     *
5250     * The smooth scaling should be disabled when making animations that change
5251     * the image size, since it will be faster. Animations that don't require
5252     * resizing of the image can keep the smooth scaling enabled (even if the
5253     * image is already scaled, since the scaled image will be cached).
5254     *
5255     * @see elm_image_smooth_get()
5256     *
5257     * @ingroup Image
5258     */
5259    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5260    /**
5261     * Get the smooth effect for an image.
5262     *
5263     * @param obj The image object
5264     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5265     *
5266     * @see elm_image_smooth_get()
5267     *
5268     * @ingroup Image
5269     */
5270    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5271
5272    /**
5273     * Gets the current size of the image.
5274     *
5275     * @param obj The image object.
5276     * @param w Pointer to store width, or NULL.
5277     * @param h Pointer to store height, or NULL.
5278     *
5279     * This is the real size of the image, not the size of the object.
5280     *
5281     * On error, neither w or h will be written.
5282     *
5283     * @ingroup Image
5284     */
5285    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5286    /**
5287     * Disable scaling of this object.
5288     *
5289     * @param obj The image object.
5290     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5291     * otherwise. Default is @c EINA_FALSE.
5292     *
5293     * This function disables scaling of the elm_image widget through the
5294     * function elm_object_scale_set(). However, this does not affect the widget
5295     * size/resize in any way. For that effect, take a look at
5296     * elm_image_scale_set().
5297     *
5298     * @see elm_image_no_scale_get()
5299     * @see elm_image_scale_set()
5300     * @see elm_object_scale_set()
5301     *
5302     * @ingroup Image
5303     */
5304    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5305    /**
5306     * Get whether scaling is disabled on the object.
5307     *
5308     * @param obj The image object
5309     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5310     *
5311     * @see elm_image_no_scale_set()
5312     *
5313     * @ingroup Image
5314     */
5315    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5316    /**
5317     * Set if the object is (up/down) resizable.
5318     *
5319     * @param obj The image object
5320     * @param scale_up A bool to set if the object is resizable up. Default is
5321     * @c EINA_TRUE.
5322     * @param scale_down A bool to set if the object is resizable down. Default
5323     * is @c EINA_TRUE.
5324     *
5325     * This function limits the image resize ability. If @p scale_up is set to
5326     * @c EINA_FALSE, the object can't have its height or width resized to a value
5327     * higher than the original image size. Same is valid for @p scale_down.
5328     *
5329     * @see elm_image_scale_get()
5330     *
5331     * @ingroup Image
5332     */
5333    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5334    /**
5335     * Get if the object is (up/down) resizable.
5336     *
5337     * @param obj The image object
5338     * @param scale_up A bool to set if the object is resizable up
5339     * @param scale_down A bool to set if the object is resizable down
5340     *
5341     * @see elm_image_scale_set()
5342     *
5343     * @ingroup Image
5344     */
5345    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5346    /**
5347     * Set if the image fills the entire object area, when keeping the aspect ratio.
5348     *
5349     * @param obj The image object
5350     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5351     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5352     *
5353     * When the image should keep its aspect ratio even if resized to another
5354     * aspect ratio, there are two possibilities to resize it: keep the entire
5355     * image inside the limits of height and width of the object (@p fill_outside
5356     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5357     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5358     *
5359     * @note This option will have no effect if
5360     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5361     *
5362     * @see elm_image_fill_outside_get()
5363     * @see elm_image_aspect_ratio_retained_set()
5364     *
5365     * @ingroup Image
5366     */
5367    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5368    /**
5369     * Get if the object is filled outside
5370     *
5371     * @param obj The image object
5372     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5373     *
5374     * @see elm_image_fill_outside_set()
5375     *
5376     * @ingroup Image
5377     */
5378    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5379    /**
5380     * Set the prescale size for the image
5381     *
5382     * @param obj The image object
5383     * @param size The prescale size. This value is used for both width and
5384     * height.
5385     *
5386     * This function sets a new size for pixmap representation of the given
5387     * image. It allows the image to be loaded already in the specified size,
5388     * reducing the memory usage and load time when loading a big image with load
5389     * size set to a smaller size.
5390     *
5391     * It's equivalent to the elm_bg_load_size_set() function for bg.
5392     *
5393     * @note this is just a hint, the real size of the pixmap may differ
5394     * depending on the type of image being loaded, being bigger than requested.
5395     *
5396     * @see elm_image_prescale_get()
5397     * @see elm_bg_load_size_set()
5398     *
5399     * @ingroup Image
5400     */
5401    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5402    /**
5403     * Get the prescale size for the image
5404     *
5405     * @param obj The image object
5406     * @return The prescale size
5407     *
5408     * @see elm_image_prescale_set()
5409     *
5410     * @ingroup Image
5411     */
5412    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5413    /**
5414     * Set the image orientation.
5415     *
5416     * @param obj The image object
5417     * @param orient The image orientation @ref Elm_Image_Orient
5418     *  Default is #ELM_IMAGE_ORIENT_NONE.
5419     *
5420     * This function allows to rotate or flip the given image.
5421     *
5422     * @see elm_image_orient_get()
5423     * @see @ref Elm_Image_Orient
5424     *
5425     * @ingroup Image
5426     */
5427    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5428    /**
5429     * Get the image orientation.
5430     *
5431     * @param obj The image object
5432     * @return The image orientation @ref Elm_Image_Orient
5433     *
5434     * @see elm_image_orient_set()
5435     * @see @ref Elm_Image_Orient
5436     *
5437     * @ingroup Image
5438     */
5439    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5440    /**
5441     * Make the image 'editable'.
5442     *
5443     * @param obj Image object.
5444     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5445     *
5446     * This means the image is a valid drag target for drag and drop, and can be
5447     * cut or pasted too.
5448     *
5449     * @ingroup Image
5450     */
5451    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5452    /**
5453     * Check if the image 'editable'.
5454     *
5455     * @param obj Image object.
5456     * @return Editability.
5457     *
5458     * A return value of EINA_TRUE means the image is a valid drag target
5459     * for drag and drop, and can be cut or pasted too.
5460     *
5461     * @ingroup Image
5462     */
5463    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5464    /**
5465     * Get the basic Evas_Image object from this object (widget).
5466     *
5467     * @param obj The image object to get the inlined image from
5468     * @return The inlined image object, or NULL if none exists
5469     *
5470     * This function allows one to get the underlying @c Evas_Object of type
5471     * Image from this elementary widget. It can be useful to do things like get
5472     * the pixel data, save the image to a file, etc.
5473     *
5474     * @note Be careful to not manipulate it, as it is under control of
5475     * elementary.
5476     *
5477     * @ingroup Image
5478     */
5479    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5480    /**
5481     * Set whether the original aspect ratio of the image should be kept on resize.
5482     *
5483     * @param obj The image object.
5484     * @param retained @c EINA_TRUE if the image should retain the aspect,
5485     * @c EINA_FALSE otherwise.
5486     *
5487     * The original aspect ratio (width / height) of the image is usually
5488     * distorted to match the object's size. Enabling this option will retain
5489     * this original aspect, and the way that the image is fit into the object's
5490     * area depends on the option set by elm_image_fill_outside_set().
5491     *
5492     * @see elm_image_aspect_ratio_retained_get()
5493     * @see elm_image_fill_outside_set()
5494     *
5495     * @ingroup Image
5496     */
5497    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5498    /**
5499     * Get if the object retains the original aspect ratio.
5500     *
5501     * @param obj The image object.
5502     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5503     * otherwise.
5504     *
5505     * @ingroup Image
5506     */
5507    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5508
5509    /**
5510     * @}
5511     */
5512
5513    /* glview */
5514    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5515
5516    typedef enum _Elm_GLView_Mode
5517      {
5518         ELM_GLVIEW_ALPHA   = 1,
5519         ELM_GLVIEW_DEPTH   = 2,
5520         ELM_GLVIEW_STENCIL = 4
5521      } Elm_GLView_Mode;
5522
5523    /**
5524     * Defines a policy for the glview resizing.
5525     *
5526     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5527     */
5528    typedef enum _Elm_GLView_Resize_Policy
5529      {
5530         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5531         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5532      } Elm_GLView_Resize_Policy;
5533
5534    typedef enum _Elm_GLView_Render_Policy
5535      {
5536         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5537         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5538      } Elm_GLView_Render_Policy;
5539
5540    /**
5541     * @defgroup GLView
5542     *
5543     * A simple GLView widget that allows GL rendering.
5544     *
5545     * Signals that you can add callbacks for are:
5546     *
5547     * @{
5548     */
5549
5550    /**
5551     * Add a new glview to the parent
5552     *
5553     * @param parent The parent object
5554     * @return The new object or NULL if it cannot be created
5555     *
5556     * @ingroup GLView
5557     */
5558    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5559
5560    /**
5561     * Sets the size of the glview
5562     *
5563     * @param obj The glview object
5564     * @param width width of the glview object
5565     * @param height height of the glview object
5566     *
5567     * @ingroup GLView
5568     */
5569    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5570
5571    /**
5572     * Gets the size of the glview.
5573     *
5574     * @param obj The glview object
5575     * @param width width of the glview object
5576     * @param height height of the glview object
5577     *
5578     * Note that this function returns the actual image size of the
5579     * glview.  This means that when the scale policy is set to
5580     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5581     * size.
5582     *
5583     * @ingroup GLView
5584     */
5585    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5586
5587    /**
5588     * Gets the gl api struct for gl rendering
5589     *
5590     * @param obj The glview object
5591     * @return The api object or NULL if it cannot be created
5592     *
5593     * @ingroup GLView
5594     */
5595    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5596
5597    /**
5598     * Set the mode of the GLView. Supports Three simple modes.
5599     *
5600     * @param obj The glview object
5601     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5602     * @return True if set properly.
5603     *
5604     * @ingroup GLView
5605     */
5606    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5607
5608    /**
5609     * Set the resize policy for the glview object.
5610     *
5611     * @param obj The glview object.
5612     * @param policy The scaling policy.
5613     *
5614     * By default, the resize policy is set to
5615     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5616     * destroys the previous surface and recreates the newly specified
5617     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5618     * however, glview only scales the image object and not the underlying
5619     * GL Surface.
5620     *
5621     * @ingroup GLView
5622     */
5623    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5624
5625    /**
5626     * Set the render policy for the glview object.
5627     *
5628     * @param obj The glview object.
5629     * @param policy The render policy.
5630     *
5631     * By default, the render policy is set to
5632     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5633     * that during the render loop, glview is only redrawn if it needs
5634     * to be redrawn. (i.e. When it is visible) If the policy is set to
5635     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5636     * whether it is visible/need redrawing or not.
5637     *
5638     * @ingroup GLView
5639     */
5640    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5641
5642    /**
5643     * Set the init function that runs once in the main loop.
5644     *
5645     * @param obj The glview object.
5646     * @param func The init function to be registered.
5647     *
5648     * The registered init function gets called once during the render loop.
5649     *
5650     * @ingroup GLView
5651     */
5652    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5653
5654    /**
5655     * Set the render function that runs in the main loop.
5656     *
5657     * @param obj The glview object.
5658     * @param func The delete function to be registered.
5659     *
5660     * The registered del function gets called when GLView object is deleted.
5661     *
5662     * @ingroup GLView
5663     */
5664    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5665
5666    /**
5667     * Set the resize function that gets called when resize happens.
5668     *
5669     * @param obj The glview object.
5670     * @param func The resize function to be registered.
5671     *
5672     * @ingroup GLView
5673     */
5674    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5675
5676    /**
5677     * Set the render function that runs in the main loop.
5678     *
5679     * @param obj The glview object.
5680     * @param func The render function to be registered.
5681     *
5682     * @ingroup GLView
5683     */
5684    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5685
5686    /**
5687     * Notifies that there has been changes in the GLView.
5688     *
5689     * @param obj The glview object.
5690     *
5691     * @ingroup GLView
5692     */
5693    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5694
5695    /**
5696     * @}
5697     */
5698
5699    /* box */
5700    /**
5701     * @defgroup Box Box
5702     *
5703     * @image html img/widget/box/preview-00.png
5704     * @image latex img/widget/box/preview-00.eps width=\textwidth
5705     *
5706     * @image html img/box.png
5707     * @image latex img/box.eps width=\textwidth
5708     *
5709     * A box arranges objects in a linear fashion, governed by a layout function
5710     * that defines the details of this arrangement.
5711     *
5712     * By default, the box will use an internal function to set the layout to
5713     * a single row, either vertical or horizontal. This layout is affected
5714     * by a number of parameters, such as the homogeneous flag set by
5715     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5716     * elm_box_align_set() and the hints set to each object in the box.
5717     *
5718     * For this default layout, it's possible to change the orientation with
5719     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5720     * placing its elements ordered from top to bottom. When horizontal is set,
5721     * the order will go from left to right. If the box is set to be
5722     * homogeneous, every object in it will be assigned the same space, that
5723     * of the largest object. Padding can be used to set some spacing between
5724     * the cell given to each object. The alignment of the box, set with
5725     * elm_box_align_set(), determines how the bounding box of all the elements
5726     * will be placed within the space given to the box widget itself.
5727     *
5728     * The size hints of each object also affect how they are placed and sized
5729     * within the box. evas_object_size_hint_min_set() will give the minimum
5730     * size the object can have, and the box will use it as the basis for all
5731     * latter calculations. Elementary widgets set their own minimum size as
5732     * needed, so there's rarely any need to use it manually.
5733     *
5734     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5735     * used to tell whether the object will be allocated the minimum size it
5736     * needs or if the space given to it should be expanded. It's important
5737     * to realize that expanding the size given to the object is not the same
5738     * thing as resizing the object. It could very well end being a small
5739     * widget floating in a much larger empty space. If not set, the weight
5740     * for objects will normally be 0.0 for both axis, meaning the widget will
5741     * not be expanded. To take as much space possible, set the weight to
5742     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5743     *
5744     * Besides how much space each object is allocated, it's possible to control
5745     * how the widget will be placed within that space using
5746     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5747     * for both axis, meaning the object will be centered, but any value from
5748     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5749     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5750     * is -1.0, means the object will be resized to fill the entire space it
5751     * was allocated.
5752     *
5753     * In addition, customized functions to define the layout can be set, which
5754     * allow the application developer to organize the objects within the box
5755     * in any number of ways.
5756     *
5757     * The special elm_box_layout_transition() function can be used
5758     * to switch from one layout to another, animating the motion of the
5759     * children of the box.
5760     *
5761     * @note Objects should not be added to box objects using _add() calls.
5762     *
5763     * Some examples on how to use boxes follow:
5764     * @li @ref box_example_01
5765     * @li @ref box_example_02
5766     *
5767     * @{
5768     */
5769    /**
5770     * @typedef Elm_Box_Transition
5771     *
5772     * Opaque handler containing the parameters to perform an animated
5773     * transition of the layout the box uses.
5774     *
5775     * @see elm_box_transition_new()
5776     * @see elm_box_layout_set()
5777     * @see elm_box_layout_transition()
5778     */
5779    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5780
5781    /**
5782     * Add a new box to the parent
5783     *
5784     * By default, the box will be in vertical mode and non-homogeneous.
5785     *
5786     * @param parent The parent object
5787     * @return The new object or NULL if it cannot be created
5788     */
5789    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5790    /**
5791     * Set the horizontal orientation
5792     *
5793     * By default, box object arranges their contents vertically from top to
5794     * bottom.
5795     * By calling this function with @p horizontal as EINA_TRUE, the box will
5796     * become horizontal, arranging contents from left to right.
5797     *
5798     * @note This flag is ignored if a custom layout function is set.
5799     *
5800     * @param obj The box object
5801     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5802     * EINA_FALSE = vertical)
5803     */
5804    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5805    /**
5806     * Get the horizontal orientation
5807     *
5808     * @param obj The box object
5809     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5810     */
5811    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5812    /**
5813     * Set the box to arrange its children homogeneously
5814     *
5815     * If enabled, homogeneous layout makes all items the same size, according
5816     * to the size of the largest of its children.
5817     *
5818     * @note This flag is ignored if a custom layout function is set.
5819     *
5820     * @param obj The box object
5821     * @param homogeneous The homogeneous flag
5822     */
5823    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5824    /**
5825     * Get whether the box is using homogeneous mode or not
5826     *
5827     * @param obj The box object
5828     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5829     */
5830    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5831    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5832    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5833    /**
5834     * Add an object to the beginning of the pack list
5835     *
5836     * Pack @p subobj into the box @p obj, placing it first in the list of
5837     * children objects. The actual position the object will get on screen
5838     * depends on the layout used. If no custom layout is set, it will be at
5839     * the top or left, depending if the box is vertical or horizontal,
5840     * respectively.
5841     *
5842     * @param obj The box object
5843     * @param subobj The object to add to the box
5844     *
5845     * @see elm_box_pack_end()
5846     * @see elm_box_pack_before()
5847     * @see elm_box_pack_after()
5848     * @see elm_box_unpack()
5849     * @see elm_box_unpack_all()
5850     * @see elm_box_clear()
5851     */
5852    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5853    /**
5854     * Add an object at the end of the pack list
5855     *
5856     * Pack @p subobj into the box @p obj, placing it last in the list of
5857     * children objects. The actual position the object will get on screen
5858     * depends on the layout used. If no custom layout is set, it will be at
5859     * the bottom or right, depending if the box is vertical or horizontal,
5860     * respectively.
5861     *
5862     * @param obj The box object
5863     * @param subobj The object to add to the box
5864     *
5865     * @see elm_box_pack_start()
5866     * @see elm_box_pack_before()
5867     * @see elm_box_pack_after()
5868     * @see elm_box_unpack()
5869     * @see elm_box_unpack_all()
5870     * @see elm_box_clear()
5871     */
5872    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5873    /**
5874     * Adds an object to the box before the indicated object
5875     *
5876     * This will add the @p subobj to the box indicated before the object
5877     * indicated with @p before. If @p before is not already in the box, results
5878     * are undefined. Before means either to the left of the indicated object or
5879     * above it depending on orientation.
5880     *
5881     * @param obj The box object
5882     * @param subobj The object to add to the box
5883     * @param before The object before which to add it
5884     *
5885     * @see elm_box_pack_start()
5886     * @see elm_box_pack_end()
5887     * @see elm_box_pack_after()
5888     * @see elm_box_unpack()
5889     * @see elm_box_unpack_all()
5890     * @see elm_box_clear()
5891     */
5892    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5893    /**
5894     * Adds an object to the box after the indicated object
5895     *
5896     * This will add the @p subobj to the box indicated after the object
5897     * indicated with @p after. If @p after is not already in the box, results
5898     * are undefined. After means either to the right of the indicated object or
5899     * below it depending on orientation.
5900     *
5901     * @param obj The box object
5902     * @param subobj The object to add to the box
5903     * @param after The object after which to add it
5904     *
5905     * @see elm_box_pack_start()
5906     * @see elm_box_pack_end()
5907     * @see elm_box_pack_before()
5908     * @see elm_box_unpack()
5909     * @see elm_box_unpack_all()
5910     * @see elm_box_clear()
5911     */
5912    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5913    /**
5914     * Clear the box of all children
5915     *
5916     * Remove all the elements contained by the box, deleting the respective
5917     * objects.
5918     *
5919     * @param obj The box object
5920     *
5921     * @see elm_box_unpack()
5922     * @see elm_box_unpack_all()
5923     */
5924    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5925    /**
5926     * Unpack a box item
5927     *
5928     * Remove the object given by @p subobj from the box @p obj without
5929     * deleting it.
5930     *
5931     * @param obj The box object
5932     *
5933     * @see elm_box_unpack_all()
5934     * @see elm_box_clear()
5935     */
5936    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5937    /**
5938     * Remove all items from the box, without deleting them
5939     *
5940     * Clear the box from all children, but don't delete the respective objects.
5941     * If no other references of the box children exist, the objects will never
5942     * be deleted, and thus the application will leak the memory. Make sure
5943     * when using this function that you hold a reference to all the objects
5944     * in the box @p obj.
5945     *
5946     * @param obj The box object
5947     *
5948     * @see elm_box_clear()
5949     * @see elm_box_unpack()
5950     */
5951    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5952    /**
5953     * Retrieve a list of the objects packed into the box
5954     *
5955     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5956     * The order of the list corresponds to the packing order the box uses.
5957     *
5958     * You must free this list with eina_list_free() once you are done with it.
5959     *
5960     * @param obj The box object
5961     */
5962    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5963    /**
5964     * Set the space (padding) between the box's elements.
5965     *
5966     * Extra space in pixels that will be added between a box child and its
5967     * neighbors after its containing cell has been calculated. This padding
5968     * is set for all elements in the box, besides any possible padding that
5969     * individual elements may have through their size hints.
5970     *
5971     * @param obj The box object
5972     * @param horizontal The horizontal space between elements
5973     * @param vertical The vertical space between elements
5974     */
5975    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5976    /**
5977     * Get the space (padding) between the box's elements.
5978     *
5979     * @param obj The box object
5980     * @param horizontal The horizontal space between elements
5981     * @param vertical The vertical space between elements
5982     *
5983     * @see elm_box_padding_set()
5984     */
5985    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5986    /**
5987     * Set the alignment of the whole bouding box of contents.
5988     *
5989     * Sets how the bounding box containing all the elements of the box, after
5990     * their sizes and position has been calculated, will be aligned within
5991     * the space given for the whole box widget.
5992     *
5993     * @param obj The box object
5994     * @param horizontal The horizontal alignment of elements
5995     * @param vertical The vertical alignment of elements
5996     */
5997    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5998    /**
5999     * Get the alignment of the whole bouding box of contents.
6000     *
6001     * @param obj The box object
6002     * @param horizontal The horizontal alignment of elements
6003     * @param vertical The vertical alignment of elements
6004     *
6005     * @see elm_box_align_set()
6006     */
6007    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6008
6009    /**
6010     * Force the box to recalculate its children packing.
6011     *
6012     * If any children was added or removed, box will not calculate the
6013     * values immediately rather leaving it to the next main loop
6014     * iteration. While this is great as it would save lots of
6015     * recalculation, whenever you need to get the position of a just
6016     * added item you must force recalculate before doing so.
6017     *
6018     * @param obj The box object.
6019     */
6020    EAPI void                 elm_box_recalculate(Evas_Object *obj);
6021
6022    /**
6023     * Set the layout defining function to be used by the box
6024     *
6025     * Whenever anything changes that requires the box in @p obj to recalculate
6026     * the size and position of its elements, the function @p cb will be called
6027     * to determine what the layout of the children will be.
6028     *
6029     * Once a custom function is set, everything about the children layout
6030     * is defined by it. The flags set by elm_box_horizontal_set() and
6031     * elm_box_homogeneous_set() no longer have any meaning, and the values
6032     * given by elm_box_padding_set() and elm_box_align_set() are up to this
6033     * layout function to decide if they are used and how. These last two
6034     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6035     * passed to @p cb. The @c Evas_Object the function receives is not the
6036     * Elementary widget, but the internal Evas Box it uses, so none of the
6037     * functions described here can be used on it.
6038     *
6039     * Any of the layout functions in @c Evas can be used here, as well as the
6040     * special elm_box_layout_transition().
6041     *
6042     * The final @p data argument received by @p cb is the same @p data passed
6043     * here, and the @p free_data function will be called to free it
6044     * whenever the box is destroyed or another layout function is set.
6045     *
6046     * Setting @p cb to NULL will revert back to the default layout function.
6047     *
6048     * @param obj The box object
6049     * @param cb The callback function used for layout
6050     * @param data Data that will be passed to layout function
6051     * @param free_data Function called to free @p data
6052     *
6053     * @see elm_box_layout_transition()
6054     */
6055    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);
6056    /**
6057     * Special layout function that animates the transition from one layout to another
6058     *
6059     * Normally, when switching the layout function for a box, this will be
6060     * reflected immediately on screen on the next render, but it's also
6061     * possible to do this through an animated transition.
6062     *
6063     * This is done by creating an ::Elm_Box_Transition and setting the box
6064     * layout to this function.
6065     *
6066     * For example:
6067     * @code
6068     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6069     *                            evas_object_box_layout_vertical, // start
6070     *                            NULL, // data for initial layout
6071     *                            NULL, // free function for initial data
6072     *                            evas_object_box_layout_horizontal, // end
6073     *                            NULL, // data for final layout
6074     *                            NULL, // free function for final data
6075     *                            anim_end, // will be called when animation ends
6076     *                            NULL); // data for anim_end function\
6077     * elm_box_layout_set(box, elm_box_layout_transition, t,
6078     *                    elm_box_transition_free);
6079     * @endcode
6080     *
6081     * @note This function can only be used with elm_box_layout_set(). Calling
6082     * it directly will not have the expected results.
6083     *
6084     * @see elm_box_transition_new
6085     * @see elm_box_transition_free
6086     * @see elm_box_layout_set
6087     */
6088    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6089    /**
6090     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6091     *
6092     * If you want to animate the change from one layout to another, you need
6093     * to set the layout function of the box to elm_box_layout_transition(),
6094     * passing as user data to it an instance of ::Elm_Box_Transition with the
6095     * necessary information to perform this animation. The free function to
6096     * set for the layout is elm_box_transition_free().
6097     *
6098     * The parameters to create an ::Elm_Box_Transition sum up to how long
6099     * will it be, in seconds, a layout function to describe the initial point,
6100     * another for the final position of the children and one function to be
6101     * called when the whole animation ends. This last function is useful to
6102     * set the definitive layout for the box, usually the same as the end
6103     * layout for the animation, but could be used to start another transition.
6104     *
6105     * @param start_layout The layout function that will be used to start the animation
6106     * @param start_layout_data The data to be passed the @p start_layout function
6107     * @param start_layout_free_data Function to free @p start_layout_data
6108     * @param end_layout The layout function that will be used to end the animation
6109     * @param end_layout_free_data The data to be passed the @p end_layout function
6110     * @param end_layout_free_data Function to free @p end_layout_data
6111     * @param transition_end_cb Callback function called when animation ends
6112     * @param transition_end_data Data to be passed to @p transition_end_cb
6113     * @return An instance of ::Elm_Box_Transition
6114     *
6115     * @see elm_box_transition_new
6116     * @see elm_box_layout_transition
6117     */
6118    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);
6119    /**
6120     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6121     *
6122     * This function is mostly useful as the @c free_data parameter in
6123     * elm_box_layout_set() when elm_box_layout_transition().
6124     *
6125     * @param data The Elm_Box_Transition instance to be freed.
6126     *
6127     * @see elm_box_transition_new
6128     * @see elm_box_layout_transition
6129     */
6130    EAPI void                elm_box_transition_free(void *data);
6131    /**
6132     * @}
6133     */
6134
6135    /* button */
6136    /**
6137     * @defgroup Button Button
6138     *
6139     * @image html img/widget/button/preview-00.png
6140     * @image latex img/widget/button/preview-00.eps
6141     * @image html img/widget/button/preview-01.png
6142     * @image latex img/widget/button/preview-01.eps
6143     * @image html img/widget/button/preview-02.png
6144     * @image latex img/widget/button/preview-02.eps
6145     *
6146     * This is a push-button. Press it and run some function. It can contain
6147     * a simple label and icon object and it also has an autorepeat feature.
6148     *
6149     * This widgets emits the following signals:
6150     * @li "clicked": the user clicked the button (press/release).
6151     * @li "repeated": the user pressed the button without releasing it.
6152     * @li "pressed": button was pressed.
6153     * @li "unpressed": button was released after being pressed.
6154     * In all three cases, the @c event parameter of the callback will be
6155     * @c NULL.
6156     *
6157     * Also, defined in the default theme, the button has the following styles
6158     * available:
6159     * @li default: a normal button.
6160     * @li anchor: Like default, but the button fades away when the mouse is not
6161     * over it, leaving only the text or icon.
6162     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6163     * continuous look across its options.
6164     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6165     *
6166     * Default contents parts of the button widget that you can use for are:
6167     * @li "elm.swallow.content" - A icon of the button
6168     *
6169     * Default text parts of the button widget that you can use for are:
6170     * @li "elm.text" - Label of the button
6171     *
6172     * Follow through a complete example @ref button_example_01 "here".
6173     * @{
6174     */
6175    /**
6176     * Add a new button to the parent's canvas
6177     *
6178     * @param parent The parent object
6179     * @return The new object or NULL if it cannot be created
6180     */
6181    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6182    /**
6183     * Set the label used in the button
6184     *
6185     * The passed @p label can be NULL to clean any existing text in it and
6186     * leave the button as an icon only object.
6187     *
6188     * @param obj The button object
6189     * @param label The text will be written on the button
6190     * @deprecated use elm_object_text_set() instead.
6191     */
6192    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6193    /**
6194     * Get the label set for the button
6195     *
6196     * The string returned is an internal pointer and should not be freed or
6197     * altered. It will also become invalid when the button is destroyed.
6198     * The string returned, if not NULL, is a stringshare, so if you need to
6199     * keep it around even after the button is destroyed, you can use
6200     * eina_stringshare_ref().
6201     *
6202     * @param obj The button object
6203     * @return The text set to the label, or NULL if nothing is set
6204     * @deprecated use elm_object_text_set() instead.
6205     */
6206    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6207    /**
6208     * Set the icon used for the button
6209     *
6210     * Setting a new icon will delete any other that was previously set, making
6211     * any reference to them invalid. If you need to maintain the previous
6212     * object alive, unset it first with elm_button_icon_unset().
6213     *
6214     * @param obj The button object
6215     * @param icon The icon object for the button
6216     */
6217    EINA_DEPRECATED EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6218    /**
6219     * Get the icon used for the button
6220     *
6221     * Return the icon object which is set for this widget. If the button is
6222     * destroyed or another icon is set, the returned object will be deleted
6223     * and any reference to it will be invalid.
6224     *
6225     * @param obj The button object
6226     * @return The icon object that is being used
6227     *
6228     * @see elm_button_icon_unset()
6229     */
6230    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6231    /**
6232     * Remove the icon set without deleting it and return the object
6233     *
6234     * This function drops the reference the button holds of the icon object
6235     * and returns this last object. It is used in case you want to remove any
6236     * icon, or set another one, without deleting the actual object. The button
6237     * will be left without an icon set.
6238     *
6239     * @param obj The button object
6240     * @return The icon object that was being used
6241     */
6242    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6243    /**
6244     * Turn on/off the autorepeat event generated when the button is kept pressed
6245     *
6246     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6247     * signal when they are clicked.
6248     *
6249     * When on, keeping a button pressed will continuously emit a @c repeated
6250     * signal until the button is released. The time it takes until it starts
6251     * emitting the signal is given by
6252     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6253     * new emission by elm_button_autorepeat_gap_timeout_set().
6254     *
6255     * @param obj The button object
6256     * @param on  A bool to turn on/off the event
6257     */
6258    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6259    /**
6260     * Get whether the autorepeat feature is enabled
6261     *
6262     * @param obj The button object
6263     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6264     *
6265     * @see elm_button_autorepeat_set()
6266     */
6267    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6268    /**
6269     * Set the initial timeout before the autorepeat event is generated
6270     *
6271     * Sets the timeout, in seconds, since the button is pressed until the
6272     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6273     * won't be any delay and the even will be fired the moment the button is
6274     * pressed.
6275     *
6276     * @param obj The button object
6277     * @param t   Timeout in seconds
6278     *
6279     * @see elm_button_autorepeat_set()
6280     * @see elm_button_autorepeat_gap_timeout_set()
6281     */
6282    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6283    /**
6284     * Get the initial timeout before the autorepeat event is generated
6285     *
6286     * @param obj The button object
6287     * @return Timeout in seconds
6288     *
6289     * @see elm_button_autorepeat_initial_timeout_set()
6290     */
6291    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6292    /**
6293     * Set the interval between each generated autorepeat event
6294     *
6295     * After the first @c repeated event is fired, all subsequent ones will
6296     * follow after a delay of @p t seconds for each.
6297     *
6298     * @param obj The button object
6299     * @param t   Interval in seconds
6300     *
6301     * @see elm_button_autorepeat_initial_timeout_set()
6302     */
6303    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6304    /**
6305     * Get the interval between each generated autorepeat event
6306     *
6307     * @param obj The button object
6308     * @return Interval in seconds
6309     */
6310    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6311    /**
6312     * @}
6313     */
6314
6315    /**
6316     * @defgroup File_Selector_Button File Selector Button
6317     *
6318     * @image html img/widget/fileselector_button/preview-00.png
6319     * @image latex img/widget/fileselector_button/preview-00.eps
6320     * @image html img/widget/fileselector_button/preview-01.png
6321     * @image latex img/widget/fileselector_button/preview-01.eps
6322     * @image html img/widget/fileselector_button/preview-02.png
6323     * @image latex img/widget/fileselector_button/preview-02.eps
6324     *
6325     * This is a button that, when clicked, creates an Elementary
6326     * window (or inner window) <b> with a @ref Fileselector "file
6327     * selector widget" within</b>. When a file is chosen, the (inner)
6328     * window is closed and the button emits a signal having the
6329     * selected file as it's @c event_info.
6330     *
6331     * This widget encapsulates operations on its internal file
6332     * selector on its own API. There is less control over its file
6333     * selector than that one would have instatiating one directly.
6334     *
6335     * The following styles are available for this button:
6336     * @li @c "default"
6337     * @li @c "anchor"
6338     * @li @c "hoversel_vertical"
6339     * @li @c "hoversel_vertical_entry"
6340     *
6341     * Smart callbacks one can register to:
6342     * - @c "file,chosen" - the user has selected a path, whose string
6343     *   pointer comes as the @c event_info data (a stringshared
6344     *   string)
6345     *
6346     * Here is an example on its usage:
6347     * @li @ref fileselector_button_example
6348     *
6349     * @see @ref File_Selector_Entry for a similar widget.
6350     * @{
6351     */
6352
6353    /**
6354     * Add a new file selector button widget to the given parent
6355     * Elementary (container) object
6356     *
6357     * @param parent The parent object
6358     * @return a new file selector button widget handle or @c NULL, on
6359     * errors
6360     */
6361    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6362
6363    /**
6364     * Set the label for a given file selector button widget
6365     *
6366     * @param obj The file selector button widget
6367     * @param label The text label to be displayed on @p obj
6368     *
6369     * @deprecated use elm_object_text_set() instead.
6370     */
6371    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6372
6373    /**
6374     * Get the label set for a given file selector button widget
6375     *
6376     * @param obj The file selector button widget
6377     * @return The button label
6378     *
6379     * @deprecated use elm_object_text_set() instead.
6380     */
6381    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6382
6383    /**
6384     * Set the icon on a given file selector button widget
6385     *
6386     * @param obj The file selector button widget
6387     * @param icon The icon object for the button
6388     *
6389     * Once the icon object is set, a previously set one will be
6390     * deleted. If you want to keep the latter, use the
6391     * elm_fileselector_button_icon_unset() function.
6392     *
6393     * @see elm_fileselector_button_icon_get()
6394     */
6395    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6396
6397    /**
6398     * Get the icon set for a given file selector button widget
6399     *
6400     * @param obj The file selector button widget
6401     * @return The icon object currently set on @p obj or @c NULL, if
6402     * none is
6403     *
6404     * @see elm_fileselector_button_icon_set()
6405     */
6406    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6407
6408    /**
6409     * Unset the icon used in a given file selector button widget
6410     *
6411     * @param obj The file selector button widget
6412     * @return The icon object that was being used on @p obj or @c
6413     * NULL, on errors
6414     *
6415     * Unparent and return the icon object which was set for this
6416     * widget.
6417     *
6418     * @see elm_fileselector_button_icon_set()
6419     */
6420    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6421
6422    /**
6423     * Set the title for a given file selector button widget's window
6424     *
6425     * @param obj The file selector button widget
6426     * @param title The title string
6427     *
6428     * This will change the window's title, when the file selector pops
6429     * out after a click on the button. Those windows have the default
6430     * (unlocalized) value of @c "Select a file" as titles.
6431     *
6432     * @note It will only take any effect if the file selector
6433     * button widget is @b not under "inwin mode".
6434     *
6435     * @see elm_fileselector_button_window_title_get()
6436     */
6437    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6438
6439    /**
6440     * Get the title set for a given file selector button widget's
6441     * window
6442     *
6443     * @param obj The file selector button widget
6444     * @return Title of the file selector button's window
6445     *
6446     * @see elm_fileselector_button_window_title_get() for more details
6447     */
6448    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6449
6450    /**
6451     * Set the size of a given file selector button widget's window,
6452     * holding the file selector itself.
6453     *
6454     * @param obj The file selector button widget
6455     * @param width The window's width
6456     * @param height The window's height
6457     *
6458     * @note it will only take any effect if the file selector button
6459     * widget is @b not under "inwin mode". The default size for the
6460     * window (when applicable) is 400x400 pixels.
6461     *
6462     * @see elm_fileselector_button_window_size_get()
6463     */
6464    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6465
6466    /**
6467     * Get the size of a given file selector button widget's window,
6468     * holding the file selector itself.
6469     *
6470     * @param obj The file selector button widget
6471     * @param width Pointer into which to store the width value
6472     * @param height Pointer into which to store the height value
6473     *
6474     * @note Use @c NULL pointers on the size values you're not
6475     * interested in: they'll be ignored by the function.
6476     *
6477     * @see elm_fileselector_button_window_size_set(), for more details
6478     */
6479    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6480
6481    /**
6482     * Set the initial file system path for a given file selector
6483     * button widget
6484     *
6485     * @param obj The file selector button widget
6486     * @param path The path string
6487     *
6488     * It must be a <b>directory</b> path, which will have the contents
6489     * displayed initially in the file selector's view, when invoked
6490     * from @p obj. The default initial path is the @c "HOME"
6491     * environment variable's value.
6492     *
6493     * @see elm_fileselector_button_path_get()
6494     */
6495    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6496
6497    /**
6498     * Get the initial file system path set for a given file selector
6499     * button widget
6500     *
6501     * @param obj The file selector button widget
6502     * @return path The path string
6503     *
6504     * @see elm_fileselector_button_path_set() for more details
6505     */
6506    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6507
6508    /**
6509     * Enable/disable a tree view in the given file selector button
6510     * widget's internal file selector
6511     *
6512     * @param obj The file selector button widget
6513     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6514     * disable
6515     *
6516     * This has the same effect as elm_fileselector_expandable_set(),
6517     * but now applied to a file selector button's internal file
6518     * selector.
6519     *
6520     * @note There's no way to put a file selector button's internal
6521     * file selector in "grid mode", as one may do with "pure" file
6522     * selectors.
6523     *
6524     * @see elm_fileselector_expandable_get()
6525     */
6526    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6527
6528    /**
6529     * Get whether tree view is enabled for the given file selector
6530     * button widget's internal file selector
6531     *
6532     * @param obj The file selector button widget
6533     * @return @c EINA_TRUE if @p obj widget's internal file selector
6534     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6535     *
6536     * @see elm_fileselector_expandable_set() for more details
6537     */
6538    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6539
6540    /**
6541     * Set whether a given file selector button widget's internal file
6542     * selector is to display folders only or the directory contents,
6543     * as well.
6544     *
6545     * @param obj The file selector button widget
6546     * @param only @c EINA_TRUE to make @p obj widget's internal file
6547     * selector only display directories, @c EINA_FALSE to make files
6548     * to be displayed in it too
6549     *
6550     * This has the same effect as elm_fileselector_folder_only_set(),
6551     * but now applied to a file selector button's internal file
6552     * selector.
6553     *
6554     * @see elm_fileselector_folder_only_get()
6555     */
6556    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6557
6558    /**
6559     * Get whether a given file selector button widget's internal file
6560     * selector is displaying folders only or the directory contents,
6561     * as well.
6562     *
6563     * @param obj The file selector button widget
6564     * @return @c EINA_TRUE if @p obj widget's internal file
6565     * selector is only displaying directories, @c EINA_FALSE if files
6566     * are being displayed in it too (and on errors)
6567     *
6568     * @see elm_fileselector_button_folder_only_set() for more details
6569     */
6570    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6571
6572    /**
6573     * Enable/disable the file name entry box where the user can type
6574     * in a name for a file, in a given file selector button widget's
6575     * internal file selector.
6576     *
6577     * @param obj The file selector button widget
6578     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6579     * file selector a "saving dialog", @c EINA_FALSE otherwise
6580     *
6581     * This has the same effect as elm_fileselector_is_save_set(),
6582     * but now applied to a file selector button's internal file
6583     * selector.
6584     *
6585     * @see elm_fileselector_is_save_get()
6586     */
6587    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6588
6589    /**
6590     * Get whether the given file selector button widget's internal
6591     * file selector is in "saving dialog" mode
6592     *
6593     * @param obj The file selector button widget
6594     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6595     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6596     * errors)
6597     *
6598     * @see elm_fileselector_button_is_save_set() for more details
6599     */
6600    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6601
6602    /**
6603     * Set whether a given file selector button widget's internal file
6604     * selector will raise an Elementary "inner window", instead of a
6605     * dedicated Elementary window. By default, it won't.
6606     *
6607     * @param obj The file selector button widget
6608     * @param value @c EINA_TRUE to make it use an inner window, @c
6609     * EINA_TRUE to make it use a dedicated window
6610     *
6611     * @see elm_win_inwin_add() for more information on inner windows
6612     * @see elm_fileselector_button_inwin_mode_get()
6613     */
6614    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6615
6616    /**
6617     * Get whether a given file selector button widget's internal file
6618     * selector will raise an Elementary "inner window", instead of a
6619     * dedicated Elementary window.
6620     *
6621     * @param obj The file selector button widget
6622     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6623     * if it will use a dedicated window
6624     *
6625     * @see elm_fileselector_button_inwin_mode_set() for more details
6626     */
6627    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6628
6629    /**
6630     * @}
6631     */
6632
6633     /**
6634     * @defgroup File_Selector_Entry File Selector Entry
6635     *
6636     * @image html img/widget/fileselector_entry/preview-00.png
6637     * @image latex img/widget/fileselector_entry/preview-00.eps
6638     *
6639     * This is an entry made to be filled with or display a <b>file
6640     * system path string</b>. Besides the entry itself, the widget has
6641     * a @ref File_Selector_Button "file selector button" on its side,
6642     * which will raise an internal @ref Fileselector "file selector widget",
6643     * when clicked, for path selection aided by file system
6644     * navigation.
6645     *
6646     * This file selector may appear in an Elementary window or in an
6647     * inner window. When a file is chosen from it, the (inner) window
6648     * is closed and the selected file's path string is exposed both as
6649     * an smart event and as the new text on the entry.
6650     *
6651     * This widget encapsulates operations on its internal file
6652     * selector on its own API. There is less control over its file
6653     * selector than that one would have instatiating one directly.
6654     *
6655     * Smart callbacks one can register to:
6656     * - @c "changed" - The text within the entry was changed
6657     * - @c "activated" - The entry has had editing finished and
6658     *   changes are to be "committed"
6659     * - @c "press" - The entry has been clicked
6660     * - @c "longpressed" - The entry has been clicked (and held) for a
6661     *   couple seconds
6662     * - @c "clicked" - The entry has been clicked
6663     * - @c "clicked,double" - The entry has been double clicked
6664     * - @c "focused" - The entry has received focus
6665     * - @c "unfocused" - The entry has lost focus
6666     * - @c "selection,paste" - A paste action has occurred on the
6667     *   entry
6668     * - @c "selection,copy" - A copy action has occurred on the entry
6669     * - @c "selection,cut" - A cut action has occurred on the entry
6670     * - @c "unpressed" - The file selector entry's button was released
6671     *   after being pressed.
6672     * - @c "file,chosen" - The user has selected a path via the file
6673     *   selector entry's internal file selector, whose string pointer
6674     *   comes as the @c event_info data (a stringshared string)
6675     *
6676     * Here is an example on its usage:
6677     * @li @ref fileselector_entry_example
6678     *
6679     * @see @ref File_Selector_Button for a similar widget.
6680     * @{
6681     */
6682
6683    /**
6684     * Add a new file selector entry widget to the given parent
6685     * Elementary (container) object
6686     *
6687     * @param parent The parent object
6688     * @return a new file selector entry widget handle or @c NULL, on
6689     * errors
6690     */
6691    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6692
6693    /**
6694     * Set the label for a given file selector entry widget's button
6695     *
6696     * @param obj The file selector entry widget
6697     * @param label The text label to be displayed on @p obj widget's
6698     * button
6699     *
6700     * @deprecated use elm_object_text_set() instead.
6701     */
6702    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6703
6704    /**
6705     * Get the label set for a given file selector entry widget's button
6706     *
6707     * @param obj The file selector entry widget
6708     * @return The widget button's label
6709     *
6710     * @deprecated use elm_object_text_set() instead.
6711     */
6712    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6713
6714    /**
6715     * Set the icon on a given file selector entry widget's button
6716     *
6717     * @param obj The file selector entry widget
6718     * @param icon The icon object for the entry's button
6719     *
6720     * Once the icon object is set, a previously set one will be
6721     * deleted. If you want to keep the latter, use the
6722     * elm_fileselector_entry_button_icon_unset() function.
6723     *
6724     * @see elm_fileselector_entry_button_icon_get()
6725     */
6726    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6727
6728    /**
6729     * Get the icon set for a given file selector entry widget's button
6730     *
6731     * @param obj The file selector entry widget
6732     * @return The icon object currently set on @p obj widget's button
6733     * or @c NULL, if none is
6734     *
6735     * @see elm_fileselector_entry_button_icon_set()
6736     */
6737    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6738
6739    /**
6740     * Unset the icon used in a given file selector entry widget's
6741     * button
6742     *
6743     * @param obj The file selector entry widget
6744     * @return The icon object that was being used on @p obj widget's
6745     * button or @c NULL, on errors
6746     *
6747     * Unparent and return the icon object which was set for this
6748     * widget's button.
6749     *
6750     * @see elm_fileselector_entry_button_icon_set()
6751     */
6752    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6753
6754    /**
6755     * Set the title for a given file selector entry widget's window
6756     *
6757     * @param obj The file selector entry widget
6758     * @param title The title string
6759     *
6760     * This will change the window's title, when the file selector pops
6761     * out after a click on the entry's button. Those windows have the
6762     * default (unlocalized) value of @c "Select a file" as titles.
6763     *
6764     * @note It will only take any effect if the file selector
6765     * entry widget is @b not under "inwin mode".
6766     *
6767     * @see elm_fileselector_entry_window_title_get()
6768     */
6769    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6770
6771    /**
6772     * Get the title set for a given file selector entry widget's
6773     * window
6774     *
6775     * @param obj The file selector entry widget
6776     * @return Title of the file selector entry's window
6777     *
6778     * @see elm_fileselector_entry_window_title_get() for more details
6779     */
6780    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6781
6782    /**
6783     * Set the size of a given file selector entry widget's window,
6784     * holding the file selector itself.
6785     *
6786     * @param obj The file selector entry widget
6787     * @param width The window's width
6788     * @param height The window's height
6789     *
6790     * @note it will only take any effect if the file selector entry
6791     * widget is @b not under "inwin mode". The default size for the
6792     * window (when applicable) is 400x400 pixels.
6793     *
6794     * @see elm_fileselector_entry_window_size_get()
6795     */
6796    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6797
6798    /**
6799     * Get the size of a given file selector entry widget's window,
6800     * holding the file selector itself.
6801     *
6802     * @param obj The file selector entry widget
6803     * @param width Pointer into which to store the width value
6804     * @param height Pointer into which to store the height value
6805     *
6806     * @note Use @c NULL pointers on the size values you're not
6807     * interested in: they'll be ignored by the function.
6808     *
6809     * @see elm_fileselector_entry_window_size_set(), for more details
6810     */
6811    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6812
6813    /**
6814     * Set the initial file system path and the entry's path string for
6815     * a given file selector entry widget
6816     *
6817     * @param obj The file selector entry widget
6818     * @param path The path string
6819     *
6820     * It must be a <b>directory</b> path, which will have the contents
6821     * displayed initially in the file selector's view, when invoked
6822     * from @p obj. The default initial path is the @c "HOME"
6823     * environment variable's value.
6824     *
6825     * @see elm_fileselector_entry_path_get()
6826     */
6827    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6828
6829    /**
6830     * Get the entry's path string for a given file selector entry
6831     * widget
6832     *
6833     * @param obj The file selector entry widget
6834     * @return path The path string
6835     *
6836     * @see elm_fileselector_entry_path_set() for more details
6837     */
6838    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6839
6840    /**
6841     * Enable/disable a tree view in the given file selector entry
6842     * widget's internal file selector
6843     *
6844     * @param obj The file selector entry widget
6845     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6846     * disable
6847     *
6848     * This has the same effect as elm_fileselector_expandable_set(),
6849     * but now applied to a file selector entry's internal file
6850     * selector.
6851     *
6852     * @note There's no way to put a file selector entry's internal
6853     * file selector in "grid mode", as one may do with "pure" file
6854     * selectors.
6855     *
6856     * @see elm_fileselector_expandable_get()
6857     */
6858    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6859
6860    /**
6861     * Get whether tree view is enabled for the given file selector
6862     * entry widget's internal file selector
6863     *
6864     * @param obj The file selector entry widget
6865     * @return @c EINA_TRUE if @p obj widget's internal file selector
6866     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6867     *
6868     * @see elm_fileselector_expandable_set() for more details
6869     */
6870    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6871
6872    /**
6873     * Set whether a given file selector entry widget's internal file
6874     * selector is to display folders only or the directory contents,
6875     * as well.
6876     *
6877     * @param obj The file selector entry widget
6878     * @param only @c EINA_TRUE to make @p obj widget's internal file
6879     * selector only display directories, @c EINA_FALSE to make files
6880     * to be displayed in it too
6881     *
6882     * This has the same effect as elm_fileselector_folder_only_set(),
6883     * but now applied to a file selector entry's internal file
6884     * selector.
6885     *
6886     * @see elm_fileselector_folder_only_get()
6887     */
6888    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6889
6890    /**
6891     * Get whether a given file selector entry widget's internal file
6892     * selector is displaying folders only or the directory contents,
6893     * as well.
6894     *
6895     * @param obj The file selector entry widget
6896     * @return @c EINA_TRUE if @p obj widget's internal file
6897     * selector is only displaying directories, @c EINA_FALSE if files
6898     * are being displayed in it too (and on errors)
6899     *
6900     * @see elm_fileselector_entry_folder_only_set() for more details
6901     */
6902    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6903
6904    /**
6905     * Enable/disable the file name entry box where the user can type
6906     * in a name for a file, in a given file selector entry widget's
6907     * internal file selector.
6908     *
6909     * @param obj The file selector entry widget
6910     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6911     * file selector a "saving dialog", @c EINA_FALSE otherwise
6912     *
6913     * This has the same effect as elm_fileselector_is_save_set(),
6914     * but now applied to a file selector entry's internal file
6915     * selector.
6916     *
6917     * @see elm_fileselector_is_save_get()
6918     */
6919    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6920
6921    /**
6922     * Get whether the given file selector entry widget's internal
6923     * file selector is in "saving dialog" mode
6924     *
6925     * @param obj The file selector entry widget
6926     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6927     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6928     * errors)
6929     *
6930     * @see elm_fileselector_entry_is_save_set() for more details
6931     */
6932    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6933
6934    /**
6935     * Set whether a given file selector entry widget's internal file
6936     * selector will raise an Elementary "inner window", instead of a
6937     * dedicated Elementary window. By default, it won't.
6938     *
6939     * @param obj The file selector entry widget
6940     * @param value @c EINA_TRUE to make it use an inner window, @c
6941     * EINA_TRUE to make it use a dedicated window
6942     *
6943     * @see elm_win_inwin_add() for more information on inner windows
6944     * @see elm_fileselector_entry_inwin_mode_get()
6945     */
6946    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6947
6948    /**
6949     * Get whether a given file selector entry widget's internal file
6950     * selector will raise an Elementary "inner window", instead of a
6951     * dedicated Elementary window.
6952     *
6953     * @param obj The file selector entry widget
6954     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6955     * if it will use a dedicated window
6956     *
6957     * @see elm_fileselector_entry_inwin_mode_set() for more details
6958     */
6959    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6960
6961    /**
6962     * Set the initial file system path for a given file selector entry
6963     * widget
6964     *
6965     * @param obj The file selector entry widget
6966     * @param path The path string
6967     *
6968     * It must be a <b>directory</b> path, which will have the contents
6969     * displayed initially in the file selector's view, when invoked
6970     * from @p obj. The default initial path is the @c "HOME"
6971     * environment variable's value.
6972     *
6973     * @see elm_fileselector_entry_path_get()
6974     */
6975    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6976
6977    /**
6978     * Get the parent directory's path to the latest file selection on
6979     * a given filer selector entry widget
6980     *
6981     * @param obj The file selector object
6982     * @return The (full) path of the directory of the last selection
6983     * on @p obj widget, a @b stringshared string
6984     *
6985     * @see elm_fileselector_entry_path_set()
6986     */
6987    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6988
6989    /**
6990     * @}
6991     */
6992
6993    /**
6994     * @defgroup Scroller Scroller
6995     *
6996     * A scroller holds a single object and "scrolls it around". This means that
6997     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6998     * region around, allowing to move through a much larger object that is
6999     * contained in the scroller. The scroller will always have a small minimum
7000     * size by default as it won't be limited by the contents of the scroller.
7001     *
7002     * Signals that you can add callbacks for are:
7003     * @li "edge,left" - the left edge of the content has been reached
7004     * @li "edge,right" - the right edge of the content has been reached
7005     * @li "edge,top" - the top edge of the content has been reached
7006     * @li "edge,bottom" - the bottom edge of the content has been reached
7007     * @li "scroll" - the content has been scrolled (moved)
7008     * @li "scroll,anim,start" - scrolling animation has started
7009     * @li "scroll,anim,stop" - scrolling animation has stopped
7010     * @li "scroll,drag,start" - dragging the contents around has started
7011     * @li "scroll,drag,stop" - dragging the contents around has stopped
7012     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7013     * user intervetion.
7014     *
7015     * @note When Elemementary is in embedded mode the scrollbars will not be
7016     * dragable, they appear merely as indicators of how much has been scrolled.
7017     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7018     * fingerscroll) won't work.
7019     *
7020     * To set/get/unset the content of the panel, you can use
7021     * elm_object_content_set/get/unset APIs.
7022     * Once the content object is set, a previously set one will be deleted.
7023     * If you want to keep that old content object, use the
7024     * elm_object_content_unset() function
7025     *
7026     * In @ref tutorial_scroller you'll find an example of how to use most of
7027     * this API.
7028     * @{
7029     */
7030    /**
7031     * @brief Type that controls when scrollbars should appear.
7032     *
7033     * @see elm_scroller_policy_set()
7034     */
7035    typedef enum _Elm_Scroller_Policy
7036      {
7037         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7038         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7039         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7040         ELM_SCROLLER_POLICY_LAST
7041      } Elm_Scroller_Policy;
7042    /**
7043     * @brief Add a new scroller to the parent
7044     *
7045     * @param parent The parent object
7046     * @return The new object or NULL if it cannot be created
7047     */
7048    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7049    /**
7050     * @brief Set the content of the scroller widget (the object to be scrolled around).
7051     *
7052     * @param obj The scroller object
7053     * @param content The new content object
7054     *
7055     * Once the content object is set, a previously set one will be deleted.
7056     * If you want to keep that old content object, use the
7057     * elm_scroller_content_unset() function.
7058     */
7059    EINA_DEPRECATED EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7060    /**
7061     * @brief Get the content of the scroller widget
7062     *
7063     * @param obj The slider object
7064     * @return The content that is being used
7065     *
7066     * Return the content object which is set for this widget
7067     *
7068     * @see elm_scroller_content_set()
7069     */
7070    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7071    /**
7072     * @brief Unset the content of the scroller widget
7073     *
7074     * @param obj The slider object
7075     * @return The content that was being used
7076     *
7077     * Unparent and return the content object which was set for this widget
7078     *
7079     * @see elm_scroller_content_set()
7080     */
7081    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7082    /**
7083     * @brief Set custom theme elements for the scroller
7084     *
7085     * @param obj The scroller object
7086     * @param widget The widget name to use (default is "scroller")
7087     * @param base The base name to use (default is "base")
7088     */
7089    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7090    /**
7091     * @brief Make the scroller minimum size limited to the minimum size of the content
7092     *
7093     * @param obj The scroller object
7094     * @param w Enable limiting minimum size horizontally
7095     * @param h Enable limiting minimum size vertically
7096     *
7097     * By default the scroller will be as small as its design allows,
7098     * irrespective of its content. This will make the scroller minimum size the
7099     * right size horizontally and/or vertically to perfectly fit its content in
7100     * that direction.
7101     */
7102    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7103    /**
7104     * @brief Show a specific virtual region within the scroller content object
7105     *
7106     * @param obj The scroller object
7107     * @param x X coordinate of the region
7108     * @param y Y coordinate of the region
7109     * @param w Width of the region
7110     * @param h Height of the region
7111     *
7112     * This will ensure all (or part if it does not fit) of the designated
7113     * region in the virtual content object (0, 0 starting at the top-left of the
7114     * virtual content object) is shown within the scroller.
7115     */
7116    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);
7117    /**
7118     * @brief Set the scrollbar visibility policy
7119     *
7120     * @param obj The scroller object
7121     * @param policy_h Horizontal scrollbar policy
7122     * @param policy_v Vertical scrollbar policy
7123     *
7124     * This sets the scrollbar visibility policy for the given scroller.
7125     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7126     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7127     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7128     * respectively for the horizontal and vertical scrollbars.
7129     */
7130    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7131    /**
7132     * @brief Gets scrollbar visibility policy
7133     *
7134     * @param obj The scroller object
7135     * @param policy_h Horizontal scrollbar policy
7136     * @param policy_v Vertical scrollbar policy
7137     *
7138     * @see elm_scroller_policy_set()
7139     */
7140    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7141    /**
7142     * @brief Get the currently visible content region
7143     *
7144     * @param obj The scroller object
7145     * @param x X coordinate of the region
7146     * @param y Y coordinate of the region
7147     * @param w Width of the region
7148     * @param h Height of the region
7149     *
7150     * This gets the current region in the content object that is visible through
7151     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7152     * w, @p h values pointed to.
7153     *
7154     * @note All coordinates are relative to the content.
7155     *
7156     * @see elm_scroller_region_show()
7157     */
7158    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);
7159    /**
7160     * @brief Get the size of the content object
7161     *
7162     * @param obj The scroller object
7163     * @param w Width of the content object.
7164     * @param h Height of the content object.
7165     *
7166     * This gets the size of the content object of the scroller.
7167     */
7168    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7169    /**
7170     * @brief Set bouncing behavior
7171     *
7172     * @param obj The scroller object
7173     * @param h_bounce Allow bounce horizontally
7174     * @param v_bounce Allow bounce vertically
7175     *
7176     * When scrolling, the scroller may "bounce" when reaching an edge of the
7177     * content object. This is a visual way to indicate the end has been reached.
7178     * This is enabled by default for both axis. This API will set if it is enabled
7179     * for the given axis with the boolean parameters for each axis.
7180     */
7181    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7182    /**
7183     * @brief Get the bounce behaviour
7184     *
7185     * @param obj The Scroller object
7186     * @param h_bounce Will the scroller bounce horizontally or not
7187     * @param v_bounce Will the scroller bounce vertically or not
7188     *
7189     * @see elm_scroller_bounce_set()
7190     */
7191    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7192    /**
7193     * @brief Set scroll page size relative to viewport size.
7194     *
7195     * @param obj The scroller object
7196     * @param h_pagerel The horizontal page relative size
7197     * @param v_pagerel The vertical page relative size
7198     *
7199     * The scroller is capable of limiting scrolling by the user to "pages". That
7200     * is to jump by and only show a "whole page" at a time as if the continuous
7201     * area of the scroller content is split into page sized pieces. This sets
7202     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7203     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7204     * axis. This is mutually exclusive with page size
7205     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7206     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7207     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7208     * the other axis.
7209     */
7210    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7211    /**
7212     * @brief Set scroll page size.
7213     *
7214     * @param obj The scroller object
7215     * @param h_pagesize The horizontal page size
7216     * @param v_pagesize The vertical page size
7217     *
7218     * This sets the page size to an absolute fixed value, with 0 turning it off
7219     * for that axis.
7220     *
7221     * @see elm_scroller_page_relative_set()
7222     */
7223    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7224    /**
7225     * @brief Get scroll current page number.
7226     *
7227     * @param obj The scroller object
7228     * @param h_pagenumber The horizontal page number
7229     * @param v_pagenumber The vertical page number
7230     *
7231     * The page number starts from 0. 0 is the first page.
7232     * Current page means the page which meets the top-left of the viewport.
7233     * If there are two or more pages in the viewport, it returns the number of the page
7234     * which meets the top-left of the viewport.
7235     *
7236     * @see elm_scroller_last_page_get()
7237     * @see elm_scroller_page_show()
7238     * @see elm_scroller_page_brint_in()
7239     */
7240    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7241    /**
7242     * @brief Get scroll last page number.
7243     *
7244     * @param obj The scroller object
7245     * @param h_pagenumber The horizontal page number
7246     * @param v_pagenumber The vertical page number
7247     *
7248     * The page number starts from 0. 0 is the first page.
7249     * This returns the last page number among the pages.
7250     *
7251     * @see elm_scroller_current_page_get()
7252     * @see elm_scroller_page_show()
7253     * @see elm_scroller_page_brint_in()
7254     */
7255    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7256    /**
7257     * Show a specific virtual region within the scroller content object by page number.
7258     *
7259     * @param obj The scroller object
7260     * @param h_pagenumber The horizontal page number
7261     * @param v_pagenumber The vertical page number
7262     *
7263     * 0, 0 of the indicated page is located at the top-left of the viewport.
7264     * This will jump to the page directly without animation.
7265     *
7266     * Example of usage:
7267     *
7268     * @code
7269     * sc = elm_scroller_add(win);
7270     * elm_scroller_content_set(sc, content);
7271     * elm_scroller_page_relative_set(sc, 1, 0);
7272     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7273     * elm_scroller_page_show(sc, h_page + 1, v_page);
7274     * @endcode
7275     *
7276     * @see elm_scroller_page_bring_in()
7277     */
7278    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7279    /**
7280     * Show a specific virtual region within the scroller content object by page number.
7281     *
7282     * @param obj The scroller object
7283     * @param h_pagenumber The horizontal page number
7284     * @param v_pagenumber The vertical page number
7285     *
7286     * 0, 0 of the indicated page is located at the top-left of the viewport.
7287     * This will slide to the page with animation.
7288     *
7289     * Example of usage:
7290     *
7291     * @code
7292     * sc = elm_scroller_add(win);
7293     * elm_scroller_content_set(sc, content);
7294     * elm_scroller_page_relative_set(sc, 1, 0);
7295     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7296     * elm_scroller_page_bring_in(sc, h_page, v_page);
7297     * @endcode
7298     *
7299     * @see elm_scroller_page_show()
7300     */
7301    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7302    /**
7303     * @brief Show a specific virtual region within the scroller content object.
7304     *
7305     * @param obj The scroller object
7306     * @param x X coordinate of the region
7307     * @param y Y coordinate of the region
7308     * @param w Width of the region
7309     * @param h Height of the region
7310     *
7311     * This will ensure all (or part if it does not fit) of the designated
7312     * region in the virtual content object (0, 0 starting at the top-left of the
7313     * virtual content object) is shown within the scroller. Unlike
7314     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7315     * to this location (if configuration in general calls for transitions). It
7316     * may not jump immediately to the new location and make take a while and
7317     * show other content along the way.
7318     *
7319     * @see elm_scroller_region_show()
7320     */
7321    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);
7322    /**
7323     * @brief Set event propagation on a scroller
7324     *
7325     * @param obj The scroller object
7326     * @param propagation If propagation is enabled or not
7327     *
7328     * This enables or disabled event propagation from the scroller content to
7329     * the scroller and its parent. By default event propagation is disabled.
7330     */
7331    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7332    /**
7333     * @brief Get event propagation for a scroller
7334     *
7335     * @param obj The scroller object
7336     * @return The propagation state
7337     *
7338     * This gets the event propagation for a scroller.
7339     *
7340     * @see elm_scroller_propagate_events_set()
7341     */
7342    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7343    /**
7344     * @brief Set scrolling gravity on a scroller
7345     *
7346     * @param obj The scroller object
7347     * @param x The scrolling horizontal gravity
7348     * @param y The scrolling vertical gravity
7349     *
7350     * The gravity, defines how the scroller will adjust its view
7351     * when the size of the scroller contents increase.
7352     *
7353     * The scroller will adjust the view to glue itself as follows.
7354     *
7355     *  x=0.0, for showing the left most region of the content.
7356     *  x=1.0, for showing the right most region of the content.
7357     *  y=0.0, for showing the bottom most region of the content.
7358     *  y=1.0, for showing the top most region of the content.
7359     *
7360     * Default values for x and y are 0.0
7361     */
7362    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7363    /**
7364     * @brief Get scrolling gravity values for a scroller
7365     *
7366     * @param obj The scroller object
7367     * @param x The scrolling horizontal gravity
7368     * @param y The scrolling vertical gravity
7369     *
7370     * This gets gravity values for a scroller.
7371     *
7372     * @see elm_scroller_gravity_set()
7373     *
7374     */
7375    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7376    /**
7377     * @}
7378     */
7379
7380    /**
7381     * @defgroup Label Label
7382     *
7383     * @image html img/widget/label/preview-00.png
7384     * @image latex img/widget/label/preview-00.eps
7385     *
7386     * @brief Widget to display text, with simple html-like markup.
7387     *
7388     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7389     * text doesn't fit the geometry of the label it will be ellipsized or be
7390     * cut. Elementary provides several themes for this widget:
7391     * @li default - No animation
7392     * @li marker - Centers the text in the label and make it bold by default
7393     * @li slide_long - The entire text appears from the right of the screen and
7394     * slides until it disappears in the left of the screen(reappering on the
7395     * right again).
7396     * @li slide_short - The text appears in the left of the label and slides to
7397     * the right to show the overflow. When all of the text has been shown the
7398     * position is reset.
7399     * @li slide_bounce - The text appears in the left of the label and slides to
7400     * the right to show the overflow. When all of the text has been shown the
7401     * animation reverses, moving the text to the left.
7402     *
7403     * Custom themes can of course invent new markup tags and style them any way
7404     * they like.
7405     *
7406     * The following signals may be emitted by the label widget:
7407     * @li "language,changed": The program's language changed.
7408     *
7409     * See @ref tutorial_label for a demonstration of how to use a label widget.
7410     * @{
7411     */
7412    /**
7413     * @brief Add a new label to the parent
7414     *
7415     * @param parent The parent object
7416     * @return The new object or NULL if it cannot be created
7417     */
7418    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7419    /**
7420     * @brief Set the label on the label object
7421     *
7422     * @param obj The label object
7423     * @param label The label will be used on the label object
7424     * @deprecated See elm_object_text_set()
7425     */
7426    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 */
7427    /**
7428     * @brief Get the label used on the label object
7429     *
7430     * @param obj The label object
7431     * @return The string inside the label
7432     * @deprecated See elm_object_text_get()
7433     */
7434    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7435    /**
7436     * @brief Set the wrapping behavior of the label
7437     *
7438     * @param obj The label object
7439     * @param wrap To wrap text or not
7440     *
7441     * By default no wrapping is done. Possible values for @p wrap are:
7442     * @li ELM_WRAP_NONE - No wrapping
7443     * @li ELM_WRAP_CHAR - wrap between characters
7444     * @li ELM_WRAP_WORD - wrap between words
7445     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7446     */
7447    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7448    /**
7449     * @brief Get the wrapping behavior of the label
7450     *
7451     * @param obj The label object
7452     * @return Wrap type
7453     *
7454     * @see elm_label_line_wrap_set()
7455     */
7456    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7457    /**
7458     * @brief Set wrap width of the label
7459     *
7460     * @param obj The label object
7461     * @param w The wrap width in pixels at a minimum where words need to wrap
7462     *
7463     * This function sets the maximum width size hint of the label.
7464     *
7465     * @warning This is only relevant if the label is inside a container.
7466     */
7467    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7468    /**
7469     * @brief Get wrap width of the label
7470     *
7471     * @param obj The label object
7472     * @return The wrap width in pixels at a minimum where words need to wrap
7473     *
7474     * @see elm_label_wrap_width_set()
7475     */
7476    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7477    /**
7478     * @brief Set wrap height of the label
7479     *
7480     * @param obj The label object
7481     * @param h The wrap height in pixels at a minimum where words need to wrap
7482     *
7483     * This function sets the maximum height size hint of the label.
7484     *
7485     * @warning This is only relevant if the label is inside a container.
7486     */
7487    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7488    /**
7489     * @brief get wrap width of the label
7490     *
7491     * @param obj The label object
7492     * @return The wrap height in pixels at a minimum where words need to wrap
7493     */
7494    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7495    /**
7496     * @brief Set the font size on the label object.
7497     *
7498     * @param obj The label object
7499     * @param size font size
7500     *
7501     * @warning NEVER use this. It is for hyper-special cases only. use styles
7502     * instead. e.g. "big", "medium", "small" - or better name them by use:
7503     * "title", "footnote", "quote" etc.
7504     */
7505    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7506    /**
7507     * @brief Set the text color on the label object
7508     *
7509     * @param obj The label object
7510     * @param r Red property background color of The label object
7511     * @param g Green property background color of The label object
7512     * @param b Blue property background color of The label object
7513     * @param a Alpha property background color of The label object
7514     *
7515     * @warning NEVER use this. It is for hyper-special cases only. use styles
7516     * instead. e.g. "big", "medium", "small" - or better name them by use:
7517     * "title", "footnote", "quote" etc.
7518     */
7519    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);
7520    /**
7521     * @brief Set the text align on the label object
7522     *
7523     * @param obj The label object
7524     * @param align align mode ("left", "center", "right")
7525     *
7526     * @warning NEVER use this. It is for hyper-special cases only. use styles
7527     * instead. e.g. "big", "medium", "small" - or better name them by use:
7528     * "title", "footnote", "quote" etc.
7529     */
7530    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7531    /**
7532     * @brief Set background color of the label
7533     *
7534     * @param obj The label object
7535     * @param r Red property background color of The label object
7536     * @param g Green property background color of The label object
7537     * @param b Blue property background color of The label object
7538     * @param a Alpha property background alpha of The label object
7539     *
7540     * @warning NEVER use this. It is for hyper-special cases only. use styles
7541     * instead. e.g. "big", "medium", "small" - or better name them by use:
7542     * "title", "footnote", "quote" etc.
7543     */
7544    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);
7545    /**
7546     * @brief Set the ellipsis behavior of the label
7547     *
7548     * @param obj The label object
7549     * @param ellipsis To ellipsis text or not
7550     *
7551     * If set to true and the text doesn't fit in the label an ellipsis("...")
7552     * will be shown at the end of the widget.
7553     *
7554     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7555     * choosen wrap method was ELM_WRAP_WORD.
7556     */
7557    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7558    /**
7559     * @brief Set the text slide of the label
7560     *
7561     * @param obj The label object
7562     * @param slide To start slide or stop
7563     *
7564     * If set to true, the text of the label will slide/scroll through the length of
7565     * label.
7566     *
7567     * @warning This only works with the themes "slide_short", "slide_long" and
7568     * "slide_bounce".
7569     */
7570    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7571    /**
7572     * @brief Get the text slide mode of the label
7573     *
7574     * @param obj The label object
7575     * @return slide slide mode value
7576     *
7577     * @see elm_label_slide_set()
7578     */
7579    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7580    /**
7581     * @brief Set the slide duration(speed) of the label
7582     *
7583     * @param obj The label object
7584     * @return The duration in seconds in moving text from slide begin position
7585     * to slide end position
7586     */
7587    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7588    /**
7589     * @brief Get the slide duration(speed) of the label
7590     *
7591     * @param obj The label object
7592     * @return The duration time in moving text from slide begin position to slide end position
7593     *
7594     * @see elm_label_slide_duration_set()
7595     */
7596    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7597    /**
7598     * @}
7599     */
7600
7601    /**
7602     * @defgroup Toggle Toggle
7603     *
7604     * @image html img/widget/toggle/preview-00.png
7605     * @image latex img/widget/toggle/preview-00.eps
7606     *
7607     * @brief A toggle is a slider which can be used to toggle between
7608     * two values.  It has two states: on and off.
7609     *
7610     * This widget is deprecated. Please use elm_check_add() instead using the
7611     * toggle style like:
7612     * 
7613     * @code
7614     * obj = elm_check_add(parent);
7615     * elm_object_style_set(obj, "toggle");
7616     * elm_object_text_part_set(obj, "on", "ON");
7617     * elm_object_text_part_set(obj, "off", "OFF");
7618     * @endcode
7619     * 
7620     * Signals that you can add callbacks for are:
7621     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7622     *                 until the toggle is released by the cursor (assuming it
7623     *                 has been triggered by the cursor in the first place).
7624     *
7625     * @ref tutorial_toggle show how to use a toggle.
7626     * @{
7627     */
7628    /**
7629     * @brief Add a toggle to @p parent.
7630     *
7631     * @param parent The parent object
7632     *
7633     * @return The toggle object
7634     */
7635    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7636    /**
7637     * @brief Sets the label to be displayed with the toggle.
7638     *
7639     * @param obj The toggle object
7640     * @param label The label to be displayed
7641     *
7642     * @deprecated use elm_object_text_set() instead.
7643     */
7644    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7645    /**
7646     * @brief Gets the label of the toggle
7647     *
7648     * @param obj  toggle object
7649     * @return The label of the toggle
7650     *
7651     * @deprecated use elm_object_text_get() instead.
7652     */
7653    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7654    /**
7655     * @brief Set the icon used for the toggle
7656     *
7657     * @param obj The toggle object
7658     * @param icon The icon object for the button
7659     *
7660     * Once the icon object is set, a previously set one will be deleted
7661     * If you want to keep that old content object, use the
7662     * elm_toggle_icon_unset() function.
7663     *
7664     * @deprecated use elm_object_content_set() instead.
7665     */
7666    EINA_DEPRECATED EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7667    /**
7668     * @brief Get the icon used for the toggle
7669     *
7670     * @param obj The toggle object
7671     * @return The icon object that is being used
7672     *
7673     * Return the icon object which is set for this widget.
7674     *
7675     * @see elm_toggle_icon_set()
7676     *
7677     * @deprecated use elm_object_content_get() instead.
7678     */
7679    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7680    /**
7681     * @brief Unset the icon used for the toggle
7682     *
7683     * @param obj The toggle object
7684     * @return The icon object that was being used
7685     *
7686     * Unparent and return the icon object which was set for this widget.
7687     *
7688     * @see elm_toggle_icon_set()
7689     *
7690     * @deprecated use elm_object_content_unset() instead.
7691     */
7692    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7693    /**
7694     * @brief Sets the labels to be associated with the on and off states of the toggle.
7695     *
7696     * @param obj The toggle object
7697     * @param onlabel The label displayed when the toggle is in the "on" state
7698     * @param offlabel The label displayed when the toggle is in the "off" state
7699     *
7700     * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7701     * instead.
7702     */
7703    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7704    /**
7705     * @brief Gets the labels associated with the on and off states of the
7706     * toggle.
7707     *
7708     * @param obj The toggle object
7709     * @param onlabel A char** to place the onlabel of @p obj into
7710     * @param offlabel A char** to place the offlabel of @p obj into
7711     *
7712     * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7713     * instead.
7714     */
7715    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7716    /**
7717     * @brief Sets the state of the toggle to @p state.
7718     *
7719     * @param obj The toggle object
7720     * @param state The state of @p obj
7721     *
7722     * @deprecated use elm_check_state_set() instead.
7723     */
7724    EINA_DEPRECATED EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7725    /**
7726     * @brief Gets the state of the toggle to @p state.
7727     *
7728     * @param obj The toggle object
7729     * @return The state of @p obj
7730     *
7731     * @deprecated use elm_check_state_get() instead.
7732     */
7733    EINA_DEPRECATED EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7734    /**
7735     * @brief Sets the state pointer of the toggle to @p statep.
7736     *
7737     * @param obj The toggle object
7738     * @param statep The state pointer of @p obj
7739     *
7740     * @deprecated use elm_check_state_pointer_set() instead.
7741     */
7742    EINA_DEPRECATED EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7743    /**
7744     * @}
7745     */
7746
7747    /**
7748     * @defgroup Frame Frame
7749     *
7750     * @image html img/widget/frame/preview-00.png
7751     * @image latex img/widget/frame/preview-00.eps
7752     *
7753     * @brief Frame is a widget that holds some content and has a title.
7754     *
7755     * The default look is a frame with a title, but Frame supports multple
7756     * styles:
7757     * @li default
7758     * @li pad_small
7759     * @li pad_medium
7760     * @li pad_large
7761     * @li pad_huge
7762     * @li outdent_top
7763     * @li outdent_bottom
7764     *
7765     * Of all this styles only default shows the title. Frame emits no signals.
7766     *
7767     * Default contents parts of the frame widget that you can use for are:
7768     * @li "elm.swallow.content" - A content of the frame
7769     *
7770     * Default text parts of the frame widget that you can use for are:
7771     * @li "elm.text" - Label of the frame
7772     *
7773     * For a detailed example see the @ref tutorial_frame.
7774     *
7775     * @{
7776     */
7777    /**
7778     * @brief Add a new frame to the parent
7779     *
7780     * @param parent The parent object
7781     * @return The new object or NULL if it cannot be created
7782     */
7783    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7784    /**
7785     * @brief Set the frame label
7786     *
7787     * @param obj The frame object
7788     * @param label The label of this frame object
7789     *
7790     * @deprecated use elm_object_text_set() instead.
7791     */
7792    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7793    /**
7794     * @brief Get the frame label
7795     *
7796     * @param obj The frame object
7797     *
7798     * @return The label of this frame objet or NULL if unable to get frame
7799     *
7800     * @deprecated use elm_object_text_get() instead.
7801     */
7802    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7803    /**
7804     * @brief Set the content of the frame widget
7805     *
7806     * Once the content object is set, a previously set one will be deleted.
7807     * If you want to keep that old content object, use the
7808     * elm_frame_content_unset() function.
7809     *
7810     * @param obj The frame object
7811     * @param content The content will be filled in this frame object
7812     */
7813    EINA_DEPRECATED EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7814    /**
7815     * @brief Get the content of the frame widget
7816     *
7817     * Return the content object which is set for this widget
7818     *
7819     * @param obj The frame object
7820     * @return The content that is being used
7821     */
7822    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7823    /**
7824     * @brief Unset the content of the frame widget
7825     *
7826     * Unparent and return the content object which was set for this widget
7827     *
7828     * @param obj The frame object
7829     * @return The content that was being used
7830     */
7831    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7832    /**
7833     * @}
7834     */
7835
7836    /**
7837     * @defgroup Table Table
7838     *
7839     * A container widget to arrange other widgets in a table where items can
7840     * also span multiple columns or rows - even overlap (and then be raised or
7841     * lowered accordingly to adjust stacking if they do overlap).
7842     *
7843     * For a Table widget the row/column count is not fixed.
7844     * The table widget adjusts itself when subobjects are added to it dynamically.
7845     *
7846     * The followin are examples of how to use a table:
7847     * @li @ref tutorial_table_01
7848     * @li @ref tutorial_table_02
7849     *
7850     * @{
7851     */
7852    /**
7853     * @brief Add a new table to the parent
7854     *
7855     * @param parent The parent object
7856     * @return The new object or NULL if it cannot be created
7857     */
7858    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7859    /**
7860     * @brief Set the homogeneous layout in the table
7861     *
7862     * @param obj The layout object
7863     * @param homogeneous A boolean to set if the layout is homogeneous in the
7864     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7865     */
7866    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7867    /**
7868     * @brief Get the current table homogeneous mode.
7869     *
7870     * @param obj The table object
7871     * @return A boolean to indicating if the layout is homogeneous in the table
7872     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7873     */
7874    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7875    /**
7876     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7877     */
7878    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7879    /**
7880     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7881     */
7882    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7883    /**
7884     * @brief Set padding between cells.
7885     *
7886     * @param obj The layout object.
7887     * @param horizontal set the horizontal padding.
7888     * @param vertical set the vertical padding.
7889     *
7890     * Default value is 0.
7891     */
7892    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7893    /**
7894     * @brief Get padding between cells.
7895     *
7896     * @param obj The layout object.
7897     * @param horizontal set the horizontal padding.
7898     * @param vertical set the vertical padding.
7899     */
7900    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7901    /**
7902     * @brief Add a subobject on the table with the coordinates passed
7903     *
7904     * @param obj The table object
7905     * @param subobj The subobject to be added to the table
7906     * @param x Row number
7907     * @param y Column number
7908     * @param w rowspan
7909     * @param h colspan
7910     *
7911     * @note All positioning inside the table is relative to rows and columns, so
7912     * a value of 0 for x and y, means the top left cell of the table, and a
7913     * value of 1 for w and h means @p subobj only takes that 1 cell.
7914     */
7915    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7916    /**
7917     * @brief Remove child from table.
7918     *
7919     * @param obj The table object
7920     * @param subobj The subobject
7921     */
7922    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7923    /**
7924     * @brief Faster way to remove all child objects from a table object.
7925     *
7926     * @param obj The table object
7927     * @param clear If true, will delete children, else just remove from table.
7928     */
7929    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7930    /**
7931     * @brief Set the packing location of an existing child of the table
7932     *
7933     * @param subobj The subobject to be modified in the table
7934     * @param x Row number
7935     * @param y Column number
7936     * @param w rowspan
7937     * @param h colspan
7938     *
7939     * Modifies the position of an object already in the table.
7940     *
7941     * @note All positioning inside the table is relative to rows and columns, so
7942     * a value of 0 for x and y, means the top left cell of the table, and a
7943     * value of 1 for w and h means @p subobj only takes that 1 cell.
7944     */
7945    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7946    /**
7947     * @brief Get the packing location of an existing child of the table
7948     *
7949     * @param subobj The subobject to be modified in the table
7950     * @param x Row number
7951     * @param y Column number
7952     * @param w rowspan
7953     * @param h colspan
7954     *
7955     * @see elm_table_pack_set()
7956     */
7957    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7958    /**
7959     * @}
7960     */
7961
7962    /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
7963    typedef struct Elm_Gen_Item Elm_Gen_Item;
7964    typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
7965    typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
7966    typedef char        *(*Elm_Gen_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
7967    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. */
7968    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. */
7969    typedef void         (*Elm_Gen_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
7970    struct _Elm_Gen_Item_Class
7971      {
7972         const char             *item_style;
7973         struct _Elm_Gen_Item_Class_Func
7974           {
7975              Elm_Gen_Item_Label_Get_Cb label_get;
7976              Elm_Gen_Item_Content_Get_Cb  content_get;
7977              Elm_Gen_Item_State_Get_Cb state_get;
7978              Elm_Gen_Item_Del_Cb       del;
7979           } func;
7980      };
7981    EAPI void elm_gen_clear(Evas_Object *obj);
7982    EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
7983    EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
7984    EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
7985    EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
7986    EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
7987    EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
7988    EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
7989    EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
7990    EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
7991    EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
7992    EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
7993    EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
7994    EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
7995    EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
7996    EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
7997    EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
7998    EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
7999    EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8000    EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8001    EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8002
8003    /**
8004     * @defgroup Gengrid Gengrid (Generic grid)
8005     *
8006     * This widget aims to position objects in a grid layout while
8007     * actually creating and rendering only the visible ones, using the
8008     * same idea as the @ref Genlist "genlist": the user defines a @b
8009     * class for each item, specifying functions that will be called at
8010     * object creation, deletion, etc. When those items are selected by
8011     * the user, a callback function is issued. Users may interact with
8012     * a gengrid via the mouse (by clicking on items to select them and
8013     * clicking on the grid's viewport and swiping to pan the whole
8014     * view) or via the keyboard, navigating through item with the
8015     * arrow keys.
8016     *
8017     * @section Gengrid_Layouts Gengrid layouts
8018     *
8019     * Gengrid may layout its items in one of two possible layouts:
8020     * - horizontal or
8021     * - vertical.
8022     *
8023     * When in "horizontal mode", items will be placed in @b columns,
8024     * from top to bottom and, when the space for a column is filled,
8025     * another one is started on the right, thus expanding the grid
8026     * horizontally, making for horizontal scrolling. When in "vertical
8027     * mode" , though, items will be placed in @b rows, from left to
8028     * right and, when the space for a row is filled, another one is
8029     * started below, thus expanding the grid vertically (and making
8030     * for vertical scrolling).
8031     *
8032     * @section Gengrid_Items Gengrid items
8033     *
8034     * An item in a gengrid can have 0 or more text labels (they can be
8035     * regular text or textblock Evas objects - that's up to the style
8036     * to determine), 0 or more icons (which are simply objects
8037     * swallowed into the gengrid item's theming Edje object) and 0 or
8038     * more <b>boolean states</b>, which have the behavior left to the
8039     * user to define. The Edje part names for each of these properties
8040     * will be looked up, in the theme file for the gengrid, under the
8041     * Edje (string) data items named @c "labels", @c "icons" and @c
8042     * "states", respectively. For each of those properties, if more
8043     * than one part is provided, they must have names listed separated
8044     * by spaces in the data fields. For the default gengrid item
8045     * theme, we have @b one label part (@c "elm.text"), @b two icon
8046     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8047     * no state parts.
8048     *
8049     * A gengrid item may be at one of several styles. Elementary
8050     * provides one by default - "default", but this can be extended by
8051     * system or application custom themes/overlays/extensions (see
8052     * @ref Theme "themes" for more details).
8053     *
8054     * @section Gengrid_Item_Class Gengrid item classes
8055     *
8056     * In order to have the ability to add and delete items on the fly,
8057     * gengrid implements a class (callback) system where the
8058     * application provides a structure with information about that
8059     * type of item (gengrid may contain multiple different items with
8060     * different classes, states and styles). Gengrid will call the
8061     * functions in this struct (methods) when an item is "realized"
8062     * (i.e., created dynamically, while the user is scrolling the
8063     * grid). All objects will simply be deleted when no longer needed
8064     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8065     * contains the following members:
8066     * - @c item_style - This is a constant string and simply defines
8067     * the name of the item style. It @b must be specified and the
8068     * default should be @c "default".
8069     * - @c func.label_get - This function is called when an item
8070     * object is actually created. The @c data parameter will point to
8071     * the same data passed to elm_gengrid_item_append() and related
8072     * item creation functions. The @c obj parameter is the gengrid
8073     * object itself, while the @c part one is the name string of one
8074     * of the existing text parts in the Edje group implementing the
8075     * item's theme. This function @b must return a strdup'()ed string,
8076     * as the caller will free() it when done. See
8077     * #Elm_Gengrid_Item_Label_Get_Cb.
8078     * - @c func.content_get - This function is called when an item object
8079     * is actually created. The @c data parameter will point to the
8080     * same data passed to elm_gengrid_item_append() and related item
8081     * creation functions. The @c obj parameter is the gengrid object
8082     * itself, while the @c part one is the name string of one of the
8083     * existing (content) swallow parts in the Edje group implementing the
8084     * item's theme. It must return @c NULL, when no content is desired,
8085     * or a valid object handle, otherwise. The object will be deleted
8086     * by the gengrid on its deletion or when the item is "unrealized".
8087     * See #Elm_Gengrid_Item_Content_Get_Cb.
8088     * - @c func.state_get - This function is called when an item
8089     * object is actually created. The @c data parameter will point to
8090     * the same data passed to elm_gengrid_item_append() and related
8091     * item creation functions. The @c obj parameter is the gengrid
8092     * object itself, while the @c part one is the name string of one
8093     * of the state parts in the Edje group implementing the item's
8094     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8095     * true/on. Gengrids will emit a signal to its theming Edje object
8096     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8097     * "source" arguments, respectively, when the state is true (the
8098     * default is false), where @c XXX is the name of the (state) part.
8099     * See #Elm_Gengrid_Item_State_Get_Cb.
8100     * - @c func.del - This is called when elm_gengrid_item_del() is
8101     * called on an item or elm_gengrid_clear() is called on the
8102     * gengrid. This is intended for use when gengrid items are
8103     * deleted, so any data attached to the item (e.g. its data
8104     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8105     *
8106     * @section Gengrid_Usage_Hints Usage hints
8107     *
8108     * If the user wants to have multiple items selected at the same
8109     * time, elm_gengrid_multi_select_set() will permit it. If the
8110     * gengrid is single-selection only (the default), then
8111     * elm_gengrid_select_item_get() will return the selected item or
8112     * @c NULL, if none is selected. If the gengrid is under
8113     * multi-selection, then elm_gengrid_selected_items_get() will
8114     * return a list (that is only valid as long as no items are
8115     * modified (added, deleted, selected or unselected) of child items
8116     * on a gengrid.
8117     *
8118     * If an item changes (internal (boolean) state, label or content 
8119     * changes), then use elm_gengrid_item_update() to have gengrid
8120     * update the item with the new state. A gengrid will re-"realize"
8121     * the item, thus calling the functions in the
8122     * #Elm_Gengrid_Item_Class set for that item.
8123     *
8124     * To programmatically (un)select an item, use
8125     * elm_gengrid_item_selected_set(). To get its selected state use
8126     * elm_gengrid_item_selected_get(). To make an item disabled
8127     * (unable to be selected and appear differently) use
8128     * elm_gengrid_item_disabled_set() to set this and
8129     * elm_gengrid_item_disabled_get() to get the disabled state.
8130     *
8131     * Grid cells will only have their selection smart callbacks called
8132     * when firstly getting selected. Any further clicks will do
8133     * nothing, unless you enable the "always select mode", with
8134     * elm_gengrid_always_select_mode_set(), thus making every click to
8135     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8136     * turn off the ability to select items entirely in the widget and
8137     * they will neither appear selected nor call the selection smart
8138     * callbacks.
8139     *
8140     * Remember that you can create new styles and add your own theme
8141     * augmentation per application with elm_theme_extension_add(). If
8142     * you absolutely must have a specific style that overrides any
8143     * theme the user or system sets up you can use
8144     * elm_theme_overlay_add() to add such a file.
8145     *
8146     * @section Gengrid_Smart_Events Gengrid smart events
8147     *
8148     * Smart events that you can add callbacks for are:
8149     * - @c "activated" - The user has double-clicked or pressed
8150     *   (enter|return|spacebar) on an item. The @c event_info parameter
8151     *   is the gengrid item that was activated.
8152     * - @c "clicked,double" - The user has double-clicked an item.
8153     *   The @c event_info parameter is the gengrid item that was double-clicked.
8154     * - @c "longpressed" - This is called when the item is pressed for a certain
8155     *   amount of time. By default it's 1 second.
8156     * - @c "selected" - The user has made an item selected. The
8157     *   @c event_info parameter is the gengrid item that was selected.
8158     * - @c "unselected" - The user has made an item unselected. The
8159     *   @c event_info parameter is the gengrid item that was unselected.
8160     * - @c "realized" - This is called when the item in the gengrid
8161     *   has its implementing Evas object instantiated, de facto. @c
8162     *   event_info is the gengrid item that was created. The object
8163     *   may be deleted at any time, so it is highly advised to the
8164     *   caller @b not to use the object pointer returned from
8165     *   elm_gengrid_item_object_get(), because it may point to freed
8166     *   objects.
8167     * - @c "unrealized" - This is called when the implementing Evas
8168     *   object for this item is deleted. @c event_info is the gengrid
8169     *   item that was deleted.
8170     * - @c "changed" - Called when an item is added, removed, resized
8171     *   or moved and when the gengrid is resized or gets "horizontal"
8172     *   property changes.
8173     * - @c "scroll,anim,start" - This is called when scrolling animation has
8174     *   started.
8175     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8176     *   stopped.
8177     * - @c "drag,start,up" - Called when the item in the gengrid has
8178     *   been dragged (not scrolled) up.
8179     * - @c "drag,start,down" - Called when the item in the gengrid has
8180     *   been dragged (not scrolled) down.
8181     * - @c "drag,start,left" - Called when the item in the gengrid has
8182     *   been dragged (not scrolled) left.
8183     * - @c "drag,start,right" - Called when the item in the gengrid has
8184     *   been dragged (not scrolled) right.
8185     * - @c "drag,stop" - Called when the item in the gengrid has
8186     *   stopped being dragged.
8187     * - @c "drag" - Called when the item in the gengrid is being
8188     *   dragged.
8189     * - @c "scroll" - called when the content has been scrolled
8190     *   (moved).
8191     * - @c "scroll,drag,start" - called when dragging the content has
8192     *   started.
8193     * - @c "scroll,drag,stop" - called when dragging the content has
8194     *   stopped.
8195     * - @c "edge,top" - This is called when the gengrid is scrolled until
8196     *   the top edge.
8197     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8198     *   until the bottom edge.
8199     * - @c "edge,left" - This is called when the gengrid is scrolled
8200     *   until the left edge.
8201     * - @c "edge,right" - This is called when the gengrid is scrolled
8202     *   until the right edge.
8203     *
8204     * List of gengrid examples:
8205     * @li @ref gengrid_example
8206     */
8207
8208    /**
8209     * @addtogroup Gengrid
8210     * @{
8211     */
8212
8213    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8214    #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8215    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8216    #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8217    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8218    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8219    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. */
8220    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. */
8221    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8222
8223    /**
8224     * @struct _Elm_Gengrid_Item_Class
8225     *
8226     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8227     * field details.
8228     */
8229    struct _Elm_Gengrid_Item_Class
8230      {
8231         const char             *item_style;
8232         struct _Elm_Gengrid_Item_Class_Func
8233           {
8234              Elm_Gengrid_Item_Label_Get_Cb label_get;
8235              Elm_Gengrid_Item_Content_Get_Cb content_get;
8236              Elm_Gengrid_Item_State_Get_Cb state_get;
8237              Elm_Gengrid_Item_Del_Cb       del;
8238           } func;
8239      }; /**< #Elm_Gengrid_Item_Class member definitions */
8240    #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8241    /**
8242     * Add a new gengrid widget to the given parent Elementary
8243     * (container) object
8244     *
8245     * @param parent The parent object
8246     * @return a new gengrid widget handle or @c NULL, on errors
8247     *
8248     * This function inserts a new gengrid widget on the canvas.
8249     *
8250     * @see elm_gengrid_item_size_set()
8251     * @see elm_gengrid_group_item_size_set()
8252     * @see elm_gengrid_horizontal_set()
8253     * @see elm_gengrid_item_append()
8254     * @see elm_gengrid_item_del()
8255     * @see elm_gengrid_clear()
8256     *
8257     * @ingroup Gengrid
8258     */
8259    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8260
8261    /**
8262     * Set the size for the items of a given gengrid widget
8263     *
8264     * @param obj The gengrid object.
8265     * @param w The items' width.
8266     * @param h The items' height;
8267     *
8268     * A gengrid, after creation, has still no information on the size
8269     * to give to each of its cells. So, you most probably will end up
8270     * with squares one @ref Fingers "finger" wide, the default
8271     * size. Use this function to force a custom size for you items,
8272     * making them as big as you wish.
8273     *
8274     * @see elm_gengrid_item_size_get()
8275     *
8276     * @ingroup Gengrid
8277     */
8278    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8279
8280    /**
8281     * Get the size set for the items of a given gengrid widget
8282     *
8283     * @param obj The gengrid object.
8284     * @param w Pointer to a variable where to store the items' width.
8285     * @param h Pointer to a variable where to store the items' height.
8286     *
8287     * @note Use @c NULL pointers on the size values you're not
8288     * interested in: they'll be ignored by the function.
8289     *
8290     * @see elm_gengrid_item_size_get() for more details
8291     *
8292     * @ingroup Gengrid
8293     */
8294    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8295
8296    /**
8297     * Set the size for the group items of a given gengrid widget
8298     *
8299     * @param obj The gengrid object.
8300     * @param w The group items' width.
8301     * @param h The group items' height;
8302     *
8303     * A gengrid, after creation, has still no information on the size
8304     * to give to each of its cells. So, you most probably will end up
8305     * with squares one @ref Fingers "finger" wide, the default
8306     * size. Use this function to force a custom size for you group items,
8307     * making them as big as you wish.
8308     *
8309     * @see elm_gengrid_group_item_size_get()
8310     *
8311     * @ingroup Gengrid
8312     */
8313    EAPI void               elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8314
8315    /**
8316     * Get the size set for the group items of a given gengrid widget
8317     *
8318     * @param obj The gengrid object.
8319     * @param w Pointer to a variable where to store the group items' width.
8320     * @param h Pointer to a variable where to store the group items' height.
8321     *
8322     * @note Use @c NULL pointers on the size values you're not
8323     * interested in: they'll be ignored by the function.
8324     *
8325     * @see elm_gengrid_group_item_size_get() for more details
8326     *
8327     * @ingroup Gengrid
8328     */
8329    EAPI void               elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8330
8331    /**
8332     * Set the items grid's alignment within a given gengrid widget
8333     *
8334     * @param obj The gengrid object.
8335     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8336     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8337     *
8338     * This sets the alignment of the whole grid of items of a gengrid
8339     * within its given viewport. By default, those values are both
8340     * 0.5, meaning that the gengrid will have its items grid placed
8341     * exactly in the middle of its viewport.
8342     *
8343     * @note If given alignment values are out of the cited ranges,
8344     * they'll be changed to the nearest boundary values on the valid
8345     * ranges.
8346     *
8347     * @see elm_gengrid_align_get()
8348     *
8349     * @ingroup Gengrid
8350     */
8351    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8352
8353    /**
8354     * Get the items grid's alignment values within a given gengrid
8355     * widget
8356     *
8357     * @param obj The gengrid object.
8358     * @param align_x Pointer to a variable where to store the
8359     * horizontal alignment.
8360     * @param align_y Pointer to a variable where to store the vertical
8361     * alignment.
8362     *
8363     * @note Use @c NULL pointers on the alignment values you're not
8364     * interested in: they'll be ignored by the function.
8365     *
8366     * @see elm_gengrid_align_set() for more details
8367     *
8368     * @ingroup Gengrid
8369     */
8370    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8371
8372    /**
8373     * Set whether a given gengrid widget is or not able have items
8374     * @b reordered
8375     *
8376     * @param obj The gengrid object
8377     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8378     * @c EINA_FALSE to turn it off
8379     *
8380     * If a gengrid is set to allow reordering, a click held for more
8381     * than 0.5 over a given item will highlight it specially,
8382     * signalling the gengrid has entered the reordering state. From
8383     * that time on, the user will be able to, while still holding the
8384     * mouse button down, move the item freely in the gengrid's
8385     * viewport, replacing to said item to the locations it goes to.
8386     * The replacements will be animated and, whenever the user
8387     * releases the mouse button, the item being replaced gets a new
8388     * definitive place in the grid.
8389     *
8390     * @see elm_gengrid_reorder_mode_get()
8391     *
8392     * @ingroup Gengrid
8393     */
8394    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8395
8396    /**
8397     * Get whether a given gengrid widget is or not able have items
8398     * @b reordered
8399     *
8400     * @param obj The gengrid object
8401     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8402     * off
8403     *
8404     * @see elm_gengrid_reorder_mode_set() for more details
8405     *
8406     * @ingroup Gengrid
8407     */
8408    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8409
8410    /**
8411     * Append a new item in a given gengrid widget.
8412     *
8413     * @param obj The gengrid object.
8414     * @param gic The item class for the item.
8415     * @param data The item data.
8416     * @param func Convenience function called when the item is
8417     * selected.
8418     * @param func_data Data to be passed to @p func.
8419     * @return A handle to the item added or @c NULL, on errors.
8420     *
8421     * This adds an item to the beginning of the gengrid.
8422     *
8423     * @see elm_gengrid_item_prepend()
8424     * @see elm_gengrid_item_insert_before()
8425     * @see elm_gengrid_item_insert_after()
8426     * @see elm_gengrid_item_del()
8427     *
8428     * @ingroup Gengrid
8429     */
8430    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);
8431
8432    /**
8433     * Prepend a new item in a given gengrid widget.
8434     *
8435     * @param obj The gengrid object.
8436     * @param gic The item class for the item.
8437     * @param data The item data.
8438     * @param func Convenience function called when the item is
8439     * selected.
8440     * @param func_data Data to be passed to @p func.
8441     * @return A handle to the item added or @c NULL, on errors.
8442     *
8443     * This adds an item to the end of the gengrid.
8444     *
8445     * @see elm_gengrid_item_append()
8446     * @see elm_gengrid_item_insert_before()
8447     * @see elm_gengrid_item_insert_after()
8448     * @see elm_gengrid_item_del()
8449     *
8450     * @ingroup Gengrid
8451     */
8452    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);
8453
8454    /**
8455     * Insert an item before another in a gengrid widget
8456     *
8457     * @param obj The gengrid object.
8458     * @param gic The item class for the item.
8459     * @param data The item data.
8460     * @param relative The item to place this new one before.
8461     * @param func Convenience function called when the item is
8462     * selected.
8463     * @param func_data Data to be passed to @p func.
8464     * @return A handle to the item added or @c NULL, on errors.
8465     *
8466     * This inserts an item before another in the gengrid.
8467     *
8468     * @see elm_gengrid_item_append()
8469     * @see elm_gengrid_item_prepend()
8470     * @see elm_gengrid_item_insert_after()
8471     * @see elm_gengrid_item_del()
8472     *
8473     * @ingroup Gengrid
8474     */
8475    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);
8476
8477    /**
8478     * Insert an item after another in a gengrid widget
8479     *
8480     * @param obj The gengrid object.
8481     * @param gic The item class for the item.
8482     * @param data The item data.
8483     * @param relative The item to place this new one after.
8484     * @param func Convenience function called when the item is
8485     * selected.
8486     * @param func_data Data to be passed to @p func.
8487     * @return A handle to the item added or @c NULL, on errors.
8488     *
8489     * This inserts an item after another in the gengrid.
8490     *
8491     * @see elm_gengrid_item_append()
8492     * @see elm_gengrid_item_prepend()
8493     * @see elm_gengrid_item_insert_after()
8494     * @see elm_gengrid_item_del()
8495     *
8496     * @ingroup Gengrid
8497     */
8498    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);
8499
8500    /**
8501     * Insert an item in a gengrid widget using a user-defined sort function.
8502     *
8503     * @param obj The gengrid object.
8504     * @param gic The item class for the item.
8505     * @param data The item data.
8506     * @param comp User defined comparison function that defines the sort order based on
8507     * Elm_Gen_Item and its data param.
8508     * @param func Convenience function called when the item is selected.
8509     * @param func_data Data to be passed to @p func.
8510     * @return A handle to the item added or @c NULL, on errors.
8511     *
8512     * This inserts an item in the gengrid based on user defined comparison function.
8513     *
8514     * @see elm_gengrid_item_append()
8515     * @see elm_gengrid_item_prepend()
8516     * @see elm_gengrid_item_insert_after()
8517     * @see elm_gengrid_item_del()
8518     * @see elm_gengrid_item_direct_sorted_insert()
8519     *
8520     * @ingroup Gengrid
8521     */
8522    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);
8523
8524    /**
8525     * Insert an item in a gengrid widget using a user-defined sort function.
8526     *
8527     * @param obj The gengrid object.
8528     * @param gic The item class for the item.
8529     * @param data The item data.
8530     * @param comp User defined comparison function that defines the sort order based on
8531     * Elm_Gen_Item.
8532     * @param func Convenience function called when the item is selected.
8533     * @param func_data Data to be passed to @p func.
8534     * @return A handle to the item added or @c NULL, on errors.
8535     *
8536     * This inserts an item in the gengrid based on user defined comparison function.
8537     *
8538     * @see elm_gengrid_item_append()
8539     * @see elm_gengrid_item_prepend()
8540     * @see elm_gengrid_item_insert_after()
8541     * @see elm_gengrid_item_del()
8542     * @see elm_gengrid_item_sorted_insert()
8543     *
8544     * @ingroup Gengrid
8545     */
8546    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);
8547
8548    /**
8549     * Set whether items on a given gengrid widget are to get their
8550     * selection callbacks issued for @b every subsequent selection
8551     * click on them or just for the first click.
8552     *
8553     * @param obj The gengrid object
8554     * @param always_select @c EINA_TRUE to make items "always
8555     * selected", @c EINA_FALSE, otherwise
8556     *
8557     * By default, grid items will only call their selection callback
8558     * function when firstly getting selected, any subsequent further
8559     * clicks will do nothing. With this call, you make those
8560     * subsequent clicks also to issue the selection callbacks.
8561     *
8562     * @note <b>Double clicks</b> will @b always be reported on items.
8563     *
8564     * @see elm_gengrid_always_select_mode_get()
8565     *
8566     * @ingroup Gengrid
8567     */
8568    EINA_DEPRECATED EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8569
8570    /**
8571     * Get whether items on a given gengrid widget have their selection
8572     * callbacks issued for @b every subsequent selection click on them
8573     * or just for the first click.
8574     *
8575     * @param obj The gengrid object.
8576     * @return @c EINA_TRUE if the gengrid items are "always selected",
8577     * @c EINA_FALSE, otherwise
8578     *
8579     * @see elm_gengrid_always_select_mode_set() for more details
8580     *
8581     * @ingroup Gengrid
8582     */
8583    EINA_DEPRECATED EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8584
8585    /**
8586     * Set whether items on a given gengrid widget can be selected or not.
8587     *
8588     * @param obj The gengrid object
8589     * @param no_select @c EINA_TRUE to make items selectable,
8590     * @c EINA_FALSE otherwise
8591     *
8592     * This will make items in @p obj selectable or not. In the latter
8593     * case, any user interaction on the gengrid items will neither make
8594     * them appear selected nor them call their selection callback
8595     * functions.
8596     *
8597     * @see elm_gengrid_no_select_mode_get()
8598     *
8599     * @ingroup Gengrid
8600     */
8601    EINA_DEPRECATED EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8602
8603    /**
8604     * Get whether items on a given gengrid widget can be selected or
8605     * not.
8606     *
8607     * @param obj The gengrid object
8608     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8609     * otherwise
8610     *
8611     * @see elm_gengrid_no_select_mode_set() for more details
8612     *
8613     * @ingroup Gengrid
8614     */
8615    EINA_DEPRECATED EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8616
8617    /**
8618     * Enable or disable multi-selection in a given gengrid widget
8619     *
8620     * @param obj The gengrid object.
8621     * @param multi @c EINA_TRUE, to enable multi-selection,
8622     * @c EINA_FALSE to disable it.
8623     *
8624     * Multi-selection is the ability to have @b more than one
8625     * item selected, on a given gengrid, simultaneously. When it is
8626     * enabled, a sequence of clicks on different items will make them
8627     * all selected, progressively. A click on an already selected item
8628     * will unselect it. If interacting via the keyboard,
8629     * multi-selection is enabled while holding the "Shift" key.
8630     *
8631     * @note By default, multi-selection is @b disabled on gengrids
8632     *
8633     * @see elm_gengrid_multi_select_get()
8634     *
8635     * @ingroup Gengrid
8636     */
8637    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8638
8639    /**
8640     * Get whether multi-selection is enabled or disabled for a given
8641     * gengrid widget
8642     *
8643     * @param obj The gengrid object.
8644     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8645     * EINA_FALSE otherwise
8646     *
8647     * @see elm_gengrid_multi_select_set() for more details
8648     *
8649     * @ingroup Gengrid
8650     */
8651    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8652
8653    /**
8654     * Enable or disable bouncing effect for a given gengrid widget
8655     *
8656     * @param obj The gengrid object
8657     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8658     * @c EINA_FALSE to disable it
8659     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8660     * @c EINA_FALSE to disable it
8661     *
8662     * The bouncing effect occurs whenever one reaches the gengrid's
8663     * edge's while panning it -- it will scroll past its limits a
8664     * little bit and return to the edge again, in a animated for,
8665     * automatically.
8666     *
8667     * @note By default, gengrids have bouncing enabled on both axis
8668     *
8669     * @see elm_gengrid_bounce_get()
8670     *
8671     * @ingroup Gengrid
8672     */
8673    EINA_DEPRECATED EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8674
8675    /**
8676     * Get whether bouncing effects are enabled or disabled, for a
8677     * given gengrid widget, on each axis
8678     *
8679     * @param obj The gengrid object
8680     * @param h_bounce Pointer to a variable where to store the
8681     * horizontal bouncing flag.
8682     * @param v_bounce Pointer to a variable where to store the
8683     * vertical bouncing flag.
8684     *
8685     * @see elm_gengrid_bounce_set() for more details
8686     *
8687     * @ingroup Gengrid
8688     */
8689    EINA_DEPRECATED EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8690
8691    /**
8692     * Set a given gengrid widget's scrolling page size, relative to
8693     * its viewport size.
8694     *
8695     * @param obj The gengrid object
8696     * @param h_pagerel The horizontal page (relative) size
8697     * @param v_pagerel The vertical page (relative) size
8698     *
8699     * The gengrid's scroller is capable of binding scrolling by the
8700     * user to "pages". It means that, while scrolling and, specially
8701     * after releasing the mouse button, the grid will @b snap to the
8702     * nearest displaying page's area. When page sizes are set, the
8703     * grid's continuous content area is split into (equal) page sized
8704     * pieces.
8705     *
8706     * This function sets the size of a page <b>relatively to the
8707     * viewport dimensions</b> of the gengrid, for each axis. A value
8708     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8709     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8710     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8711     * 1.0. Values beyond those will make it behave behave
8712     * inconsistently. If you only want one axis to snap to pages, use
8713     * the value @c 0.0 for the other one.
8714     *
8715     * There is a function setting page size values in @b absolute
8716     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8717     * is mutually exclusive to this one.
8718     *
8719     * @see elm_gengrid_page_relative_get()
8720     *
8721     * @ingroup Gengrid
8722     */
8723    EINA_DEPRECATED EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8724
8725    /**
8726     * Get a given gengrid widget's scrolling page size, relative to
8727     * its viewport size.
8728     *
8729     * @param obj The gengrid object
8730     * @param h_pagerel Pointer to a variable where to store the
8731     * horizontal page (relative) size
8732     * @param v_pagerel Pointer to a variable where to store the
8733     * vertical page (relative) size
8734     *
8735     * @see elm_gengrid_page_relative_set() for more details
8736     *
8737     * @ingroup Gengrid
8738     */
8739    EINA_DEPRECATED EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8740
8741    /**
8742     * Set a given gengrid widget's scrolling page size
8743     *
8744     * @param obj The gengrid object
8745     * @param h_pagerel The horizontal page size, in pixels
8746     * @param v_pagerel The vertical page size, in pixels
8747     *
8748     * The gengrid's scroller is capable of binding scrolling by the
8749     * user to "pages". It means that, while scrolling and, specially
8750     * after releasing the mouse button, the grid will @b snap to the
8751     * nearest displaying page's area. When page sizes are set, the
8752     * grid's continuous content area is split into (equal) page sized
8753     * pieces.
8754     *
8755     * This function sets the size of a page of the gengrid, in pixels,
8756     * for each axis. Sane usable values are, between @c 0 and the
8757     * dimensions of @p obj, for each axis. Values beyond those will
8758     * make it behave behave inconsistently. If you only want one axis
8759     * to snap to pages, use the value @c 0 for the other one.
8760     *
8761     * There is a function setting page size values in @b relative
8762     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8763     * use is mutually exclusive to this one.
8764     *
8765     * @ingroup Gengrid
8766     */
8767    EINA_DEPRECATED EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8768
8769    /**
8770     * @brief Get gengrid current page number.
8771     *
8772     * @param obj The gengrid object
8773     * @param h_pagenumber The horizontal page number
8774     * @param v_pagenumber The vertical page number
8775     *
8776     * The page number starts from 0. 0 is the first page.
8777     * Current page means the page which meet the top-left of the viewport.
8778     * If there are two or more pages in the viewport, it returns the number of page
8779     * which meet the top-left of the viewport.
8780     *
8781     * @see elm_gengrid_last_page_get()
8782     * @see elm_gengrid_page_show()
8783     * @see elm_gengrid_page_brint_in()
8784     */
8785    EINA_DEPRECATED EAPI void         elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8786
8787    /**
8788     * @brief Get scroll last page number.
8789     *
8790     * @param obj The gengrid object
8791     * @param h_pagenumber The horizontal page number
8792     * @param v_pagenumber The vertical page number
8793     *
8794     * The page number starts from 0. 0 is the first page.
8795     * This returns the last page number among the pages.
8796     *
8797     * @see elm_gengrid_current_page_get()
8798     * @see elm_gengrid_page_show()
8799     * @see elm_gengrid_page_brint_in()
8800     */
8801    EINA_DEPRECATED EAPI void         elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8802
8803    /**
8804     * Show a specific virtual region within the gengrid content object by page number.
8805     *
8806     * @param obj The gengrid object
8807     * @param h_pagenumber The horizontal page number
8808     * @param v_pagenumber The vertical page number
8809     *
8810     * 0, 0 of the indicated page is located at the top-left of the viewport.
8811     * This will jump to the page directly without animation.
8812     *
8813     * Example of usage:
8814     *
8815     * @code
8816     * sc = elm_gengrid_add(win);
8817     * elm_gengrid_content_set(sc, content);
8818     * elm_gengrid_page_relative_set(sc, 1, 0);
8819     * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8820     * elm_gengrid_page_show(sc, h_page + 1, v_page);
8821     * @endcode
8822     *
8823     * @see elm_gengrid_page_bring_in()
8824     */
8825    EINA_DEPRECATED EAPI void         elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8826
8827    /**
8828     * Show a specific virtual region within the gengrid content object by page number.
8829     *
8830     * @param obj The gengrid object
8831     * @param h_pagenumber The horizontal page number
8832     * @param v_pagenumber The vertical page number
8833     *
8834     * 0, 0 of the indicated page is located at the top-left of the viewport.
8835     * This will slide to the page with animation.
8836     *
8837     * Example of usage:
8838     *
8839     * @code
8840     * sc = elm_gengrid_add(win);
8841     * elm_gengrid_content_set(sc, content);
8842     * elm_gengrid_page_relative_set(sc, 1, 0);
8843     * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8844     * elm_gengrid_page_bring_in(sc, h_page, v_page);
8845     * @endcode
8846     *
8847     * @see elm_gengrid_page_show()
8848     */
8849     EINA_DEPRECATED EAPI void         elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8850
8851    /**
8852     * Set the direction in which a given gengrid widget will expand while
8853     * placing its items.
8854     *
8855     * @param obj The gengrid object.
8856     * @param setting @c EINA_TRUE to make the gengrid expand
8857     * horizontally, @c EINA_FALSE to expand vertically.
8858     *
8859     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8860     * in @b columns, from top to bottom and, when the space for a
8861     * column is filled, another one is started on the right, thus
8862     * expanding the grid horizontally. When in "vertical mode"
8863     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8864     * to right and, when the space for a row is filled, another one is
8865     * started below, thus expanding the grid vertically.
8866     *
8867     * @see elm_gengrid_horizontal_get()
8868     *
8869     * @ingroup Gengrid
8870     */
8871    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8872
8873    /**
8874     * Get for what direction a given gengrid widget will expand while
8875     * placing its items.
8876     *
8877     * @param obj The gengrid object.
8878     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8879     * @c EINA_FALSE if it's set to expand vertically.
8880     *
8881     * @see elm_gengrid_horizontal_set() for more detais
8882     *
8883     * @ingroup Gengrid
8884     */
8885    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8886
8887    /**
8888     * Get the first item in a given gengrid widget
8889     *
8890     * @param obj The gengrid object
8891     * @return The first item's handle or @c NULL, if there are no
8892     * items in @p obj (and on errors)
8893     *
8894     * This returns the first item in the @p obj's internal list of
8895     * items.
8896     *
8897     * @see elm_gengrid_last_item_get()
8898     *
8899     * @ingroup Gengrid
8900     */
8901    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8902
8903    /**
8904     * Get the last item in a given gengrid widget
8905     *
8906     * @param obj The gengrid object
8907     * @return The last item's handle or @c NULL, if there are no
8908     * items in @p obj (and on errors)
8909     *
8910     * This returns the last item in the @p obj's internal list of
8911     * items.
8912     *
8913     * @see elm_gengrid_first_item_get()
8914     *
8915     * @ingroup Gengrid
8916     */
8917    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8918
8919    /**
8920     * Get the @b next item in a gengrid widget's internal list of items,
8921     * given a handle to one of those items.
8922     *
8923     * @param item The gengrid item to fetch next from
8924     * @return The item after @p item, or @c NULL if there's none (and
8925     * on errors)
8926     *
8927     * This returns the item placed after the @p item, on the container
8928     * gengrid.
8929     *
8930     * @see elm_gengrid_item_prev_get()
8931     *
8932     * @ingroup Gengrid
8933     */
8934    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8935
8936    /**
8937     * Get the @b previous item in a gengrid widget's internal list of items,
8938     * given a handle to one of those items.
8939     *
8940     * @param item The gengrid item to fetch previous from
8941     * @return The item before @p item, or @c NULL if there's none (and
8942     * on errors)
8943     *
8944     * This returns the item placed before the @p item, on the container
8945     * gengrid.
8946     *
8947     * @see elm_gengrid_item_next_get()
8948     *
8949     * @ingroup Gengrid
8950     */
8951    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8952
8953    /**
8954     * Get the gengrid object's handle which contains a given gengrid
8955     * item
8956     *
8957     * @param item The item to fetch the container from
8958     * @return The gengrid (parent) object
8959     *
8960     * This returns the gengrid object itself that an item belongs to.
8961     *
8962     * @ingroup Gengrid
8963     */
8964    EINA_DEPRECATED EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8965
8966    /**
8967     * Remove a gengrid item from its parent, deleting it.
8968     *
8969     * @param item The item to be removed.
8970     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8971     *
8972     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8973     * once.
8974     *
8975     * @ingroup Gengrid
8976     */
8977    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8978
8979    /**
8980     * Update the contents of a given gengrid item
8981     *
8982     * @param item The gengrid item
8983     *
8984     * This updates an item by calling all the item class functions
8985     * again to get the contents, labels and states. Use this when the
8986     * original item data has changed and you want the changes to be
8987     * reflected.
8988     *
8989     * @ingroup Gengrid
8990     */
8991    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8992
8993    /**
8994     * Get the Gengrid Item class for the given Gengrid Item.
8995     *
8996     * @param item The gengrid item
8997     *
8998     * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8999     * the function pointers and item_style.
9000     *
9001     * @ingroup Gengrid
9002     */
9003    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9004
9005    /**
9006     * Get the Gengrid Item class for the given Gengrid Item.
9007     *
9008     * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9009     * the function pointers and item_style.
9010     *
9011     * @param item The gengrid item
9012     * @param gic The gengrid item class describing the function pointers and the item style.
9013     *
9014     * @ingroup Gengrid
9015     */
9016    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9017
9018    /**
9019     * Return the data associated to a given gengrid item
9020     *
9021     * @param item The gengrid item.
9022     * @return the data associated with this item.
9023     *
9024     * This returns the @c data value passed on the
9025     * elm_gengrid_item_append() and related item addition calls.
9026     *
9027     * @see elm_gengrid_item_append()
9028     * @see elm_gengrid_item_data_set()
9029     *
9030     * @ingroup Gengrid
9031     */
9032    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9033
9034    /**
9035     * Set the data associated with a given gengrid item
9036     *
9037     * @param item The gengrid item
9038     * @param data The data pointer to set on it
9039     *
9040     * This @b overrides the @c data value passed on the
9041     * elm_gengrid_item_append() and related item addition calls. This
9042     * function @b won't call elm_gengrid_item_update() automatically,
9043     * so you'd issue it afterwards if you want to have the item
9044     * updated to reflect the new data.
9045     *
9046     * @see elm_gengrid_item_data_get()
9047     * @see elm_gengrid_item_update()
9048     *
9049     * @ingroup Gengrid
9050     */
9051    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9052
9053    /**
9054     * Get a given gengrid item's position, relative to the whole
9055     * gengrid's grid area.
9056     *
9057     * @param item The Gengrid item.
9058     * @param x Pointer to variable to store the item's <b>row number</b>.
9059     * @param y Pointer to variable to store the item's <b>column number</b>.
9060     *
9061     * This returns the "logical" position of the item within the
9062     * gengrid. For example, @c (0, 1) would stand for first row,
9063     * second column.
9064     *
9065     * @ingroup Gengrid
9066     */
9067    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9068
9069    /**
9070     * Set whether a given gengrid item is selected or not
9071     *
9072     * @param item The gengrid item
9073     * @param selected Use @c EINA_TRUE, to make it selected, @c
9074     * EINA_FALSE to make it unselected
9075     *
9076     * This sets the selected state of an item. If multi-selection is
9077     * not enabled on the containing gengrid and @p selected is @c
9078     * EINA_TRUE, any other previously selected items will get
9079     * unselected in favor of this new one.
9080     *
9081     * @see elm_gengrid_item_selected_get()
9082     *
9083     * @ingroup Gengrid
9084     */
9085    EINA_DEPRECATED EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9086
9087    /**
9088     * Get whether a given gengrid item is selected or not
9089     *
9090     * @param item The gengrid item
9091     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9092     *
9093     * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9094     *
9095     * @see elm_gengrid_item_selected_set() for more details
9096     *
9097     * @ingroup Gengrid
9098     */
9099    EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9100
9101    /**
9102     * Get the real Evas object created to implement the view of a
9103     * given gengrid item
9104     *
9105     * @param item The gengrid item.
9106     * @return the Evas object implementing this item's view.
9107     *
9108     * This returns the actual Evas object used to implement the
9109     * specified gengrid item's view. This may be @c NULL, as it may
9110     * not have been created or may have been deleted, at any time, by
9111     * the gengrid. <b>Do not modify this object</b> (move, resize,
9112     * show, hide, etc.), as the gengrid is controlling it. This
9113     * function is for querying, emitting custom signals or hooking
9114     * lower level callbacks for events on that object. Do not delete
9115     * this object under any circumstances.
9116     *
9117     * @see elm_gengrid_item_data_get()
9118     *
9119     * @ingroup Gengrid
9120     */
9121    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9122
9123    /**
9124     * Show the portion of a gengrid's internal grid containing a given
9125     * item, @b immediately.
9126     *
9127     * @param item The item to display
9128     *
9129     * This causes gengrid to @b redraw its viewport's contents to the
9130     * region contining the given @p item item, if it is not fully
9131     * visible.
9132     *
9133     * @see elm_gengrid_item_bring_in()
9134     *
9135     * @ingroup Gengrid
9136     */
9137    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9138
9139    /**
9140     * Animatedly bring in, to the visible area of a gengrid, a given
9141     * item on it.
9142     *
9143     * @param item The gengrid item to display
9144     *
9145     * This causes gengrid to jump to the given @p item and show
9146     * it (by scrolling), if it is not fully visible. This will use
9147     * animation to do so and take a period of time to complete.
9148     *
9149     * @see elm_gengrid_item_show()
9150     *
9151     * @ingroup Gengrid
9152     */
9153    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9154
9155    /**
9156     * Set whether a given gengrid item is disabled or not.
9157     *
9158     * @param item The gengrid item
9159     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9160     * to enable it back.
9161     *
9162     * A disabled item cannot be selected or unselected. It will also
9163     * change its appearance, to signal the user it's disabled.
9164     *
9165     * @see elm_gengrid_item_disabled_get()
9166     *
9167     * @ingroup Gengrid
9168     */
9169    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9170
9171    /**
9172     * Get whether a given gengrid item is disabled or not.
9173     *
9174     * @param item The gengrid item
9175     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9176     * (and on errors).
9177     *
9178     * @see elm_gengrid_item_disabled_set() for more details
9179     *
9180     * @ingroup Gengrid
9181     */
9182    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9183
9184    /**
9185     * Set the text to be shown in a given gengrid item's tooltips.
9186     *
9187     * @param item The gengrid item
9188     * @param text The text to set in the content
9189     *
9190     * This call will setup the text to be used as tooltip to that item
9191     * (analogous to elm_object_tooltip_text_set(), but being item
9192     * tooltips with higher precedence than object tooltips). It can
9193     * have only one tooltip at a time, so any previous tooltip data
9194     * will get removed.
9195     *
9196     * @ingroup Gengrid
9197     */
9198    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9199
9200    /**
9201     * Set the content to be shown in a given gengrid item's tooltip
9202     *
9203     * @param item The gengrid item.
9204     * @param func The function returning the tooltip contents.
9205     * @param data What to provide to @a func as callback data/context.
9206     * @param del_cb Called when data is not needed anymore, either when
9207     *        another callback replaces @p func, the tooltip is unset with
9208     *        elm_gengrid_item_tooltip_unset() or the owner @p item
9209     *        dies. This callback receives as its first parameter the
9210     *        given @p data, being @c event_info the item handle.
9211     *
9212     * This call will setup the tooltip's contents to @p item
9213     * (analogous to elm_object_tooltip_content_cb_set(), but being
9214     * item tooltips with higher precedence than object tooltips). It
9215     * can have only one tooltip at a time, so any previous tooltip
9216     * content will get removed. @p func (with @p data) will be called
9217     * every time Elementary needs to show the tooltip and it should
9218     * return a valid Evas object, which will be fully managed by the
9219     * tooltip system, getting deleted when the tooltip is gone.
9220     *
9221     * @ingroup Gengrid
9222     */
9223    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);
9224
9225    /**
9226     * Unset a tooltip from a given gengrid item
9227     *
9228     * @param item gengrid item to remove a previously set tooltip from.
9229     *
9230     * This call removes any tooltip set on @p item. The callback
9231     * provided as @c del_cb to
9232     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9233     * notify it is not used anymore (and have resources cleaned, if
9234     * need be).
9235     *
9236     * @see elm_gengrid_item_tooltip_content_cb_set()
9237     *
9238     * @ingroup Gengrid
9239     */
9240    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9241
9242    /**
9243     * Set a different @b style for a given gengrid item's tooltip.
9244     *
9245     * @param item gengrid item with tooltip set
9246     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9247     * "default", @c "transparent", etc)
9248     *
9249     * Tooltips can have <b>alternate styles</b> to be displayed on,
9250     * which are defined by the theme set on Elementary. This function
9251     * works analogously as elm_object_tooltip_style_set(), but here
9252     * applied only to gengrid item objects. The default style for
9253     * tooltips is @c "default".
9254     *
9255     * @note before you set a style you should define a tooltip with
9256     *       elm_gengrid_item_tooltip_content_cb_set() or
9257     *       elm_gengrid_item_tooltip_text_set()
9258     *
9259     * @see elm_gengrid_item_tooltip_style_get()
9260     *
9261     * @ingroup Gengrid
9262     */
9263    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9264
9265    /**
9266     * Get the style set a given gengrid item's tooltip.
9267     *
9268     * @param item gengrid item with tooltip already set on.
9269     * @return style the theme style in use, which defaults to
9270     *         "default". If the object does not have a tooltip set,
9271     *         then @c NULL is returned.
9272     *
9273     * @see elm_gengrid_item_tooltip_style_set() for more details
9274     *
9275     * @ingroup Gengrid
9276     */
9277    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9278    /**
9279     * @brief Disable size restrictions on an object's tooltip
9280     * @param item The tooltip's anchor object
9281     * @param disable If EINA_TRUE, size restrictions are disabled
9282     * @return EINA_FALSE on failure, EINA_TRUE on success
9283     *
9284     * This function allows a tooltip to expand beyond its parant window's canvas.
9285     * It will instead be limited only by the size of the display.
9286     */
9287    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9288    /**
9289     * @brief Retrieve size restriction state of an object's tooltip
9290     * @param item The tooltip's anchor object
9291     * @return If EINA_TRUE, size restrictions are disabled
9292     *
9293     * This function returns whether a tooltip is allowed to expand beyond
9294     * its parant window's canvas.
9295     * It will instead be limited only by the size of the display.
9296     */
9297    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9298    /**
9299     * Set the type of mouse pointer/cursor decoration to be shown,
9300     * when the mouse pointer is over the given gengrid widget item
9301     *
9302     * @param item gengrid item to customize cursor on
9303     * @param cursor the cursor type's name
9304     *
9305     * This function works analogously as elm_object_cursor_set(), but
9306     * here the cursor's changing area is restricted to the item's
9307     * area, and not the whole widget's. Note that that item cursors
9308     * have precedence over widget cursors, so that a mouse over @p
9309     * item will always show cursor @p type.
9310     *
9311     * If this function is called twice for an object, a previously set
9312     * cursor will be unset on the second call.
9313     *
9314     * @see elm_object_cursor_set()
9315     * @see elm_gengrid_item_cursor_get()
9316     * @see elm_gengrid_item_cursor_unset()
9317     *
9318     * @ingroup Gengrid
9319     */
9320    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9321
9322    /**
9323     * Get the type of mouse pointer/cursor decoration set to be shown,
9324     * when the mouse pointer is over the given gengrid widget item
9325     *
9326     * @param item gengrid item with custom cursor set
9327     * @return the cursor type's name or @c NULL, if no custom cursors
9328     * were set to @p item (and on errors)
9329     *
9330     * @see elm_object_cursor_get()
9331     * @see elm_gengrid_item_cursor_set() for more details
9332     * @see elm_gengrid_item_cursor_unset()
9333     *
9334     * @ingroup Gengrid
9335     */
9336    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9337
9338    /**
9339     * Unset any custom mouse pointer/cursor decoration set to be
9340     * shown, when the mouse pointer is over the given gengrid widget
9341     * item, thus making it show the @b default cursor again.
9342     *
9343     * @param item a gengrid item
9344     *
9345     * Use this call to undo any custom settings on this item's cursor
9346     * decoration, bringing it back to defaults (no custom style set).
9347     *
9348     * @see elm_object_cursor_unset()
9349     * @see elm_gengrid_item_cursor_set() for more details
9350     *
9351     * @ingroup Gengrid
9352     */
9353    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9354
9355    /**
9356     * Set a different @b style for a given custom cursor set for a
9357     * gengrid item.
9358     *
9359     * @param item gengrid item with custom cursor set
9360     * @param style the <b>theme style</b> to use (e.g. @c "default",
9361     * @c "transparent", etc)
9362     *
9363     * This function only makes sense when one is using custom mouse
9364     * cursor decorations <b>defined in a theme file</b> , which can
9365     * have, given a cursor name/type, <b>alternate styles</b> on
9366     * it. It works analogously as elm_object_cursor_style_set(), but
9367     * here applied only to gengrid item objects.
9368     *
9369     * @warning Before you set a cursor style you should have defined a
9370     *       custom cursor previously on the item, with
9371     *       elm_gengrid_item_cursor_set()
9372     *
9373     * @see elm_gengrid_item_cursor_engine_only_set()
9374     * @see elm_gengrid_item_cursor_style_get()
9375     *
9376     * @ingroup Gengrid
9377     */
9378    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9379
9380    /**
9381     * Get the current @b style set for a given gengrid item's custom
9382     * cursor
9383     *
9384     * @param item gengrid item with custom cursor set.
9385     * @return style the cursor style in use. If the object does not
9386     *         have a cursor set, then @c NULL is returned.
9387     *
9388     * @see elm_gengrid_item_cursor_style_set() for more details
9389     *
9390     * @ingroup Gengrid
9391     */
9392    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9393
9394    /**
9395     * Set if the (custom) cursor for a given gengrid item should be
9396     * searched in its theme, also, or should only rely on the
9397     * rendering engine.
9398     *
9399     * @param item item with custom (custom) cursor already set on
9400     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9401     * only on those provided by the rendering engine, @c EINA_FALSE to
9402     * have them searched on the widget's theme, as well.
9403     *
9404     * @note This call is of use only if you've set a custom cursor
9405     * for gengrid items, with elm_gengrid_item_cursor_set().
9406     *
9407     * @note By default, cursors will only be looked for between those
9408     * provided by the rendering engine.
9409     *
9410     * @ingroup Gengrid
9411     */
9412    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9413
9414    /**
9415     * Get if the (custom) cursor for a given gengrid item is being
9416     * searched in its theme, also, or is only relying on the rendering
9417     * engine.
9418     *
9419     * @param item a gengrid item
9420     * @return @c EINA_TRUE, if cursors are being looked for only on
9421     * those provided by the rendering engine, @c EINA_FALSE if they
9422     * are being searched on the widget's theme, as well.
9423     *
9424     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9425     *
9426     * @ingroup Gengrid
9427     */
9428    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9429
9430    /**
9431     * Remove all items from a given gengrid widget
9432     *
9433     * @param obj The gengrid object.
9434     *
9435     * This removes (and deletes) all items in @p obj, leaving it
9436     * empty.
9437     *
9438     * @see elm_gengrid_item_del(), to remove just one item.
9439     *
9440     * @ingroup Gengrid
9441     */
9442    EINA_DEPRECATED EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9443
9444    /**
9445     * Get the selected item in a given gengrid widget
9446     *
9447     * @param obj The gengrid object.
9448     * @return The selected item's handleor @c NULL, if none is
9449     * selected at the moment (and on errors)
9450     *
9451     * This returns the selected item in @p obj. If multi selection is
9452     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9453     * the first item in the list is selected, which might not be very
9454     * useful. For that case, see elm_gengrid_selected_items_get().
9455     *
9456     * @ingroup Gengrid
9457     */
9458    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9459
9460    /**
9461     * Get <b>a list</b> of selected items in a given gengrid
9462     *
9463     * @param obj The gengrid object.
9464     * @return The list of selected items or @c NULL, if none is
9465     * selected at the moment (and on errors)
9466     *
9467     * This returns a list of the selected items, in the order that
9468     * they appear in the grid. This list is only valid as long as no
9469     * more items are selected or unselected (or unselected implictly
9470     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9471     * data, naturally.
9472     *
9473     * @see elm_gengrid_selected_item_get()
9474     *
9475     * @ingroup Gengrid
9476     */
9477    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9478
9479    /**
9480     * @}
9481     */
9482
9483    /**
9484     * @defgroup Clock Clock
9485     *
9486     * @image html img/widget/clock/preview-00.png
9487     * @image latex img/widget/clock/preview-00.eps
9488     *
9489     * This is a @b digital clock widget. In its default theme, it has a
9490     * vintage "flipping numbers clock" appearance, which will animate
9491     * sheets of individual algarisms individually as time goes by.
9492     *
9493     * A newly created clock will fetch system's time (already
9494     * considering local time adjustments) to start with, and will tick
9495     * accondingly. It may or may not show seconds.
9496     *
9497     * Clocks have an @b edition mode. When in it, the sheets will
9498     * display extra arrow indications on the top and bottom and the
9499     * user may click on them to raise or lower the time values. After
9500     * it's told to exit edition mode, it will keep ticking with that
9501     * new time set (it keeps the difference from local time).
9502     *
9503     * Also, when under edition mode, user clicks on the cited arrows
9504     * which are @b held for some time will make the clock to flip the
9505     * sheet, thus editing the time, continuosly and automatically for
9506     * the user. The interval between sheet flips will keep growing in
9507     * time, so that it helps the user to reach a time which is distant
9508     * from the one set.
9509     *
9510     * The time display is, by default, in military mode (24h), but an
9511     * am/pm indicator may be optionally shown, too, when it will
9512     * switch to 12h.
9513     *
9514     * Smart callbacks one can register to:
9515     * - "changed" - the clock's user changed the time
9516     *
9517     * Here is an example on its usage:
9518     * @li @ref clock_example
9519     */
9520
9521    /**
9522     * @addtogroup Clock
9523     * @{
9524     */
9525
9526    /**
9527     * Identifiers for which clock digits should be editable, when a
9528     * clock widget is in edition mode. Values may be ORed together to
9529     * make a mask, naturally.
9530     *
9531     * @see elm_clock_edit_set()
9532     * @see elm_clock_digit_edit_set()
9533     */
9534    typedef enum _Elm_Clock_Digedit
9535      {
9536         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9537         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9538         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9539         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9540         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9541         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9542         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9543         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9544      } Elm_Clock_Digedit;
9545
9546    /**
9547     * Add a new clock widget to the given parent Elementary
9548     * (container) object
9549     *
9550     * @param parent The parent object
9551     * @return a new clock widget handle or @c NULL, on errors
9552     *
9553     * This function inserts a new clock widget on the canvas.
9554     *
9555     * @ingroup Clock
9556     */
9557    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9558
9559    /**
9560     * Set a clock widget's time, programmatically
9561     *
9562     * @param obj The clock widget object
9563     * @param hrs The hours to set
9564     * @param min The minutes to set
9565     * @param sec The secondes to set
9566     *
9567     * This function updates the time that is showed by the clock
9568     * widget.
9569     *
9570     *  Values @b must be set within the following ranges:
9571     * - 0 - 23, for hours
9572     * - 0 - 59, for minutes
9573     * - 0 - 59, for seconds,
9574     *
9575     * even if the clock is not in "military" mode.
9576     *
9577     * @warning The behavior for values set out of those ranges is @b
9578     * indefined.
9579     *
9580     * @ingroup Clock
9581     */
9582    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9583
9584    /**
9585     * Get a clock widget's time values
9586     *
9587     * @param obj The clock object
9588     * @param[out] hrs Pointer to the variable to get the hours value
9589     * @param[out] min Pointer to the variable to get the minutes value
9590     * @param[out] sec Pointer to the variable to get the seconds value
9591     *
9592     * This function gets the time set for @p obj, returning
9593     * it on the variables passed as the arguments to function
9594     *
9595     * @note Use @c NULL pointers on the time values you're not
9596     * interested in: they'll be ignored by the function.
9597     *
9598     * @ingroup Clock
9599     */
9600    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9601
9602    /**
9603     * Set whether a given clock widget is under <b>edition mode</b> or
9604     * under (default) displaying-only mode.
9605     *
9606     * @param obj The clock object
9607     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9608     * put it back to "displaying only" mode
9609     *
9610     * This function makes a clock's time to be editable or not <b>by
9611     * user interaction</b>. When in edition mode, clocks @b stop
9612     * ticking, until one brings them back to canonical mode. The
9613     * elm_clock_digit_edit_set() function will influence which digits
9614     * of the clock will be editable. By default, all of them will be
9615     * (#ELM_CLOCK_NONE).
9616     *
9617     * @note am/pm sheets, if being shown, will @b always be editable
9618     * under edition mode.
9619     *
9620     * @see elm_clock_edit_get()
9621     *
9622     * @ingroup Clock
9623     */
9624    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9625
9626    /**
9627     * Retrieve whether a given clock widget is under <b>edition
9628     * mode</b> or under (default) displaying-only mode.
9629     *
9630     * @param obj The clock object
9631     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9632     * otherwise
9633     *
9634     * This function retrieves whether the clock's time can be edited
9635     * or not by user interaction.
9636     *
9637     * @see elm_clock_edit_set() for more details
9638     *
9639     * @ingroup Clock
9640     */
9641    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9642
9643    /**
9644     * Set what digits of the given clock widget should be editable
9645     * when in edition mode.
9646     *
9647     * @param obj The clock object
9648     * @param digedit Bit mask indicating the digits to be editable
9649     * (values in #Elm_Clock_Digedit).
9650     *
9651     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9652     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9653     * EINA_FALSE).
9654     *
9655     * @see elm_clock_digit_edit_get()
9656     *
9657     * @ingroup Clock
9658     */
9659    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9660
9661    /**
9662     * Retrieve what digits of the given clock widget should be
9663     * editable when in edition mode.
9664     *
9665     * @param obj The clock object
9666     * @return Bit mask indicating the digits to be editable
9667     * (values in #Elm_Clock_Digedit).
9668     *
9669     * @see elm_clock_digit_edit_set() for more details
9670     *
9671     * @ingroup Clock
9672     */
9673    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9674
9675    /**
9676     * Set if the given clock widget must show hours in military or
9677     * am/pm mode
9678     *
9679     * @param obj The clock object
9680     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9681     * to military mode
9682     *
9683     * This function sets if the clock must show hours in military or
9684     * am/pm mode. In some countries like Brazil the military mode
9685     * (00-24h-format) is used, in opposition to the USA, where the
9686     * am/pm mode is more commonly used.
9687     *
9688     * @see elm_clock_show_am_pm_get()
9689     *
9690     * @ingroup Clock
9691     */
9692    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9693
9694    /**
9695     * Get if the given clock widget shows hours in military or am/pm
9696     * mode
9697     *
9698     * @param obj The clock object
9699     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9700     * military
9701     *
9702     * This function gets if the clock shows hours in military or am/pm
9703     * mode.
9704     *
9705     * @see elm_clock_show_am_pm_set() for more details
9706     *
9707     * @ingroup Clock
9708     */
9709    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9710
9711    /**
9712     * Set if the given clock widget must show time with seconds or not
9713     *
9714     * @param obj The clock object
9715     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9716     *
9717     * This function sets if the given clock must show or not elapsed
9718     * seconds. By default, they are @b not shown.
9719     *
9720     * @see elm_clock_show_seconds_get()
9721     *
9722     * @ingroup Clock
9723     */
9724    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9725
9726    /**
9727     * Get whether the given clock widget is showing time with seconds
9728     * or not
9729     *
9730     * @param obj The clock object
9731     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9732     *
9733     * This function gets whether @p obj is showing or not the elapsed
9734     * seconds.
9735     *
9736     * @see elm_clock_show_seconds_set()
9737     *
9738     * @ingroup Clock
9739     */
9740    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9741
9742    /**
9743     * Set the interval on time updates for an user mouse button hold
9744     * on clock widgets' time edition.
9745     *
9746     * @param obj The clock object
9747     * @param interval The (first) interval value in seconds
9748     *
9749     * This interval value is @b decreased while the user holds the
9750     * mouse pointer either incrementing or decrementing a given the
9751     * clock digit's value.
9752     *
9753     * This helps the user to get to a given time distant from the
9754     * current one easier/faster, as it will start to flip quicker and
9755     * quicker on mouse button holds.
9756     *
9757     * The calculation for the next flip interval value, starting from
9758     * the one set with this call, is the previous interval divided by
9759     * 1.05, so it decreases a little bit.
9760     *
9761     * The default starting interval value for automatic flips is
9762     * @b 0.85 seconds.
9763     *
9764     * @see elm_clock_interval_get()
9765     *
9766     * @ingroup Clock
9767     */
9768    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9769
9770    /**
9771     * Get the interval on time updates for an user mouse button hold
9772     * on clock widgets' time edition.
9773     *
9774     * @param obj The clock object
9775     * @return The (first) interval value, in seconds, set on it
9776     *
9777     * @see elm_clock_interval_set() for more details
9778     *
9779     * @ingroup Clock
9780     */
9781    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9782
9783    /**
9784     * @}
9785     */
9786
9787    /**
9788     * @defgroup Layout Layout
9789     *
9790     * @image html img/widget/layout/preview-00.png
9791     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9792     *
9793     * @image html img/layout-predefined.png
9794     * @image latex img/layout-predefined.eps width=\textwidth
9795     *
9796     * This is a container widget that takes a standard Edje design file and
9797     * wraps it very thinly in a widget.
9798     *
9799     * An Edje design (theme) file has a very wide range of possibilities to
9800     * describe the behavior of elements added to the Layout. Check out the Edje
9801     * documentation and the EDC reference to get more information about what can
9802     * be done with Edje.
9803     *
9804     * Just like @ref List, @ref Box, and other container widgets, any
9805     * object added to the Layout will become its child, meaning that it will be
9806     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9807     *
9808     * The Layout widget can contain as many Contents, Boxes or Tables as
9809     * described in its theme file. For instance, objects can be added to
9810     * different Tables by specifying the respective Table part names. The same
9811     * is valid for Content and Box.
9812     *
9813     * The objects added as child of the Layout will behave as described in the
9814     * part description where they were added. There are 3 possible types of
9815     * parts where a child can be added:
9816     *
9817     * @section secContent Content (SWALLOW part)
9818     *
9819     * Only one object can be added to the @c SWALLOW part (but you still can
9820     * have many @c SWALLOW parts and one object on each of them). Use the @c
9821     * elm_object_content_set/get/unset functions to set, retrieve and unset 
9822     * objects as content of the @c SWALLOW. After being set to this part, the 
9823     * object size, position, visibility, clipping and other description 
9824     * properties will be totally controled by the description of the given part 
9825     * (inside the Edje theme file).
9826     *
9827     * One can use @c evas_object_size_hint_* functions on the child to have some
9828     * kind of control over its behavior, but the resulting behavior will still
9829     * depend heavily on the @c SWALLOW part description.
9830     *
9831     * The Edje theme also can change the part description, based on signals or
9832     * scripts running inside the theme. This change can also be animated. All of
9833     * this will affect the child object set as content accordingly. The object
9834     * size will be changed if the part size is changed, it will animate move if
9835     * the part is moving, and so on.
9836     *
9837     * The following picture demonstrates a Layout widget with a child object
9838     * added to its @c SWALLOW:
9839     *
9840     * @image html layout_swallow.png
9841     * @image latex layout_swallow.eps width=\textwidth
9842     *
9843     * @section secBox Box (BOX part)
9844     *
9845     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9846     * allows one to add objects to the box and have them distributed along its
9847     * area, accordingly to the specified @a layout property (now by @a layout we
9848     * mean the chosen layouting design of the Box, not the Layout widget
9849     * itself).
9850     *
9851     * A similar effect for having a box with its position, size and other things
9852     * controled by the Layout theme would be to create an Elementary @ref Box
9853     * widget and add it as a Content in the @c SWALLOW part.
9854     *
9855     * The main difference of using the Layout Box is that its behavior, the box
9856     * properties like layouting format, padding, align, etc. will be all
9857     * controled by the theme. This means, for example, that a signal could be
9858     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9859     * handled the signal by changing the box padding, or align, or both. Using
9860     * the Elementary @ref Box widget is not necessarily harder or easier, it
9861     * just depends on the circunstances and requirements.
9862     *
9863     * The Layout Box can be used through the @c elm_layout_box_* set of
9864     * functions.
9865     *
9866     * The following picture demonstrates a Layout widget with many child objects
9867     * added to its @c BOX part:
9868     *
9869     * @image html layout_box.png
9870     * @image latex layout_box.eps width=\textwidth
9871     *
9872     * @section secTable Table (TABLE part)
9873     *
9874     * Just like the @ref secBox, the Layout Table is very similar to the
9875     * Elementary @ref Table widget. It allows one to add objects to the Table
9876     * specifying the row and column where the object should be added, and any
9877     * column or row span if necessary.
9878     *
9879     * Again, we could have this design by adding a @ref Table widget to the @c
9880     * SWALLOW part using elm_object_content_part_set(). The same difference happens
9881     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9882     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9883     *
9884     * The Layout Table can be used through the @c elm_layout_table_* set of
9885     * functions.
9886     *
9887     * The following picture demonstrates a Layout widget with many child objects
9888     * added to its @c TABLE part:
9889     *
9890     * @image html layout_table.png
9891     * @image latex layout_table.eps width=\textwidth
9892     *
9893     * @section secPredef Predefined Layouts
9894     *
9895     * Another interesting thing about the Layout widget is that it offers some
9896     * predefined themes that come with the default Elementary theme. These
9897     * themes can be set by the call elm_layout_theme_set(), and provide some
9898     * basic functionality depending on the theme used.
9899     *
9900     * Most of them already send some signals, some already provide a toolbar or
9901     * back and next buttons.
9902     *
9903     * These are available predefined theme layouts. All of them have class = @c
9904     * layout, group = @c application, and style = one of the following options:
9905     *
9906     * @li @c toolbar-content - application with toolbar and main content area
9907     * @li @c toolbar-content-back - application with toolbar and main content
9908     * area with a back button and title area
9909     * @li @c toolbar-content-back-next - application with toolbar and main
9910     * content area with a back and next buttons and title area
9911     * @li @c content-back - application with a main content area with a back
9912     * button and title area
9913     * @li @c content-back-next - application with a main content area with a
9914     * back and next buttons and title area
9915     * @li @c toolbar-vbox - application with toolbar and main content area as a
9916     * vertical box
9917     * @li @c toolbar-table - application with toolbar and main content area as a
9918     * table
9919     *
9920     * @section secExamples Examples
9921     *
9922     * Some examples of the Layout widget can be found here:
9923     * @li @ref layout_example_01
9924     * @li @ref layout_example_02
9925     * @li @ref layout_example_03
9926     * @li @ref layout_example_edc
9927     *
9928     */
9929
9930    /**
9931     * Add a new layout to the parent
9932     *
9933     * @param parent The parent object
9934     * @return The new object or NULL if it cannot be created
9935     *
9936     * @see elm_layout_file_set()
9937     * @see elm_layout_theme_set()
9938     *
9939     * @ingroup Layout
9940     */
9941    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9942    /**
9943     * Set the file that will be used as layout
9944     *
9945     * @param obj The layout object
9946     * @param file The path to file (edj) that will be used as layout
9947     * @param group The group that the layout belongs in edje file
9948     *
9949     * @return (1 = success, 0 = error)
9950     *
9951     * @ingroup Layout
9952     */
9953    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9954    /**
9955     * Set the edje group from the elementary theme that will be used as layout
9956     *
9957     * @param obj The layout object
9958     * @param clas the clas of the group
9959     * @param group the group
9960     * @param style the style to used
9961     *
9962     * @return (1 = success, 0 = error)
9963     *
9964     * @ingroup Layout
9965     */
9966    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9967    /**
9968     * Set the layout content.
9969     *
9970     * @param obj The layout object
9971     * @param swallow The swallow part name in the edje file
9972     * @param content The child that will be added in this layout object
9973     *
9974     * Once the content object is set, a previously set one will be deleted.
9975     * If you want to keep that old content object, use the
9976     * elm_object_content_part_unset() function.
9977     *
9978     * @note In an Edje theme, the part used as a content container is called @c
9979     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9980     * expected to be a part name just like the second parameter of
9981     * elm_layout_box_append().
9982     *
9983     * @see elm_layout_box_append()
9984     * @see elm_object_content_part_get()
9985     * @see elm_object_content_part_unset()
9986     * @see @ref secBox
9987     *
9988     * @ingroup Layout
9989     */
9990    EINA_DEPRECATED EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9991    /**
9992     * Get the child object in the given content part.
9993     *
9994     * @param obj The layout object
9995     * @param swallow The SWALLOW part to get its content
9996     *
9997     * @return The swallowed object or NULL if none or an error occurred
9998     *
9999     * @see elm_object_content_part_set()
10000     *
10001     * @ingroup Layout
10002     */
10003    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10004    /**
10005     * Unset the layout content.
10006     *
10007     * @param obj The layout object
10008     * @param swallow The swallow part name in the edje file
10009     * @return The content that was being used
10010     *
10011     * Unparent and return the content object which was set for this part.
10012     *
10013     * @see elm_object_content_part_set()
10014     *
10015     * @ingroup Layout
10016     */
10017    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10018    /**
10019     * Set the text of the given part
10020     *
10021     * @param obj The layout object
10022     * @param part The TEXT part where to set the text
10023     * @param text The text to set
10024     *
10025     * @ingroup Layout
10026     * @deprecated use elm_object_text_* instead.
10027     */
10028    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10029    /**
10030     * Get the text set in the given part
10031     *
10032     * @param obj The layout object
10033     * @param part The TEXT part to retrieve the text off
10034     *
10035     * @return The text set in @p part
10036     *
10037     * @ingroup Layout
10038     * @deprecated use elm_object_text_* instead.
10039     */
10040    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10041    /**
10042     * Append child to layout box part.
10043     *
10044     * @param obj the layout object
10045     * @param part the box part to which the object will be appended.
10046     * @param child the child object to append to box.
10047     *
10048     * Once the object is appended, it will become child of the layout. Its
10049     * lifetime will be bound to the layout, whenever the layout dies the child
10050     * will be deleted automatically. One should use elm_layout_box_remove() to
10051     * make this layout forget about the object.
10052     *
10053     * @see elm_layout_box_prepend()
10054     * @see elm_layout_box_insert_before()
10055     * @see elm_layout_box_insert_at()
10056     * @see elm_layout_box_remove()
10057     *
10058     * @ingroup Layout
10059     */
10060    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10061    /**
10062     * Prepend child to layout box part.
10063     *
10064     * @param obj the layout object
10065     * @param part the box part to prepend.
10066     * @param child the child object to prepend to box.
10067     *
10068     * Once the object is prepended, it will become child of the layout. Its
10069     * lifetime will be bound to the layout, whenever the layout dies the child
10070     * will be deleted automatically. One should use elm_layout_box_remove() to
10071     * make this layout forget about the object.
10072     *
10073     * @see elm_layout_box_append()
10074     * @see elm_layout_box_insert_before()
10075     * @see elm_layout_box_insert_at()
10076     * @see elm_layout_box_remove()
10077     *
10078     * @ingroup Layout
10079     */
10080    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10081    /**
10082     * Insert child to layout box part before a reference object.
10083     *
10084     * @param obj the layout object
10085     * @param part the box part to insert.
10086     * @param child the child object to insert into box.
10087     * @param reference another reference object to insert before in box.
10088     *
10089     * Once the object is inserted, it will become child of the layout. Its
10090     * lifetime will be bound to the layout, whenever the layout dies the child
10091     * will be deleted automatically. One should use elm_layout_box_remove() to
10092     * make this layout forget about the object.
10093     *
10094     * @see elm_layout_box_append()
10095     * @see elm_layout_box_prepend()
10096     * @see elm_layout_box_insert_before()
10097     * @see elm_layout_box_remove()
10098     *
10099     * @ingroup Layout
10100     */
10101    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10102    /**
10103     * Insert child to layout box part at a given position.
10104     *
10105     * @param obj the layout object
10106     * @param part the box part to insert.
10107     * @param child the child object to insert into box.
10108     * @param pos the numeric position >=0 to insert the child.
10109     *
10110     * Once the object is inserted, it will become child of the layout. Its
10111     * lifetime will be bound to the layout, whenever the layout dies the child
10112     * will be deleted automatically. One should use elm_layout_box_remove() to
10113     * make this layout forget about the object.
10114     *
10115     * @see elm_layout_box_append()
10116     * @see elm_layout_box_prepend()
10117     * @see elm_layout_box_insert_before()
10118     * @see elm_layout_box_remove()
10119     *
10120     * @ingroup Layout
10121     */
10122    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10123    /**
10124     * Remove a child of the given part box.
10125     *
10126     * @param obj The layout object
10127     * @param part The box part name to remove child.
10128     * @param child The object to remove from box.
10129     * @return The object that was being used, or NULL if not found.
10130     *
10131     * The object will be removed from the box part and its lifetime will
10132     * not be handled by the layout anymore. This is equivalent to
10133     * elm_object_content_part_unset() for box.
10134     *
10135     * @see elm_layout_box_append()
10136     * @see elm_layout_box_remove_all()
10137     *
10138     * @ingroup Layout
10139     */
10140    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10141    /**
10142     * Remove all child of the given part box.
10143     *
10144     * @param obj The layout object
10145     * @param part The box part name to remove child.
10146     * @param clear If EINA_TRUE, then all objects will be deleted as
10147     *        well, otherwise they will just be removed and will be
10148     *        dangling on the canvas.
10149     *
10150     * The objects will be removed from the box part and their lifetime will
10151     * not be handled by the layout anymore. This is equivalent to
10152     * elm_layout_box_remove() for all box children.
10153     *
10154     * @see elm_layout_box_append()
10155     * @see elm_layout_box_remove()
10156     *
10157     * @ingroup Layout
10158     */
10159    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10160    /**
10161     * Insert child to layout table part.
10162     *
10163     * @param obj the layout object
10164     * @param part the box part to pack child.
10165     * @param child_obj the child object to pack into table.
10166     * @param col the column to which the child should be added. (>= 0)
10167     * @param row the row to which the child should be added. (>= 0)
10168     * @param colspan how many columns should be used to store this object. (>=
10169     *        1)
10170     * @param rowspan how many rows should be used to store this object. (>= 1)
10171     *
10172     * Once the object is inserted, it will become child of the table. Its
10173     * lifetime will be bound to the layout, and whenever the layout dies the
10174     * child will be deleted automatically. One should use
10175     * elm_layout_table_remove() to make this layout forget about the object.
10176     *
10177     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10178     * more space than a single cell. For instance, the following code:
10179     * @code
10180     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10181     * @endcode
10182     *
10183     * Would result in an object being added like the following picture:
10184     *
10185     * @image html layout_colspan.png
10186     * @image latex layout_colspan.eps width=\textwidth
10187     *
10188     * @see elm_layout_table_unpack()
10189     * @see elm_layout_table_clear()
10190     *
10191     * @ingroup Layout
10192     */
10193    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);
10194    /**
10195     * Unpack (remove) a child of the given part table.
10196     *
10197     * @param obj The layout object
10198     * @param part The table part name to remove child.
10199     * @param child_obj The object to remove from table.
10200     * @return The object that was being used, or NULL if not found.
10201     *
10202     * The object will be unpacked from the table part and its lifetime
10203     * will not be handled by the layout anymore. This is equivalent to
10204     * elm_object_content_part_unset() for table.
10205     *
10206     * @see elm_layout_table_pack()
10207     * @see elm_layout_table_clear()
10208     *
10209     * @ingroup Layout
10210     */
10211    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10212    /**
10213     * Remove all child of the given part table.
10214     *
10215     * @param obj The layout object
10216     * @param part The table part name to remove child.
10217     * @param clear If EINA_TRUE, then all objects will be deleted as
10218     *        well, otherwise they will just be removed and will be
10219     *        dangling on the canvas.
10220     *
10221     * The objects will be removed from the table part and their lifetime will
10222     * not be handled by the layout anymore. This is equivalent to
10223     * elm_layout_table_unpack() for all table children.
10224     *
10225     * @see elm_layout_table_pack()
10226     * @see elm_layout_table_unpack()
10227     *
10228     * @ingroup Layout
10229     */
10230    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10231    /**
10232     * Get the edje layout
10233     *
10234     * @param obj The layout object
10235     *
10236     * @return A Evas_Object with the edje layout settings loaded
10237     * with function elm_layout_file_set
10238     *
10239     * This returns the edje object. It is not expected to be used to then
10240     * swallow objects via edje_object_part_swallow() for example. Use
10241     * elm_object_content_part_set() instead so child object handling and sizing is
10242     * done properly.
10243     *
10244     * @note This function should only be used if you really need to call some
10245     * low level Edje function on this edje object. All the common stuff (setting
10246     * text, emitting signals, hooking callbacks to signals, etc.) can be done
10247     * with proper elementary functions.
10248     *
10249     * @see elm_object_signal_callback_add()
10250     * @see elm_object_signal_emit()
10251     * @see elm_object_text_part_set()
10252     * @see elm_object_content_part_set()
10253     * @see elm_layout_box_append()
10254     * @see elm_layout_table_pack()
10255     * @see elm_layout_data_get()
10256     *
10257     * @ingroup Layout
10258     */
10259    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10260    /**
10261     * Get the edje data from the given layout
10262     *
10263     * @param obj The layout object
10264     * @param key The data key
10265     *
10266     * @return The edje data string
10267     *
10268     * This function fetches data specified inside the edje theme of this layout.
10269     * This function return NULL if data is not found.
10270     *
10271     * In EDC this comes from a data block within the group block that @p
10272     * obj was loaded from. E.g.
10273     *
10274     * @code
10275     * collections {
10276     *   group {
10277     *     name: "a_group";
10278     *     data {
10279     *       item: "key1" "value1";
10280     *       item: "key2" "value2";
10281     *     }
10282     *   }
10283     * }
10284     * @endcode
10285     *
10286     * @ingroup Layout
10287     */
10288    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10289    /**
10290     * Eval sizing
10291     *
10292     * @param obj The layout object
10293     *
10294     * Manually forces a sizing re-evaluation. This is useful when the minimum
10295     * size required by the edje theme of this layout has changed. The change on
10296     * the minimum size required by the edje theme is not immediately reported to
10297     * the elementary layout, so one needs to call this function in order to tell
10298     * the widget (layout) that it needs to reevaluate its own size.
10299     *
10300     * The minimum size of the theme is calculated based on minimum size of
10301     * parts, the size of elements inside containers like box and table, etc. All
10302     * of this can change due to state changes, and that's when this function
10303     * should be called.
10304     *
10305     * Also note that a standard signal of "size,eval" "elm" emitted from the
10306     * edje object will cause this to happen too.
10307     *
10308     * @ingroup Layout
10309     */
10310    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10311
10312    /**
10313     * Sets a specific cursor for an edje part.
10314     *
10315     * @param obj The layout object.
10316     * @param part_name a part from loaded edje group.
10317     * @param cursor cursor name to use, see Elementary_Cursor.h
10318     *
10319     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10320     *         part not exists or it has "mouse_events: 0".
10321     *
10322     * @ingroup Layout
10323     */
10324    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10325
10326    /**
10327     * Get the cursor to be shown when mouse is over an edje part
10328     *
10329     * @param obj The layout object.
10330     * @param part_name a part from loaded edje group.
10331     * @return the cursor name.
10332     *
10333     * @ingroup Layout
10334     */
10335    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10336
10337    /**
10338     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10339     *
10340     * @param obj The layout object.
10341     * @param part_name a part from loaded edje group, that had a cursor set
10342     *        with elm_layout_part_cursor_set().
10343     *
10344     * @ingroup Layout
10345     */
10346    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10347
10348    /**
10349     * Sets a specific cursor style for an edje part.
10350     *
10351     * @param obj The layout object.
10352     * @param part_name a part from loaded edje group.
10353     * @param style the theme style to use (default, transparent, ...)
10354     *
10355     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10356     *         part not exists or it did not had a cursor set.
10357     *
10358     * @ingroup Layout
10359     */
10360    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10361
10362    /**
10363     * Gets a specific cursor style for an edje part.
10364     *
10365     * @param obj The layout object.
10366     * @param part_name a part from loaded edje group.
10367     *
10368     * @return the theme style in use, defaults to "default". If the
10369     *         object does not have a cursor set, then NULL is returned.
10370     *
10371     * @ingroup Layout
10372     */
10373    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10374
10375    /**
10376     * Sets if the cursor set should be searched on the theme or should use
10377     * the provided by the engine, only.
10378     *
10379     * @note before you set if should look on theme you should define a
10380     * cursor with elm_layout_part_cursor_set(). By default it will only
10381     * look for cursors provided by the engine.
10382     *
10383     * @param obj The layout object.
10384     * @param part_name a part from loaded edje group.
10385     * @param engine_only if cursors should be just provided by the engine
10386     *        or should also search on widget's theme as well
10387     *
10388     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10389     *         part not exists or it did not had a cursor set.
10390     *
10391     * @ingroup Layout
10392     */
10393    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);
10394
10395    /**
10396     * Gets a specific cursor engine_only for an edje part.
10397     *
10398     * @param obj The layout object.
10399     * @param part_name a part from loaded edje group.
10400     *
10401     * @return whenever the cursor is just provided by engine or also from theme.
10402     *
10403     * @ingroup Layout
10404     */
10405    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10406
10407 /**
10408  * @def elm_layout_icon_set
10409  * Convienience macro to set the icon object in a layout that follows the
10410  * Elementary naming convention for its parts.
10411  *
10412  * @ingroup Layout
10413  */
10414 #define elm_layout_icon_set(_ly, _obj) \
10415   do { \
10416     const char *sig; \
10417     elm_object_content_part_set((_ly), "elm.swallow.icon", (_obj)); \
10418     if ((_obj)) sig = "elm,state,icon,visible"; \
10419     else sig = "elm,state,icon,hidden"; \
10420     elm_object_signal_emit((_ly), sig, "elm"); \
10421   } while (0)
10422
10423 /**
10424  * @def elm_layout_icon_get
10425  * Convienience macro to get the icon object from a layout that follows the
10426  * Elementary naming convention for its parts.
10427  *
10428  * @ingroup Layout
10429  */
10430 #define elm_layout_icon_get(_ly) \
10431   elm_object_content_part_get((_ly), "elm.swallow.icon")
10432
10433 /**
10434  * @def elm_layout_end_set
10435  * Convienience macro to set the end object in a layout that follows the
10436  * Elementary naming convention for its parts.
10437  *
10438  * @ingroup Layout
10439  */
10440 #define elm_layout_end_set(_ly, _obj) \
10441   do { \
10442     const char *sig; \
10443     elm_object_content_part_set((_ly), "elm.swallow.end", (_obj)); \
10444     if ((_obj)) sig = "elm,state,end,visible"; \
10445     else sig = "elm,state,end,hidden"; \
10446     elm_object_signal_emit((_ly), sig, "elm"); \
10447   } while (0)
10448
10449 /**
10450  * @def elm_layout_end_get
10451  * Convienience macro to get the end object in a layout that follows the
10452  * Elementary naming convention for its parts.
10453  *
10454  * @ingroup Layout
10455  */
10456 #define elm_layout_end_get(_ly) \
10457   elm_object_content_part_get((_ly), "elm.swallow.end")
10458
10459 /**
10460  * @def elm_layout_label_set
10461  * Convienience macro to set the label in a layout that follows the
10462  * Elementary naming convention for its parts.
10463  *
10464  * @ingroup Layout
10465  * @deprecated use elm_object_text_* instead.
10466  */
10467 #define elm_layout_label_set(_ly, _txt) \
10468   elm_layout_text_set((_ly), "elm.text", (_txt))
10469
10470 /**
10471  * @def elm_layout_label_get
10472  * Convienience macro to get the label in a layout that follows the
10473  * Elementary naming convention for its parts.
10474  *
10475  * @ingroup Layout
10476  * @deprecated use elm_object_text_* instead.
10477  */
10478 #define elm_layout_label_get(_ly) \
10479   elm_layout_text_get((_ly), "elm.text")
10480
10481    /* smart callbacks called:
10482     * "theme,changed" - when elm theme is changed.
10483     */
10484
10485    /**
10486     * @defgroup Notify Notify
10487     *
10488     * @image html img/widget/notify/preview-00.png
10489     * @image latex img/widget/notify/preview-00.eps
10490     *
10491     * Display a container in a particular region of the parent(top, bottom,
10492     * etc.  A timeout can be set to automatically hide the notify. This is so
10493     * that, after an evas_object_show() on a notify object, if a timeout was set
10494     * on it, it will @b automatically get hidden after that time.
10495     *
10496     * Signals that you can add callbacks for are:
10497     * @li "timeout" - when timeout happens on notify and it's hidden
10498     * @li "block,clicked" - when a click outside of the notify happens
10499     *
10500     * Default contents parts of the notify widget that you can use for are:
10501     * @li "elm.swallow.content" - A content of the notify
10502     *
10503     * @ref tutorial_notify show usage of the API.
10504     *
10505     * @{
10506     */
10507    /**
10508     * @brief Possible orient values for notify.
10509     *
10510     * This values should be used in conjunction to elm_notify_orient_set() to
10511     * set the position in which the notify should appear(relative to its parent)
10512     * and in conjunction with elm_notify_orient_get() to know where the notify
10513     * is appearing.
10514     */
10515    typedef enum _Elm_Notify_Orient
10516      {
10517         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10518         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10519         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10520         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10521         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10522         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10523         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10524         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10525         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10526         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10527      } Elm_Notify_Orient;
10528    /**
10529     * @brief Add a new notify to the parent
10530     *
10531     * @param parent The parent object
10532     * @return The new object or NULL if it cannot be created
10533     */
10534    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10535    /**
10536     * @brief Set the content of the notify widget
10537     *
10538     * @param obj The notify object
10539     * @param content The content will be filled in this notify object
10540     *
10541     * Once the content object is set, a previously set one will be deleted. If
10542     * you want to keep that old content object, use the
10543     * elm_notify_content_unset() function.
10544     */
10545    EINA_DEPRECATED EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10546    /**
10547     * @brief Unset the content of the notify widget
10548     *
10549     * @param obj The notify object
10550     * @return The content that was being used
10551     *
10552     * Unparent and return the content object which was set for this widget
10553     *
10554     * @see elm_notify_content_set()
10555     */
10556    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10557    /**
10558     * @brief Return the content of the notify widget
10559     *
10560     * @param obj The notify object
10561     * @return The content that is being used
10562     *
10563     * @see elm_notify_content_set()
10564     */
10565    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10566    /**
10567     * @brief Set the notify parent
10568     *
10569     * @param obj The notify object
10570     * @param content The new parent
10571     *
10572     * Once the parent object is set, a previously set one will be disconnected
10573     * and replaced.
10574     */
10575    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10576    /**
10577     * @brief Get the notify parent
10578     *
10579     * @param obj The notify object
10580     * @return The parent
10581     *
10582     * @see elm_notify_parent_set()
10583     */
10584    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10585    /**
10586     * @brief Set the orientation
10587     *
10588     * @param obj The notify object
10589     * @param orient The new orientation
10590     *
10591     * Sets the position in which the notify will appear in its parent.
10592     *
10593     * @see @ref Elm_Notify_Orient for possible values.
10594     */
10595    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10596    /**
10597     * @brief Return the orientation
10598     * @param obj The notify object
10599     * @return The orientation of the notification
10600     *
10601     * @see elm_notify_orient_set()
10602     * @see Elm_Notify_Orient
10603     */
10604    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10605    /**
10606     * @brief Set the time interval after which the notify window is going to be
10607     * hidden.
10608     *
10609     * @param obj The notify object
10610     * @param time The timeout in seconds
10611     *
10612     * This function sets a timeout and starts the timer controlling when the
10613     * notify is hidden. Since calling evas_object_show() on a notify restarts
10614     * the timer controlling when the notify is hidden, setting this before the
10615     * notify is shown will in effect mean starting the timer when the notify is
10616     * shown.
10617     *
10618     * @note Set a value <= 0.0 to disable a running timer.
10619     *
10620     * @note If the value > 0.0 and the notify is previously visible, the
10621     * timer will be started with this value, canceling any running timer.
10622     */
10623    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10624    /**
10625     * @brief Return the timeout value (in seconds)
10626     * @param obj the notify object
10627     *
10628     * @see elm_notify_timeout_set()
10629     */
10630    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10631    /**
10632     * @brief Sets whether events should be passed to by a click outside
10633     * its area.
10634     *
10635     * @param obj The notify object
10636     * @param repeats EINA_TRUE Events are repeats, else no
10637     *
10638     * When true if the user clicks outside the window the events will be caught
10639     * by the others widgets, else the events are blocked.
10640     *
10641     * @note The default value is EINA_TRUE.
10642     */
10643    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10644    /**
10645     * @brief Return true if events are repeat below the notify object
10646     * @param obj the notify object
10647     *
10648     * @see elm_notify_repeat_events_set()
10649     */
10650    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10651    /**
10652     * @}
10653     */
10654
10655    /**
10656     * @defgroup Hover Hover
10657     *
10658     * @image html img/widget/hover/preview-00.png
10659     * @image latex img/widget/hover/preview-00.eps
10660     *
10661     * A Hover object will hover over its @p parent object at the @p target
10662     * location. Anything in the background will be given a darker coloring to
10663     * indicate that the hover object is on top (at the default theme). When the
10664     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10665     * clicked that @b doesn't cause the hover to be dismissed.
10666     *
10667     * A Hover object has two parents. One parent that owns it during creation
10668     * and the other parent being the one over which the hover object spans.
10669     *
10670     *
10671     * @note The hover object will take up the entire space of @p target
10672     * object.
10673     *
10674     * Elementary has the following styles for the hover widget:
10675     * @li default
10676     * @li popout
10677     * @li menu
10678     * @li hoversel_vertical
10679     *
10680     * The following are the available position for content:
10681     * @li left
10682     * @li top-left
10683     * @li top
10684     * @li top-right
10685     * @li right
10686     * @li bottom-right
10687     * @li bottom
10688     * @li bottom-left
10689     * @li middle
10690     * @li smart
10691     *
10692     * Signals that you can add callbacks for are:
10693     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10694     * @li "smart,changed" - a content object placed under the "smart"
10695     *                   policy was replaced to a new slot direction.
10696     *
10697     * See @ref tutorial_hover for more information.
10698     *
10699     * @{
10700     */
10701    typedef enum _Elm_Hover_Axis
10702      {
10703         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10704         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10705         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10706         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10707      } Elm_Hover_Axis;
10708    /**
10709     * @brief Adds a hover object to @p parent
10710     *
10711     * @param parent The parent object
10712     * @return The hover object or NULL if one could not be created
10713     */
10714    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10715    /**
10716     * @brief Sets the target object for the hover.
10717     *
10718     * @param obj The hover object
10719     * @param target The object to center the hover onto. The hover
10720     *
10721     * This function will cause the hover to be centered on the target object.
10722     */
10723    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10724    /**
10725     * @brief Gets the target object for the hover.
10726     *
10727     * @param obj The hover object
10728     * @param parent The object to locate the hover over.
10729     *
10730     * @see elm_hover_target_set()
10731     */
10732    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10733    /**
10734     * @brief Sets the parent object for the hover.
10735     *
10736     * @param obj The hover object
10737     * @param parent The object to locate the hover over.
10738     *
10739     * This function will cause the hover to take up the entire space that the
10740     * parent object fills.
10741     */
10742    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10743    /**
10744     * @brief Gets the parent object for the hover.
10745     *
10746     * @param obj The hover object
10747     * @return The parent object to locate the hover over.
10748     *
10749     * @see elm_hover_parent_set()
10750     */
10751    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10752    /**
10753     * @brief Sets the content of the hover object and the direction in which it
10754     * will pop out.
10755     *
10756     * @param obj The hover object
10757     * @param swallow The direction that the object will be displayed
10758     * at. Accepted values are "left", "top-left", "top", "top-right",
10759     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10760     * "smart".
10761     * @param content The content to place at @p swallow
10762     *
10763     * Once the content object is set for a given direction, a previously
10764     * set one (on the same direction) will be deleted. If you want to
10765     * keep that old content object, use the elm_hover_content_unset()
10766     * function.
10767     *
10768     * All directions may have contents at the same time, except for
10769     * "smart". This is a special placement hint and its use case
10770     * independs of the calculations coming from
10771     * elm_hover_best_content_location_get(). Its use is for cases when
10772     * one desires only one hover content, but with a dinamic special
10773     * placement within the hover area. The content's geometry, whenever
10774     * it changes, will be used to decide on a best location not
10775     * extrapolating the hover's parent object view to show it in (still
10776     * being the hover's target determinant of its medium part -- move and
10777     * resize it to simulate finger sizes, for example). If one of the
10778     * directions other than "smart" are used, a previously content set
10779     * using it will be deleted, and vice-versa.
10780     */
10781    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10782    /**
10783     * @brief Get the content of the hover object, in a given direction.
10784     *
10785     * Return the content object which was set for this widget in the
10786     * @p swallow direction.
10787     *
10788     * @param obj The hover object
10789     * @param swallow The direction that the object was display at.
10790     * @return The content that was being used
10791     *
10792     * @see elm_hover_content_set()
10793     */
10794    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10795    /**
10796     * @brief Unset the content of the hover object, in a given direction.
10797     *
10798     * Unparent and return the content object set at @p swallow direction.
10799     *
10800     * @param obj The hover object
10801     * @param swallow The direction that the object was display at.
10802     * @return The content that was being used.
10803     *
10804     * @see elm_hover_content_set()
10805     */
10806    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10807    /**
10808     * @brief Returns the best swallow location for content in the hover.
10809     *
10810     * @param obj The hover object
10811     * @param pref_axis The preferred orientation axis for the hover object to use
10812     * @return The edje location to place content into the hover or @c
10813     *         NULL, on errors.
10814     *
10815     * Best is defined here as the location at which there is the most available
10816     * space.
10817     *
10818     * @p pref_axis may be one of
10819     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10820     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10821     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10822     * - @c ELM_HOVER_AXIS_BOTH -- both
10823     *
10824     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10825     * nescessarily be along the horizontal axis("left" or "right"). If
10826     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10827     * be along the vertical axis("top" or "bottom"). Chossing
10828     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10829     * returned position may be in either axis.
10830     *
10831     * @see elm_hover_content_set()
10832     */
10833    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10834    /**
10835     * @}
10836     */
10837
10838    /* entry */
10839    /**
10840     * @defgroup Entry Entry
10841     *
10842     * @image html img/widget/entry/preview-00.png
10843     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10844     * @image html img/widget/entry/preview-01.png
10845     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10846     * @image html img/widget/entry/preview-02.png
10847     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10848     * @image html img/widget/entry/preview-03.png
10849     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10850     *
10851     * An entry is a convenience widget which shows a box that the user can
10852     * enter text into. Entries by default don't scroll, so they grow to
10853     * accomodate the entire text, resizing the parent window as needed. This
10854     * can be changed with the elm_entry_scrollable_set() function.
10855     *
10856     * They can also be single line or multi line (the default) and when set
10857     * to multi line mode they support text wrapping in any of the modes
10858     * indicated by #Elm_Wrap_Type.
10859     *
10860     * Other features include password mode, filtering of inserted text with
10861     * elm_entry_text_filter_append() and related functions, inline "items" and
10862     * formatted markup text.
10863     *
10864     * @section entry-markup Formatted text
10865     *
10866     * The markup tags supported by the Entry are defined by the theme, but
10867     * even when writing new themes or extensions it's a good idea to stick to
10868     * a sane default, to maintain coherency and avoid application breakages.
10869     * Currently defined by the default theme are the following tags:
10870     * @li \<br\>: Inserts a line break.
10871     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10872     * breaks.
10873     * @li \<tab\>: Inserts a tab.
10874     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10875     * enclosed text.
10876     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10877     * @li \<link\>...\</link\>: Underlines the enclosed text.
10878     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10879     *
10880     * @section entry-special Special markups
10881     *
10882     * Besides those used to format text, entries support two special markup
10883     * tags used to insert clickable portions of text or items inlined within
10884     * the text.
10885     *
10886     * @subsection entry-anchors Anchors
10887     *
10888     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10889     * \</a\> tags and an event will be generated when this text is clicked,
10890     * like this:
10891     *
10892     * @code
10893     * This text is outside <a href=anc-01>but this one is an anchor</a>
10894     * @endcode
10895     *
10896     * The @c href attribute in the opening tag gives the name that will be
10897     * used to identify the anchor and it can be any valid utf8 string.
10898     *
10899     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10900     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10901     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10902     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10903     * an anchor.
10904     *
10905     * @subsection entry-items Items
10906     *
10907     * Inlined in the text, any other @c Evas_Object can be inserted by using
10908     * \<item\> tags this way:
10909     *
10910     * @code
10911     * <item size=16x16 vsize=full href=emoticon/haha></item>
10912     * @endcode
10913     *
10914     * Just like with anchors, the @c href identifies each item, but these need,
10915     * in addition, to indicate their size, which is done using any one of
10916     * @c size, @c absize or @c relsize attributes. These attributes take their
10917     * value in the WxH format, where W is the width and H the height of the
10918     * item.
10919     *
10920     * @li absize: Absolute pixel size for the item. Whatever value is set will
10921     * be the item's size regardless of any scale value the object may have
10922     * been set to. The final line height will be adjusted to fit larger items.
10923     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10924     * for the object.
10925     * @li relsize: Size is adjusted for the item to fit within the current
10926     * line height.
10927     *
10928     * Besides their size, items are specificed a @c vsize value that affects
10929     * how their final size and position are calculated. The possible values
10930     * are:
10931     * @li ascent: Item will be placed within the line's baseline and its
10932     * ascent. That is, the height between the line where all characters are
10933     * positioned and the highest point in the line. For @c size and @c absize
10934     * items, the descent value will be added to the total line height to make
10935     * them fit. @c relsize items will be adjusted to fit within this space.
10936     * @li full: Items will be placed between the descent and ascent, or the
10937     * lowest point in the line and its highest.
10938     *
10939     * The next image shows different configurations of items and how they
10940     * are the previously mentioned options affect their sizes. In all cases,
10941     * the green line indicates the ascent, blue for the baseline and red for
10942     * the descent.
10943     *
10944     * @image html entry_item.png
10945     * @image latex entry_item.eps width=\textwidth
10946     *
10947     * And another one to show how size differs from absize. In the first one,
10948     * the scale value is set to 1.0, while the second one is using one of 2.0.
10949     *
10950     * @image html entry_item_scale.png
10951     * @image latex entry_item_scale.eps width=\textwidth
10952     *
10953     * After the size for an item is calculated, the entry will request an
10954     * object to place in its space. For this, the functions set with
10955     * elm_entry_item_provider_append() and related functions will be called
10956     * in order until one of them returns a @c non-NULL value. If no providers
10957     * are available, or all of them return @c NULL, then the entry falls back
10958     * to one of the internal defaults, provided the name matches with one of
10959     * them.
10960     *
10961     * All of the following are currently supported:
10962     *
10963     * - emoticon/angry
10964     * - emoticon/angry-shout
10965     * - emoticon/crazy-laugh
10966     * - emoticon/evil-laugh
10967     * - emoticon/evil
10968     * - emoticon/goggle-smile
10969     * - emoticon/grumpy
10970     * - emoticon/grumpy-smile
10971     * - emoticon/guilty
10972     * - emoticon/guilty-smile
10973     * - emoticon/haha
10974     * - emoticon/half-smile
10975     * - emoticon/happy-panting
10976     * - emoticon/happy
10977     * - emoticon/indifferent
10978     * - emoticon/kiss
10979     * - emoticon/knowing-grin
10980     * - emoticon/laugh
10981     * - emoticon/little-bit-sorry
10982     * - emoticon/love-lots
10983     * - emoticon/love
10984     * - emoticon/minimal-smile
10985     * - emoticon/not-happy
10986     * - emoticon/not-impressed
10987     * - emoticon/omg
10988     * - emoticon/opensmile
10989     * - emoticon/smile
10990     * - emoticon/sorry
10991     * - emoticon/squint-laugh
10992     * - emoticon/surprised
10993     * - emoticon/suspicious
10994     * - emoticon/tongue-dangling
10995     * - emoticon/tongue-poke
10996     * - emoticon/uh
10997     * - emoticon/unhappy
10998     * - emoticon/very-sorry
10999     * - emoticon/what
11000     * - emoticon/wink
11001     * - emoticon/worried
11002     * - emoticon/wtf
11003     *
11004     * Alternatively, an item may reference an image by its path, using
11005     * the URI form @c file:///path/to/an/image.png and the entry will then
11006     * use that image for the item.
11007     *
11008     * @section entry-files Loading and saving files
11009     *
11010     * Entries have convinience functions to load text from a file and save
11011     * changes back to it after a short delay. The automatic saving is enabled
11012     * by default, but can be disabled with elm_entry_autosave_set() and files
11013     * can be loaded directly as plain text or have any markup in them
11014     * recognized. See elm_entry_file_set() for more details.
11015     *
11016     * @section entry-signals Emitted signals
11017     *
11018     * This widget emits the following signals:
11019     *
11020     * @li "changed": The text within the entry was changed.
11021     * @li "changed,user": The text within the entry was changed because of user interaction.
11022     * @li "activated": The enter key was pressed on a single line entry.
11023     * @li "press": A mouse button has been pressed on the entry.
11024     * @li "longpressed": A mouse button has been pressed and held for a couple
11025     * seconds.
11026     * @li "clicked": The entry has been clicked (mouse press and release).
11027     * @li "clicked,double": The entry has been double clicked.
11028     * @li "clicked,triple": The entry has been triple clicked.
11029     * @li "focused": The entry has received focus.
11030     * @li "unfocused": The entry has lost focus.
11031     * @li "selection,paste": A paste of the clipboard contents was requested.
11032     * @li "selection,copy": A copy of the selected text into the clipboard was
11033     * requested.
11034     * @li "selection,cut": A cut of the selected text into the clipboard was
11035     * requested.
11036     * @li "selection,start": A selection has begun and no previous selection
11037     * existed.
11038     * @li "selection,changed": The current selection has changed.
11039     * @li "selection,cleared": The current selection has been cleared.
11040     * @li "cursor,changed": The cursor has changed position.
11041     * @li "anchor,clicked": An anchor has been clicked. The event_info
11042     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11043     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11044     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11045     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11046     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11047     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11048     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11049     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11050     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11051     * @li "preedit,changed": The preedit string has changed.
11052     * @li "language,changed": Program language changed.
11053     *
11054     * @section entry-examples
11055     *
11056     * An overview of the Entry API can be seen in @ref entry_example_01
11057     *
11058     * @{
11059     */
11060    /**
11061     * @typedef Elm_Entry_Anchor_Info
11062     *
11063     * The info sent in the callback for the "anchor,clicked" signals emitted
11064     * by entries.
11065     */
11066    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11067    /**
11068     * @struct _Elm_Entry_Anchor_Info
11069     *
11070     * The info sent in the callback for the "anchor,clicked" signals emitted
11071     * by entries.
11072     */
11073    struct _Elm_Entry_Anchor_Info
11074      {
11075         const char *name; /**< The name of the anchor, as stated in its href */
11076         int         button; /**< The mouse button used to click on it */
11077         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
11078                     y, /**< Anchor geometry, relative to canvas */
11079                     w, /**< Anchor geometry, relative to canvas */
11080                     h; /**< Anchor geometry, relative to canvas */
11081      };
11082    /**
11083     * @typedef Elm_Entry_Filter_Cb
11084     * This callback type is used by entry filters to modify text.
11085     * @param data The data specified as the last param when adding the filter
11086     * @param entry The entry object
11087     * @param text A pointer to the location of the text being filtered. This data can be modified,
11088     * but any additional allocations must be managed by the user.
11089     * @see elm_entry_text_filter_append
11090     * @see elm_entry_text_filter_prepend
11091     */
11092    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11093
11094    /**
11095     * This adds an entry to @p parent object.
11096     *
11097     * By default, entries are:
11098     * @li not scrolled
11099     * @li multi-line
11100     * @li word wrapped
11101     * @li autosave is enabled
11102     *
11103     * @param parent The parent object
11104     * @return The new object or NULL if it cannot be created
11105     */
11106    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11107    /**
11108     * Sets the entry to single line mode.
11109     *
11110     * In single line mode, entries don't ever wrap when the text reaches the
11111     * edge, and instead they keep growing horizontally. Pressing the @c Enter
11112     * key will generate an @c "activate" event instead of adding a new line.
11113     *
11114     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11115     * and pressing enter will break the text into a different line
11116     * without generating any events.
11117     *
11118     * @param obj The entry object
11119     * @param single_line If true, the text in the entry
11120     * will be on a single line.
11121     */
11122    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11123    /**
11124     * Gets whether the entry is set to be single line.
11125     *
11126     * @param obj The entry object
11127     * @return single_line If true, the text in the entry is set to display
11128     * on a single line.
11129     *
11130     * @see elm_entry_single_line_set()
11131     */
11132    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11133    /**
11134     * Sets the entry to password mode.
11135     *
11136     * In password mode, entries are implicitly single line and the display of
11137     * any text in them is replaced with asterisks (*).
11138     *
11139     * @param obj The entry object
11140     * @param password If true, password mode is enabled.
11141     */
11142    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11143    /**
11144     * Gets whether the entry is set to password mode.
11145     *
11146     * @param obj The entry object
11147     * @return If true, the entry is set to display all characters
11148     * as asterisks (*).
11149     *
11150     * @see elm_entry_password_set()
11151     */
11152    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11153    /**
11154     * This sets the text displayed within the entry to @p entry.
11155     *
11156     * @param obj The entry object
11157     * @param entry The text to be displayed
11158     *
11159     * @deprecated Use elm_object_text_set() instead.
11160     * @note Using this function bypasses text filters
11161     */
11162    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11163    /**
11164     * This returns the text currently shown in object @p entry.
11165     * See also elm_entry_entry_set().
11166     *
11167     * @param obj The entry object
11168     * @return The currently displayed text or NULL on failure
11169     *
11170     * @deprecated Use elm_object_text_get() instead.
11171     */
11172    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11173    /**
11174     * Appends @p entry to the text of the entry.
11175     *
11176     * Adds the text in @p entry to the end of any text already present in the
11177     * widget.
11178     *
11179     * The appended text is subject to any filters set for the widget.
11180     *
11181     * @param obj The entry object
11182     * @param entry The text to be displayed
11183     *
11184     * @see elm_entry_text_filter_append()
11185     */
11186    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11187    /**
11188     * Gets whether the entry is empty.
11189     *
11190     * Empty means no text at all. If there are any markup tags, like an item
11191     * tag for which no provider finds anything, and no text is displayed, this
11192     * function still returns EINA_FALSE.
11193     *
11194     * @param obj The entry object
11195     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11196     */
11197    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11198    /**
11199     * Gets any selected text within the entry.
11200     *
11201     * If there's any selected text in the entry, this function returns it as
11202     * a string in markup format. NULL is returned if no selection exists or
11203     * if an error occurred.
11204     *
11205     * The returned value points to an internal string and should not be freed
11206     * or modified in any way. If the @p entry object is deleted or its
11207     * contents are changed, the returned pointer should be considered invalid.
11208     *
11209     * @param obj The entry object
11210     * @return The selected text within the entry or NULL on failure
11211     */
11212    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11213    /**
11214     * Inserts the given text into the entry at the current cursor position.
11215     *
11216     * This inserts text at the cursor position as if it was typed
11217     * by the user (note that this also allows markup which a user
11218     * can't just "type" as it would be converted to escaped text, so this
11219     * call can be used to insert things like emoticon items or bold push/pop
11220     * tags, other font and color change tags etc.)
11221     *
11222     * If any selection exists, it will be replaced by the inserted text.
11223     *
11224     * The inserted text is subject to any filters set for the widget.
11225     *
11226     * @param obj The entry object
11227     * @param entry The text to insert
11228     *
11229     * @see elm_entry_text_filter_append()
11230     */
11231    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11232    /**
11233     * Set the line wrap type to use on multi-line entries.
11234     *
11235     * Sets the wrap type used by the entry to any of the specified in
11236     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11237     * line (without inserting a line break or paragraph separator) when it
11238     * reaches the far edge of the widget.
11239     *
11240     * Note that this only makes sense for multi-line entries. A widget set
11241     * to be single line will never wrap.
11242     *
11243     * @param obj The entry object
11244     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11245     */
11246    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11247    /**
11248     * Gets the wrap mode the entry was set to use.
11249     *
11250     * @param obj The entry object
11251     * @return Wrap type
11252     *
11253     * @see also elm_entry_line_wrap_set()
11254     */
11255    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11256    /**
11257     * Sets if the entry is to be editable or not.
11258     *
11259     * By default, entries are editable and when focused, any text input by the
11260     * user will be inserted at the current cursor position. But calling this
11261     * function with @p editable as EINA_FALSE will prevent the user from
11262     * inputting text into the entry.
11263     *
11264     * The only way to change the text of a non-editable entry is to use
11265     * elm_object_text_set(), elm_entry_entry_insert() and other related
11266     * functions.
11267     *
11268     * @param obj The entry object
11269     * @param editable If EINA_TRUE, user input will be inserted in the entry,
11270     * if not, the entry is read-only and no user input is allowed.
11271     */
11272    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11273    /**
11274     * Gets whether the entry is editable or not.
11275     *
11276     * @param obj The entry object
11277     * @return If true, the entry is editable by the user.
11278     * If false, it is not editable by the user
11279     *
11280     * @see elm_entry_editable_set()
11281     */
11282    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11283    /**
11284     * This drops any existing text selection within the entry.
11285     *
11286     * @param obj The entry object
11287     */
11288    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11289    /**
11290     * This selects all text within the entry.
11291     *
11292     * @param obj The entry object
11293     */
11294    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11295    /**
11296     * This moves the cursor one place to the right within the entry.
11297     *
11298     * @param obj The entry object
11299     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11300     */
11301    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11302    /**
11303     * This moves the cursor one place to the left within the entry.
11304     *
11305     * @param obj The entry object
11306     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11307     */
11308    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11309    /**
11310     * This moves the cursor one line up within the entry.
11311     *
11312     * @param obj The entry object
11313     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11314     */
11315    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11316    /**
11317     * This moves the cursor one line down within the entry.
11318     *
11319     * @param obj The entry object
11320     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11321     */
11322    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11323    /**
11324     * This moves the cursor to the beginning of the entry.
11325     *
11326     * @param obj The entry object
11327     */
11328    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11329    /**
11330     * This moves the cursor to the end of the entry.
11331     *
11332     * @param obj The entry object
11333     */
11334    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11335    /**
11336     * This moves the cursor to the beginning of the current line.
11337     *
11338     * @param obj The entry object
11339     */
11340    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11341    /**
11342     * This moves the cursor to the end of the current line.
11343     *
11344     * @param obj The entry object
11345     */
11346    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11347    /**
11348     * This begins a selection within the entry as though
11349     * the user were holding down the mouse button to make a selection.
11350     *
11351     * @param obj The entry object
11352     */
11353    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11354    /**
11355     * This ends a selection within the entry as though
11356     * the user had just released the mouse button while making a selection.
11357     *
11358     * @param obj The entry object
11359     */
11360    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11361    /**
11362     * Gets whether a format node exists at the current cursor position.
11363     *
11364     * A format node is anything that defines how the text is rendered. It can
11365     * be a visible format node, such as a line break or a paragraph separator,
11366     * or an invisible one, such as bold begin or end tag.
11367     * This function returns whether any format node exists at the current
11368     * cursor position.
11369     *
11370     * @param obj The entry object
11371     * @return EINA_TRUE if the current cursor position contains a format node,
11372     * EINA_FALSE otherwise.
11373     *
11374     * @see elm_entry_cursor_is_visible_format_get()
11375     */
11376    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11377    /**
11378     * Gets if the current cursor position holds a visible format node.
11379     *
11380     * @param obj The entry object
11381     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11382     * if it's an invisible one or no format exists.
11383     *
11384     * @see elm_entry_cursor_is_format_get()
11385     */
11386    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11387    /**
11388     * Gets the character pointed by the cursor at its current position.
11389     *
11390     * This function returns a string with the utf8 character stored at the
11391     * current cursor position.
11392     * Only the text is returned, any format that may exist will not be part
11393     * of the return value.
11394     *
11395     * @param obj The entry object
11396     * @return The text pointed by the cursors.
11397     */
11398    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11399    /**
11400     * This function returns the geometry of the cursor.
11401     *
11402     * It's useful if you want to draw something on the cursor (or where it is),
11403     * or for example in the case of scrolled entry where you want to show the
11404     * cursor.
11405     *
11406     * @param obj The entry object
11407     * @param x returned geometry
11408     * @param y returned geometry
11409     * @param w returned geometry
11410     * @param h returned geometry
11411     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11412     */
11413    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);
11414    /**
11415     * Sets the cursor position in the entry to the given value
11416     *
11417     * The value in @p pos is the index of the character position within the
11418     * contents of the string as returned by elm_entry_cursor_pos_get().
11419     *
11420     * @param obj The entry object
11421     * @param pos The position of the cursor
11422     */
11423    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11424    /**
11425     * Retrieves the current position of the cursor in the entry
11426     *
11427     * @param obj The entry object
11428     * @return The cursor position
11429     */
11430    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11431    /**
11432     * This executes a "cut" action on the selected text in the entry.
11433     *
11434     * @param obj The entry object
11435     */
11436    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11437    /**
11438     * This executes a "copy" action on the selected text in the entry.
11439     *
11440     * @param obj The entry object
11441     */
11442    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11443    /**
11444     * This executes a "paste" action in the entry.
11445     *
11446     * @param obj The entry object
11447     */
11448    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11449    /**
11450     * This clears and frees the items in a entry's contextual (longpress)
11451     * menu.
11452     *
11453     * @param obj The entry object
11454     *
11455     * @see elm_entry_context_menu_item_add()
11456     */
11457    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11458    /**
11459     * This adds an item to the entry's contextual menu.
11460     *
11461     * A longpress on an entry will make the contextual menu show up, if this
11462     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11463     * By default, this menu provides a few options like enabling selection mode,
11464     * which is useful on embedded devices that need to be explicit about it,
11465     * and when a selection exists it also shows the copy and cut actions.
11466     *
11467     * With this function, developers can add other options to this menu to
11468     * perform any action they deem necessary.
11469     *
11470     * @param obj The entry object
11471     * @param label The item's text label
11472     * @param icon_file The item's icon file
11473     * @param icon_type The item's icon type
11474     * @param func The callback to execute when the item is clicked
11475     * @param data The data to associate with the item for related functions
11476     */
11477    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);
11478    /**
11479     * This disables the entry's contextual (longpress) menu.
11480     *
11481     * @param obj The entry object
11482     * @param disabled If true, the menu is disabled
11483     */
11484    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11485    /**
11486     * This returns whether the entry's contextual (longpress) menu is
11487     * disabled.
11488     *
11489     * @param obj The entry object
11490     * @return If true, the menu is disabled
11491     */
11492    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11493    /**
11494     * This appends a custom item provider to the list for that entry
11495     *
11496     * This appends the given callback. The list is walked from beginning to end
11497     * with each function called given the item href string in the text. If the
11498     * function returns an object handle other than NULL (it should create an
11499     * object to do this), then this object is used to replace that item. If
11500     * not the next provider is called until one provides an item object, or the
11501     * default provider in entry does.
11502     *
11503     * @param obj The entry object
11504     * @param func The function called to provide the item object
11505     * @param data The data passed to @p func
11506     *
11507     * @see @ref entry-items
11508     */
11509    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);
11510    /**
11511     * This prepends a custom item provider to the list for that entry
11512     *
11513     * This prepends the given callback. See elm_entry_item_provider_append() for
11514     * more information
11515     *
11516     * @param obj The entry object
11517     * @param func The function called to provide the item object
11518     * @param data The data passed to @p func
11519     */
11520    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);
11521    /**
11522     * This removes a custom item provider to the list for that entry
11523     *
11524     * This removes the given callback. See elm_entry_item_provider_append() for
11525     * more information
11526     *
11527     * @param obj The entry object
11528     * @param func The function called to provide the item object
11529     * @param data The data passed to @p func
11530     */
11531    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);
11532    /**
11533     * Append a filter function for text inserted in the entry
11534     *
11535     * Append the given callback to the list. This functions will be called
11536     * whenever any text is inserted into the entry, with the text to be inserted
11537     * as a parameter. The callback function is free to alter the text in any way
11538     * it wants, but it must remember to free the given pointer and update it.
11539     * If the new text is to be discarded, the function can free it and set its
11540     * text parameter to NULL. This will also prevent any following filters from
11541     * being called.
11542     *
11543     * @param obj The entry object
11544     * @param func The function to use as text filter
11545     * @param data User data to pass to @p func
11546     */
11547    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11548    /**
11549     * Prepend a filter function for text insdrted in the entry
11550     *
11551     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11552     * for more information
11553     *
11554     * @param obj The entry object
11555     * @param func The function to use as text filter
11556     * @param data User data to pass to @p func
11557     */
11558    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11559    /**
11560     * Remove a filter from the list
11561     *
11562     * Removes the given callback from the filter list. See
11563     * elm_entry_text_filter_append() for more information.
11564     *
11565     * @param obj The entry object
11566     * @param func The filter function to remove
11567     * @param data The user data passed when adding the function
11568     */
11569    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11570    /**
11571     * This converts a markup (HTML-like) string into UTF-8.
11572     *
11573     * The returned string is a malloc'ed buffer and it should be freed when
11574     * not needed anymore.
11575     *
11576     * @param s The string (in markup) to be converted
11577     * @return The converted string (in UTF-8). It should be freed.
11578     */
11579    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11580    /**
11581     * This converts a UTF-8 string into markup (HTML-like).
11582     *
11583     * The returned string is a malloc'ed buffer and it should be freed when
11584     * not needed anymore.
11585     *
11586     * @param s The string (in UTF-8) to be converted
11587     * @return The converted string (in markup). It should be freed.
11588     */
11589    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11590    /**
11591     * This sets the file (and implicitly loads it) for the text to display and
11592     * then edit. All changes are written back to the file after a short delay if
11593     * the entry object is set to autosave (which is the default).
11594     *
11595     * If the entry had any other file set previously, any changes made to it
11596     * will be saved if the autosave feature is enabled, otherwise, the file
11597     * will be silently discarded and any non-saved changes will be lost.
11598     *
11599     * @param obj The entry object
11600     * @param file The path to the file to load and save
11601     * @param format The file format
11602     */
11603    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11604    /**
11605     * Gets the file being edited by the entry.
11606     *
11607     * This function can be used to retrieve any file set on the entry for
11608     * edition, along with the format used to load and save it.
11609     *
11610     * @param obj The entry object
11611     * @param file The path to the file to load and save
11612     * @param format The file format
11613     */
11614    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11615    /**
11616     * This function writes any changes made to the file set with
11617     * elm_entry_file_set()
11618     *
11619     * @param obj The entry object
11620     */
11621    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11622    /**
11623     * This sets the entry object to 'autosave' the loaded text file or not.
11624     *
11625     * @param obj The entry object
11626     * @param autosave Autosave the loaded file or not
11627     *
11628     * @see elm_entry_file_set()
11629     */
11630    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11631    /**
11632     * This gets the entry object's 'autosave' status.
11633     *
11634     * @param obj The entry object
11635     * @return Autosave the loaded file or not
11636     *
11637     * @see elm_entry_file_set()
11638     */
11639    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11640    /**
11641     * Control pasting of text and images for the widget.
11642     *
11643     * Normally the entry allows both text and images to be pasted.  By setting
11644     * textonly to be true, this prevents images from being pasted.
11645     *
11646     * Note this only changes the behaviour of text.
11647     *
11648     * @param obj The entry object
11649     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11650     * text+image+other.
11651     */
11652    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11653    /**
11654     * Getting elm_entry text paste/drop mode.
11655     *
11656     * In textonly mode, only text may be pasted or dropped into the widget.
11657     *
11658     * @param obj The entry object
11659     * @return If the widget only accepts text from pastes.
11660     */
11661    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11662    /**
11663     * Enable or disable scrolling in entry
11664     *
11665     * Normally the entry is not scrollable unless you enable it with this call.
11666     *
11667     * @param obj The entry object
11668     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11669     */
11670    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11671    /**
11672     * Get the scrollable state of the entry
11673     *
11674     * Normally the entry is not scrollable. This gets the scrollable state
11675     * of the entry. See elm_entry_scrollable_set() for more information.
11676     *
11677     * @param obj The entry object
11678     * @return The scrollable state
11679     */
11680    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11681    /**
11682     * This sets a widget to be displayed to the left of a scrolled entry.
11683     *
11684     * @param obj The scrolled entry object
11685     * @param icon The widget to display on the left side of the scrolled
11686     * entry.
11687     *
11688     * @note A previously set widget will be destroyed.
11689     * @note If the object being set does not have minimum size hints set,
11690     * it won't get properly displayed.
11691     *
11692     * @see elm_entry_end_set()
11693     */
11694    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11695    /**
11696     * Gets the leftmost widget of the scrolled entry. This object is
11697     * owned by the scrolled entry and should not be modified.
11698     *
11699     * @param obj The scrolled entry object
11700     * @return the left widget inside the scroller
11701     */
11702    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11703    /**
11704     * Unset the leftmost widget of the scrolled entry, unparenting and
11705     * returning it.
11706     *
11707     * @param obj The scrolled entry object
11708     * @return the previously set icon sub-object of this entry, on
11709     * success.
11710     *
11711     * @see elm_entry_icon_set()
11712     */
11713    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11714    /**
11715     * Sets the visibility of the left-side widget of the scrolled entry,
11716     * set by elm_entry_icon_set().
11717     *
11718     * @param obj The scrolled entry object
11719     * @param setting EINA_TRUE if the object should be displayed,
11720     * EINA_FALSE if not.
11721     */
11722    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11723    /**
11724     * This sets a widget to be displayed to the end of a scrolled entry.
11725     *
11726     * @param obj The scrolled entry object
11727     * @param end The widget to display on the right side of the scrolled
11728     * entry.
11729     *
11730     * @note A previously set widget will be destroyed.
11731     * @note If the object being set does not have minimum size hints set,
11732     * it won't get properly displayed.
11733     *
11734     * @see elm_entry_icon_set
11735     */
11736    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11737    /**
11738     * Gets the endmost widget of the scrolled entry. This object is owned
11739     * by the scrolled entry and should not be modified.
11740     *
11741     * @param obj The scrolled entry object
11742     * @return the right widget inside the scroller
11743     */
11744    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11745    /**
11746     * Unset the endmost widget of the scrolled entry, unparenting and
11747     * returning it.
11748     *
11749     * @param obj The scrolled entry object
11750     * @return the previously set icon sub-object of this entry, on
11751     * success.
11752     *
11753     * @see elm_entry_icon_set()
11754     */
11755    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11756    /**
11757     * Sets the visibility of the end widget of the scrolled entry, set by
11758     * elm_entry_end_set().
11759     *
11760     * @param obj The scrolled entry object
11761     * @param setting EINA_TRUE if the object should be displayed,
11762     * EINA_FALSE if not.
11763     */
11764    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11765    /**
11766     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11767     * them).
11768     *
11769     * Setting an entry to single-line mode with elm_entry_single_line_set()
11770     * will automatically disable the display of scrollbars when the entry
11771     * moves inside its scroller.
11772     *
11773     * @param obj The scrolled entry object
11774     * @param h The horizontal scrollbar policy to apply
11775     * @param v The vertical scrollbar policy to apply
11776     */
11777    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11778    /**
11779     * This enables/disables bouncing within the entry.
11780     *
11781     * This function sets whether the entry will bounce when scrolling reaches
11782     * the end of the contained entry.
11783     *
11784     * @param obj The scrolled entry object
11785     * @param h The horizontal bounce state
11786     * @param v The vertical bounce state
11787     */
11788    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11789    /**
11790     * Get the bounce mode
11791     *
11792     * @param obj The Entry object
11793     * @param h_bounce Allow bounce horizontally
11794     * @param v_bounce Allow bounce vertically
11795     */
11796    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11797
11798    /* pre-made filters for entries */
11799    /**
11800     * @typedef Elm_Entry_Filter_Limit_Size
11801     *
11802     * Data for the elm_entry_filter_limit_size() entry filter.
11803     */
11804    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11805    /**
11806     * @struct _Elm_Entry_Filter_Limit_Size
11807     *
11808     * Data for the elm_entry_filter_limit_size() entry filter.
11809     */
11810    struct _Elm_Entry_Filter_Limit_Size
11811      {
11812         int max_char_count; /**< The maximum number of characters allowed. */
11813         int max_byte_count; /**< The maximum number of bytes allowed*/
11814      };
11815    /**
11816     * Filter inserted text based on user defined character and byte limits
11817     *
11818     * Add this filter to an entry to limit the characters that it will accept
11819     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11820     * The funtion works on the UTF-8 representation of the string, converting
11821     * it from the set markup, thus not accounting for any format in it.
11822     *
11823     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11824     * it as data when setting the filter. In it, it's possible to set limits
11825     * by character count or bytes (any of them is disabled if 0), and both can
11826     * be set at the same time. In that case, it first checks for characters,
11827     * then bytes.
11828     *
11829     * The function will cut the inserted text in order to allow only the first
11830     * number of characters that are still allowed. The cut is made in
11831     * characters, even when limiting by bytes, in order to always contain
11832     * valid ones and avoid half unicode characters making it in.
11833     *
11834     * This filter, like any others, does not apply when setting the entry text
11835     * directly with elm_object_text_set() (or the deprecated
11836     * elm_entry_entry_set()).
11837     */
11838    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11839    /**
11840     * @typedef Elm_Entry_Filter_Accept_Set
11841     *
11842     * Data for the elm_entry_filter_accept_set() entry filter.
11843     */
11844    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11845    /**
11846     * @struct _Elm_Entry_Filter_Accept_Set
11847     *
11848     * Data for the elm_entry_filter_accept_set() entry filter.
11849     */
11850    struct _Elm_Entry_Filter_Accept_Set
11851      {
11852         const char *accepted; /**< Set of characters accepted in the entry. */
11853         const char *rejected; /**< Set of characters rejected from the entry. */
11854      };
11855    /**
11856     * Filter inserted text based on accepted or rejected sets of characters
11857     *
11858     * Add this filter to an entry to restrict the set of accepted characters
11859     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11860     * This structure contains both accepted and rejected sets, but they are
11861     * mutually exclusive.
11862     *
11863     * The @c accepted set takes preference, so if it is set, the filter will
11864     * only work based on the accepted characters, ignoring anything in the
11865     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11866     *
11867     * In both cases, the function filters by matching utf8 characters to the
11868     * raw markup text, so it can be used to remove formatting tags.
11869     *
11870     * This filter, like any others, does not apply when setting the entry text
11871     * directly with elm_object_text_set() (or the deprecated
11872     * elm_entry_entry_set()).
11873     */
11874    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11875    /**
11876     * Set the input panel layout of the entry
11877     *
11878     * @param obj The entry object
11879     * @param layout layout type
11880     */
11881    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11882    /**
11883     * Get the input panel layout of the entry
11884     *
11885     * @param obj The entry object
11886     * @return layout type
11887     *
11888     * @see elm_entry_input_panel_layout_set
11889     */
11890    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11891    /**
11892     * Set the autocapitalization type on the immodule.
11893     *
11894     * @param obj The entry object
11895     * @param autocapital_type The type of autocapitalization
11896     */
11897    EAPI void         elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11898    /**
11899     * Retrieve the autocapitalization type on the immodule.
11900     *
11901     * @param obj The entry object
11902     * @return autocapitalization type
11903     */
11904    EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11905    /**
11906     * Sets the attribute to show the input panel automatically.
11907     *
11908     * @param obj The entry object
11909     * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11910     */
11911    EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11912    /**
11913     * Retrieve the attribute to show the input panel automatically.
11914     *
11915     * @param obj The entry object
11916     * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11917     */
11918    EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11919
11920    /**
11921     * @}
11922     */
11923
11924    /* composite widgets - these basically put together basic widgets above
11925     * in convenient packages that do more than basic stuff */
11926
11927    /* anchorview */
11928    /**
11929     * @defgroup Anchorview Anchorview
11930     *
11931     * @image html img/widget/anchorview/preview-00.png
11932     * @image latex img/widget/anchorview/preview-00.eps
11933     *
11934     * Anchorview is for displaying text that contains markup with anchors
11935     * like <c>\<a href=1234\>something\</\></c> in it.
11936     *
11937     * Besides being styled differently, the anchorview widget provides the
11938     * necessary functionality so that clicking on these anchors brings up a
11939     * popup with user defined content such as "call", "add to contacts" or
11940     * "open web page". This popup is provided using the @ref Hover widget.
11941     *
11942     * This widget is very similar to @ref Anchorblock, so refer to that
11943     * widget for an example. The only difference Anchorview has is that the
11944     * widget is already provided with scrolling functionality, so if the
11945     * text set to it is too large to fit in the given space, it will scroll,
11946     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11947     * text can be displayed.
11948     *
11949     * This widget emits the following signals:
11950     * @li "anchor,clicked": will be called when an anchor is clicked. The
11951     * @p event_info parameter on the callback will be a pointer of type
11952     * ::Elm_Entry_Anchorview_Info.
11953     *
11954     * See @ref Anchorblock for an example on how to use both of them.
11955     *
11956     * @see Anchorblock
11957     * @see Entry
11958     * @see Hover
11959     *
11960     * @{
11961     */
11962    /**
11963     * @typedef Elm_Entry_Anchorview_Info
11964     *
11965     * The info sent in the callback for "anchor,clicked" signals emitted by
11966     * the Anchorview widget.
11967     */
11968    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11969    /**
11970     * @struct _Elm_Entry_Anchorview_Info
11971     *
11972     * The info sent in the callback for "anchor,clicked" signals emitted by
11973     * the Anchorview widget.
11974     */
11975    struct _Elm_Entry_Anchorview_Info
11976      {
11977         const char     *name; /**< Name of the anchor, as indicated in its href
11978                                    attribute */
11979         int             button; /**< The mouse button used to click on it */
11980         Evas_Object    *hover; /**< The hover object to use for the popup */
11981         struct {
11982              Evas_Coord    x, y, w, h;
11983         } anchor, /**< Geometry selection of text used as anchor */
11984           hover_parent; /**< Geometry of the object used as parent by the
11985                              hover */
11986         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11987                                              for content on the left side of
11988                                              the hover. Before calling the
11989                                              callback, the widget will make the
11990                                              necessary calculations to check
11991                                              which sides are fit to be set with
11992                                              content, based on the position the
11993                                              hover is activated and its distance
11994                                              to the edges of its parent object
11995                                              */
11996         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11997                                               the right side of the hover.
11998                                               See @ref hover_left */
11999         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12000                                             of the hover. See @ref hover_left */
12001         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12002                                                below the hover. See @ref
12003                                                hover_left */
12004      };
12005    /**
12006     * Add a new Anchorview object
12007     *
12008     * @param parent The parent object
12009     * @return The new object or NULL if it cannot be created
12010     */
12011    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12012    /**
12013     * Set the text to show in the anchorview
12014     *
12015     * Sets the text of the anchorview to @p text. This text can include markup
12016     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12017     * text that will be specially styled and react to click events, ended with
12018     * either of \</a\> or \</\>. When clicked, the anchor will emit an
12019     * "anchor,clicked" signal that you can attach a callback to with
12020     * evas_object_smart_callback_add(). The name of the anchor given in the
12021     * event info struct will be the one set in the href attribute, in this
12022     * case, anchorname.
12023     *
12024     * Other markup can be used to style the text in different ways, but it's
12025     * up to the style defined in the theme which tags do what.
12026     * @deprecated use elm_object_text_set() instead.
12027     */
12028    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12029    /**
12030     * Get the markup text set for the anchorview
12031     *
12032     * Retrieves the text set on the anchorview, with markup tags included.
12033     *
12034     * @param obj The anchorview object
12035     * @return The markup text set or @c NULL if nothing was set or an error
12036     * occurred
12037     * @deprecated use elm_object_text_set() instead.
12038     */
12039    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12040    /**
12041     * Set the parent of the hover popup
12042     *
12043     * Sets the parent object to use by the hover created by the anchorview
12044     * when an anchor is clicked. See @ref Hover for more details on this.
12045     * If no parent is set, the same anchorview object will be used.
12046     *
12047     * @param obj The anchorview object
12048     * @param parent The object to use as parent for the hover
12049     */
12050    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12051    /**
12052     * Get the parent of the hover popup
12053     *
12054     * Get the object used as parent for the hover created by the anchorview
12055     * widget. See @ref Hover for more details on this.
12056     *
12057     * @param obj The anchorview object
12058     * @return The object used as parent for the hover, NULL if none is set.
12059     */
12060    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12061    /**
12062     * Set the style that the hover should use
12063     *
12064     * When creating the popup hover, anchorview will request that it's
12065     * themed according to @p style.
12066     *
12067     * @param obj The anchorview object
12068     * @param style The style to use for the underlying hover
12069     *
12070     * @see elm_object_style_set()
12071     */
12072    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12073    /**
12074     * Get the style that the hover should use
12075     *
12076     * Get the style the hover created by anchorview will use.
12077     *
12078     * @param obj The anchorview object
12079     * @return The style to use by the hover. NULL means the default is used.
12080     *
12081     * @see elm_object_style_set()
12082     */
12083    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12084    /**
12085     * Ends the hover popup in the anchorview
12086     *
12087     * When an anchor is clicked, the anchorview widget will create a hover
12088     * object to use as a popup with user provided content. This function
12089     * terminates this popup, returning the anchorview to its normal state.
12090     *
12091     * @param obj The anchorview object
12092     */
12093    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12094    /**
12095     * Set bouncing behaviour when the scrolled content reaches an edge
12096     *
12097     * Tell the internal scroller object whether it should bounce or not
12098     * when it reaches the respective edges for each axis.
12099     *
12100     * @param obj The anchorview object
12101     * @param h_bounce Whether to bounce or not in the horizontal axis
12102     * @param v_bounce Whether to bounce or not in the vertical axis
12103     *
12104     * @see elm_scroller_bounce_set()
12105     */
12106    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12107    /**
12108     * Get the set bouncing behaviour of the internal scroller
12109     *
12110     * Get whether the internal scroller should bounce when the edge of each
12111     * axis is reached scrolling.
12112     *
12113     * @param obj The anchorview object
12114     * @param h_bounce Pointer where to store the bounce state of the horizontal
12115     *                 axis
12116     * @param v_bounce Pointer where to store the bounce state of the vertical
12117     *                 axis
12118     *
12119     * @see elm_scroller_bounce_get()
12120     */
12121    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12122    /**
12123     * Appends a custom item provider to the given anchorview
12124     *
12125     * Appends the given function to the list of items providers. This list is
12126     * called, one function at a time, with the given @p data pointer, the
12127     * anchorview object and, in the @p item parameter, the item name as
12128     * referenced in its href string. Following functions in the list will be
12129     * called in order until one of them returns something different to NULL,
12130     * which should be an Evas_Object which will be used in place of the item
12131     * element.
12132     *
12133     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12134     * href=item/name\>\</item\>
12135     *
12136     * @param obj The anchorview object
12137     * @param func The function to add to the list of providers
12138     * @param data User data that will be passed to the callback function
12139     *
12140     * @see elm_entry_item_provider_append()
12141     */
12142    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);
12143    /**
12144     * Prepend a custom item provider to the given anchorview
12145     *
12146     * Like elm_anchorview_item_provider_append(), but it adds the function
12147     * @p func to the beginning of the list, instead of the end.
12148     *
12149     * @param obj The anchorview object
12150     * @param func The function to add to the list of providers
12151     * @param data User data that will be passed to the callback function
12152     */
12153    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);
12154    /**
12155     * Remove a custom item provider from the list of the given anchorview
12156     *
12157     * Removes the function and data pairing that matches @p func and @p data.
12158     * That is, unless the same function and same user data are given, the
12159     * function will not be removed from the list. This allows us to add the
12160     * same callback several times, with different @p data pointers and be
12161     * able to remove them later without conflicts.
12162     *
12163     * @param obj The anchorview object
12164     * @param func The function to remove from the list
12165     * @param data The data matching the function to remove from the list
12166     */
12167    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);
12168    /**
12169     * @}
12170     */
12171
12172    /* anchorblock */
12173    /**
12174     * @defgroup Anchorblock Anchorblock
12175     *
12176     * @image html img/widget/anchorblock/preview-00.png
12177     * @image latex img/widget/anchorblock/preview-00.eps
12178     *
12179     * Anchorblock is for displaying text that contains markup with anchors
12180     * like <c>\<a href=1234\>something\</\></c> in it.
12181     *
12182     * Besides being styled differently, the anchorblock widget provides the
12183     * necessary functionality so that clicking on these anchors brings up a
12184     * popup with user defined content such as "call", "add to contacts" or
12185     * "open web page". This popup is provided using the @ref Hover widget.
12186     *
12187     * This widget emits the following signals:
12188     * @li "anchor,clicked": will be called when an anchor is clicked. The
12189     * @p event_info parameter on the callback will be a pointer of type
12190     * ::Elm_Entry_Anchorblock_Info.
12191     *
12192     * @see Anchorview
12193     * @see Entry
12194     * @see Hover
12195     *
12196     * Since examples are usually better than plain words, we might as well
12197     * try @ref tutorial_anchorblock_example "one".
12198     */
12199    /**
12200     * @addtogroup Anchorblock
12201     * @{
12202     */
12203    /**
12204     * @typedef Elm_Entry_Anchorblock_Info
12205     *
12206     * The info sent in the callback for "anchor,clicked" signals emitted by
12207     * the Anchorblock widget.
12208     */
12209    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12210    /**
12211     * @struct _Elm_Entry_Anchorblock_Info
12212     *
12213     * The info sent in the callback for "anchor,clicked" signals emitted by
12214     * the Anchorblock widget.
12215     */
12216    struct _Elm_Entry_Anchorblock_Info
12217      {
12218         const char     *name; /**< Name of the anchor, as indicated in its href
12219                                    attribute */
12220         int             button; /**< The mouse button used to click on it */
12221         Evas_Object    *hover; /**< The hover object to use for the popup */
12222         struct {
12223              Evas_Coord    x, y, w, h;
12224         } anchor, /**< Geometry selection of text used as anchor */
12225           hover_parent; /**< Geometry of the object used as parent by the
12226                              hover */
12227         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12228                                              for content on the left side of
12229                                              the hover. Before calling the
12230                                              callback, the widget will make the
12231                                              necessary calculations to check
12232                                              which sides are fit to be set with
12233                                              content, based on the position the
12234                                              hover is activated and its distance
12235                                              to the edges of its parent object
12236                                              */
12237         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12238                                               the right side of the hover.
12239                                               See @ref hover_left */
12240         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12241                                             of the hover. See @ref hover_left */
12242         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12243                                                below the hover. See @ref
12244                                                hover_left */
12245      };
12246    /**
12247     * Add a new Anchorblock object
12248     *
12249     * @param parent The parent object
12250     * @return The new object or NULL if it cannot be created
12251     */
12252    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12253    /**
12254     * Set the text to show in the anchorblock
12255     *
12256     * Sets the text of the anchorblock to @p text. This text can include markup
12257     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12258     * of text that will be specially styled and react to click events, ended
12259     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12260     * "anchor,clicked" signal that you can attach a callback to with
12261     * evas_object_smart_callback_add(). The name of the anchor given in the
12262     * event info struct will be the one set in the href attribute, in this
12263     * case, anchorname.
12264     *
12265     * Other markup can be used to style the text in different ways, but it's
12266     * up to the style defined in the theme which tags do what.
12267     * @deprecated use elm_object_text_set() instead.
12268     */
12269    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12270    /**
12271     * Get the markup text set for the anchorblock
12272     *
12273     * Retrieves the text set on the anchorblock, with markup tags included.
12274     *
12275     * @param obj The anchorblock object
12276     * @return The markup text set or @c NULL if nothing was set or an error
12277     * occurred
12278     * @deprecated use elm_object_text_set() instead.
12279     */
12280    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12281    /**
12282     * Set the parent of the hover popup
12283     *
12284     * Sets the parent object to use by the hover created by the anchorblock
12285     * when an anchor is clicked. See @ref Hover for more details on this.
12286     *
12287     * @param obj The anchorblock object
12288     * @param parent The object to use as parent for the hover
12289     */
12290    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12291    /**
12292     * Get the parent of the hover popup
12293     *
12294     * Get the object used as parent for the hover created by the anchorblock
12295     * widget. See @ref Hover for more details on this.
12296     * If no parent is set, the same anchorblock object will be used.
12297     *
12298     * @param obj The anchorblock object
12299     * @return The object used as parent for the hover, NULL if none is set.
12300     */
12301    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12302    /**
12303     * Set the style that the hover should use
12304     *
12305     * When creating the popup hover, anchorblock will request that it's
12306     * themed according to @p style.
12307     *
12308     * @param obj The anchorblock object
12309     * @param style The style to use for the underlying hover
12310     *
12311     * @see elm_object_style_set()
12312     */
12313    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12314    /**
12315     * Get the style that the hover should use
12316     *
12317     * Get the style, the hover created by anchorblock will use.
12318     *
12319     * @param obj The anchorblock object
12320     * @return The style to use by the hover. NULL means the default is used.
12321     *
12322     * @see elm_object_style_set()
12323     */
12324    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12325    /**
12326     * Ends the hover popup in the anchorblock
12327     *
12328     * When an anchor is clicked, the anchorblock widget will create a hover
12329     * object to use as a popup with user provided content. This function
12330     * terminates this popup, returning the anchorblock to its normal state.
12331     *
12332     * @param obj The anchorblock object
12333     */
12334    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12335    /**
12336     * Appends a custom item provider to the given anchorblock
12337     *
12338     * Appends the given function to the list of items providers. This list is
12339     * called, one function at a time, with the given @p data pointer, the
12340     * anchorblock object and, in the @p item parameter, the item name as
12341     * referenced in its href string. Following functions in the list will be
12342     * called in order until one of them returns something different to NULL,
12343     * which should be an Evas_Object which will be used in place of the item
12344     * element.
12345     *
12346     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12347     * href=item/name\>\</item\>
12348     *
12349     * @param obj The anchorblock object
12350     * @param func The function to add to the list of providers
12351     * @param data User data that will be passed to the callback function
12352     *
12353     * @see elm_entry_item_provider_append()
12354     */
12355    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);
12356    /**
12357     * Prepend a custom item provider to the given anchorblock
12358     *
12359     * Like elm_anchorblock_item_provider_append(), but it adds the function
12360     * @p func to the beginning of the list, instead of the end.
12361     *
12362     * @param obj The anchorblock object
12363     * @param func The function to add to the list of providers
12364     * @param data User data that will be passed to the callback function
12365     */
12366    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);
12367    /**
12368     * Remove a custom item provider from the list of the given anchorblock
12369     *
12370     * Removes the function and data pairing that matches @p func and @p data.
12371     * That is, unless the same function and same user data are given, the
12372     * function will not be removed from the list. This allows us to add the
12373     * same callback several times, with different @p data pointers and be
12374     * able to remove them later without conflicts.
12375     *
12376     * @param obj The anchorblock object
12377     * @param func The function to remove from the list
12378     * @param data The data matching the function to remove from the list
12379     */
12380    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);
12381    /**
12382     * @}
12383     */
12384
12385    /**
12386     * @defgroup Bubble Bubble
12387     *
12388     * @image html img/widget/bubble/preview-00.png
12389     * @image latex img/widget/bubble/preview-00.eps
12390     * @image html img/widget/bubble/preview-01.png
12391     * @image latex img/widget/bubble/preview-01.eps
12392     * @image html img/widget/bubble/preview-02.png
12393     * @image latex img/widget/bubble/preview-02.eps
12394     *
12395     * @brief The Bubble is a widget to show text similar to how speech is
12396     * represented in comics.
12397     *
12398     * The bubble widget contains 5 important visual elements:
12399     * @li The frame is a rectangle with rounded edjes and an "arrow".
12400     * @li The @p icon is an image to which the frame's arrow points to.
12401     * @li The @p label is a text which appears to the right of the icon if the
12402     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12403     * otherwise.
12404     * @li The @p info is a text which appears to the right of the label. Info's
12405     * font is of a ligther color than label.
12406     * @li The @p content is an evas object that is shown inside the frame.
12407     *
12408     * The position of the arrow, icon, label and info depends on which corner is
12409     * selected. The four available corners are:
12410     * @li "top_left" - Default
12411     * @li "top_right"
12412     * @li "bottom_left"
12413     * @li "bottom_right"
12414     *
12415     * Signals that you can add callbacks for are:
12416     * @li "clicked" - This is called when a user has clicked the bubble.
12417     *
12418     * For an example of using a buble see @ref bubble_01_example_page "this".
12419     *
12420     * @{
12421     */
12422    /**
12423     * Add a new bubble to the parent
12424     *
12425     * @param parent The parent object
12426     * @return The new object or NULL if it cannot be created
12427     *
12428     * This function adds a text bubble to the given parent evas object.
12429     */
12430    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12431    /**
12432     * Set the label of the bubble
12433     *
12434     * @param obj The bubble object
12435     * @param label The string to set in the label
12436     *
12437     * This function sets the title of the bubble. Where this appears depends on
12438     * the selected corner.
12439     * @deprecated use elm_object_text_set() instead.
12440     */
12441    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12442    /**
12443     * Get the label of the bubble
12444     *
12445     * @param obj The bubble object
12446     * @return The string of set in the label
12447     *
12448     * This function gets the title of the bubble.
12449     * @deprecated use elm_object_text_get() instead.
12450     */
12451    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12452    /**
12453     * Set the info of the bubble
12454     *
12455     * @param obj The bubble object
12456     * @param info The given info about the bubble
12457     *
12458     * This function sets the info of the bubble. Where this appears depends on
12459     * the selected corner.
12460     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12461     */
12462    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12463    /**
12464     * Get the info of the bubble
12465     *
12466     * @param obj The bubble object
12467     *
12468     * @return The "info" string of the bubble
12469     *
12470     * This function gets the info text.
12471     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12472     */
12473    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12474    /**
12475     * Set the content to be shown in the bubble
12476     *
12477     * Once the content object is set, a previously set one will be deleted.
12478     * If you want to keep the old content object, use the
12479     * elm_bubble_content_unset() function.
12480     *
12481     * @param obj The bubble object
12482     * @param content The given content of the bubble
12483     *
12484     * This function sets the content shown on the middle of the bubble.
12485     */
12486    EINA_DEPRECATED EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12487    /**
12488     * Get the content shown in the bubble
12489     *
12490     * Return the content object which is set for this widget.
12491     *
12492     * @param obj The bubble object
12493     * @return The content that is being used
12494     */
12495    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12496    /**
12497     * Unset the content shown in the bubble
12498     *
12499     * Unparent and return the content object which was set for this widget.
12500     *
12501     * @param obj The bubble object
12502     * @return The content that was being used
12503     */
12504    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12505    /**
12506     * Set the icon of the bubble
12507     *
12508     * Once the icon object is set, a previously set one will be deleted.
12509     * If you want to keep the old content object, use the
12510     * elm_icon_content_unset() function.
12511     *
12512     * @param obj The bubble object
12513     * @param icon The given icon for the bubble
12514     */
12515    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12516    /**
12517     * Get the icon of the bubble
12518     *
12519     * @param obj The bubble object
12520     * @return The icon for the bubble
12521     *
12522     * This function gets the icon shown on the top left of bubble.
12523     */
12524    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12525    /**
12526     * Unset the icon of the bubble
12527     *
12528     * Unparent and return the icon object which was set for this widget.
12529     *
12530     * @param obj The bubble object
12531     * @return The icon that was being used
12532     */
12533    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12534    /**
12535     * Set the corner of the bubble
12536     *
12537     * @param obj The bubble object.
12538     * @param corner The given corner for the bubble.
12539     *
12540     * This function sets the corner of the bubble. The corner will be used to
12541     * determine where the arrow in the frame points to and where label, icon and
12542     * info are shown.
12543     *
12544     * Possible values for corner are:
12545     * @li "top_left" - Default
12546     * @li "top_right"
12547     * @li "bottom_left"
12548     * @li "bottom_right"
12549     */
12550    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12551    /**
12552     * Get the corner of the bubble
12553     *
12554     * @param obj The bubble object.
12555     * @return The given corner for the bubble.
12556     *
12557     * This function gets the selected corner of the bubble.
12558     */
12559    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12560    /**
12561     * @}
12562     */
12563
12564    /**
12565     * @defgroup Photo Photo
12566     *
12567     * For displaying the photo of a person (contact). Simple, yet
12568     * with a very specific purpose.
12569     *
12570     * Signals that you can add callbacks for are:
12571     *
12572     * "clicked" - This is called when a user has clicked the photo
12573     * "drag,start" - Someone started dragging the image out of the object
12574     * "drag,end" - Dragged item was dropped (somewhere)
12575     *
12576     * @{
12577     */
12578
12579    /**
12580     * Add a new photo to the parent
12581     *
12582     * @param parent The parent object
12583     * @return The new object or NULL if it cannot be created
12584     *
12585     * @ingroup Photo
12586     */
12587    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12588
12589    /**
12590     * Set the file that will be used as photo
12591     *
12592     * @param obj The photo object
12593     * @param file The path to file that will be used as photo
12594     *
12595     * @return (1 = success, 0 = error)
12596     *
12597     * @ingroup Photo
12598     */
12599    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12600
12601     /**
12602     * Set the file that will be used as thumbnail in the photo.
12603     *
12604     * @param obj The photo object.
12605     * @param file The path to file that will be used as thumb.
12606     * @param group The key used in case of an EET file.
12607     *
12608     * @ingroup Photo
12609     */
12610    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12611
12612    /**
12613     * Set the size that will be used on the photo
12614     *
12615     * @param obj The photo object
12616     * @param size The size that the photo will be
12617     *
12618     * @ingroup Photo
12619     */
12620    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12621
12622    /**
12623     * Set if the photo should be completely visible or not.
12624     *
12625     * @param obj The photo object
12626     * @param fill if true the photo will be completely visible
12627     *
12628     * @ingroup Photo
12629     */
12630    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12631
12632    /**
12633     * Set editability of the photo.
12634     *
12635     * An editable photo can be dragged to or from, and can be cut or
12636     * pasted too.  Note that pasting an image or dropping an item on
12637     * the image will delete the existing content.
12638     *
12639     * @param obj The photo object.
12640     * @param set To set of clear editablity.
12641     */
12642    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12643
12644    /**
12645     * @}
12646     */
12647
12648    /* gesture layer */
12649    /**
12650     * @defgroup Elm_Gesture_Layer Gesture Layer
12651     * Gesture Layer Usage:
12652     *
12653     * Use Gesture Layer to detect gestures.
12654     * The advantage is that you don't have to implement
12655     * gesture detection, just set callbacks of gesture state.
12656     * By using gesture layer we make standard interface.
12657     *
12658     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12659     * with a parent object parameter.
12660     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12661     * call. Usually with same object as target (2nd parameter).
12662     *
12663     * Now you need to tell gesture layer what gestures you follow.
12664     * This is done with @ref elm_gesture_layer_cb_set call.
12665     * By setting the callback you actually saying to gesture layer:
12666     * I would like to know when the gesture @ref Elm_Gesture_Types
12667     * switches to state @ref Elm_Gesture_State.
12668     *
12669     * Next, you need to implement the actual action that follows the input
12670     * in your callback.
12671     *
12672     * Note that if you like to stop being reported about a gesture, just set
12673     * all callbacks referring this gesture to NULL.
12674     * (again with @ref elm_gesture_layer_cb_set)
12675     *
12676     * The information reported by gesture layer to your callback is depending
12677     * on @ref Elm_Gesture_Types:
12678     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12679     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12680     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12681     *
12682     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12683     * @ref ELM_GESTURE_MOMENTUM.
12684     *
12685     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12686     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12687     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12688     * Note that we consider a flick as a line-gesture that should be completed
12689     * in flick-time-limit as defined in @ref Config.
12690     *
12691     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12692     *
12693     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12694     *
12695     *
12696     * Gesture Layer Tweaks:
12697     *
12698     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12699     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12700     *
12701     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12702     * so gesture starts when user touches (a *DOWN event) touch-surface
12703     * and ends when no fingers touches surface (a *UP event).
12704     */
12705
12706    /**
12707     * @enum _Elm_Gesture_Types
12708     * Enum of supported gesture types.
12709     * @ingroup Elm_Gesture_Layer
12710     */
12711    enum _Elm_Gesture_Types
12712      {
12713         ELM_GESTURE_FIRST = 0,
12714
12715         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12716         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12717         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12718         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12719
12720         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12721
12722         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12723         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12724
12725         ELM_GESTURE_ZOOM, /**< Zoom */
12726         ELM_GESTURE_ROTATE, /**< Rotate */
12727
12728         ELM_GESTURE_LAST
12729      };
12730
12731    /**
12732     * @typedef Elm_Gesture_Types
12733     * gesture types enum
12734     * @ingroup Elm_Gesture_Layer
12735     */
12736    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12737
12738    /**
12739     * @enum _Elm_Gesture_State
12740     * Enum of gesture states.
12741     * @ingroup Elm_Gesture_Layer
12742     */
12743    enum _Elm_Gesture_State
12744      {
12745         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12746         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12747         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12748         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12749         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12750      };
12751
12752    /**
12753     * @typedef Elm_Gesture_State
12754     * gesture states enum
12755     * @ingroup Elm_Gesture_Layer
12756     */
12757    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12758
12759    /**
12760     * @struct _Elm_Gesture_Taps_Info
12761     * Struct holds taps info for user
12762     * @ingroup Elm_Gesture_Layer
12763     */
12764    struct _Elm_Gesture_Taps_Info
12765      {
12766         Evas_Coord x, y;         /**< Holds center point between fingers */
12767         unsigned int n;          /**< Number of fingers tapped           */
12768         unsigned int timestamp;  /**< event timestamp       */
12769      };
12770
12771    /**
12772     * @typedef Elm_Gesture_Taps_Info
12773     * holds taps info for user
12774     * @ingroup Elm_Gesture_Layer
12775     */
12776    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12777
12778    /**
12779     * @struct _Elm_Gesture_Momentum_Info
12780     * Struct holds momentum info for user
12781     * x1 and y1 are not necessarily in sync
12782     * x1 holds x value of x direction starting point
12783     * and same holds for y1.
12784     * This is noticeable when doing V-shape movement
12785     * @ingroup Elm_Gesture_Layer
12786     */
12787    struct _Elm_Gesture_Momentum_Info
12788      {  /* Report line ends, timestamps, and momentum computed        */
12789         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12790         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12791         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12792         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12793
12794         unsigned int tx; /**< Timestamp of start of final x-swipe */
12795         unsigned int ty; /**< Timestamp of start of final y-swipe */
12796
12797         Evas_Coord mx; /**< Momentum on X */
12798         Evas_Coord my; /**< Momentum on Y */
12799
12800         unsigned int n;  /**< Number of fingers */
12801      };
12802
12803    /**
12804     * @typedef Elm_Gesture_Momentum_Info
12805     * holds momentum info for user
12806     * @ingroup Elm_Gesture_Layer
12807     */
12808     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12809
12810    /**
12811     * @struct _Elm_Gesture_Line_Info
12812     * Struct holds line info for user
12813     * @ingroup Elm_Gesture_Layer
12814     */
12815    struct _Elm_Gesture_Line_Info
12816      {  /* Report line ends, timestamps, and momentum computed      */
12817         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12818         /* FIXME should be radians, bot degrees */
12819         double angle;              /**< Angle (direction) of lines  */
12820      };
12821
12822    /**
12823     * @typedef Elm_Gesture_Line_Info
12824     * Holds line info for user
12825     * @ingroup Elm_Gesture_Layer
12826     */
12827     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12828
12829    /**
12830     * @struct _Elm_Gesture_Zoom_Info
12831     * Struct holds zoom info for user
12832     * @ingroup Elm_Gesture_Layer
12833     */
12834    struct _Elm_Gesture_Zoom_Info
12835      {
12836         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12837         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12838         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12839         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12840      };
12841
12842    /**
12843     * @typedef Elm_Gesture_Zoom_Info
12844     * Holds zoom info for user
12845     * @ingroup Elm_Gesture_Layer
12846     */
12847    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12848
12849    /**
12850     * @struct _Elm_Gesture_Rotate_Info
12851     * Struct holds rotation info for user
12852     * @ingroup Elm_Gesture_Layer
12853     */
12854    struct _Elm_Gesture_Rotate_Info
12855      {
12856         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12857         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12858         double base_angle; /**< Holds start-angle */
12859         double angle;      /**< Rotation value: 0.0 means no rotation         */
12860         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12861      };
12862
12863    /**
12864     * @typedef Elm_Gesture_Rotate_Info
12865     * Holds rotation info for user
12866     * @ingroup Elm_Gesture_Layer
12867     */
12868    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12869
12870    /**
12871     * @typedef Elm_Gesture_Event_Cb
12872     * User callback used to stream gesture info from gesture layer
12873     * @param data user data
12874     * @param event_info gesture report info
12875     * Returns a flag field to be applied on the causing event.
12876     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12877     * upon the event, in an irreversible way.
12878     *
12879     * @ingroup Elm_Gesture_Layer
12880     */
12881    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12882
12883    /**
12884     * Use function to set callbacks to be notified about
12885     * change of state of gesture.
12886     * When a user registers a callback with this function
12887     * this means this gesture has to be tested.
12888     *
12889     * When ALL callbacks for a gesture are set to NULL
12890     * it means user isn't interested in gesture-state
12891     * and it will not be tested.
12892     *
12893     * @param obj Pointer to gesture-layer.
12894     * @param idx The gesture you would like to track its state.
12895     * @param cb callback function pointer.
12896     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12897     * @param data user info to be sent to callback (usually, Smart Data)
12898     *
12899     * @ingroup Elm_Gesture_Layer
12900     */
12901    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);
12902
12903    /**
12904     * Call this function to get repeat-events settings.
12905     *
12906     * @param obj Pointer to gesture-layer.
12907     *
12908     * @return repeat events settings.
12909     * @see elm_gesture_layer_hold_events_set()
12910     * @ingroup Elm_Gesture_Layer
12911     */
12912    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12913
12914    /**
12915     * This function called in order to make gesture-layer repeat events.
12916     * Set this of you like to get the raw events only if gestures were not detected.
12917     * Clear this if you like gesture layer to fwd events as testing gestures.
12918     *
12919     * @param obj Pointer to gesture-layer.
12920     * @param r Repeat: TRUE/FALSE
12921     *
12922     * @ingroup Elm_Gesture_Layer
12923     */
12924    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12925
12926    /**
12927     * This function sets step-value for zoom action.
12928     * Set step to any positive value.
12929     * Cancel step setting by setting to 0.0
12930     *
12931     * @param obj Pointer to gesture-layer.
12932     * @param s new zoom step value.
12933     *
12934     * @ingroup Elm_Gesture_Layer
12935     */
12936    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12937
12938    /**
12939     * This function sets step-value for rotate action.
12940     * Set step to any positive value.
12941     * Cancel step setting by setting to 0.0
12942     *
12943     * @param obj Pointer to gesture-layer.
12944     * @param s new roatate step value.
12945     *
12946     * @ingroup Elm_Gesture_Layer
12947     */
12948    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12949
12950    /**
12951     * This function called to attach gesture-layer to an Evas_Object.
12952     * @param obj Pointer to gesture-layer.
12953     * @param t Pointer to underlying object (AKA Target)
12954     *
12955     * @return TRUE, FALSE on success, failure.
12956     *
12957     * @ingroup Elm_Gesture_Layer
12958     */
12959    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12960
12961    /**
12962     * Call this function to construct a new gesture-layer object.
12963     * This does not activate the gesture layer. You have to
12964     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12965     *
12966     * @param parent the parent object.
12967     *
12968     * @return Pointer to new gesture-layer object.
12969     *
12970     * @ingroup Elm_Gesture_Layer
12971     */
12972    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12973
12974    /**
12975     * @defgroup Thumb Thumb
12976     *
12977     * @image html img/widget/thumb/preview-00.png
12978     * @image latex img/widget/thumb/preview-00.eps
12979     *
12980     * A thumb object is used for displaying the thumbnail of an image or video.
12981     * You must have compiled Elementary with Ethumb_Client support and the DBus
12982     * service must be present and auto-activated in order to have thumbnails to
12983     * be generated.
12984     *
12985     * Once the thumbnail object becomes visible, it will check if there is a
12986     * previously generated thumbnail image for the file set on it. If not, it
12987     * will start generating this thumbnail.
12988     *
12989     * Different config settings will cause different thumbnails to be generated
12990     * even on the same file.
12991     *
12992     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12993     * Ethumb documentation to change this path, and to see other configuration
12994     * options.
12995     *
12996     * Signals that you can add callbacks for are:
12997     *
12998     * - "clicked" - This is called when a user has clicked the thumb without dragging
12999     *             around.
13000     * - "clicked,double" - This is called when a user has double-clicked the thumb.
13001     * - "press" - This is called when a user has pressed down the thumb.
13002     * - "generate,start" - The thumbnail generation started.
13003     * - "generate,stop" - The generation process stopped.
13004     * - "generate,error" - The generation failed.
13005     * - "load,error" - The thumbnail image loading failed.
13006     *
13007     * available styles:
13008     * - default
13009     * - noframe
13010     *
13011     * An example of use of thumbnail:
13012     *
13013     * - @ref thumb_example_01
13014     */
13015
13016    /**
13017     * @addtogroup Thumb
13018     * @{
13019     */
13020
13021    /**
13022     * @enum _Elm_Thumb_Animation_Setting
13023     * @typedef Elm_Thumb_Animation_Setting
13024     *
13025     * Used to set if a video thumbnail is animating or not.
13026     *
13027     * @ingroup Thumb
13028     */
13029    typedef enum _Elm_Thumb_Animation_Setting
13030      {
13031         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13032         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
13033         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
13034         ELM_THUMB_ANIMATION_LAST
13035      } Elm_Thumb_Animation_Setting;
13036
13037    /**
13038     * Add a new thumb object to the parent.
13039     *
13040     * @param parent The parent object.
13041     * @return The new object or NULL if it cannot be created.
13042     *
13043     * @see elm_thumb_file_set()
13044     * @see elm_thumb_ethumb_client_get()
13045     *
13046     * @ingroup Thumb
13047     */
13048    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13049    /**
13050     * Reload thumbnail if it was generated before.
13051     *
13052     * @param obj The thumb object to reload
13053     *
13054     * This is useful if the ethumb client configuration changed, like its
13055     * size, aspect or any other property one set in the handle returned
13056     * by elm_thumb_ethumb_client_get().
13057     *
13058     * If the options didn't change, the thumbnail won't be generated again, but
13059     * the old one will still be used.
13060     *
13061     * @see elm_thumb_file_set()
13062     *
13063     * @ingroup Thumb
13064     */
13065    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13066    /**
13067     * Set the file that will be used as thumbnail.
13068     *
13069     * @param obj The thumb object.
13070     * @param file The path to file that will be used as thumb.
13071     * @param key The key used in case of an EET file.
13072     *
13073     * The file can be an image or a video (in that case, acceptable extensions are:
13074     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13075     * function elm_thumb_animate().
13076     *
13077     * @see elm_thumb_file_get()
13078     * @see elm_thumb_reload()
13079     * @see elm_thumb_animate()
13080     *
13081     * @ingroup Thumb
13082     */
13083    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13084    /**
13085     * Get the image or video path and key used to generate the thumbnail.
13086     *
13087     * @param obj The thumb object.
13088     * @param file Pointer to filename.
13089     * @param key Pointer to key.
13090     *
13091     * @see elm_thumb_file_set()
13092     * @see elm_thumb_path_get()
13093     *
13094     * @ingroup Thumb
13095     */
13096    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13097    /**
13098     * Get the path and key to the image or video generated by ethumb.
13099     *
13100     * One just need to make sure that the thumbnail was generated before getting
13101     * its path; otherwise, the path will be NULL. One way to do that is by asking
13102     * for the path when/after the "generate,stop" smart callback is called.
13103     *
13104     * @param obj The thumb object.
13105     * @param file Pointer to thumb path.
13106     * @param key Pointer to thumb key.
13107     *
13108     * @see elm_thumb_file_get()
13109     *
13110     * @ingroup Thumb
13111     */
13112    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13113    /**
13114     * Set the animation state for the thumb object. If its content is an animated
13115     * video, you may start/stop the animation or tell it to play continuously and
13116     * looping.
13117     *
13118     * @param obj The thumb object.
13119     * @param setting The animation setting.
13120     *
13121     * @see elm_thumb_file_set()
13122     *
13123     * @ingroup Thumb
13124     */
13125    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13126    /**
13127     * Get the animation state for the thumb object.
13128     *
13129     * @param obj The thumb object.
13130     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13131     * on errors.
13132     *
13133     * @see elm_thumb_animate_set()
13134     *
13135     * @ingroup Thumb
13136     */
13137    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13138    /**
13139     * Get the ethumb_client handle so custom configuration can be made.
13140     *
13141     * @return Ethumb_Client instance or NULL.
13142     *
13143     * This must be called before the objects are created to be sure no object is
13144     * visible and no generation started.
13145     *
13146     * Example of usage:
13147     *
13148     * @code
13149     * #include <Elementary.h>
13150     * #ifndef ELM_LIB_QUICKLAUNCH
13151     * EAPI_MAIN int
13152     * elm_main(int argc, char **argv)
13153     * {
13154     *    Ethumb_Client *client;
13155     *
13156     *    elm_need_ethumb();
13157     *
13158     *    // ... your code
13159     *
13160     *    client = elm_thumb_ethumb_client_get();
13161     *    if (!client)
13162     *      {
13163     *         ERR("could not get ethumb_client");
13164     *         return 1;
13165     *      }
13166     *    ethumb_client_size_set(client, 100, 100);
13167     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
13168     *    // ... your code
13169     *
13170     *    // Create elm_thumb objects here
13171     *
13172     *    elm_run();
13173     *    elm_shutdown();
13174     *    return 0;
13175     * }
13176     * #endif
13177     * ELM_MAIN()
13178     * @endcode
13179     *
13180     * @note There's only one client handle for Ethumb, so once a configuration
13181     * change is done to it, any other request for thumbnails (for any thumbnail
13182     * object) will use that configuration. Thus, this configuration is global.
13183     *
13184     * @ingroup Thumb
13185     */
13186    EAPI void                        *elm_thumb_ethumb_client_get(void);
13187    /**
13188     * Get the ethumb_client connection state.
13189     *
13190     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13191     * otherwise.
13192     */
13193    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
13194    /**
13195     * Make the thumbnail 'editable'.
13196     *
13197     * @param obj Thumb object.
13198     * @param set Turn on or off editability. Default is @c EINA_FALSE.
13199     *
13200     * This means the thumbnail is a valid drag target for drag and drop, and can be
13201     * cut or pasted too.
13202     *
13203     * @see elm_thumb_editable_get()
13204     *
13205     * @ingroup Thumb
13206     */
13207    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13208    /**
13209     * Make the thumbnail 'editable'.
13210     *
13211     * @param obj Thumb object.
13212     * @return Editability.
13213     *
13214     * This means the thumbnail is a valid drag target for drag and drop, and can be
13215     * cut or pasted too.
13216     *
13217     * @see elm_thumb_editable_set()
13218     *
13219     * @ingroup Thumb
13220     */
13221    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13222
13223    /**
13224     * @}
13225     */
13226
13227    /**
13228     * @defgroup Web Web
13229     *
13230     * @image html img/widget/web/preview-00.png
13231     * @image latex img/widget/web/preview-00.eps
13232     *
13233     * A web object is used for displaying web pages (HTML/CSS/JS)
13234     * using WebKit-EFL. You must have compiled Elementary with
13235     * ewebkit support.
13236     *
13237     * Signals that you can add callbacks for are:
13238     * @li "download,request": A file download has been requested. Event info is
13239     * a pointer to a Elm_Web_Download
13240     * @li "editorclient,contents,changed": Editor client's contents changed
13241     * @li "editorclient,selection,changed": Editor client's selection changed
13242     * @li "frame,created": A new frame was created. Event info is an
13243     * Evas_Object which can be handled with WebKit's ewk_frame API
13244     * @li "icon,received": An icon was received by the main frame
13245     * @li "inputmethod,changed": Input method changed. Event info is an
13246     * Eina_Bool indicating whether it's enabled or not
13247     * @li "js,windowobject,clear": JS window object has been cleared
13248     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13249     * is a char *link[2], where the first string contains the URL the link
13250     * points to, and the second one the title of the link
13251     * @li "link,hover,out": Mouse cursor left the link
13252     * @li "load,document,finished": Loading of a document finished. Event info
13253     * is the frame that finished loading
13254     * @li "load,error": Load failed. Event info is a pointer to
13255     * Elm_Web_Frame_Load_Error
13256     * @li "load,finished": Load finished. Event info is NULL on success, on
13257     * error it's a pointer to Elm_Web_Frame_Load_Error
13258     * @li "load,newwindow,show": A new window was created and is ready to be
13259     * shown
13260     * @li "load,progress": Overall load progress. Event info is a pointer to
13261     * a double containing a value between 0.0 and 1.0
13262     * @li "load,provisional": Started provisional load
13263     * @li "load,started": Loading of a document started
13264     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13265     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13266     * the menubar is visible, or EINA_FALSE in case it's not
13267     * @li "menubar,visible,set": Informs menubar visibility. Event info is
13268     * an Eina_Bool indicating the visibility
13269     * @li "popup,created": A dropdown widget was activated, requesting its
13270     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13271     * @li "popup,willdelete": The web object is ready to destroy the popup
13272     * object created. Event info is a pointer to Elm_Web_Menu
13273     * @li "ready": Page is fully loaded
13274     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13275     * info is a pointer to Eina_Bool where the visibility state should be set
13276     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13277     * is an Eina_Bool with the visibility state set
13278     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13279     * a string with the new text
13280     * @li "statusbar,visible,get": Queries visibility of the status bar.
13281     * Event info is a pointer to Eina_Bool where the visibility state should be
13282     * set.
13283     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13284     * an Eina_Bool with the visibility value
13285     * @li "title,changed": Title of the main frame changed. Event info is a
13286     * string with the new title
13287     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13288     * is a pointer to Eina_Bool where the visibility state should be set
13289     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13290     * info is an Eina_Bool with the visibility state
13291     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13292     * a string with the text to show
13293     * @li "uri,changed": URI of the main frame changed. Event info is a string
13294     * with the new URI
13295     * @li "view,resized": The web object internal's view changed sized
13296     * @li "windows,close,request": A JavaScript request to close the current
13297     * window was requested
13298     * @li "zoom,animated,end": Animated zoom finished
13299     *
13300     * available styles:
13301     * - default
13302     *
13303     * An example of use of web:
13304     *
13305     * - @ref web_example_01 TBD
13306     */
13307
13308    /**
13309     * @addtogroup Web
13310     * @{
13311     */
13312
13313    /**
13314     * Structure used to report load errors.
13315     *
13316     * Load errors are reported as signal by elm_web. All the strings are
13317     * temporary references and should @b not be used after the signal
13318     * callback returns. If it's required, make copies with strdup() or
13319     * eina_stringshare_add() (they are not even guaranteed to be
13320     * stringshared, so must use eina_stringshare_add() and not
13321     * eina_stringshare_ref()).
13322     */
13323    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13324    /**
13325     * Structure used to report load errors.
13326     *
13327     * Load errors are reported as signal by elm_web. All the strings are
13328     * temporary references and should @b not be used after the signal
13329     * callback returns. If it's required, make copies with strdup() or
13330     * eina_stringshare_add() (they are not even guaranteed to be
13331     * stringshared, so must use eina_stringshare_add() and not
13332     * eina_stringshare_ref()).
13333     */
13334    struct _Elm_Web_Frame_Load_Error
13335      {
13336         int code; /**< Numeric error code */
13337         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13338         const char *domain; /**< Error domain name */
13339         const char *description; /**< Error description (already localized) */
13340         const char *failing_url; /**< The URL that failed to load */
13341         Evas_Object *frame; /**< Frame object that produced the error */
13342      };
13343
13344    /**
13345     * The possibles types that the items in a menu can be
13346     */
13347    typedef enum _Elm_Web_Menu_Item_Type
13348      {
13349         ELM_WEB_MENU_SEPARATOR,
13350         ELM_WEB_MENU_GROUP,
13351         ELM_WEB_MENU_OPTION
13352      } Elm_Web_Menu_Item_Type;
13353
13354    /**
13355     * Structure describing the items in a menu
13356     */
13357    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13358    /**
13359     * Structure describing the items in a menu
13360     */
13361    struct _Elm_Web_Menu_Item
13362      {
13363         const char *text; /**< The text for the item */
13364         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13365      };
13366
13367    /**
13368     * Structure describing the menu of a popup
13369     *
13370     * This structure will be passed as the @c event_info for the "popup,create"
13371     * signal, which is emitted when a dropdown menu is opened. Users wanting
13372     * to handle these popups by themselves should listen to this signal and
13373     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13374     * property as @c EINA_FALSE means that the user will not handle the popup
13375     * and the default implementation will be used.
13376     *
13377     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13378     * will be emitted to notify the user that it can destroy any objects and
13379     * free all data related to it.
13380     *
13381     * @see elm_web_popup_selected_set()
13382     * @see elm_web_popup_destroy()
13383     */
13384    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13385    /**
13386     * Structure describing the menu of a popup
13387     *
13388     * This structure will be passed as the @c event_info for the "popup,create"
13389     * signal, which is emitted when a dropdown menu is opened. Users wanting
13390     * to handle these popups by themselves should listen to this signal and
13391     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13392     * property as @c EINA_FALSE means that the user will not handle the popup
13393     * and the default implementation will be used.
13394     *
13395     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13396     * will be emitted to notify the user that it can destroy any objects and
13397     * free all data related to it.
13398     *
13399     * @see elm_web_popup_selected_set()
13400     * @see elm_web_popup_destroy()
13401     */
13402    struct _Elm_Web_Menu
13403      {
13404         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13405         int x; /**< The X position of the popup, relative to the elm_web object */
13406         int y; /**< The Y position of the popup, relative to the elm_web object */
13407         int width; /**< Width of the popup menu */
13408         int height; /**< Height of the popup menu */
13409
13410         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. */
13411      };
13412
13413    typedef struct _Elm_Web_Download Elm_Web_Download;
13414    struct _Elm_Web_Download
13415      {
13416         const char *url;
13417      };
13418
13419    /**
13420     * Types of zoom available.
13421     */
13422    typedef enum _Elm_Web_Zoom_Mode
13423      {
13424         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13425         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13426         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13427         ELM_WEB_ZOOM_MODE_LAST
13428      } Elm_Web_Zoom_Mode;
13429    /**
13430     * Opaque handler containing the features (such as statusbar, menubar, etc)
13431     * that are to be set on a newly requested window.
13432     */
13433    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13434    /**
13435     * Callback type for the create_window hook.
13436     *
13437     * The function parameters are:
13438     * @li @p data User data pointer set when setting the hook function
13439     * @li @p obj The elm_web object requesting the new window
13440     * @li @p js Set to @c EINA_TRUE if the request was originated from
13441     * JavaScript. @c EINA_FALSE otherwise.
13442     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13443     * the features requested for the new window.
13444     *
13445     * The returned value of the function should be the @c elm_web widget where
13446     * the request will be loaded. That is, if a new window or tab is created,
13447     * the elm_web widget in it should be returned, and @b NOT the window
13448     * object.
13449     * Returning @c NULL should cancel the request.
13450     *
13451     * @see elm_web_window_create_hook_set()
13452     */
13453    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13454    /**
13455     * Callback type for the JS alert hook.
13456     *
13457     * The function parameters are:
13458     * @li @p data User data pointer set when setting the hook function
13459     * @li @p obj The elm_web object requesting the new window
13460     * @li @p message The message to show in the alert dialog
13461     *
13462     * The function should return the object representing the alert dialog.
13463     * Elm_Web will run a second main loop to handle the dialog and normal
13464     * flow of the application will be restored when the object is deleted, so
13465     * the user should handle the popup properly in order to delete the object
13466     * when the action is finished.
13467     * If the function returns @c NULL the popup will be ignored.
13468     *
13469     * @see elm_web_dialog_alert_hook_set()
13470     */
13471    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13472    /**
13473     * Callback type for the JS confirm hook.
13474     *
13475     * The function parameters are:
13476     * @li @p data User data pointer set when setting the hook function
13477     * @li @p obj The elm_web object requesting the new window
13478     * @li @p message The message to show in the confirm dialog
13479     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13480     * the user selected @c Ok, @c EINA_FALSE otherwise.
13481     *
13482     * The function should return the object representing the confirm dialog.
13483     * Elm_Web will run a second main loop to handle the dialog and normal
13484     * flow of the application will be restored when the object is deleted, so
13485     * the user should handle the popup properly in order to delete the object
13486     * when the action is finished.
13487     * If the function returns @c NULL the popup will be ignored.
13488     *
13489     * @see elm_web_dialog_confirm_hook_set()
13490     */
13491    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13492    /**
13493     * Callback type for the JS prompt hook.
13494     *
13495     * The function parameters are:
13496     * @li @p data User data pointer set when setting the hook function
13497     * @li @p obj The elm_web object requesting the new window
13498     * @li @p message The message to show in the prompt dialog
13499     * @li @p def_value The default value to present the user in the entry
13500     * @li @p value Pointer where to store the value given by the user. Must
13501     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13502     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13503     * the user selected @c Ok, @c EINA_FALSE otherwise.
13504     *
13505     * The function should return the object representing the prompt dialog.
13506     * Elm_Web will run a second main loop to handle the dialog and normal
13507     * flow of the application will be restored when the object is deleted, so
13508     * the user should handle the popup properly in order to delete the object
13509     * when the action is finished.
13510     * If the function returns @c NULL the popup will be ignored.
13511     *
13512     * @see elm_web_dialog_prompt_hook_set()
13513     */
13514    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13515    /**
13516     * Callback type for the JS file selector hook.
13517     *
13518     * The function parameters are:
13519     * @li @p data User data pointer set when setting the hook function
13520     * @li @p obj The elm_web object requesting the new window
13521     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13522     * @li @p accept_types Mime types accepted
13523     * @li @p selected Pointer where to store the list of malloc'ed strings
13524     * containing the path to each file selected. Must be @c NULL if the file
13525     * dialog is cancelled
13526     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13527     * the user selected @c Ok, @c EINA_FALSE otherwise.
13528     *
13529     * The function should return the object representing the file selector
13530     * dialog.
13531     * Elm_Web will run a second main loop to handle the dialog and normal
13532     * flow of the application will be restored when the object is deleted, so
13533     * the user should handle the popup properly in order to delete the object
13534     * when the action is finished.
13535     * If the function returns @c NULL the popup will be ignored.
13536     *
13537     * @see elm_web_dialog_file selector_hook_set()
13538     */
13539    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);
13540    /**
13541     * Callback type for the JS console message hook.
13542     *
13543     * When a console message is added from JavaScript, any set function to the
13544     * console message hook will be called for the user to handle. There is no
13545     * default implementation of this hook.
13546     *
13547     * The function parameters are:
13548     * @li @p data User data pointer set when setting the hook function
13549     * @li @p obj The elm_web object that originated the message
13550     * @li @p message The message sent
13551     * @li @p line_number The line number
13552     * @li @p source_id Source id
13553     *
13554     * @see elm_web_console_message_hook_set()
13555     */
13556    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13557    /**
13558     * Add a new web object to the parent.
13559     *
13560     * @param parent The parent object.
13561     * @return The new object or NULL if it cannot be created.
13562     *
13563     * @see elm_web_uri_set()
13564     * @see elm_web_webkit_view_get()
13565     */
13566    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13567
13568    /**
13569     * Get internal ewk_view object from web object.
13570     *
13571     * Elementary may not provide some low level features of EWebKit,
13572     * instead of cluttering the API with proxy methods we opted to
13573     * return the internal reference. Be careful using it as it may
13574     * interfere with elm_web behavior.
13575     *
13576     * @param obj The web object.
13577     * @return The internal ewk_view object or NULL if it does not
13578     *         exist. (Failure to create or Elementary compiled without
13579     *         ewebkit)
13580     *
13581     * @see elm_web_add()
13582     */
13583    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13584
13585    /**
13586     * Sets the function to call when a new window is requested
13587     *
13588     * This hook will be called when a request to create a new window is
13589     * issued from the web page loaded.
13590     * There is no default implementation for this feature, so leaving this
13591     * unset or passing @c NULL in @p func will prevent new windows from
13592     * opening.
13593     *
13594     * @param obj The web object where to set the hook function
13595     * @param func The hook function to be called when a window is requested
13596     * @param data User data
13597     */
13598    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13599    /**
13600     * Sets the function to call when an alert dialog
13601     *
13602     * This hook will be called when a JavaScript alert dialog is requested.
13603     * If no function is set or @c NULL is passed in @p func, the default
13604     * implementation will take place.
13605     *
13606     * @param obj The web object where to set the hook function
13607     * @param func The callback function to be used
13608     * @param data User data
13609     *
13610     * @see elm_web_inwin_mode_set()
13611     */
13612    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13613    /**
13614     * Sets the function to call when an confirm dialog
13615     *
13616     * This hook will be called when a JavaScript confirm dialog is requested.
13617     * If no function is set or @c NULL is passed in @p func, the default
13618     * implementation will take place.
13619     *
13620     * @param obj The web object where to set the hook function
13621     * @param func The callback function to be used
13622     * @param data User data
13623     *
13624     * @see elm_web_inwin_mode_set()
13625     */
13626    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13627    /**
13628     * Sets the function to call when an prompt dialog
13629     *
13630     * This hook will be called when a JavaScript prompt dialog is requested.
13631     * If no function is set or @c NULL is passed in @p func, the default
13632     * implementation will take place.
13633     *
13634     * @param obj The web object where to set the hook function
13635     * @param func The callback function to be used
13636     * @param data User data
13637     *
13638     * @see elm_web_inwin_mode_set()
13639     */
13640    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13641    /**
13642     * Sets the function to call when an file selector dialog
13643     *
13644     * This hook will be called when a JavaScript file selector dialog is
13645     * requested.
13646     * If no function is set or @c NULL is passed in @p func, the default
13647     * implementation will take place.
13648     *
13649     * @param obj The web object where to set the hook function
13650     * @param func The callback function to be used
13651     * @param data User data
13652     *
13653     * @see elm_web_inwin_mode_set()
13654     */
13655    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13656    /**
13657     * Sets the function to call when a console message is emitted from JS
13658     *
13659     * This hook will be called when a console message is emitted from
13660     * JavaScript. There is no default implementation for this feature.
13661     *
13662     * @param obj The web object where to set the hook function
13663     * @param func The callback function to be used
13664     * @param data User data
13665     */
13666    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13667    /**
13668     * Gets the status of the tab propagation
13669     *
13670     * @param obj The web object to query
13671     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13672     *
13673     * @see elm_web_tab_propagate_set()
13674     */
13675    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
13676    /**
13677     * Sets whether to use tab propagation
13678     *
13679     * If tab propagation is enabled, whenever the user presses the Tab key,
13680     * Elementary will handle it and switch focus to the next widget.
13681     * The default value is disabled, where WebKit will handle the Tab key to
13682     * cycle focus though its internal objects, jumping to the next widget
13683     * only when that cycle ends.
13684     *
13685     * @param obj The web object
13686     * @param propagate Whether to propagate Tab keys to Elementary or not
13687     */
13688    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13689    /**
13690     * Sets the URI for the web object
13691     *
13692     * It must be a full URI, with resource included, in the form
13693     * http://www.enlightenment.org or file:///tmp/something.html
13694     *
13695     * @param obj The web object
13696     * @param uri The URI to set
13697     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13698     */
13699    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
13700    /**
13701     * Gets the current URI for the object
13702     *
13703     * The returned string must not be freed and is guaranteed to be
13704     * stringshared.
13705     *
13706     * @param obj The web object
13707     * @return A stringshared internal string with the current URI, or NULL on
13708     * failure
13709     */
13710    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
13711    /**
13712     * Gets the current title
13713     *
13714     * The returned string must not be freed and is guaranteed to be
13715     * stringshared.
13716     *
13717     * @param obj The web object
13718     * @return A stringshared internal string with the current title, or NULL on
13719     * failure
13720     */
13721    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
13722    /**
13723     * Sets the background color to be used by the web object
13724     *
13725     * This is the color that will be used by default when the loaded page
13726     * does not set it's own. Color values are pre-multiplied.
13727     *
13728     * @param obj The web object
13729     * @param r Red component
13730     * @param g Green component
13731     * @param b Blue component
13732     * @param a Alpha component
13733     */
13734    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13735    /**
13736     * Gets the background color to be used by the web object
13737     *
13738     * This is the color that will be used by default when the loaded page
13739     * does not set it's own. Color values are pre-multiplied.
13740     *
13741     * @param obj The web object
13742     * @param r Red component
13743     * @param g Green component
13744     * @param b Blue component
13745     * @param a Alpha component
13746     */
13747    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13748    /**
13749     * Gets a copy of the currently selected text
13750     *
13751     * The string returned must be freed by the user when it's done with it.
13752     *
13753     * @param obj The web object
13754     * @return A newly allocated string, or NULL if nothing is selected or an
13755     * error occurred
13756     */
13757    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
13758    /**
13759     * Tells the web object which index in the currently open popup was selected
13760     *
13761     * When the user handles the popup creation from the "popup,created" signal,
13762     * it needs to tell the web object which item was selected by calling this
13763     * function with the index corresponding to the item.
13764     *
13765     * @param obj The web object
13766     * @param index The index selected
13767     *
13768     * @see elm_web_popup_destroy()
13769     */
13770    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
13771    /**
13772     * Dismisses an open dropdown popup
13773     *
13774     * When the popup from a dropdown widget is to be dismissed, either after
13775     * selecting an option or to cancel it, this function must be called, which
13776     * will later emit an "popup,willdelete" signal to notify the user that
13777     * any memory and objects related to this popup can be freed.
13778     *
13779     * @param obj The web object
13780     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13781     * if there was no menu to destroy
13782     */
13783    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
13784    /**
13785     * Searches the given string in a document.
13786     *
13787     * @param obj The web object where to search the text
13788     * @param string String to search
13789     * @param case_sensitive If search should be case sensitive or not
13790     * @param forward If search is from cursor and on or backwards
13791     * @param wrap If search should wrap at the end
13792     *
13793     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13794     * or failure
13795     */
13796    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13797    /**
13798     * Marks matches of the given string in a document.
13799     *
13800     * @param obj The web object where to search text
13801     * @param string String to match
13802     * @param case_sensitive If match should be case sensitive or not
13803     * @param highlight If matches should be highlighted
13804     * @param limit Maximum amount of matches, or zero to unlimited
13805     *
13806     * @return number of matched @a string
13807     */
13808    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13809    /**
13810     * Clears all marked matches in the document
13811     *
13812     * @param obj The web object
13813     *
13814     * @return EINA_TRUE on success, EINA_FALSE otherwise
13815     */
13816    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
13817    /**
13818     * Sets whether to highlight the matched marks
13819     *
13820     * If enabled, marks set with elm_web_text_matches_mark() will be
13821     * highlighted.
13822     *
13823     * @param obj The web object
13824     * @param highlight Whether to highlight the marks or not
13825     *
13826     * @return EINA_TRUE on success, EINA_FALSE otherwise
13827     */
13828    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13829    /**
13830     * Gets whether highlighting marks is enabled
13831     *
13832     * @param The web object
13833     *
13834     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13835     * otherwise
13836     */
13837    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
13838    /**
13839     * Gets the overall loading progress of the page
13840     *
13841     * Returns the estimated loading progress of the page, with a value between
13842     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13843     * included in the page.
13844     *
13845     * @param The web object
13846     *
13847     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13848     * failure
13849     */
13850    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
13851    /**
13852     * Stops loading the current page
13853     *
13854     * Cancels the loading of the current page in the web object. This will
13855     * cause a "load,error" signal to be emitted, with the is_cancellation
13856     * flag set to EINA_TRUE.
13857     *
13858     * @param obj The web object
13859     *
13860     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13861     */
13862    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
13863    /**
13864     * Requests a reload of the current document in the object
13865     *
13866     * @param obj The web object
13867     *
13868     * @return EINA_TRUE on success, EINA_FALSE otherwise
13869     */
13870    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
13871    /**
13872     * Requests a reload of the current document, avoiding any existing caches
13873     *
13874     * @param obj The web object
13875     *
13876     * @return EINA_TRUE on success, EINA_FALSE otherwise
13877     */
13878    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
13879    /**
13880     * Goes back one step in the browsing history
13881     *
13882     * This is equivalent to calling elm_web_object_navigate(obj, -1);
13883     *
13884     * @param obj The web object
13885     *
13886     * @return EINA_TRUE on success, EINA_FALSE otherwise
13887     *
13888     * @see elm_web_history_enable_set()
13889     * @see elm_web_back_possible()
13890     * @see elm_web_forward()
13891     * @see elm_web_navigate()
13892     */
13893    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
13894    /**
13895     * Goes forward one step in the browsing history
13896     *
13897     * This is equivalent to calling elm_web_object_navigate(obj, 1);
13898     *
13899     * @param obj The web object
13900     *
13901     * @return EINA_TRUE on success, EINA_FALSE otherwise
13902     *
13903     * @see elm_web_history_enable_set()
13904     * @see elm_web_forward_possible()
13905     * @see elm_web_back()
13906     * @see elm_web_navigate()
13907     */
13908    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
13909    /**
13910     * Jumps the given number of steps in the browsing history
13911     *
13912     * The @p steps value can be a negative integer to back in history, or a
13913     * positive to move forward.
13914     *
13915     * @param obj The web object
13916     * @param steps The number of steps to jump
13917     *
13918     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13919     * history exists to jump the given number of steps
13920     *
13921     * @see elm_web_history_enable_set()
13922     * @see elm_web_navigate_possible()
13923     * @see elm_web_back()
13924     * @see elm_web_forward()
13925     */
13926    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
13927    /**
13928     * Queries whether it's possible to go back in history
13929     *
13930     * @param obj The web object
13931     *
13932     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13933     * otherwise
13934     */
13935    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
13936    /**
13937     * Queries whether it's possible to go forward in history
13938     *
13939     * @param obj The web object
13940     *
13941     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13942     * otherwise
13943     */
13944    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
13945    /**
13946     * Queries whether it's possible to jump the given number of steps
13947     *
13948     * The @p steps value can be a negative integer to back in history, or a
13949     * positive to move forward.
13950     *
13951     * @param obj The web object
13952     * @param steps The number of steps to check for
13953     *
13954     * @return EINA_TRUE if enough history exists to perform the given jump,
13955     * EINA_FALSE otherwise
13956     */
13957    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
13958    /**
13959     * Gets whether browsing history is enabled for the given object
13960     *
13961     * @param obj The web object
13962     *
13963     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13964     */
13965    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
13966    /**
13967     * Enables or disables the browsing history
13968     *
13969     * @param obj The web object
13970     * @param enable Whether to enable or disable the browsing history
13971     */
13972    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13973    /**
13974     * Sets the zoom level of the web object
13975     *
13976     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13977     * values meaning zoom in and lower meaning zoom out. This function will
13978     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13979     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13980     *
13981     * @param obj The web object
13982     * @param zoom The zoom level to set
13983     */
13984    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
13985    /**
13986     * Gets the current zoom level set on the web object
13987     *
13988     * Note that this is the zoom level set on the web object and not that
13989     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13990     * the two zoom levels should match, but for the other two modes the
13991     * Webkit zoom is calculated internally to match the chosen mode without
13992     * changing the zoom level set for the web object.
13993     *
13994     * @param obj The web object
13995     *
13996     * @return The zoom level set on the object
13997     */
13998    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
13999    /**
14000     * Sets the zoom mode to use
14001     *
14002     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14003     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14004     *
14005     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14006     * with the elm_web_zoom_set() function.
14007     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14008     * make sure the entirety of the web object's contents are shown.
14009     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14010     * fit the contents in the web object's size, without leaving any space
14011     * unused.
14012     *
14013     * @param obj The web object
14014     * @param mode The mode to set
14015     */
14016    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14017    /**
14018     * Gets the currently set zoom mode
14019     *
14020     * @param obj The web object
14021     *
14022     * @return The current zoom mode set for the object, or
14023     * ::ELM_WEB_ZOOM_MODE_LAST on error
14024     */
14025    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
14026    /**
14027     * Shows the given region in the web object
14028     *
14029     * @param obj The web object
14030     * @param x The x coordinate of the region to show
14031     * @param y The y coordinate of the region to show
14032     * @param w The width of the region to show
14033     * @param h The height of the region to show
14034     */
14035    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14036    /**
14037     * Brings in the region to the visible area
14038     *
14039     * Like elm_web_region_show(), but it animates the scrolling of the object
14040     * to show the area
14041     *
14042     * @param obj The web object
14043     * @param x The x coordinate of the region to show
14044     * @param y The y coordinate of the region to show
14045     * @param w The width of the region to show
14046     * @param h The height of the region to show
14047     */
14048    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14049    /**
14050     * Sets the default dialogs to use an Inwin instead of a normal window
14051     *
14052     * If set, then the default implementation for the JavaScript dialogs and
14053     * file selector will be opened in an Inwin. Otherwise they will use a
14054     * normal separated window.
14055     *
14056     * @param obj The web object
14057     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14058     */
14059    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14060    /**
14061     * Gets whether Inwin mode is set for the current object
14062     *
14063     * @param obj The web object
14064     *
14065     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14066     */
14067    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
14068
14069    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14070    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14071    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);
14072    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14073
14074    /**
14075     * @}
14076     */
14077
14078    /**
14079     * @defgroup Hoversel Hoversel
14080     *
14081     * @image html img/widget/hoversel/preview-00.png
14082     * @image latex img/widget/hoversel/preview-00.eps
14083     *
14084     * A hoversel is a button that pops up a list of items (automatically
14085     * choosing the direction to display) that have a label and, optionally, an
14086     * icon to select from. It is a convenience widget to avoid the need to do
14087     * all the piecing together yourself. It is intended for a small number of
14088     * items in the hoversel menu (no more than 8), though is capable of many
14089     * more.
14090     *
14091     * Signals that you can add callbacks for are:
14092     * "clicked" - the user clicked the hoversel button and popped up the sel
14093     * "selected" - an item in the hoversel list is selected. event_info is the item
14094     * "dismissed" - the hover is dismissed
14095     *
14096     * See @ref tutorial_hoversel for an example.
14097     * @{
14098     */
14099    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14100    /**
14101     * @brief Add a new Hoversel object
14102     *
14103     * @param parent The parent object
14104     * @return The new object or NULL if it cannot be created
14105     */
14106    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14107    /**
14108     * @brief This sets the hoversel to expand horizontally.
14109     *
14110     * @param obj The hoversel object
14111     * @param horizontal If true, the hover will expand horizontally to the
14112     * right.
14113     *
14114     * @note The initial button will display horizontally regardless of this
14115     * setting.
14116     */
14117    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14118    /**
14119     * @brief This returns whether the hoversel is set to expand horizontally.
14120     *
14121     * @param obj The hoversel object
14122     * @return If true, the hover will expand horizontally to the right.
14123     *
14124     * @see elm_hoversel_horizontal_set()
14125     */
14126    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14127    /**
14128     * @brief Set the Hover parent
14129     *
14130     * @param obj The hoversel object
14131     * @param parent The parent to use
14132     *
14133     * Sets the hover parent object, the area that will be darkened when the
14134     * hoversel is clicked. Should probably be the window that the hoversel is
14135     * in. See @ref Hover objects for more information.
14136     */
14137    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14138    /**
14139     * @brief Get the Hover parent
14140     *
14141     * @param obj The hoversel object
14142     * @return The used parent
14143     *
14144     * Gets the hover parent object.
14145     *
14146     * @see elm_hoversel_hover_parent_set()
14147     */
14148    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14149    /**
14150     * @brief Set the hoversel button label
14151     *
14152     * @param obj The hoversel object
14153     * @param label The label text.
14154     *
14155     * This sets the label of the button that is always visible (before it is
14156     * clicked and expanded).
14157     *
14158     * @deprecated elm_object_text_set()
14159     */
14160    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14161    /**
14162     * @brief Get the hoversel button label
14163     *
14164     * @param obj The hoversel object
14165     * @return The label text.
14166     *
14167     * @deprecated elm_object_text_get()
14168     */
14169    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14170    /**
14171     * @brief Set the icon of the hoversel button
14172     *
14173     * @param obj The hoversel object
14174     * @param icon The icon object
14175     *
14176     * Sets the icon of the button that is always visible (before it is clicked
14177     * and expanded).  Once the icon object is set, a previously set one will be
14178     * deleted, if you want to keep that old content object, use the
14179     * elm_hoversel_icon_unset() function.
14180     *
14181     * @see elm_object_content_set() for the button widget
14182     */
14183    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14184    /**
14185     * @brief Get the icon of the hoversel button
14186     *
14187     * @param obj The hoversel object
14188     * @return The icon object
14189     *
14190     * Get the icon of the button that is always visible (before it is clicked
14191     * and expanded). Also see elm_object_content_get() for the button widget.
14192     *
14193     * @see elm_hoversel_icon_set()
14194     */
14195    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14196    /**
14197     * @brief Get and unparent the icon of the hoversel button
14198     *
14199     * @param obj The hoversel object
14200     * @return The icon object that was being used
14201     *
14202     * Unparent and return the icon of the button that is always visible
14203     * (before it is clicked and expanded).
14204     *
14205     * @see elm_hoversel_icon_set()
14206     * @see elm_object_content_unset() for the button widget
14207     */
14208    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14209    /**
14210     * @brief This triggers the hoversel popup from code, the same as if the user
14211     * had clicked the button.
14212     *
14213     * @param obj The hoversel object
14214     */
14215    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14216    /**
14217     * @brief This dismisses the hoversel popup as if the user had clicked
14218     * outside the hover.
14219     *
14220     * @param obj The hoversel object
14221     */
14222    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14223    /**
14224     * @brief Returns whether the hoversel is expanded.
14225     *
14226     * @param obj The hoversel object
14227     * @return  This will return EINA_TRUE if the hoversel is expanded or
14228     * EINA_FALSE if it is not expanded.
14229     */
14230    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14231    /**
14232     * @brief This will remove all the children items from the hoversel.
14233     *
14234     * @param obj The hoversel object
14235     *
14236     * @warning Should @b not be called while the hoversel is active; use
14237     * elm_hoversel_expanded_get() to check first.
14238     *
14239     * @see elm_hoversel_item_del_cb_set()
14240     * @see elm_hoversel_item_del()
14241     */
14242    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14243    /**
14244     * @brief Get the list of items within the given hoversel.
14245     *
14246     * @param obj The hoversel object
14247     * @return Returns a list of Elm_Hoversel_Item*
14248     *
14249     * @see elm_hoversel_item_add()
14250     */
14251    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14252    /**
14253     * @brief Add an item to the hoversel button
14254     *
14255     * @param obj The hoversel object
14256     * @param label The text label to use for the item (NULL if not desired)
14257     * @param icon_file An image file path on disk to use for the icon or standard
14258     * icon name (NULL if not desired)
14259     * @param icon_type The icon type if relevant
14260     * @param func Convenience function to call when this item is selected
14261     * @param data Data to pass to item-related functions
14262     * @return A handle to the item added.
14263     *
14264     * This adds an item to the hoversel to show when it is clicked. Note: if you
14265     * need to use an icon from an edje file then use
14266     * elm_hoversel_item_icon_set() right after the this function, and set
14267     * icon_file to NULL here.
14268     *
14269     * For more information on what @p icon_file and @p icon_type are see the
14270     * @ref Icon "icon documentation".
14271     */
14272    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);
14273    /**
14274     * @brief Delete an item from the hoversel
14275     *
14276     * @param item The item to delete
14277     *
14278     * This deletes the item from the hoversel (should not be called while the
14279     * hoversel is active; use elm_hoversel_expanded_get() to check first).
14280     *
14281     * @see elm_hoversel_item_add()
14282     * @see elm_hoversel_item_del_cb_set()
14283     */
14284    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14285    /**
14286     * @brief Set the function to be called when an item from the hoversel is
14287     * freed.
14288     *
14289     * @param item The item to set the callback on
14290     * @param func The function called
14291     *
14292     * That function will receive these parameters:
14293     * @li void *item_data
14294     * @li Evas_Object *the_item_object
14295     * @li Elm_Hoversel_Item *the_object_struct
14296     *
14297     * @see elm_hoversel_item_add()
14298     */
14299    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14300    /**
14301     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14302     * that will be passed to associated function callbacks.
14303     *
14304     * @param item The item to get the data from
14305     * @return The data pointer set with elm_hoversel_item_add()
14306     *
14307     * @see elm_hoversel_item_add()
14308     */
14309    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14310    /**
14311     * @brief This returns the label text of the given hoversel item.
14312     *
14313     * @param item The item to get the label
14314     * @return The label text of the hoversel item
14315     *
14316     * @see elm_hoversel_item_add()
14317     */
14318    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14319    /**
14320     * @brief This sets the icon for the given hoversel item.
14321     *
14322     * @param item The item to set the icon
14323     * @param icon_file An image file path on disk to use for the icon or standard
14324     * icon name
14325     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14326     * to NULL if the icon is not an edje file
14327     * @param icon_type The icon type
14328     *
14329     * The icon can be loaded from the standard set, from an image file, or from
14330     * an edje file.
14331     *
14332     * @see elm_hoversel_item_add()
14333     */
14334    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);
14335    /**
14336     * @brief Get the icon object of the hoversel item
14337     *
14338     * @param item The item to get the icon from
14339     * @param icon_file The image file path on disk used for the icon or standard
14340     * icon name
14341     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14342     * if the icon is not an edje file
14343     * @param icon_type The icon type
14344     *
14345     * @see elm_hoversel_item_icon_set()
14346     * @see elm_hoversel_item_add()
14347     */
14348    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);
14349    /**
14350     * @}
14351     */
14352
14353    /**
14354     * @defgroup Toolbar Toolbar
14355     * @ingroup Elementary
14356     *
14357     * @image html img/widget/toolbar/preview-00.png
14358     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14359     *
14360     * @image html img/toolbar.png
14361     * @image latex img/toolbar.eps width=\textwidth
14362     *
14363     * A toolbar is a widget that displays a list of items inside
14364     * a box. It can be scrollable, show a menu with items that don't fit
14365     * to toolbar size or even crop them.
14366     *
14367     * Only one item can be selected at a time.
14368     *
14369     * Items can have multiple states, or show menus when selected by the user.
14370     *
14371     * Smart callbacks one can listen to:
14372     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14373     * - "language,changed" - when the program language changes
14374     *
14375     * Available styles for it:
14376     * - @c "default"
14377     * - @c "transparent" - no background or shadow, just show the content
14378     *
14379     * List of examples:
14380     * @li @ref toolbar_example_01
14381     * @li @ref toolbar_example_02
14382     * @li @ref toolbar_example_03
14383     */
14384
14385    /**
14386     * @addtogroup Toolbar
14387     * @{
14388     */
14389
14390    /**
14391     * @enum _Elm_Toolbar_Shrink_Mode
14392     * @typedef Elm_Toolbar_Shrink_Mode
14393     *
14394     * Set toolbar's items display behavior, it can be scrollabel,
14395     * show a menu with exceeding items, or simply hide them.
14396     *
14397     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14398     * from elm config.
14399     *
14400     * Values <b> don't </b> work as bitmask, only one can be choosen.
14401     *
14402     * @see elm_toolbar_mode_shrink_set()
14403     * @see elm_toolbar_mode_shrink_get()
14404     *
14405     * @ingroup Toolbar
14406     */
14407    typedef enum _Elm_Toolbar_Shrink_Mode
14408      {
14409         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
14410         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
14411         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14412         ELM_TOOLBAR_SHRINK_MENU,   /**< Inserts a button to pop up a menu with exceeding items. */
14413         ELM_TOOLBAR_SHRINK_LAST    /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14414      } Elm_Toolbar_Shrink_Mode;
14415
14416    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(). */
14417
14418    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(). */
14419
14420    /**
14421     * Add a new toolbar widget to the given parent Elementary
14422     * (container) object.
14423     *
14424     * @param parent The parent object.
14425     * @return a new toolbar widget handle or @c NULL, on errors.
14426     *
14427     * This function inserts a new toolbar widget on the canvas.
14428     *
14429     * @ingroup Toolbar
14430     */
14431    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14432
14433    /**
14434     * Set the icon size, in pixels, to be used by toolbar items.
14435     *
14436     * @param obj The toolbar object
14437     * @param icon_size The icon size in pixels
14438     *
14439     * @note Default value is @c 32. It reads value from elm config.
14440     *
14441     * @see elm_toolbar_icon_size_get()
14442     *
14443     * @ingroup Toolbar
14444     */
14445    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14446
14447    /**
14448     * Get the icon size, in pixels, to be used by toolbar items.
14449     *
14450     * @param obj The toolbar object.
14451     * @return The icon size in pixels.
14452     *
14453     * @see elm_toolbar_icon_size_set() for details.
14454     *
14455     * @ingroup Toolbar
14456     */
14457    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14458
14459    /**
14460     * Sets icon lookup order, for toolbar items' icons.
14461     *
14462     * @param obj The toolbar object.
14463     * @param order The icon lookup order.
14464     *
14465     * Icons added before calling this function will not be affected.
14466     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14467     *
14468     * @see elm_toolbar_icon_order_lookup_get()
14469     *
14470     * @ingroup Toolbar
14471     */
14472    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14473
14474    /**
14475     * Gets the icon lookup order.
14476     *
14477     * @param obj The toolbar object.
14478     * @return The icon lookup order.
14479     *
14480     * @see elm_toolbar_icon_order_lookup_set() for details.
14481     *
14482     * @ingroup Toolbar
14483     */
14484    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14485
14486    /**
14487     * Set whether the toolbar should always have an item selected.
14488     *
14489     * @param obj The toolbar object.
14490     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14491     * disable it.
14492     *
14493     * This will cause the toolbar to always have an item selected, and clicking
14494     * the selected item will not cause a selected event to be emitted. Enabling this mode
14495     * will immediately select the first toolbar item.
14496     *
14497     * Always-selected is disabled by default.
14498     *
14499     * @see elm_toolbar_always_select_mode_get().
14500     *
14501     * @ingroup Toolbar
14502     */
14503    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14504
14505    /**
14506     * Get whether the toolbar should always have an item selected.
14507     *
14508     * @param obj The toolbar object.
14509     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14510     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14511     *
14512     * @see elm_toolbar_always_select_mode_set() for details.
14513     *
14514     * @ingroup Toolbar
14515     */
14516    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14517
14518    /**
14519     * Set whether the toolbar items' should be selected by the user or not.
14520     *
14521     * @param obj The toolbar object.
14522     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14523     * enable it.
14524     *
14525     * This will turn off the ability to select items entirely and they will
14526     * neither appear selected nor emit selected signals. The clicked
14527     * callback function will still be called.
14528     *
14529     * Selection is enabled by default.
14530     *
14531     * @see elm_toolbar_no_select_mode_get().
14532     *
14533     * @ingroup Toolbar
14534     */
14535    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14536
14537    /**
14538     * Set whether the toolbar items' should be selected by the user or not.
14539     *
14540     * @param obj The toolbar object.
14541     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14542     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14543     *
14544     * @see elm_toolbar_no_select_mode_set() for details.
14545     *
14546     * @ingroup Toolbar
14547     */
14548    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14549
14550    /**
14551     * Append item to the toolbar.
14552     *
14553     * @param obj The toolbar object.
14554     * @param icon A string with icon name or the absolute path of an image file.
14555     * @param label The label of the item.
14556     * @param func The function to call when the item is clicked.
14557     * @param data The data to associate with the item for related callbacks.
14558     * @return The created item or @c NULL upon failure.
14559     *
14560     * A new item will be created and appended to the toolbar, i.e., will
14561     * be set as @b last item.
14562     *
14563     * Items created with this method can be deleted with
14564     * elm_toolbar_item_del().
14565     *
14566     * Associated @p data can be properly freed when item is deleted if a
14567     * callback function is set with elm_toolbar_item_del_cb_set().
14568     *
14569     * If a function is passed as argument, it will be called everytime this item
14570     * is selected, i.e., the user clicks over an unselected item.
14571     * If such function isn't needed, just passing
14572     * @c NULL as @p func is enough. The same should be done for @p data.
14573     *
14574     * Toolbar will load icon image from fdo or current theme.
14575     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14576     * If an absolute path is provided it will load it direct from a file.
14577     *
14578     * @see elm_toolbar_item_icon_set()
14579     * @see elm_toolbar_item_del()
14580     * @see elm_toolbar_item_del_cb_set()
14581     *
14582     * @ingroup Toolbar
14583     */
14584    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);
14585
14586    /**
14587     * Prepend item to the toolbar.
14588     *
14589     * @param obj The toolbar object.
14590     * @param icon A string with icon name or the absolute path of an image file.
14591     * @param label The label of the item.
14592     * @param func The function to call when the item is clicked.
14593     * @param data The data to associate with the item for related callbacks.
14594     * @return The created item or @c NULL upon failure.
14595     *
14596     * A new item will be created and prepended to the toolbar, i.e., will
14597     * be set as @b first item.
14598     *
14599     * Items created with this method can be deleted with
14600     * elm_toolbar_item_del().
14601     *
14602     * Associated @p data can be properly freed when item is deleted if a
14603     * callback function is set with elm_toolbar_item_del_cb_set().
14604     *
14605     * If a function is passed as argument, it will be called everytime this item
14606     * is selected, i.e., the user clicks over an unselected item.
14607     * If such function isn't needed, just passing
14608     * @c NULL as @p func is enough. The same should be done for @p data.
14609     *
14610     * Toolbar will load icon image from fdo or current theme.
14611     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14612     * If an absolute path is provided it will load it direct from a file.
14613     *
14614     * @see elm_toolbar_item_icon_set()
14615     * @see elm_toolbar_item_del()
14616     * @see elm_toolbar_item_del_cb_set()
14617     *
14618     * @ingroup Toolbar
14619     */
14620    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);
14621
14622    /**
14623     * Insert a new item into the toolbar object before item @p before.
14624     *
14625     * @param obj The toolbar object.
14626     * @param before The toolbar item to insert before.
14627     * @param icon A string with icon name or the absolute path of an image file.
14628     * @param label The label of the item.
14629     * @param func The function to call when the item is clicked.
14630     * @param data The data to associate with the item for related callbacks.
14631     * @return The created item or @c NULL upon failure.
14632     *
14633     * A new item will be created and added to the toolbar. Its position in
14634     * this toolbar will be just before item @p before.
14635     *
14636     * Items created with this method can be deleted with
14637     * elm_toolbar_item_del().
14638     *
14639     * Associated @p data can be properly freed when item is deleted if a
14640     * callback function is set with elm_toolbar_item_del_cb_set().
14641     *
14642     * If a function is passed as argument, it will be called everytime this item
14643     * is selected, i.e., the user clicks over an unselected item.
14644     * If such function isn't needed, just passing
14645     * @c NULL as @p func is enough. The same should be done for @p data.
14646     *
14647     * Toolbar will load icon image from fdo or current theme.
14648     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14649     * If an absolute path is provided it will load it direct from a file.
14650     *
14651     * @see elm_toolbar_item_icon_set()
14652     * @see elm_toolbar_item_del()
14653     * @see elm_toolbar_item_del_cb_set()
14654     *
14655     * @ingroup Toolbar
14656     */
14657    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);
14658
14659    /**
14660     * Insert a new item into the toolbar object after item @p after.
14661     *
14662     * @param obj The toolbar object.
14663     * @param before The toolbar item to insert before.
14664     * @param icon A string with icon name or the absolute path of an image file.
14665     * @param label The label of the item.
14666     * @param func The function to call when the item is clicked.
14667     * @param data The data to associate with the item for related callbacks.
14668     * @return The created item or @c NULL upon failure.
14669     *
14670     * A new item will be created and added to the toolbar. Its position in
14671     * this toolbar will be just after item @p after.
14672     *
14673     * Items created with this method can be deleted with
14674     * elm_toolbar_item_del().
14675     *
14676     * Associated @p data can be properly freed when item is deleted if a
14677     * callback function is set with elm_toolbar_item_del_cb_set().
14678     *
14679     * If a function is passed as argument, it will be called everytime this item
14680     * is selected, i.e., the user clicks over an unselected item.
14681     * If such function isn't needed, just passing
14682     * @c NULL as @p func is enough. The same should be done for @p data.
14683     *
14684     * Toolbar will load icon image from fdo or current theme.
14685     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14686     * If an absolute path is provided it will load it direct from a file.
14687     *
14688     * @see elm_toolbar_item_icon_set()
14689     * @see elm_toolbar_item_del()
14690     * @see elm_toolbar_item_del_cb_set()
14691     *
14692     * @ingroup Toolbar
14693     */
14694    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);
14695
14696    /**
14697     * Get the first item in the given toolbar widget's list of
14698     * items.
14699     *
14700     * @param obj The toolbar object
14701     * @return The first item or @c NULL, if it has no items (and on
14702     * errors)
14703     *
14704     * @see elm_toolbar_item_append()
14705     * @see elm_toolbar_last_item_get()
14706     *
14707     * @ingroup Toolbar
14708     */
14709    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14710
14711    /**
14712     * Get the last item in the given toolbar widget's list of
14713     * items.
14714     *
14715     * @param obj The toolbar object
14716     * @return The last item or @c NULL, if it has no items (and on
14717     * errors)
14718     *
14719     * @see elm_toolbar_item_prepend()
14720     * @see elm_toolbar_first_item_get()
14721     *
14722     * @ingroup Toolbar
14723     */
14724    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14725
14726    /**
14727     * Get the item after @p item in toolbar.
14728     *
14729     * @param item The toolbar item.
14730     * @return The item after @p item, or @c NULL if none or on failure.
14731     *
14732     * @note If it is the last item, @c NULL will be returned.
14733     *
14734     * @see elm_toolbar_item_append()
14735     *
14736     * @ingroup Toolbar
14737     */
14738    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14739
14740    /**
14741     * Get the item before @p item in toolbar.
14742     *
14743     * @param item The toolbar item.
14744     * @return The item before @p item, or @c NULL if none or on failure.
14745     *
14746     * @note If it is the first item, @c NULL will be returned.
14747     *
14748     * @see elm_toolbar_item_prepend()
14749     *
14750     * @ingroup Toolbar
14751     */
14752    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14753
14754    /**
14755     * Get the toolbar object from an item.
14756     *
14757     * @param item The item.
14758     * @return The toolbar object.
14759     *
14760     * This returns the toolbar object itself that an item belongs to.
14761     *
14762     * @ingroup Toolbar
14763     */
14764    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14765
14766    /**
14767     * Set the priority of a toolbar item.
14768     *
14769     * @param item The toolbar item.
14770     * @param priority The item priority. The default is zero.
14771     *
14772     * This is used only when the toolbar shrink mode is set to
14773     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14774     * When space is less than required, items with low priority
14775     * will be removed from the toolbar and added to a dynamically-created menu,
14776     * while items with higher priority will remain on the toolbar,
14777     * with the same order they were added.
14778     *
14779     * @see elm_toolbar_item_priority_get()
14780     *
14781     * @ingroup Toolbar
14782     */
14783    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14784
14785    /**
14786     * Get the priority of a toolbar item.
14787     *
14788     * @param item The toolbar item.
14789     * @return The @p item priority, or @c 0 on failure.
14790     *
14791     * @see elm_toolbar_item_priority_set() for details.
14792     *
14793     * @ingroup Toolbar
14794     */
14795    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14796
14797    /**
14798     * Get the label of item.
14799     *
14800     * @param item The item of toolbar.
14801     * @return The label of item.
14802     *
14803     * The return value is a pointer to the label associated to @p item when
14804     * it was created, with function elm_toolbar_item_append() or similar,
14805     * or later,
14806     * with function elm_toolbar_item_label_set. If no label
14807     * was passed as argument, it will return @c NULL.
14808     *
14809     * @see elm_toolbar_item_label_set() for more details.
14810     * @see elm_toolbar_item_append()
14811     *
14812     * @ingroup Toolbar
14813     */
14814    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14815
14816    /**
14817     * Set the label of item.
14818     *
14819     * @param item The item of toolbar.
14820     * @param text The label of item.
14821     *
14822     * The label to be displayed by the item.
14823     * Label will be placed at icons bottom (if set).
14824     *
14825     * If a label was passed as argument on item creation, with function
14826     * elm_toolbar_item_append() or similar, it will be already
14827     * displayed by the item.
14828     *
14829     * @see elm_toolbar_item_label_get()
14830     * @see elm_toolbar_item_append()
14831     *
14832     * @ingroup Toolbar
14833     */
14834    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14835
14836    /**
14837     * Return the data associated with a given toolbar widget item.
14838     *
14839     * @param item The toolbar widget item handle.
14840     * @return The data associated with @p item.
14841     *
14842     * @see elm_toolbar_item_data_set()
14843     *
14844     * @ingroup Toolbar
14845     */
14846    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14847
14848    /**
14849     * Set the data associated with a given toolbar widget item.
14850     *
14851     * @param item The toolbar widget item handle.
14852     * @param data The new data pointer to set to @p item.
14853     *
14854     * This sets new item data on @p item.
14855     *
14856     * @warning The old data pointer won't be touched by this function, so
14857     * the user had better to free that old data himself/herself.
14858     *
14859     * @ingroup Toolbar
14860     */
14861    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14862
14863    /**
14864     * Returns a pointer to a toolbar item by its label.
14865     *
14866     * @param obj The toolbar object.
14867     * @param label The label of the item to find.
14868     *
14869     * @return The pointer to the toolbar item matching @p label or @c NULL
14870     * on failure.
14871     *
14872     * @ingroup Toolbar
14873     */
14874    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14875
14876    /*
14877     * Get whether the @p item is selected or not.
14878     *
14879     * @param item The toolbar item.
14880     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14881     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14882     *
14883     * @see elm_toolbar_selected_item_set() for details.
14884     * @see elm_toolbar_item_selected_get()
14885     *
14886     * @ingroup Toolbar
14887     */
14888    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14889
14890    /**
14891     * Set the selected state of an item.
14892     *
14893     * @param item The toolbar item
14894     * @param selected The selected state
14895     *
14896     * This sets the selected state of the given item @p it.
14897     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14898     *
14899     * If a new item is selected the previosly selected will be unselected.
14900     * Previoulsy selected item can be get with function
14901     * elm_toolbar_selected_item_get().
14902     *
14903     * Selected items will be highlighted.
14904     *
14905     * @see elm_toolbar_item_selected_get()
14906     * @see elm_toolbar_selected_item_get()
14907     *
14908     * @ingroup Toolbar
14909     */
14910    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14911
14912    /**
14913     * Get the selected item.
14914     *
14915     * @param obj The toolbar object.
14916     * @return The selected toolbar item.
14917     *
14918     * The selected item can be unselected with function
14919     * elm_toolbar_item_selected_set().
14920     *
14921     * The selected item always will be highlighted on toolbar.
14922     *
14923     * @see elm_toolbar_selected_items_get()
14924     *
14925     * @ingroup Toolbar
14926     */
14927    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14928
14929    /**
14930     * Set the icon associated with @p item.
14931     *
14932     * @param obj The parent of this item.
14933     * @param item The toolbar item.
14934     * @param icon A string with icon name or the absolute path of an image file.
14935     *
14936     * Toolbar will load icon image from fdo or current theme.
14937     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14938     * If an absolute path is provided it will load it direct from a file.
14939     *
14940     * @see elm_toolbar_icon_order_lookup_set()
14941     * @see elm_toolbar_icon_order_lookup_get()
14942     *
14943     * @ingroup Toolbar
14944     */
14945    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14946
14947    /**
14948     * Get the string used to set the icon of @p item.
14949     *
14950     * @param item The toolbar item.
14951     * @return The string associated with the icon object.
14952     *
14953     * @see elm_toolbar_item_icon_set() for details.
14954     *
14955     * @ingroup Toolbar
14956     */
14957    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14958
14959    /**
14960     * Get the object of @p item.
14961     *
14962     * @param item The toolbar item.
14963     * @return The object
14964     *
14965     * @ingroup Toolbar
14966     */
14967    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14968
14969    /**
14970     * Get the icon object of @p item.
14971     *
14972     * @param item The toolbar item.
14973     * @return The icon object
14974     *
14975     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14976     *
14977     * @ingroup Toolbar
14978     */
14979    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14980
14981    /**
14982     * Set the icon associated with @p item to an image in a binary buffer.
14983     *
14984     * @param item The toolbar item.
14985     * @param img The binary data that will be used as an image
14986     * @param size The size of binary data @p img
14987     * @param format Optional format of @p img to pass to the image loader
14988     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14989     *
14990     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14991     *
14992     * @note The icon image set by this function can be changed by
14993     * elm_toolbar_item_icon_set().
14994     * 
14995     * @ingroup Toolbar
14996     */
14997    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);
14998
14999    /**
15000     * Delete them item from the toolbar.
15001     *
15002     * @param item The item of toolbar to be deleted.
15003     *
15004     * @see elm_toolbar_item_append()
15005     * @see elm_toolbar_item_del_cb_set()
15006     *
15007     * @ingroup Toolbar
15008     */
15009    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15010
15011    /**
15012     * Set the function called when a toolbar item is freed.
15013     *
15014     * @param item The item to set the callback on.
15015     * @param func The function called.
15016     *
15017     * If there is a @p func, then it will be called prior item's memory release.
15018     * That will be called with the following arguments:
15019     * @li item's data;
15020     * @li item's Evas object;
15021     * @li item itself;
15022     *
15023     * This way, a data associated to a toolbar item could be properly freed.
15024     *
15025     * @ingroup Toolbar
15026     */
15027    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15028
15029    /**
15030     * Get a value whether toolbar item is disabled or not.
15031     *
15032     * @param item The item.
15033     * @return The disabled state.
15034     *
15035     * @see elm_toolbar_item_disabled_set() for more details.
15036     *
15037     * @ingroup Toolbar
15038     */
15039    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15040
15041    /**
15042     * Sets the disabled/enabled state of a toolbar item.
15043     *
15044     * @param item The item.
15045     * @param disabled The disabled state.
15046     *
15047     * A disabled item cannot be selected or unselected. It will also
15048     * change its appearance (generally greyed out). This sets the
15049     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15050     * enabled).
15051     *
15052     * @ingroup Toolbar
15053     */
15054    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15055
15056    /**
15057     * Set or unset item as a separator.
15058     *
15059     * @param item The toolbar item.
15060     * @param setting @c EINA_TRUE to set item @p item as separator or
15061     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15062     *
15063     * Items aren't set as separator by default.
15064     *
15065     * If set as separator it will display separator theme, so won't display
15066     * icons or label.
15067     *
15068     * @see elm_toolbar_item_separator_get()
15069     *
15070     * @ingroup Toolbar
15071     */
15072    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15073
15074    /**
15075     * Get a value whether item is a separator or not.
15076     *
15077     * @param item The toolbar item.
15078     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15079     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15080     *
15081     * @see elm_toolbar_item_separator_set() for details.
15082     *
15083     * @ingroup Toolbar
15084     */
15085    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15086
15087    /**
15088     * Set the shrink state of toolbar @p obj.
15089     *
15090     * @param obj The toolbar object.
15091     * @param shrink_mode Toolbar's items display behavior.
15092     *
15093     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15094     * but will enforce a minimun size so all the items will fit, won't scroll
15095     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15096     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15097     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15098     *
15099     * @ingroup Toolbar
15100     */
15101    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15102
15103    /**
15104     * Get the shrink mode of toolbar @p obj.
15105     *
15106     * @param obj The toolbar object.
15107     * @return Toolbar's items display behavior.
15108     *
15109     * @see elm_toolbar_mode_shrink_set() for details.
15110     *
15111     * @ingroup Toolbar
15112     */
15113    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15114
15115    /**
15116     * Enable/disable homogenous mode.
15117     *
15118     * @param obj The toolbar object
15119     * @param homogeneous Assume the items within the toolbar are of the
15120     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15121     *
15122     * This will enable the homogeneous mode where items are of the same size.
15123     * @see elm_toolbar_homogeneous_get()
15124     *
15125     * @ingroup Toolbar
15126     */
15127    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15128
15129    /**
15130     * Get whether the homogenous mode is enabled.
15131     *
15132     * @param obj The toolbar object.
15133     * @return Assume the items within the toolbar are of the same height
15134     * and width (EINA_TRUE = on, EINA_FALSE = off).
15135     *
15136     * @see elm_toolbar_homogeneous_set()
15137     *
15138     * @ingroup Toolbar
15139     */
15140    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15141
15142    /**
15143     * Enable/disable homogenous mode.
15144     *
15145     * @param obj The toolbar object
15146     * @param homogeneous Assume the items within the toolbar are of the
15147     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15148     *
15149     * This will enable the homogeneous mode where items are of the same size.
15150     * @see elm_toolbar_homogeneous_get()
15151     *
15152     * @deprecated use elm_toolbar_homogeneous_set() instead.
15153     *
15154     * @ingroup Toolbar
15155     */
15156    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15157
15158    /**
15159     * Get whether the homogenous mode is enabled.
15160     *
15161     * @param obj The toolbar object.
15162     * @return Assume the items within the toolbar are of the same height
15163     * and width (EINA_TRUE = on, EINA_FALSE = off).
15164     *
15165     * @see elm_toolbar_homogeneous_set()
15166     * @deprecated use elm_toolbar_homogeneous_get() instead.
15167     *
15168     * @ingroup Toolbar
15169     */
15170    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15171
15172    /**
15173     * Set the parent object of the toolbar items' menus.
15174     *
15175     * @param obj The toolbar object.
15176     * @param parent The parent of the menu objects.
15177     *
15178     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15179     *
15180     * For more details about setting the parent for toolbar menus, see
15181     * elm_menu_parent_set().
15182     *
15183     * @see elm_menu_parent_set() for details.
15184     * @see elm_toolbar_item_menu_set() for details.
15185     *
15186     * @ingroup Toolbar
15187     */
15188    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15189
15190    /**
15191     * Get the parent object of the toolbar items' menus.
15192     *
15193     * @param obj The toolbar object.
15194     * @return The parent of the menu objects.
15195     *
15196     * @see elm_toolbar_menu_parent_set() for details.
15197     *
15198     * @ingroup Toolbar
15199     */
15200    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15201
15202    /**
15203     * Set the alignment of the items.
15204     *
15205     * @param obj The toolbar object.
15206     * @param align The new alignment, a float between <tt> 0.0 </tt>
15207     * and <tt> 1.0 </tt>.
15208     *
15209     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15210     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15211     * items.
15212     *
15213     * Centered items by default.
15214     *
15215     * @see elm_toolbar_align_get()
15216     *
15217     * @ingroup Toolbar
15218     */
15219    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15220
15221    /**
15222     * Get the alignment of the items.
15223     *
15224     * @param obj The toolbar object.
15225     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15226     * <tt> 1.0 </tt>.
15227     *
15228     * @see elm_toolbar_align_set() for details.
15229     *
15230     * @ingroup Toolbar
15231     */
15232    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15233
15234    /**
15235     * Set whether the toolbar item opens a menu.
15236     *
15237     * @param item The toolbar item.
15238     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15239     *
15240     * A toolbar item can be set to be a menu, using this function.
15241     *
15242     * Once it is set to be a menu, it can be manipulated through the
15243     * menu-like function elm_toolbar_menu_parent_set() and the other
15244     * elm_menu functions, using the Evas_Object @c menu returned by
15245     * elm_toolbar_item_menu_get().
15246     *
15247     * So, items to be displayed in this item's menu should be added with
15248     * elm_menu_item_add().
15249     *
15250     * The following code exemplifies the most basic usage:
15251     * @code
15252     * tb = elm_toolbar_add(win)
15253     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15254     * elm_toolbar_item_menu_set(item, EINA_TRUE);
15255     * elm_toolbar_menu_parent_set(tb, win);
15256     * menu = elm_toolbar_item_menu_get(item);
15257     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15258     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15259     * NULL);
15260     * @endcode
15261     *
15262     * @see elm_toolbar_item_menu_get()
15263     *
15264     * @ingroup Toolbar
15265     */
15266    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15267
15268    /**
15269     * Get toolbar item's menu.
15270     *
15271     * @param item The toolbar item.
15272     * @return Item's menu object or @c NULL on failure.
15273     *
15274     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15275     * this function will set it.
15276     *
15277     * @see elm_toolbar_item_menu_set() for details.
15278     *
15279     * @ingroup Toolbar
15280     */
15281    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15282
15283    /**
15284     * Add a new state to @p item.
15285     *
15286     * @param item The item.
15287     * @param icon A string with icon name or the absolute path of an image file.
15288     * @param label The label of the new state.
15289     * @param func The function to call when the item is clicked when this
15290     * state is selected.
15291     * @param data The data to associate with the state.
15292     * @return The toolbar item state, or @c NULL upon failure.
15293     *
15294     * Toolbar will load icon image from fdo or current theme.
15295     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15296     * If an absolute path is provided it will load it direct from a file.
15297     *
15298     * States created with this function can be removed with
15299     * elm_toolbar_item_state_del().
15300     *
15301     * @see elm_toolbar_item_state_del()
15302     * @see elm_toolbar_item_state_sel()
15303     * @see elm_toolbar_item_state_get()
15304     *
15305     * @ingroup Toolbar
15306     */
15307    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);
15308
15309    /**
15310     * Delete a previoulsy added state to @p item.
15311     *
15312     * @param item The toolbar item.
15313     * @param state The state to be deleted.
15314     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15315     *
15316     * @see elm_toolbar_item_state_add()
15317     */
15318    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15319
15320    /**
15321     * Set @p state as the current state of @p it.
15322     *
15323     * @param it The item.
15324     * @param state The state to use.
15325     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15326     *
15327     * If @p state is @c NULL, it won't select any state and the default item's
15328     * icon and label will be used. It's the same behaviour than
15329     * elm_toolbar_item_state_unser().
15330     *
15331     * @see elm_toolbar_item_state_unset()
15332     *
15333     * @ingroup Toolbar
15334     */
15335    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15336
15337    /**
15338     * Unset the state of @p it.
15339     *
15340     * @param it The item.
15341     *
15342     * The default icon and label from this item will be displayed.
15343     *
15344     * @see elm_toolbar_item_state_set() for more details.
15345     *
15346     * @ingroup Toolbar
15347     */
15348    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15349
15350    /**
15351     * Get the current state of @p it.
15352     *
15353     * @param item The item.
15354     * @return The selected state or @c NULL if none is selected or on failure.
15355     *
15356     * @see elm_toolbar_item_state_set() for details.
15357     * @see elm_toolbar_item_state_unset()
15358     * @see elm_toolbar_item_state_add()
15359     *
15360     * @ingroup Toolbar
15361     */
15362    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15363
15364    /**
15365     * Get the state after selected state in toolbar's @p item.
15366     *
15367     * @param it The toolbar item to change state.
15368     * @return The state after current state, or @c NULL on failure.
15369     *
15370     * If last state is selected, this function will return first state.
15371     *
15372     * @see elm_toolbar_item_state_set()
15373     * @see elm_toolbar_item_state_add()
15374     *
15375     * @ingroup Toolbar
15376     */
15377    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15378
15379    /**
15380     * Get the state before selected state in toolbar's @p item.
15381     *
15382     * @param it The toolbar item to change state.
15383     * @return The state before current state, or @c NULL on failure.
15384     *
15385     * If first state is selected, this function will return last state.
15386     *
15387     * @see elm_toolbar_item_state_set()
15388     * @see elm_toolbar_item_state_add()
15389     *
15390     * @ingroup Toolbar
15391     */
15392    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15393
15394    /**
15395     * Set the text to be shown in a given toolbar item's tooltips.
15396     *
15397     * @param item Target item.
15398     * @param text The text to set in the content.
15399     *
15400     * Setup the text as tooltip to object. The item can have only one tooltip,
15401     * so any previous tooltip data - set with this function or
15402     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15403     *
15404     * @see elm_object_tooltip_text_set() for more details.
15405     *
15406     * @ingroup Toolbar
15407     */
15408    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15409
15410    /**
15411     * Set the content to be shown in the tooltip item.
15412     *
15413     * Setup the tooltip to item. The item can have only one tooltip,
15414     * so any previous tooltip data is removed. @p func(with @p data) will
15415     * be called every time that need show the tooltip and it should
15416     * return a valid Evas_Object. This object is then managed fully by
15417     * tooltip system and is deleted when the tooltip is gone.
15418     *
15419     * @param item the toolbar item being attached a tooltip.
15420     * @param func the function used to create the tooltip contents.
15421     * @param data what to provide to @a func as callback data/context.
15422     * @param del_cb called when data is not needed anymore, either when
15423     *        another callback replaces @a func, the tooltip is unset with
15424     *        elm_toolbar_item_tooltip_unset() or the owner @a item
15425     *        dies. This callback receives as the first parameter the
15426     *        given @a data, and @c event_info is the item.
15427     *
15428     * @see elm_object_tooltip_content_cb_set() for more details.
15429     *
15430     * @ingroup Toolbar
15431     */
15432    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);
15433
15434    /**
15435     * Unset tooltip from item.
15436     *
15437     * @param item toolbar item to remove previously set tooltip.
15438     *
15439     * Remove tooltip from item. The callback provided as del_cb to
15440     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15441     * it is not used anymore.
15442     *
15443     * @see elm_object_tooltip_unset() for more details.
15444     * @see elm_toolbar_item_tooltip_content_cb_set()
15445     *
15446     * @ingroup Toolbar
15447     */
15448    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15449
15450    /**
15451     * Sets a different style for this item tooltip.
15452     *
15453     * @note before you set a style you should define a tooltip with
15454     *       elm_toolbar_item_tooltip_content_cb_set() or
15455     *       elm_toolbar_item_tooltip_text_set()
15456     *
15457     * @param item toolbar item with tooltip already set.
15458     * @param style the theme style to use (default, transparent, ...)
15459     *
15460     * @see elm_object_tooltip_style_set() for more details.
15461     *
15462     * @ingroup Toolbar
15463     */
15464    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15465
15466    /**
15467     * Get the style for this item tooltip.
15468     *
15469     * @param item toolbar item with tooltip already set.
15470     * @return style the theme style in use, defaults to "default". If the
15471     *         object does not have a tooltip set, then NULL is returned.
15472     *
15473     * @see elm_object_tooltip_style_get() for more details.
15474     * @see elm_toolbar_item_tooltip_style_set()
15475     *
15476     * @ingroup Toolbar
15477     */
15478    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15479
15480    /**
15481     * Set the type of mouse pointer/cursor decoration to be shown,
15482     * when the mouse pointer is over the given toolbar widget item
15483     *
15484     * @param item toolbar item to customize cursor on
15485     * @param cursor the cursor type's name
15486     *
15487     * This function works analogously as elm_object_cursor_set(), but
15488     * here the cursor's changing area is restricted to the item's
15489     * area, and not the whole widget's. Note that that item cursors
15490     * have precedence over widget cursors, so that a mouse over an
15491     * item with custom cursor set will always show @b that cursor.
15492     *
15493     * If this function is called twice for an object, a previously set
15494     * cursor will be unset on the second call.
15495     *
15496     * @see elm_object_cursor_set()
15497     * @see elm_toolbar_item_cursor_get()
15498     * @see elm_toolbar_item_cursor_unset()
15499     *
15500     * @ingroup Toolbar
15501     */
15502    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15503
15504    /*
15505     * Get the type of mouse pointer/cursor decoration set to be shown,
15506     * when the mouse pointer is over the given toolbar widget item
15507     *
15508     * @param item toolbar item with custom cursor set
15509     * @return the cursor type's name or @c NULL, if no custom cursors
15510     * were set to @p item (and on errors)
15511     *
15512     * @see elm_object_cursor_get()
15513     * @see elm_toolbar_item_cursor_set()
15514     * @see elm_toolbar_item_cursor_unset()
15515     *
15516     * @ingroup Toolbar
15517     */
15518    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15519
15520    /**
15521     * Unset any custom mouse pointer/cursor decoration set to be
15522     * shown, when the mouse pointer is over the given toolbar widget
15523     * item, thus making it show the @b default cursor again.
15524     *
15525     * @param item a toolbar item
15526     *
15527     * Use this call to undo any custom settings on this item's cursor
15528     * decoration, bringing it back to defaults (no custom style set).
15529     *
15530     * @see elm_object_cursor_unset()
15531     * @see elm_toolbar_item_cursor_set()
15532     *
15533     * @ingroup Toolbar
15534     */
15535    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15536
15537    /**
15538     * Set a different @b style for a given custom cursor set for a
15539     * toolbar item.
15540     *
15541     * @param item toolbar item with custom cursor set
15542     * @param style the <b>theme style</b> to use (e.g. @c "default",
15543     * @c "transparent", etc)
15544     *
15545     * This function only makes sense when one is using custom mouse
15546     * cursor decorations <b>defined in a theme file</b>, which can have,
15547     * given a cursor name/type, <b>alternate styles</b> on it. It
15548     * works analogously as elm_object_cursor_style_set(), but here
15549     * applyed only to toolbar item objects.
15550     *
15551     * @warning Before you set a cursor style you should have definen a
15552     *       custom cursor previously on the item, with
15553     *       elm_toolbar_item_cursor_set()
15554     *
15555     * @see elm_toolbar_item_cursor_engine_only_set()
15556     * @see elm_toolbar_item_cursor_style_get()
15557     *
15558     * @ingroup Toolbar
15559     */
15560    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15561
15562    /**
15563     * Get the current @b style set for a given toolbar item's custom
15564     * cursor
15565     *
15566     * @param item toolbar item with custom cursor set.
15567     * @return style the cursor style in use. If the object does not
15568     *         have a cursor set, then @c NULL is returned.
15569     *
15570     * @see elm_toolbar_item_cursor_style_set() for more details
15571     *
15572     * @ingroup Toolbar
15573     */
15574    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15575
15576    /**
15577     * Set if the (custom)cursor for a given toolbar item should be
15578     * searched in its theme, also, or should only rely on the
15579     * rendering engine.
15580     *
15581     * @param item item with custom (custom) cursor already set on
15582     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15583     * only on those provided by the rendering engine, @c EINA_FALSE to
15584     * have them searched on the widget's theme, as well.
15585     *
15586     * @note This call is of use only if you've set a custom cursor
15587     * for toolbar items, with elm_toolbar_item_cursor_set().
15588     *
15589     * @note By default, cursors will only be looked for between those
15590     * provided by the rendering engine.
15591     *
15592     * @ingroup Toolbar
15593     */
15594    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15595
15596    /**
15597     * Get if the (custom) cursor for a given toolbar item is being
15598     * searched in its theme, also, or is only relying on the rendering
15599     * engine.
15600     *
15601     * @param item a toolbar item
15602     * @return @c EINA_TRUE, if cursors are being looked for only on
15603     * those provided by the rendering engine, @c EINA_FALSE if they
15604     * are being searched on the widget's theme, as well.
15605     *
15606     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15607     *
15608     * @ingroup Toolbar
15609     */
15610    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15611
15612    /**
15613     * Change a toolbar's orientation
15614     * @param obj The toolbar object
15615     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15616     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15617     * @ingroup Toolbar
15618     */
15619    EINA_DEPRECATED EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15620
15621    /**
15622     * Change a toolbar's orientation
15623     * @param obj The toolbar object
15624     * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15625     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15626     * @ingroup Toolbar
15627     */
15628    EAPI void             elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15629
15630    /**
15631     * Get a toolbar's orientation
15632     * @param obj The toolbar object
15633     * @return If @c EINA_TRUE, the toolbar is vertical
15634     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15635     * @ingroup Toolbar
15636     */
15637    EINA_DEPRECATED EAPI Eina_Bool        elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15638
15639    /**
15640     * Get a toolbar's orientation
15641     * @param obj The toolbar object
15642     * @return If @c EINA_TRUE, the toolbar is horizontal
15643     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15644     * @ingroup Toolbar
15645     */
15646    EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15647    /**
15648     * @}
15649     */
15650
15651    /**
15652     * @defgroup Tooltips Tooltips
15653     *
15654     * The Tooltip is an (internal, for now) smart object used to show a
15655     * content in a frame on mouse hover of objects(or widgets), with
15656     * tips/information about them.
15657     *
15658     * @{
15659     */
15660
15661    EAPI double       elm_tooltip_delay_get(void);
15662    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
15663    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15664    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15665    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15666    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15667 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15668    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);
15669    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15670    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15671    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15672    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15673    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15674
15675    /**
15676     * @}
15677     */
15678
15679    /**
15680     * @defgroup Cursors Cursors
15681     *
15682     * The Elementary cursor is an internal smart object used to
15683     * customize the mouse cursor displayed over objects (or
15684     * widgets). In the most common scenario, the cursor decoration
15685     * comes from the graphical @b engine Elementary is running
15686     * on. Those engines may provide different decorations for cursors,
15687     * and Elementary provides functions to choose them (think of X11
15688     * cursors, as an example).
15689     *
15690     * There's also the possibility of, besides using engine provided
15691     * cursors, also use ones coming from Edje theming files. Both
15692     * globally and per widget, Elementary makes it possible for one to
15693     * make the cursors lookup to be held on engines only or on
15694     * Elementary's theme file, too.
15695     *
15696     * @{
15697     */
15698
15699    /**
15700     * Set the cursor to be shown when mouse is over the object
15701     *
15702     * Set the cursor that will be displayed when mouse is over the
15703     * object. The object can have only one cursor set to it, so if
15704     * this function is called twice for an object, the previous set
15705     * will be unset.
15706     * If using X cursors, a definition of all the valid cursor names
15707     * is listed on Elementary_Cursors.h. If an invalid name is set
15708     * the default cursor will be used.
15709     *
15710     * @param obj the object being set a cursor.
15711     * @param cursor the cursor name to be used.
15712     *
15713     * @ingroup Cursors
15714     */
15715    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15716
15717    /**
15718     * Get the cursor to be shown when mouse is over the object
15719     *
15720     * @param obj an object with cursor already set.
15721     * @return the cursor name.
15722     *
15723     * @ingroup Cursors
15724     */
15725    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15726
15727    /**
15728     * Unset cursor for object
15729     *
15730     * Unset cursor for object, and set the cursor to default if the mouse
15731     * was over this object.
15732     *
15733     * @param obj Target object
15734     * @see elm_object_cursor_set()
15735     *
15736     * @ingroup Cursors
15737     */
15738    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15739
15740    /**
15741     * Sets a different style for this object cursor.
15742     *
15743     * @note before you set a style you should define a cursor with
15744     *       elm_object_cursor_set()
15745     *
15746     * @param obj an object with cursor already set.
15747     * @param style the theme style to use (default, transparent, ...)
15748     *
15749     * @ingroup Cursors
15750     */
15751    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15752
15753    /**
15754     * Get the style for this object cursor.
15755     *
15756     * @param obj an object with cursor already set.
15757     * @return style the theme style in use, defaults to "default". If the
15758     *         object does not have a cursor set, then NULL is returned.
15759     *
15760     * @ingroup Cursors
15761     */
15762    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15763
15764    /**
15765     * Set if the cursor set should be searched on the theme or should use
15766     * the provided by the engine, only.
15767     *
15768     * @note before you set if should look on theme you should define a cursor
15769     * with elm_object_cursor_set(). By default it will only look for cursors
15770     * provided by the engine.
15771     *
15772     * @param obj an object with cursor already set.
15773     * @param engine_only boolean to define it cursors should be looked only
15774     * between the provided by the engine or searched on widget's theme as well.
15775     *
15776     * @ingroup Cursors
15777     */
15778    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15779
15780    /**
15781     * Get the cursor engine only usage for this object cursor.
15782     *
15783     * @param obj an object with cursor already set.
15784     * @return engine_only boolean to define it cursors should be
15785     * looked only between the provided by the engine or searched on
15786     * widget's theme as well. If the object does not have a cursor
15787     * set, then EINA_FALSE is returned.
15788     *
15789     * @ingroup Cursors
15790     */
15791    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15792
15793    /**
15794     * Get the configured cursor engine only usage
15795     *
15796     * This gets the globally configured exclusive usage of engine cursors.
15797     *
15798     * @return 1 if only engine cursors should be used
15799     * @ingroup Cursors
15800     */
15801    EAPI int          elm_cursor_engine_only_get(void);
15802
15803    /**
15804     * Set the configured cursor engine only usage
15805     *
15806     * This sets the globally configured exclusive usage of engine cursors.
15807     * It won't affect cursors set before changing this value.
15808     *
15809     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15810     * look for them on theme before.
15811     * @return EINA_TRUE if value is valid and setted (0 or 1)
15812     * @ingroup Cursors
15813     */
15814    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
15815
15816    /**
15817     * @}
15818     */
15819
15820    /**
15821     * @defgroup Menu Menu
15822     *
15823     * @image html img/widget/menu/preview-00.png
15824     * @image latex img/widget/menu/preview-00.eps
15825     *
15826     * A menu is a list of items displayed above its parent. When the menu is
15827     * showing its parent is darkened. Each item can have a sub-menu. The menu
15828     * object can be used to display a menu on a right click event, in a toolbar,
15829     * anywhere.
15830     *
15831     * Signals that you can add callbacks for are:
15832     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15833     *             event_info is NULL.
15834     *
15835     * @see @ref tutorial_menu
15836     * @{
15837     */
15838    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15839    /**
15840     * @brief Add a new menu to the parent
15841     *
15842     * @param parent The parent object.
15843     * @return The new object or NULL if it cannot be created.
15844     */
15845    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15846    /**
15847     * @brief Set the parent for the given menu widget
15848     *
15849     * @param obj The menu object.
15850     * @param parent The new parent.
15851     */
15852    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15853    /**
15854     * @brief Get the parent for the given menu widget
15855     *
15856     * @param obj The menu object.
15857     * @return The parent.
15858     *
15859     * @see elm_menu_parent_set()
15860     */
15861    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15862    /**
15863     * @brief Move the menu to a new position
15864     *
15865     * @param obj The menu object.
15866     * @param x The new position.
15867     * @param y The new position.
15868     *
15869     * Sets the top-left position of the menu to (@p x,@p y).
15870     *
15871     * @note @p x and @p y coordinates are relative to parent.
15872     */
15873    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15874    /**
15875     * @brief Close a opened menu
15876     *
15877     * @param obj the menu object
15878     * @return void
15879     *
15880     * Hides the menu and all it's sub-menus.
15881     */
15882    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15883    /**
15884     * @brief Returns a list of @p item's items.
15885     *
15886     * @param obj The menu object
15887     * @return An Eina_List* of @p item's items
15888     */
15889    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15890    /**
15891     * @brief Get the Evas_Object of an Elm_Menu_Item
15892     *
15893     * @param item The menu item object.
15894     * @return The edje object containing the swallowed content
15895     *
15896     * @warning Don't manipulate this object!
15897     */
15898    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15899    /**
15900     * @brief Add an item at the end of the given menu widget
15901     *
15902     * @param obj The menu object.
15903     * @param parent The parent menu item (optional)
15904     * @param icon A icon display on the item. The icon will be destryed by the menu.
15905     * @param label The label of the item.
15906     * @param func Function called when the user select the item.
15907     * @param data Data sent by the callback.
15908     * @return Returns the new item.
15909     */
15910    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);
15911    /**
15912     * @brief Add an object swallowed in an item at the end of the given menu
15913     * widget
15914     *
15915     * @param obj The menu object.
15916     * @param parent The parent menu item (optional)
15917     * @param subobj The object to swallow
15918     * @param func Function called when the user select the item.
15919     * @param data Data sent by the callback.
15920     * @return Returns the new item.
15921     *
15922     * Add an evas object as an item to the menu.
15923     */
15924    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);
15925    /**
15926     * @brief Set the label of a menu item
15927     *
15928     * @param item The menu item object.
15929     * @param label The label to set for @p item
15930     *
15931     * @warning Don't use this funcion on items created with
15932     * elm_menu_item_add_object() or elm_menu_item_separator_add().
15933     */
15934    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15935    /**
15936     * @brief Get the label of a menu item
15937     *
15938     * @param item The menu item object.
15939     * @return The label of @p item
15940     */
15941    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15942    /**
15943     * @brief Set the icon of a menu item to the standard icon with name @p icon
15944     *
15945     * @param item The menu item object.
15946     * @param icon The icon object to set for the content of @p item
15947     *
15948     * Once this icon is set, any previously set icon will be deleted.
15949     */
15950    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15951    /**
15952     * @brief Get the string representation from the icon of a menu item
15953     *
15954     * @param item The menu item object.
15955     * @return The string representation of @p item's icon or NULL
15956     *
15957     * @see elm_menu_item_object_icon_name_set()
15958     */
15959    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15960    /**
15961     * @brief Set the content object of a menu item
15962     *
15963     * @param item The menu item object
15964     * @param The content object or NULL
15965     * @return EINA_TRUE on success, else EINA_FALSE
15966     *
15967     * Use this function to change the object swallowed by a menu item, deleting
15968     * any previously swallowed object.
15969     */
15970    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15971    /**
15972     * @brief Get the content object of a menu item
15973     *
15974     * @param item The menu item object
15975     * @return The content object or NULL
15976     * @note If @p item was added with elm_menu_item_add_object, this
15977     * function will return the object passed, else it will return the
15978     * icon object.
15979     *
15980     * @see elm_menu_item_object_content_set()
15981     */
15982    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15983    /**
15984     * @brief Set the selected state of @p item.
15985     *
15986     * @param item The menu item object.
15987     * @param selected The selected/unselected state of the item
15988     */
15989    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15990    /**
15991     * @brief Get the selected state of @p item.
15992     *
15993     * @param item The menu item object.
15994     * @return The selected/unselected state of the item
15995     *
15996     * @see elm_menu_item_selected_set()
15997     */
15998    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15999    /**
16000     * @brief Set the disabled state of @p item.
16001     *
16002     * @param item The menu item object.
16003     * @param disabled The enabled/disabled state of the item
16004     */
16005    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16006    /**
16007     * @brief Get the disabled state of @p item.
16008     *
16009     * @param item The menu item object.
16010     * @return The enabled/disabled state of the item
16011     *
16012     * @see elm_menu_item_disabled_set()
16013     */
16014    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16015    /**
16016     * @brief Add a separator item to menu @p obj under @p parent.
16017     *
16018     * @param obj The menu object
16019     * @param parent The item to add the separator under
16020     * @return The created item or NULL on failure
16021     *
16022     * This is item is a @ref Separator.
16023     */
16024    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
16025    /**
16026     * @brief Returns whether @p item is a separator.
16027     *
16028     * @param item The item to check
16029     * @return If true, @p item is a separator
16030     *
16031     * @see elm_menu_item_separator_add()
16032     */
16033    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16034    /**
16035     * @brief Deletes an item from the menu.
16036     *
16037     * @param item The item to delete.
16038     *
16039     * @see elm_menu_item_add()
16040     */
16041    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16042    /**
16043     * @brief Set the function called when a menu item is deleted.
16044     *
16045     * @param item The item to set the callback on
16046     * @param func The function called
16047     *
16048     * @see elm_menu_item_add()
16049     * @see elm_menu_item_del()
16050     */
16051    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16052    /**
16053     * @brief Returns the data associated with menu item @p item.
16054     *
16055     * @param item The item
16056     * @return The data associated with @p item or NULL if none was set.
16057     *
16058     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16059     */
16060    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16061    /**
16062     * @brief Sets the data to be associated with menu item @p item.
16063     *
16064     * @param item The item
16065     * @param data The data to be associated with @p item
16066     */
16067    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16068    /**
16069     * @brief Returns a list of @p item's subitems.
16070     *
16071     * @param item The item
16072     * @return An Eina_List* of @p item's subitems
16073     *
16074     * @see elm_menu_add()
16075     */
16076    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16077    /**
16078     * @brief Get the position of a menu item
16079     *
16080     * @param item The menu item
16081     * @return The item's index
16082     *
16083     * This function returns the index position of a menu item in a menu.
16084     * For a sub-menu, this number is relative to the first item in the sub-menu.
16085     *
16086     * @note Index values begin with 0
16087     */
16088    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16089    /**
16090     * @brief @brief Return a menu item's owner menu
16091     *
16092     * @param item The menu item
16093     * @return The menu object owning @p item, or NULL on failure
16094     *
16095     * Use this function to get the menu object owning an item.
16096     */
16097    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16098    /**
16099     * @brief Get the selected item in the menu
16100     *
16101     * @param obj The menu object
16102     * @return The selected item, or NULL if none
16103     *
16104     * @see elm_menu_item_selected_get()
16105     * @see elm_menu_item_selected_set()
16106     */
16107    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16108    /**
16109     * @brief Get the last item in the menu
16110     *
16111     * @param obj The menu object
16112     * @return The last item, or NULL if none
16113     */
16114    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16115    /**
16116     * @brief Get the first item in the menu
16117     *
16118     * @param obj The menu object
16119     * @return The first item, or NULL if none
16120     */
16121    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16122    /**
16123     * @brief Get the next item in the menu.
16124     *
16125     * @param item The menu item object.
16126     * @return The item after it, or NULL if none
16127     */
16128    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16129    /**
16130     * @brief Get the previous item in the menu.
16131     *
16132     * @param item The menu item object.
16133     * @return The item before it, or NULL if none
16134     */
16135    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16136    /**
16137     * @}
16138     */
16139
16140    /**
16141     * @defgroup List List
16142     * @ingroup Elementary
16143     *
16144     * @image html img/widget/list/preview-00.png
16145     * @image latex img/widget/list/preview-00.eps width=\textwidth
16146     *
16147     * @image html img/list.png
16148     * @image latex img/list.eps width=\textwidth
16149     *
16150     * A list widget is a container whose children are displayed vertically or
16151     * horizontally, in order, and can be selected.
16152     * The list can accept only one or multiple items selection. Also has many
16153     * modes of items displaying.
16154     *
16155     * A list is a very simple type of list widget.  For more robust
16156     * lists, @ref Genlist should probably be used.
16157     *
16158     * Smart callbacks one can listen to:
16159     * - @c "activated" - The user has double-clicked or pressed
16160     *   (enter|return|spacebar) on an item. The @c event_info parameter
16161     *   is the item that was activated.
16162     * - @c "clicked,double" - The user has double-clicked an item.
16163     *   The @c event_info parameter is the item that was double-clicked.
16164     * - "selected" - when the user selected an item
16165     * - "unselected" - when the user unselected an item
16166     * - "longpressed" - an item in the list is long-pressed
16167     * - "edge,top" - the list is scrolled until the top edge
16168     * - "edge,bottom" - the list is scrolled until the bottom edge
16169     * - "edge,left" - the list is scrolled until the left edge
16170     * - "edge,right" - the list is scrolled until the right edge
16171     * - "language,changed" - the program's language changed
16172     *
16173     * Available styles for it:
16174     * - @c "default"
16175     *
16176     * List of examples:
16177     * @li @ref list_example_01
16178     * @li @ref list_example_02
16179     * @li @ref list_example_03
16180     */
16181
16182    /**
16183     * @addtogroup List
16184     * @{
16185     */
16186
16187    /**
16188     * @enum _Elm_List_Mode
16189     * @typedef Elm_List_Mode
16190     *
16191     * Set list's resize behavior, transverse axis scroll and
16192     * items cropping. See each mode's description for more details.
16193     *
16194     * @note Default value is #ELM_LIST_SCROLL.
16195     *
16196     * Values <b> don't </b> work as bitmask, only one can be choosen.
16197     *
16198     * @see elm_list_mode_set()
16199     * @see elm_list_mode_get()
16200     *
16201     * @ingroup List
16202     */
16203    typedef enum _Elm_List_Mode
16204      {
16205         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. */
16206         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). */
16207         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. */
16208         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. */
16209         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16210      } Elm_List_Mode;
16211
16212    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().  */
16213
16214    /**
16215     * Add a new list widget to the given parent Elementary
16216     * (container) object.
16217     *
16218     * @param parent The parent object.
16219     * @return a new list widget handle or @c NULL, on errors.
16220     *
16221     * This function inserts a new list widget on the canvas.
16222     *
16223     * @ingroup List
16224     */
16225    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16226
16227    /**
16228     * Starts the list.
16229     *
16230     * @param obj The list object
16231     *
16232     * @note Call before running show() on the list object.
16233     * @warning If not called, it won't display the list properly.
16234     *
16235     * @code
16236     * li = elm_list_add(win);
16237     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16238     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16239     * elm_list_go(li);
16240     * evas_object_show(li);
16241     * @endcode
16242     *
16243     * @ingroup List
16244     */
16245    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16246
16247    /**
16248     * Enable or disable multiple items selection on the list object.
16249     *
16250     * @param obj The list object
16251     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16252     * disable it.
16253     *
16254     * Disabled by default. If disabled, the user can select a single item of
16255     * the list each time. Selected items are highlighted on list.
16256     * If enabled, many items can be selected.
16257     *
16258     * If a selected item is selected again, it will be unselected.
16259     *
16260     * @see elm_list_multi_select_get()
16261     *
16262     * @ingroup List
16263     */
16264    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16265
16266    /**
16267     * Get a value whether multiple items selection is enabled or not.
16268     *
16269     * @see elm_list_multi_select_set() for details.
16270     *
16271     * @param obj The list object.
16272     * @return @c EINA_TRUE means multiple items selection is enabled.
16273     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16274     * @c EINA_FALSE is returned.
16275     *
16276     * @ingroup List
16277     */
16278    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16279
16280    /**
16281     * Set which mode to use for the list object.
16282     *
16283     * @param obj The list object
16284     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16285     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16286     *
16287     * Set list's resize behavior, transverse axis scroll and
16288     * items cropping. See each mode's description for more details.
16289     *
16290     * @note Default value is #ELM_LIST_SCROLL.
16291     *
16292     * Only one can be set, if a previous one was set, it will be changed
16293     * by the new mode set. Bitmask won't work as well.
16294     *
16295     * @see elm_list_mode_get()
16296     *
16297     * @ingroup List
16298     */
16299    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16300
16301    /**
16302     * Get the mode the list is at.
16303     *
16304     * @param obj The list object
16305     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16306     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16307     *
16308     * @note see elm_list_mode_set() for more information.
16309     *
16310     * @ingroup List
16311     */
16312    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16313
16314    /**
16315     * Enable or disable horizontal mode on the list object.
16316     *
16317     * @param obj The list object.
16318     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16319     * disable it, i.e., to enable vertical mode.
16320     *
16321     * @note Vertical mode is set by default.
16322     *
16323     * On horizontal mode items are displayed on list from left to right,
16324     * instead of from top to bottom. Also, the list will scroll horizontally.
16325     * Each item will presents left icon on top and right icon, or end, at
16326     * the bottom.
16327     *
16328     * @see elm_list_horizontal_get()
16329     *
16330     * @ingroup List
16331     */
16332    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16333
16334    /**
16335     * Get a value whether horizontal mode is enabled or not.
16336     *
16337     * @param obj The list object.
16338     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16339     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16340     * @c EINA_FALSE is returned.
16341     *
16342     * @see elm_list_horizontal_set() for details.
16343     *
16344     * @ingroup List
16345     */
16346    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16347
16348    /**
16349     * Enable or disable always select mode on the list object.
16350     *
16351     * @param obj The list object
16352     * @param always_select @c EINA_TRUE to enable always select mode or
16353     * @c EINA_FALSE to disable it.
16354     *
16355     * @note Always select mode is disabled by default.
16356     *
16357     * Default behavior of list items is to only call its callback function
16358     * the first time it's pressed, i.e., when it is selected. If a selected
16359     * item is pressed again, and multi-select is disabled, it won't call
16360     * this function (if multi-select is enabled it will unselect the item).
16361     *
16362     * If always select is enabled, it will call the callback function
16363     * everytime a item is pressed, so it will call when the item is selected,
16364     * and again when a selected item is pressed.
16365     *
16366     * @see elm_list_always_select_mode_get()
16367     * @see elm_list_multi_select_set()
16368     *
16369     * @ingroup List
16370     */
16371    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16372
16373    /**
16374     * Get a value whether always select mode is enabled or not, meaning that
16375     * an item will always call its callback function, even if already selected.
16376     *
16377     * @param obj The list object
16378     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16379     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16380     * @c EINA_FALSE is returned.
16381     *
16382     * @see elm_list_always_select_mode_set() for details.
16383     *
16384     * @ingroup List
16385     */
16386    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16387
16388    /**
16389     * Set bouncing behaviour when the scrolled content reaches an edge.
16390     *
16391     * Tell the internal scroller object whether it should bounce or not
16392     * when it reaches the respective edges for each axis.
16393     *
16394     * @param obj The list object
16395     * @param h_bounce Whether to bounce or not in the horizontal axis.
16396     * @param v_bounce Whether to bounce or not in the vertical axis.
16397     *
16398     * @see elm_scroller_bounce_set()
16399     *
16400     * @ingroup List
16401     */
16402    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16403
16404    /**
16405     * Get the bouncing behaviour of the internal scroller.
16406     *
16407     * Get whether the internal scroller should bounce when the edge of each
16408     * axis is reached scrolling.
16409     *
16410     * @param obj The list object.
16411     * @param h_bounce Pointer where to store the bounce state of the horizontal
16412     * axis.
16413     * @param v_bounce Pointer where to store the bounce state of the vertical
16414     * axis.
16415     *
16416     * @see elm_scroller_bounce_get()
16417     * @see elm_list_bounce_set()
16418     *
16419     * @ingroup List
16420     */
16421    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16422
16423    /**
16424     * Set the scrollbar policy.
16425     *
16426     * @param obj The list object
16427     * @param policy_h Horizontal scrollbar policy.
16428     * @param policy_v Vertical scrollbar policy.
16429     *
16430     * This sets the scrollbar visibility policy for the given scroller.
16431     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16432     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16433     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16434     * This applies respectively for the horizontal and vertical scrollbars.
16435     *
16436     * The both are disabled by default, i.e., are set to
16437     * #ELM_SCROLLER_POLICY_OFF.
16438     *
16439     * @ingroup List
16440     */
16441    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16442
16443    /**
16444     * Get the scrollbar policy.
16445     *
16446     * @see elm_list_scroller_policy_get() for details.
16447     *
16448     * @param obj The list object.
16449     * @param policy_h Pointer where to store horizontal scrollbar policy.
16450     * @param policy_v Pointer where to store vertical scrollbar policy.
16451     *
16452     * @ingroup List
16453     */
16454    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);
16455
16456    /**
16457     * Append a new item to the list object.
16458     *
16459     * @param obj The list object.
16460     * @param label The label of the list item.
16461     * @param icon The icon object to use for the left side of the item. An
16462     * icon can be any Evas object, but usually it is an icon created
16463     * with elm_icon_add().
16464     * @param end The icon object to use for the right side of the item. An
16465     * icon can be any Evas object.
16466     * @param func The function to call when the item is clicked.
16467     * @param data The data to associate with the item for related callbacks.
16468     *
16469     * @return The created item or @c NULL upon failure.
16470     *
16471     * A new item will be created and appended to the list, i.e., will
16472     * be set as @b last item.
16473     *
16474     * Items created with this method can be deleted with
16475     * elm_list_item_del().
16476     *
16477     * Associated @p data can be properly freed when item is deleted if a
16478     * callback function is set with elm_list_item_del_cb_set().
16479     *
16480     * If a function is passed as argument, it will be called everytime this item
16481     * is selected, i.e., the user clicks over an unselected item.
16482     * If always select is enabled it will call this function every time
16483     * user clicks over an item (already selected or not).
16484     * If such function isn't needed, just passing
16485     * @c NULL as @p func is enough. The same should be done for @p data.
16486     *
16487     * Simple example (with no function callback or data associated):
16488     * @code
16489     * li = elm_list_add(win);
16490     * ic = elm_icon_add(win);
16491     * elm_icon_file_set(ic, "path/to/image", NULL);
16492     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16493     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16494     * elm_list_go(li);
16495     * evas_object_show(li);
16496     * @endcode
16497     *
16498     * @see elm_list_always_select_mode_set()
16499     * @see elm_list_item_del()
16500     * @see elm_list_item_del_cb_set()
16501     * @see elm_list_clear()
16502     * @see elm_icon_add()
16503     *
16504     * @ingroup List
16505     */
16506    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);
16507
16508    /**
16509     * Prepend a new item to the list object.
16510     *
16511     * @param obj The list object.
16512     * @param label The label of the list item.
16513     * @param icon The icon object to use for the left side of the item. An
16514     * icon can be any Evas object, but usually it is an icon created
16515     * with elm_icon_add().
16516     * @param end The icon object to use for the right side of the item. An
16517     * icon can be any Evas object.
16518     * @param func The function to call when the item is clicked.
16519     * @param data The data to associate with the item for related callbacks.
16520     *
16521     * @return The created item or @c NULL upon failure.
16522     *
16523     * A new item will be created and prepended to the list, i.e., will
16524     * be set as @b first item.
16525     *
16526     * Items created with this method can be deleted with
16527     * elm_list_item_del().
16528     *
16529     * Associated @p data can be properly freed when item is deleted if a
16530     * callback function is set with elm_list_item_del_cb_set().
16531     *
16532     * If a function is passed as argument, it will be called everytime this item
16533     * is selected, i.e., the user clicks over an unselected item.
16534     * If always select is enabled it will call this function every time
16535     * user clicks over an item (already selected or not).
16536     * If such function isn't needed, just passing
16537     * @c NULL as @p func is enough. The same should be done for @p data.
16538     *
16539     * @see elm_list_item_append() for a simple code example.
16540     * @see elm_list_always_select_mode_set()
16541     * @see elm_list_item_del()
16542     * @see elm_list_item_del_cb_set()
16543     * @see elm_list_clear()
16544     * @see elm_icon_add()
16545     *
16546     * @ingroup List
16547     */
16548    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);
16549
16550    /**
16551     * Insert a new item into the list object before item @p before.
16552     *
16553     * @param obj The list object.
16554     * @param before The list item to insert before.
16555     * @param label The label of the list item.
16556     * @param icon The icon object to use for the left side of the item. An
16557     * icon can be any Evas object, but usually it is an icon created
16558     * with elm_icon_add().
16559     * @param end The icon object to use for the right side of the item. An
16560     * icon can be any Evas object.
16561     * @param func The function to call when the item is clicked.
16562     * @param data The data to associate with the item for related callbacks.
16563     *
16564     * @return The created item or @c NULL upon failure.
16565     *
16566     * A new item will be created and added to the list. Its position in
16567     * this list will be just before item @p before.
16568     *
16569     * Items created with this method can be deleted with
16570     * elm_list_item_del().
16571     *
16572     * Associated @p data can be properly freed when item is deleted if a
16573     * callback function is set with elm_list_item_del_cb_set().
16574     *
16575     * If a function is passed as argument, it will be called everytime this item
16576     * is selected, i.e., the user clicks over an unselected item.
16577     * If always select is enabled it will call this function every time
16578     * user clicks over an item (already selected or not).
16579     * If such function isn't needed, just passing
16580     * @c NULL as @p func is enough. The same should be done for @p data.
16581     *
16582     * @see elm_list_item_append() for a simple code example.
16583     * @see elm_list_always_select_mode_set()
16584     * @see elm_list_item_del()
16585     * @see elm_list_item_del_cb_set()
16586     * @see elm_list_clear()
16587     * @see elm_icon_add()
16588     *
16589     * @ingroup List
16590     */
16591    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);
16592
16593    /**
16594     * Insert a new item into the list object after item @p after.
16595     *
16596     * @param obj The list object.
16597     * @param after The list item to insert after.
16598     * @param label The label of the list item.
16599     * @param icon The icon object to use for the left side of the item. An
16600     * icon can be any Evas object, but usually it is an icon created
16601     * with elm_icon_add().
16602     * @param end The icon object to use for the right side of the item. An
16603     * icon can be any Evas object.
16604     * @param func The function to call when the item is clicked.
16605     * @param data The data to associate with the item for related callbacks.
16606     *
16607     * @return The created item or @c NULL upon failure.
16608     *
16609     * A new item will be created and added to the list. Its position in
16610     * this list will be just after item @p after.
16611     *
16612     * Items created with this method can be deleted with
16613     * elm_list_item_del().
16614     *
16615     * Associated @p data can be properly freed when item is deleted if a
16616     * callback function is set with elm_list_item_del_cb_set().
16617     *
16618     * If a function is passed as argument, it will be called everytime this item
16619     * is selected, i.e., the user clicks over an unselected item.
16620     * If always select is enabled it will call this function every time
16621     * user clicks over an item (already selected or not).
16622     * If such function isn't needed, just passing
16623     * @c NULL as @p func is enough. The same should be done for @p data.
16624     *
16625     * @see elm_list_item_append() for a simple code example.
16626     * @see elm_list_always_select_mode_set()
16627     * @see elm_list_item_del()
16628     * @see elm_list_item_del_cb_set()
16629     * @see elm_list_clear()
16630     * @see elm_icon_add()
16631     *
16632     * @ingroup List
16633     */
16634    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);
16635
16636    /**
16637     * Insert a new item into the sorted list object.
16638     *
16639     * @param obj The list object.
16640     * @param label The label of the list item.
16641     * @param icon The icon object to use for the left side of the item. An
16642     * icon can be any Evas object, but usually it is an icon created
16643     * with elm_icon_add().
16644     * @param end The icon object to use for the right side of the item. An
16645     * icon can be any Evas object.
16646     * @param func The function to call when the item is clicked.
16647     * @param data The data to associate with the item for related callbacks.
16648     * @param cmp_func The comparing function to be used to sort list
16649     * items <b>by #Elm_List_Item item handles</b>. This function will
16650     * receive two items and compare them, returning a non-negative integer
16651     * if the second item should be place after the first, or negative value
16652     * if should be placed before.
16653     *
16654     * @return The created item or @c NULL upon failure.
16655     *
16656     * @note This function inserts values into a list object assuming it was
16657     * sorted and the result will be sorted.
16658     *
16659     * A new item will be created and added to the list. Its position in
16660     * this list will be found comparing the new item with previously inserted
16661     * items using function @p cmp_func.
16662     *
16663     * Items created with this method can be deleted with
16664     * elm_list_item_del().
16665     *
16666     * Associated @p data can be properly freed when item is deleted if a
16667     * callback function is set with elm_list_item_del_cb_set().
16668     *
16669     * If a function is passed as argument, it will be called everytime this item
16670     * is selected, i.e., the user clicks over an unselected item.
16671     * If always select is enabled it will call this function every time
16672     * user clicks over an item (already selected or not).
16673     * If such function isn't needed, just passing
16674     * @c NULL as @p func is enough. The same should be done for @p data.
16675     *
16676     * @see elm_list_item_append() for a simple code example.
16677     * @see elm_list_always_select_mode_set()
16678     * @see elm_list_item_del()
16679     * @see elm_list_item_del_cb_set()
16680     * @see elm_list_clear()
16681     * @see elm_icon_add()
16682     *
16683     * @ingroup List
16684     */
16685    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);
16686
16687    /**
16688     * Remove all list's items.
16689     *
16690     * @param obj The list object
16691     *
16692     * @see elm_list_item_del()
16693     * @see elm_list_item_append()
16694     *
16695     * @ingroup List
16696     */
16697    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16698
16699    /**
16700     * Get a list of all the list items.
16701     *
16702     * @param obj The list object
16703     * @return An @c Eina_List of list items, #Elm_List_Item,
16704     * or @c NULL on failure.
16705     *
16706     * @see elm_list_item_append()
16707     * @see elm_list_item_del()
16708     * @see elm_list_clear()
16709     *
16710     * @ingroup List
16711     */
16712    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16713
16714    /**
16715     * Get the selected item.
16716     *
16717     * @param obj The list object.
16718     * @return The selected list item.
16719     *
16720     * The selected item can be unselected with function
16721     * elm_list_item_selected_set().
16722     *
16723     * The selected item always will be highlighted on list.
16724     *
16725     * @see elm_list_selected_items_get()
16726     *
16727     * @ingroup List
16728     */
16729    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16730
16731    /**
16732     * Return a list of the currently selected list items.
16733     *
16734     * @param obj The list object.
16735     * @return An @c Eina_List of list items, #Elm_List_Item,
16736     * or @c NULL on failure.
16737     *
16738     * Multiple items can be selected if multi select is enabled. It can be
16739     * done with elm_list_multi_select_set().
16740     *
16741     * @see elm_list_selected_item_get()
16742     * @see elm_list_multi_select_set()
16743     *
16744     * @ingroup List
16745     */
16746    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16747
16748    /**
16749     * Set the selected state of an item.
16750     *
16751     * @param item The list item
16752     * @param selected The selected state
16753     *
16754     * This sets the selected state of the given item @p it.
16755     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16756     *
16757     * If a new item is selected the previosly selected will be unselected,
16758     * unless multiple selection is enabled with elm_list_multi_select_set().
16759     * Previoulsy selected item can be get with function
16760     * elm_list_selected_item_get().
16761     *
16762     * Selected items will be highlighted.
16763     *
16764     * @see elm_list_item_selected_get()
16765     * @see elm_list_selected_item_get()
16766     * @see elm_list_multi_select_set()
16767     *
16768     * @ingroup List
16769     */
16770    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16771
16772    /*
16773     * Get whether the @p item is selected or not.
16774     *
16775     * @param item The list item.
16776     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16777     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16778     *
16779     * @see elm_list_selected_item_set() for details.
16780     * @see elm_list_item_selected_get()
16781     *
16782     * @ingroup List
16783     */
16784    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16785
16786    /**
16787     * Set or unset item as a separator.
16788     *
16789     * @param it The list item.
16790     * @param setting @c EINA_TRUE to set item @p it as separator or
16791     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16792     *
16793     * Items aren't set as separator by default.
16794     *
16795     * If set as separator it will display separator theme, so won't display
16796     * icons or label.
16797     *
16798     * @see elm_list_item_separator_get()
16799     *
16800     * @ingroup List
16801     */
16802    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16803
16804    /**
16805     * Get a value whether item is a separator or not.
16806     *
16807     * @see elm_list_item_separator_set() for details.
16808     *
16809     * @param it The list item.
16810     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16811     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16812     *
16813     * @ingroup List
16814     */
16815    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16816
16817    /**
16818     * Show @p item in the list view.
16819     *
16820     * @param item The list item to be shown.
16821     *
16822     * It won't animate list until item is visible. If such behavior is wanted,
16823     * use elm_list_bring_in() intead.
16824     *
16825     * @ingroup List
16826     */
16827    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16828
16829    /**
16830     * Bring in the given item to list view.
16831     *
16832     * @param item The item.
16833     *
16834     * This causes list to jump to the given item @p item and show it
16835     * (by scrolling), if it is not fully visible.
16836     *
16837     * This may use animation to do so and take a period of time.
16838     *
16839     * If animation isn't wanted, elm_list_item_show() can be used.
16840     *
16841     * @ingroup List
16842     */
16843    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16844
16845    /**
16846     * Delete them item from the list.
16847     *
16848     * @param item The item of list to be deleted.
16849     *
16850     * If deleting all list items is required, elm_list_clear()
16851     * should be used instead of getting items list and deleting each one.
16852     *
16853     * @see elm_list_clear()
16854     * @see elm_list_item_append()
16855     * @see elm_list_item_del_cb_set()
16856     *
16857     * @ingroup List
16858     */
16859    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16860
16861    /**
16862     * Set the function called when a list item is freed.
16863     *
16864     * @param item The item to set the callback on
16865     * @param func The function called
16866     *
16867     * If there is a @p func, then it will be called prior item's memory release.
16868     * That will be called with the following arguments:
16869     * @li item's data;
16870     * @li item's Evas object;
16871     * @li item itself;
16872     *
16873     * This way, a data associated to a list item could be properly freed.
16874     *
16875     * @ingroup List
16876     */
16877    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16878
16879    /**
16880     * Get the data associated to the item.
16881     *
16882     * @param item The list item
16883     * @return The data associated to @p item
16884     *
16885     * The return value is a pointer to data associated to @p item when it was
16886     * created, with function elm_list_item_append() or similar. If no data
16887     * was passed as argument, it will return @c NULL.
16888     *
16889     * @see elm_list_item_append()
16890     *
16891     * @ingroup List
16892     */
16893    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16894
16895    /**
16896     * Get the left side icon associated to the item.
16897     *
16898     * @param item The list item
16899     * @return The left side icon associated to @p item
16900     *
16901     * The return value is a pointer to the icon associated to @p item when
16902     * it was
16903     * created, with function elm_list_item_append() or similar, or later
16904     * with function elm_list_item_icon_set(). If no icon
16905     * was passed as argument, it will return @c NULL.
16906     *
16907     * @see elm_list_item_append()
16908     * @see elm_list_item_icon_set()
16909     *
16910     * @ingroup List
16911     */
16912    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16913
16914    /**
16915     * Set the left side icon associated to the item.
16916     *
16917     * @param item The list item
16918     * @param icon The left side icon object to associate with @p item
16919     *
16920     * The icon object to use at left side of the item. An
16921     * icon can be any Evas object, but usually it is an icon created
16922     * with elm_icon_add().
16923     *
16924     * Once the icon object is set, a previously set one will be deleted.
16925     * @warning Setting the same icon for two items will cause the icon to
16926     * dissapear from the first item.
16927     *
16928     * If an icon was passed as argument on item creation, with function
16929     * elm_list_item_append() or similar, it will be already
16930     * associated to the item.
16931     *
16932     * @see elm_list_item_append()
16933     * @see elm_list_item_icon_get()
16934     *
16935     * @ingroup List
16936     */
16937    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16938
16939    /**
16940     * Get the right side icon associated to the item.
16941     *
16942     * @param item The list item
16943     * @return The right side icon associated to @p item
16944     *
16945     * The return value is a pointer to the icon associated to @p item when
16946     * it was
16947     * created, with function elm_list_item_append() or similar, or later
16948     * with function elm_list_item_icon_set(). If no icon
16949     * was passed as argument, it will return @c NULL.
16950     *
16951     * @see elm_list_item_append()
16952     * @see elm_list_item_icon_set()
16953     *
16954     * @ingroup List
16955     */
16956    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16957
16958    /**
16959     * Set the right side icon associated to the item.
16960     *
16961     * @param item The list item
16962     * @param end The right side icon object to associate with @p item
16963     *
16964     * The icon object to use at right side of the item. An
16965     * icon can be any Evas object, but usually it is an icon created
16966     * with elm_icon_add().
16967     *
16968     * Once the icon object is set, a previously set one will be deleted.
16969     * @warning Setting the same icon for two items will cause the icon to
16970     * dissapear from the first item.
16971     *
16972     * If an icon was passed as argument on item creation, with function
16973     * elm_list_item_append() or similar, it will be already
16974     * associated to the item.
16975     *
16976     * @see elm_list_item_append()
16977     * @see elm_list_item_end_get()
16978     *
16979     * @ingroup List
16980     */
16981    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16982
16983    /**
16984     * Gets the base object of the item.
16985     *
16986     * @param item The list item
16987     * @return The base object associated with @p item
16988     *
16989     * Base object is the @c Evas_Object that represents that item.
16990     *
16991     * @ingroup List
16992     */
16993    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16994    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16995
16996    /**
16997     * Get the label of item.
16998     *
16999     * @param item The item of list.
17000     * @return The label of item.
17001     *
17002     * The return value is a pointer to the label associated to @p item when
17003     * it was created, with function elm_list_item_append(), or later
17004     * with function elm_list_item_label_set. If no label
17005     * was passed as argument, it will return @c NULL.
17006     *
17007     * @see elm_list_item_label_set() for more details.
17008     * @see elm_list_item_append()
17009     *
17010     * @ingroup List
17011     */
17012    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17013
17014    /**
17015     * Set the label of item.
17016     *
17017     * @param item The item of list.
17018     * @param text The label of item.
17019     *
17020     * The label to be displayed by the item.
17021     * Label will be placed between left and right side icons (if set).
17022     *
17023     * If a label was passed as argument on item creation, with function
17024     * elm_list_item_append() or similar, it will be already
17025     * displayed by the item.
17026     *
17027     * @see elm_list_item_label_get()
17028     * @see elm_list_item_append()
17029     *
17030     * @ingroup List
17031     */
17032    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17033
17034
17035    /**
17036     * Get the item before @p it in list.
17037     *
17038     * @param it The list item.
17039     * @return The item before @p it, or @c NULL if none or on failure.
17040     *
17041     * @note If it is the first item, @c NULL will be returned.
17042     *
17043     * @see elm_list_item_append()
17044     * @see elm_list_items_get()
17045     *
17046     * @ingroup List
17047     */
17048    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17049
17050    /**
17051     * Get the item after @p it in list.
17052     *
17053     * @param it The list item.
17054     * @return The item after @p it, or @c NULL if none or on failure.
17055     *
17056     * @note If it is the last item, @c NULL will be returned.
17057     *
17058     * @see elm_list_item_append()
17059     * @see elm_list_items_get()
17060     *
17061     * @ingroup List
17062     */
17063    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17064
17065    /**
17066     * Sets the disabled/enabled state of a list item.
17067     *
17068     * @param it The item.
17069     * @param disabled The disabled state.
17070     *
17071     * A disabled item cannot be selected or unselected. It will also
17072     * change its appearance (generally greyed out). This sets the
17073     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17074     * enabled).
17075     *
17076     * @ingroup List
17077     */
17078    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17079
17080    /**
17081     * Get a value whether list item is disabled or not.
17082     *
17083     * @param it The item.
17084     * @return The disabled state.
17085     *
17086     * @see elm_list_item_disabled_set() for more details.
17087     *
17088     * @ingroup List
17089     */
17090    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17091
17092    /**
17093     * Set the text to be shown in a given list item's tooltips.
17094     *
17095     * @param item Target item.
17096     * @param text The text to set in the content.
17097     *
17098     * Setup the text as tooltip to object. The item can have only one tooltip,
17099     * so any previous tooltip data - set with this function or
17100     * elm_list_item_tooltip_content_cb_set() - is removed.
17101     *
17102     * @see elm_object_tooltip_text_set() for more details.
17103     *
17104     * @ingroup List
17105     */
17106    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17107
17108
17109    /**
17110     * @brief Disable size restrictions on an object's tooltip
17111     * @param item The tooltip's anchor object
17112     * @param disable If EINA_TRUE, size restrictions are disabled
17113     * @return EINA_FALSE on failure, EINA_TRUE on success
17114     *
17115     * This function allows a tooltip to expand beyond its parant window's canvas.
17116     * It will instead be limited only by the size of the display.
17117     */
17118    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17119    /**
17120     * @brief Retrieve size restriction state of an object's tooltip
17121     * @param obj The tooltip's anchor object
17122     * @return If EINA_TRUE, size restrictions are disabled
17123     *
17124     * This function returns whether a tooltip is allowed to expand beyond
17125     * its parant window's canvas.
17126     * It will instead be limited only by the size of the display.
17127     */
17128    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17129
17130    /**
17131     * Set the content to be shown in the tooltip item.
17132     *
17133     * Setup the tooltip to item. The item can have only one tooltip,
17134     * so any previous tooltip data is removed. @p func(with @p data) will
17135     * be called every time that need show the tooltip and it should
17136     * return a valid Evas_Object. This object is then managed fully by
17137     * tooltip system and is deleted when the tooltip is gone.
17138     *
17139     * @param item the list item being attached a tooltip.
17140     * @param func the function used to create the tooltip contents.
17141     * @param data what to provide to @a func as callback data/context.
17142     * @param del_cb called when data is not needed anymore, either when
17143     *        another callback replaces @a func, the tooltip is unset with
17144     *        elm_list_item_tooltip_unset() or the owner @a item
17145     *        dies. This callback receives as the first parameter the
17146     *        given @a data, and @c event_info is the item.
17147     *
17148     * @see elm_object_tooltip_content_cb_set() for more details.
17149     *
17150     * @ingroup List
17151     */
17152    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);
17153
17154    /**
17155     * Unset tooltip from item.
17156     *
17157     * @param item list item to remove previously set tooltip.
17158     *
17159     * Remove tooltip from item. The callback provided as del_cb to
17160     * elm_list_item_tooltip_content_cb_set() will be called to notify
17161     * it is not used anymore.
17162     *
17163     * @see elm_object_tooltip_unset() for more details.
17164     * @see elm_list_item_tooltip_content_cb_set()
17165     *
17166     * @ingroup List
17167     */
17168    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17169
17170    /**
17171     * Sets a different style for this item tooltip.
17172     *
17173     * @note before you set a style you should define a tooltip with
17174     *       elm_list_item_tooltip_content_cb_set() or
17175     *       elm_list_item_tooltip_text_set()
17176     *
17177     * @param item list item with tooltip already set.
17178     * @param style the theme style to use (default, transparent, ...)
17179     *
17180     * @see elm_object_tooltip_style_set() for more details.
17181     *
17182     * @ingroup List
17183     */
17184    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17185
17186    /**
17187     * Get the style for this item tooltip.
17188     *
17189     * @param item list item with tooltip already set.
17190     * @return style the theme style in use, defaults to "default". If the
17191     *         object does not have a tooltip set, then NULL is returned.
17192     *
17193     * @see elm_object_tooltip_style_get() for more details.
17194     * @see elm_list_item_tooltip_style_set()
17195     *
17196     * @ingroup List
17197     */
17198    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17199
17200    /**
17201     * Set the type of mouse pointer/cursor decoration to be shown,
17202     * when the mouse pointer is over the given list widget item
17203     *
17204     * @param item list item to customize cursor on
17205     * @param cursor the cursor type's name
17206     *
17207     * This function works analogously as elm_object_cursor_set(), but
17208     * here the cursor's changing area is restricted to the item's
17209     * area, and not the whole widget's. Note that that item cursors
17210     * have precedence over widget cursors, so that a mouse over an
17211     * item with custom cursor set will always show @b that cursor.
17212     *
17213     * If this function is called twice for an object, a previously set
17214     * cursor will be unset on the second call.
17215     *
17216     * @see elm_object_cursor_set()
17217     * @see elm_list_item_cursor_get()
17218     * @see elm_list_item_cursor_unset()
17219     *
17220     * @ingroup List
17221     */
17222    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17223
17224    /*
17225     * Get the type of mouse pointer/cursor decoration set to be shown,
17226     * when the mouse pointer is over the given list widget item
17227     *
17228     * @param item list item with custom cursor set
17229     * @return the cursor type's name or @c NULL, if no custom cursors
17230     * were set to @p item (and on errors)
17231     *
17232     * @see elm_object_cursor_get()
17233     * @see elm_list_item_cursor_set()
17234     * @see elm_list_item_cursor_unset()
17235     *
17236     * @ingroup List
17237     */
17238    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17239
17240    /**
17241     * Unset any custom mouse pointer/cursor decoration set to be
17242     * shown, when the mouse pointer is over the given list widget
17243     * item, thus making it show the @b default cursor again.
17244     *
17245     * @param item a list item
17246     *
17247     * Use this call to undo any custom settings on this item's cursor
17248     * decoration, bringing it back to defaults (no custom style set).
17249     *
17250     * @see elm_object_cursor_unset()
17251     * @see elm_list_item_cursor_set()
17252     *
17253     * @ingroup List
17254     */
17255    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17256
17257    /**
17258     * Set a different @b style for a given custom cursor set for a
17259     * list item.
17260     *
17261     * @param item list item with custom cursor set
17262     * @param style the <b>theme style</b> to use (e.g. @c "default",
17263     * @c "transparent", etc)
17264     *
17265     * This function only makes sense when one is using custom mouse
17266     * cursor decorations <b>defined in a theme file</b>, which can have,
17267     * given a cursor name/type, <b>alternate styles</b> on it. It
17268     * works analogously as elm_object_cursor_style_set(), but here
17269     * applyed only to list item objects.
17270     *
17271     * @warning Before you set a cursor style you should have definen a
17272     *       custom cursor previously on the item, with
17273     *       elm_list_item_cursor_set()
17274     *
17275     * @see elm_list_item_cursor_engine_only_set()
17276     * @see elm_list_item_cursor_style_get()
17277     *
17278     * @ingroup List
17279     */
17280    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17281
17282    /**
17283     * Get the current @b style set for a given list item's custom
17284     * cursor
17285     *
17286     * @param item list item with custom cursor set.
17287     * @return style the cursor style in use. If the object does not
17288     *         have a cursor set, then @c NULL is returned.
17289     *
17290     * @see elm_list_item_cursor_style_set() for more details
17291     *
17292     * @ingroup List
17293     */
17294    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17295
17296    /**
17297     * Set if the (custom)cursor for a given list item should be
17298     * searched in its theme, also, or should only rely on the
17299     * rendering engine.
17300     *
17301     * @param item item with custom (custom) cursor already set on
17302     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17303     * only on those provided by the rendering engine, @c EINA_FALSE to
17304     * have them searched on the widget's theme, as well.
17305     *
17306     * @note This call is of use only if you've set a custom cursor
17307     * for list items, with elm_list_item_cursor_set().
17308     *
17309     * @note By default, cursors will only be looked for between those
17310     * provided by the rendering engine.
17311     *
17312     * @ingroup List
17313     */
17314    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17315
17316    /**
17317     * Get if the (custom) cursor for a given list item is being
17318     * searched in its theme, also, or is only relying on the rendering
17319     * engine.
17320     *
17321     * @param item a list item
17322     * @return @c EINA_TRUE, if cursors are being looked for only on
17323     * those provided by the rendering engine, @c EINA_FALSE if they
17324     * are being searched on the widget's theme, as well.
17325     *
17326     * @see elm_list_item_cursor_engine_only_set(), for more details
17327     *
17328     * @ingroup List
17329     */
17330    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17331
17332    /**
17333     * @}
17334     */
17335
17336    /**
17337     * @defgroup Slider Slider
17338     * @ingroup Elementary
17339     *
17340     * @image html img/widget/slider/preview-00.png
17341     * @image latex img/widget/slider/preview-00.eps width=\textwidth
17342     *
17343     * The slider adds a dragable ā€œsliderā€ widget for selecting the value of
17344     * something within a range.
17345     *
17346     * A slider can be horizontal or vertical. It can contain an Icon and has a
17347     * primary label as well as a units label (that is formatted with floating
17348     * point values and thus accepts a printf-style format string, like
17349     * ā€œ%1.2f unitsā€. There is also an indicator string that may be somewhere
17350     * else (like on the slider itself) that also accepts a format string like
17351     * units. Label, Icon Unit and Indicator strings/objects are optional.
17352     *
17353     * A slider may be inverted which means values invert, with high vales being
17354     * on the left or top and low values on the right or bottom (as opposed to
17355     * normally being low on the left or top and high on the bottom and right).
17356     *
17357     * The slider should have its minimum and maximum values set by the
17358     * application with  elm_slider_min_max_set() and value should also be set by
17359     * the application before use with  elm_slider_value_set(). The span of the
17360     * slider is its length (horizontally or vertically). This will be scaled by
17361     * the object or applications scaling factor. At any point code can query the
17362     * slider for its value with elm_slider_value_get().
17363     *
17364     * Smart callbacks one can listen to:
17365     * - "changed" - Whenever the slider value is changed by the user.
17366     * - "slider,drag,start" - dragging the slider indicator around has started.
17367     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17368     * - "delay,changed" - A short time after the value is changed by the user.
17369     * This will be called only when the user stops dragging for
17370     * a very short period or when they release their
17371     * finger/mouse, so it avoids possibly expensive reactions to
17372     * the value change.
17373     *
17374     * Available styles for it:
17375     * - @c "default"
17376     *
17377     * Default contents parts of the slider widget that you can use for are:
17378     * @li "elm.swallow.icon" - A icon of the slider
17379     * @li "elm.swallow.end" - A end part content of the slider
17380     * 
17381     * Here is an example on its usage:
17382     * @li @ref slider_example
17383     */
17384
17385 #define ELM_SLIDER_CONTENT_ICON "elm.swallow.icon"
17386 #define ELM_SLIDER_CONTENT_END "elm.swallow.end"
17387
17388    /**
17389     * @addtogroup Slider
17390     * @{
17391     */
17392
17393    /**
17394     * Add a new slider widget to the given parent Elementary
17395     * (container) object.
17396     *
17397     * @param parent The parent object.
17398     * @return a new slider widget handle or @c NULL, on errors.
17399     *
17400     * This function inserts a new slider widget on the canvas.
17401     *
17402     * @ingroup Slider
17403     */
17404    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17405
17406    /**
17407     * Set the label of a given slider widget
17408     *
17409     * @param obj The progress bar object
17410     * @param label The text label string, in UTF-8
17411     *
17412     * @ingroup Slider
17413     * @deprecated use elm_object_text_set() instead.
17414     */
17415    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17416
17417    /**
17418     * Get the label of a given slider widget
17419     *
17420     * @param obj The progressbar object
17421     * @return The text label string, in UTF-8
17422     *
17423     * @ingroup Slider
17424     * @deprecated use elm_object_text_get() instead.
17425     */
17426    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17427
17428    /**
17429     * Set the icon object of the slider object.
17430     *
17431     * @param obj The slider object.
17432     * @param icon The icon object.
17433     *
17434     * On horizontal mode, icon is placed at left, and on vertical mode,
17435     * placed at top.
17436     *
17437     * @note Once the icon object is set, a previously set one will be deleted.
17438     * If you want to keep that old content object, use the
17439     * elm_slider_icon_unset() function.
17440     *
17441     * @warning If the object being set does not have minimum size hints set,
17442     * it won't get properly displayed.
17443     *
17444     * @ingroup Slider
17445     */
17446    EINA_DEPRECATED EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17447
17448    /**
17449     * Unset an icon set on a given slider widget.
17450     *
17451     * @param obj The slider object.
17452     * @return The icon object that was being used, if any was set, or
17453     * @c NULL, otherwise (and on errors).
17454     *
17455     * On horizontal mode, icon is placed at left, and on vertical mode,
17456     * placed at top.
17457     *
17458     * This call will unparent and return the icon object which was set
17459     * for this widget, previously, on success.
17460     *
17461     * @see elm_slider_icon_set() for more details
17462     * @see elm_slider_icon_get()
17463     *
17464     * @ingroup Slider
17465     */
17466    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17467
17468    /**
17469     * Retrieve the icon object set for a given slider widget.
17470     *
17471     * @param obj The slider object.
17472     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17473     * otherwise (and on errors).
17474     *
17475     * On horizontal mode, icon is placed at left, and on vertical mode,
17476     * placed at top.
17477     *
17478     * @see elm_slider_icon_set() for more details
17479     * @see elm_slider_icon_unset()
17480     *
17481     * @ingroup Slider
17482     */
17483    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17484
17485    /**
17486     * Set the end object of the slider object.
17487     *
17488     * @param obj The slider object.
17489     * @param end The end object.
17490     *
17491     * On horizontal mode, end is placed at left, and on vertical mode,
17492     * placed at bottom.
17493     *
17494     * @note Once the icon object is set, a previously set one will be deleted.
17495     * If you want to keep that old content object, use the
17496     * elm_slider_end_unset() function.
17497     *
17498     * @warning If the object being set does not have minimum size hints set,
17499     * it won't get properly displayed.
17500     *
17501     * @ingroup Slider
17502     */
17503    EINA_DEPRECATED EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17504
17505    /**
17506     * Unset an end object set on a given slider widget.
17507     *
17508     * @param obj The slider object.
17509     * @return The end object that was being used, if any was set, or
17510     * @c NULL, otherwise (and on errors).
17511     *
17512     * On horizontal mode, end is placed at left, and on vertical mode,
17513     * placed at bottom.
17514     *
17515     * This call will unparent and return the icon object which was set
17516     * for this widget, previously, on success.
17517     *
17518     * @see elm_slider_end_set() for more details.
17519     * @see elm_slider_end_get()
17520     *
17521     * @ingroup Slider
17522     */
17523    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17524
17525    /**
17526     * Retrieve the end object set for a given slider widget.
17527     *
17528     * @param obj The slider object.
17529     * @return The end object's handle, if @p obj had one set, or @c NULL,
17530     * otherwise (and on errors).
17531     *
17532     * On horizontal mode, icon is placed at right, and on vertical mode,
17533     * placed at bottom.
17534     *
17535     * @see elm_slider_end_set() for more details.
17536     * @see elm_slider_end_unset()
17537     *
17538     * @ingroup Slider
17539     */
17540    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17541
17542    /**
17543     * Set the (exact) length of the bar region of a given slider widget.
17544     *
17545     * @param obj The slider object.
17546     * @param size The length of the slider's bar region.
17547     *
17548     * This sets the minimum width (when in horizontal mode) or height
17549     * (when in vertical mode) of the actual bar area of the slider
17550     * @p obj. This in turn affects the object's minimum size. Use
17551     * this when you're not setting other size hints expanding on the
17552     * given direction (like weight and alignment hints) and you would
17553     * like it to have a specific size.
17554     *
17555     * @note Icon, end, label, indicator and unit text around @p obj
17556     * will require their
17557     * own space, which will make @p obj to require more the @p size,
17558     * actually.
17559     *
17560     * @see elm_slider_span_size_get()
17561     *
17562     * @ingroup Slider
17563     */
17564    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17565
17566    /**
17567     * Get the length set for the bar region of a given slider widget
17568     *
17569     * @param obj The slider object.
17570     * @return The length of the slider's bar region.
17571     *
17572     * If that size was not set previously, with
17573     * elm_slider_span_size_set(), this call will return @c 0.
17574     *
17575     * @ingroup Slider
17576     */
17577    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17578
17579    /**
17580     * Set the format string for the unit label.
17581     *
17582     * @param obj The slider object.
17583     * @param format The format string for the unit display.
17584     *
17585     * Unit label is displayed all the time, if set, after slider's bar.
17586     * In horizontal mode, at right and in vertical mode, at bottom.
17587     *
17588     * If @c NULL, unit label won't be visible. If not it sets the format
17589     * string for the label text. To the label text is provided a floating point
17590     * value, so the label text can display up to 1 floating point value.
17591     * Note that this is optional.
17592     *
17593     * Use a format string such as "%1.2f meters" for example, and it will
17594     * display values like: "3.14 meters" for a value equal to 3.14159.
17595     *
17596     * Default is unit label disabled.
17597     *
17598     * @see elm_slider_indicator_format_get()
17599     *
17600     * @ingroup Slider
17601     */
17602    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17603
17604    /**
17605     * Get the unit label format of the slider.
17606     *
17607     * @param obj The slider object.
17608     * @return The unit label format string in UTF-8.
17609     *
17610     * Unit label is displayed all the time, if set, after slider's bar.
17611     * In horizontal mode, at right and in vertical mode, at bottom.
17612     *
17613     * @see elm_slider_unit_format_set() for more
17614     * information on how this works.
17615     *
17616     * @ingroup Slider
17617     */
17618    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17619
17620    /**
17621     * Set the format string for the indicator label.
17622     *
17623     * @param obj The slider object.
17624     * @param indicator The format string for the indicator display.
17625     *
17626     * The slider may display its value somewhere else then unit label,
17627     * for example, above the slider knob that is dragged around. This function
17628     * sets the format string used for this.
17629     *
17630     * If @c NULL, indicator label won't be visible. If not it sets the format
17631     * string for the label text. To the label text is provided a floating point
17632     * value, so the label text can display up to 1 floating point value.
17633     * Note that this is optional.
17634     *
17635     * Use a format string such as "%1.2f meters" for example, and it will
17636     * display values like: "3.14 meters" for a value equal to 3.14159.
17637     *
17638     * Default is indicator label disabled.
17639     *
17640     * @see elm_slider_indicator_format_get()
17641     *
17642     * @ingroup Slider
17643     */
17644    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17645
17646    /**
17647     * Get the indicator label format of the slider.
17648     *
17649     * @param obj The slider object.
17650     * @return The indicator label format string in UTF-8.
17651     *
17652     * The slider may display its value somewhere else then unit label,
17653     * for example, above the slider knob that is dragged around. This function
17654     * gets the format string used for this.
17655     *
17656     * @see elm_slider_indicator_format_set() for more
17657     * information on how this works.
17658     *
17659     * @ingroup Slider
17660     */
17661    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17662
17663    /**
17664     * Set the format function pointer for the indicator label
17665     *
17666     * @param obj The slider object.
17667     * @param func The indicator format function.
17668     * @param free_func The freeing function for the format string.
17669     *
17670     * Set the callback function to format the indicator string.
17671     *
17672     * @see elm_slider_indicator_format_set() for more info on how this works.
17673     *
17674     * @ingroup Slider
17675     */
17676   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);
17677
17678   /**
17679    * Set the format function pointer for the units label
17680    *
17681    * @param obj The slider object.
17682    * @param func The units format function.
17683    * @param free_func The freeing function for the format string.
17684    *
17685    * Set the callback function to format the indicator string.
17686    *
17687    * @see elm_slider_units_format_set() for more info on how this works.
17688    *
17689    * @ingroup Slider
17690    */
17691   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);
17692
17693   /**
17694    * Set the orientation of a given slider widget.
17695    *
17696    * @param obj The slider object.
17697    * @param horizontal Use @c EINA_TRUE to make @p obj to be
17698    * @b horizontal, @c EINA_FALSE to make it @b vertical.
17699    *
17700    * Use this function to change how your slider is to be
17701    * disposed: vertically or horizontally.
17702    *
17703    * By default it's displayed horizontally.
17704    *
17705    * @see elm_slider_horizontal_get()
17706    *
17707    * @ingroup Slider
17708    */
17709    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17710
17711    /**
17712     * Retrieve the orientation of a given slider widget
17713     *
17714     * @param obj The slider object.
17715     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17716     * @c EINA_FALSE if it's @b vertical (and on errors).
17717     *
17718     * @see elm_slider_horizontal_set() for more details.
17719     *
17720     * @ingroup Slider
17721     */
17722    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17723
17724    /**
17725     * Set the minimum and maximum values for the slider.
17726     *
17727     * @param obj The slider object.
17728     * @param min The minimum value.
17729     * @param max The maximum value.
17730     *
17731     * Define the allowed range of values to be selected by the user.
17732     *
17733     * If actual value is less than @p min, it will be updated to @p min. If it
17734     * is bigger then @p max, will be updated to @p max. Actual value can be
17735     * get with elm_slider_value_get().
17736     *
17737     * By default, min is equal to 0.0, and max is equal to 1.0.
17738     *
17739     * @warning Maximum must be greater than minimum, otherwise behavior
17740     * is undefined.
17741     *
17742     * @see elm_slider_min_max_get()
17743     *
17744     * @ingroup Slider
17745     */
17746    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17747
17748    /**
17749     * Get the minimum and maximum values of the slider.
17750     *
17751     * @param obj The slider object.
17752     * @param min Pointer where to store the minimum value.
17753     * @param max Pointer where to store the maximum value.
17754     *
17755     * @note If only one value is needed, the other pointer can be passed
17756     * as @c NULL.
17757     *
17758     * @see elm_slider_min_max_set() for details.
17759     *
17760     * @ingroup Slider
17761     */
17762    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17763
17764    /**
17765     * Set the value the slider displays.
17766     *
17767     * @param obj The slider object.
17768     * @param val The value to be displayed.
17769     *
17770     * Value will be presented on the unit label following format specified with
17771     * elm_slider_unit_format_set() and on indicator with
17772     * elm_slider_indicator_format_set().
17773     *
17774     * @warning The value must to be between min and max values. This values
17775     * are set by elm_slider_min_max_set().
17776     *
17777     * @see elm_slider_value_get()
17778     * @see elm_slider_unit_format_set()
17779     * @see elm_slider_indicator_format_set()
17780     * @see elm_slider_min_max_set()
17781     *
17782     * @ingroup Slider
17783     */
17784    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17785
17786    /**
17787     * Get the value displayed by the spinner.
17788     *
17789     * @param obj The spinner object.
17790     * @return The value displayed.
17791     *
17792     * @see elm_spinner_value_set() for details.
17793     *
17794     * @ingroup Slider
17795     */
17796    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17797
17798    /**
17799     * Invert a given slider widget's displaying values order
17800     *
17801     * @param obj The slider object.
17802     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17803     * @c EINA_FALSE to bring it back to default, non-inverted values.
17804     *
17805     * A slider may be @b inverted, in which state it gets its
17806     * values inverted, with high vales being on the left or top and
17807     * low values on the right or bottom, as opposed to normally have
17808     * the low values on the former and high values on the latter,
17809     * respectively, for horizontal and vertical modes.
17810     *
17811     * @see elm_slider_inverted_get()
17812     *
17813     * @ingroup Slider
17814     */
17815    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17816
17817    /**
17818     * Get whether a given slider widget's displaying values are
17819     * inverted or not.
17820     *
17821     * @param obj The slider object.
17822     * @return @c EINA_TRUE, if @p obj has inverted values,
17823     * @c EINA_FALSE otherwise (and on errors).
17824     *
17825     * @see elm_slider_inverted_set() for more details.
17826     *
17827     * @ingroup Slider
17828     */
17829    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17830
17831    /**
17832     * Set whether to enlarge slider indicator (augmented knob) or not.
17833     *
17834     * @param obj The slider object.
17835     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17836     * let the knob always at default size.
17837     *
17838     * By default, indicator will be bigger while dragged by the user.
17839     *
17840     * @warning It won't display values set with
17841     * elm_slider_indicator_format_set() if you disable indicator.
17842     *
17843     * @ingroup Slider
17844     */
17845    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17846
17847    /**
17848     * Get whether a given slider widget's enlarging indicator or not.
17849     *
17850     * @param obj The slider object.
17851     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17852     * @c EINA_FALSE otherwise (and on errors).
17853     *
17854     * @see elm_slider_indicator_show_set() for details.
17855     *
17856     * @ingroup Slider
17857     */
17858    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17859
17860    /**
17861     * @}
17862     */
17863
17864    /**
17865     * @addtogroup Actionslider Actionslider
17866     *
17867     * @image html img/widget/actionslider/preview-00.png
17868     * @image latex img/widget/actionslider/preview-00.eps
17869     *
17870     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17871     * properties. The user drags and releases the indicator, to choose a label.
17872     *
17873     * Labels occupy the following positions.
17874     * a. Left
17875     * b. Right
17876     * c. Center
17877     *
17878     * Positions can be enabled or disabled.
17879     *
17880     * Magnets can be set on the above positions.
17881     *
17882     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17883     *
17884     * @note By default all positions are set as enabled.
17885     *
17886     * Signals that you can add callbacks for are:
17887     *
17888     * "selected" - when user selects an enabled position (the label is passed
17889     *              as event info)".
17890     * @n
17891     * "pos_changed" - when the indicator reaches any of the positions("left",
17892     *                 "right" or "center").
17893     *
17894     * See an example of actionslider usage @ref actionslider_example_page "here"
17895     * @{
17896     */
17897    typedef enum _Elm_Actionslider_Pos
17898      {
17899         ELM_ACTIONSLIDER_NONE = 0,
17900         ELM_ACTIONSLIDER_LEFT = 1 << 0,
17901         ELM_ACTIONSLIDER_CENTER = 1 << 1,
17902         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17903         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17904      } Elm_Actionslider_Pos;
17905
17906    /**
17907     * Add a new actionslider to the parent.
17908     *
17909     * @param parent The parent object
17910     * @return The new actionslider object or NULL if it cannot be created
17911     */
17912    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17913    /**
17914     * Set actionslider labels.
17915     *
17916     * @param obj The actionslider object
17917     * @param left_label The label to be set on the left.
17918     * @param center_label The label to be set on the center.
17919     * @param right_label The label to be set on the right.
17920     * @deprecated use elm_object_text_set() instead.
17921     */
17922    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);
17923    /**
17924     * Get actionslider labels.
17925     *
17926     * @param obj The actionslider object
17927     * @param left_label A char** to place the left_label of @p obj into.
17928     * @param center_label A char** to place the center_label of @p obj into.
17929     * @param right_label A char** to place the right_label of @p obj into.
17930     * @deprecated use elm_object_text_set() instead.
17931     */
17932    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);
17933    /**
17934     * Get actionslider selected label.
17935     *
17936     * @param obj The actionslider object
17937     * @return The selected label
17938     */
17939    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17940    /**
17941     * Set actionslider indicator position.
17942     *
17943     * @param obj The actionslider object.
17944     * @param pos The position of the indicator.
17945     */
17946    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17947    /**
17948     * Get actionslider indicator position.
17949     *
17950     * @param obj The actionslider object.
17951     * @return The position of the indicator.
17952     */
17953    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17954    /**
17955     * Set actionslider magnet position. To make multiple positions magnets @c or
17956     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
17957     *
17958     * @param obj The actionslider object.
17959     * @param pos Bit mask indicating the magnet positions.
17960     */
17961    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17962    /**
17963     * Get actionslider magnet position.
17964     *
17965     * @param obj The actionslider object.
17966     * @return The positions with magnet property.
17967     */
17968    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17969    /**
17970     * Set actionslider enabled position. To set multiple positions as enabled @c or
17971     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
17972     *
17973     * @note All the positions are enabled by default.
17974     *
17975     * @param obj The actionslider object.
17976     * @param pos Bit mask indicating the enabled positions.
17977     */
17978    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17979    /**
17980     * Get actionslider enabled position.
17981     *
17982     * @param obj The actionslider object.
17983     * @return The enabled positions.
17984     */
17985    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17986    /**
17987     * Set the label used on the indicator.
17988     *
17989     * @param obj The actionslider object
17990     * @param label The label to be set on the indicator.
17991     * @deprecated use elm_object_text_set() instead.
17992     */
17993    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17994    /**
17995     * Get the label used on the indicator object.
17996     *
17997     * @param obj The actionslider object
17998     * @return The indicator label
17999     * @deprecated use elm_object_text_get() instead.
18000     */
18001    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18002    /**
18003     * @}
18004     */
18005
18006    /**
18007     * @defgroup Genlist Genlist
18008     *
18009     * @image html img/widget/genlist/preview-00.png
18010     * @image latex img/widget/genlist/preview-00.eps
18011     * @image html img/genlist.png
18012     * @image latex img/genlist.eps
18013     *
18014     * This widget aims to have more expansive list than the simple list in
18015     * Elementary that could have more flexible items and allow many more entries
18016     * while still being fast and low on memory usage. At the same time it was
18017     * also made to be able to do tree structures. But the price to pay is more
18018     * complexity when it comes to usage. If all you want is a simple list with
18019     * icons and a single label, use the normal @ref List object.
18020     *
18021     * Genlist has a fairly large API, mostly because it's relatively complex,
18022     * trying to be both expansive, powerful and efficient. First we will begin
18023     * an overview on the theory behind genlist.
18024     *
18025     * @section Genlist_Item_Class Genlist item classes - creating items
18026     *
18027     * In order to have the ability to add and delete items on the fly, genlist
18028     * implements a class (callback) system where the application provides a
18029     * structure with information about that type of item (genlist may contain
18030     * multiple different items with different classes, states and styles).
18031     * Genlist will call the functions in this struct (methods) when an item is
18032     * "realized" (i.e., created dynamically, while the user is scrolling the
18033     * grid). All objects will simply be deleted when no longer needed with
18034     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18035     * following members:
18036     * - @c item_style - This is a constant string and simply defines the name
18037     *   of the item style. It @b must be specified and the default should be @c
18038     *   "default".
18039     *
18040     * - @c func - A struct with pointers to functions that will be called when
18041     *   an item is going to be actually created. All of them receive a @c data
18042     *   parameter that will point to the same data passed to
18043     *   elm_genlist_item_append() and related item creation functions, and a @c
18044     *   obj parameter that points to the genlist object itself.
18045     *
18046     * The function pointers inside @c func are @c label_get, @c icon_get, @c
18047     * state_get and @c del. The 3 first functions also receive a @c part
18048     * parameter described below. A brief description of these functions follows:
18049     *
18050     * - @c label_get - The @c part parameter is the name string of one of the
18051     *   existing text parts in the Edje group implementing the item's theme.
18052     *   This function @b must return a strdup'()ed string, as the caller will
18053     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18054     * - @c content_get - The @c part parameter is the name string of one of the
18055     *   existing (content) swallow parts in the Edje group implementing the item's
18056     *   theme. It must return @c NULL, when no content is desired, or a valid
18057     *   object handle, otherwise.  The object will be deleted by the genlist on
18058     *   its deletion or when the item is "unrealized".  See
18059     *   #Elm_Genlist_Item_Icon_Get_Cb.
18060     * - @c func.state_get - The @c part parameter is the name string of one of
18061     *   the state parts in the Edje group implementing the item's theme. Return
18062     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18063     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18064     *   and @c "elm" as "emission" and "source" arguments, respectively, when
18065     *   the state is true (the default is false), where @c XXX is the name of
18066     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
18067     * - @c func.del - This is intended for use when genlist items are deleted,
18068     *   so any data attached to the item (e.g. its data parameter on creation)
18069     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
18070     *
18071     * available item styles:
18072     * - default
18073     * - default_style - The text part is a textblock
18074     *
18075     * @image html img/widget/genlist/preview-04.png
18076     * @image latex img/widget/genlist/preview-04.eps
18077     *
18078     * - double_label
18079     *
18080     * @image html img/widget/genlist/preview-01.png
18081     * @image latex img/widget/genlist/preview-01.eps
18082     *
18083     * - icon_top_text_bottom
18084     *
18085     * @image html img/widget/genlist/preview-02.png
18086     * @image latex img/widget/genlist/preview-02.eps
18087     *
18088     * - group_index
18089     *
18090     * @image html img/widget/genlist/preview-03.png
18091     * @image latex img/widget/genlist/preview-03.eps
18092     *
18093     * @section Genlist_Items Structure of items
18094     *
18095     * An item in a genlist can have 0 or more text labels (they can be regular
18096     * text or textblock Evas objects - that's up to the style to determine), 0
18097     * or more contents (which are simply objects swallowed into the genlist item's
18098     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18099     * behavior left to the user to define. The Edje part names for each of
18100     * these properties will be looked up, in the theme file for the genlist,
18101     * under the Edje (string) data items named @c "labels", @c "contents" and @c
18102     * "states", respectively. For each of those properties, if more than one
18103     * part is provided, they must have names listed separated by spaces in the
18104     * data fields. For the default genlist item theme, we have @b one label
18105     * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18106     * "elm.swallow.end") and @b no state parts.
18107     *
18108     * A genlist item may be at one of several styles. Elementary provides one
18109     * by default - "default", but this can be extended by system or application
18110     * custom themes/overlays/extensions (see @ref Theme "themes" for more
18111     * details).
18112     *
18113     * @section Genlist_Manipulation Editing and Navigating
18114     *
18115     * Items can be added by several calls. All of them return a @ref
18116     * Elm_Genlist_Item handle that is an internal member inside the genlist.
18117     * They all take a data parameter that is meant to be used for a handle to
18118     * the applications internal data (eg the struct with the original item
18119     * data). The parent parameter is the parent genlist item this belongs to if
18120     * it is a tree or an indexed group, and NULL if there is no parent. The
18121     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18122     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18123     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18124     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
18125     * is set then this item is group index item that is displayed at the top
18126     * until the next group comes. The func parameter is a convenience callback
18127     * that is called when the item is selected and the data parameter will be
18128     * the func_data parameter, obj be the genlist object and event_info will be
18129     * the genlist item.
18130     *
18131     * elm_genlist_item_append() adds an item to the end of the list, or if
18132     * there is a parent, to the end of all the child items of the parent.
18133     * elm_genlist_item_prepend() is the same but adds to the beginning of
18134     * the list or children list. elm_genlist_item_insert_before() inserts at
18135     * item before another item and elm_genlist_item_insert_after() inserts after
18136     * the indicated item.
18137     *
18138     * The application can clear the list with elm_genlist_clear() which deletes
18139     * all the items in the list and elm_genlist_item_del() will delete a specific
18140     * item. elm_genlist_item_subitems_clear() will clear all items that are
18141     * children of the indicated parent item.
18142     *
18143     * To help inspect list items you can jump to the item at the top of the list
18144     * with elm_genlist_first_item_get() which will return the item pointer, and
18145     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18146     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18147     * and previous items respectively relative to the indicated item. Using
18148     * these calls you can walk the entire item list/tree. Note that as a tree
18149     * the items are flattened in the list, so elm_genlist_item_parent_get() will
18150     * let you know which item is the parent (and thus know how to skip them if
18151     * wanted).
18152     *
18153     * @section Genlist_Muti_Selection Multi-selection
18154     *
18155     * If the application wants multiple items to be able to be selected,
18156     * elm_genlist_multi_select_set() can enable this. If the list is
18157     * single-selection only (the default), then elm_genlist_selected_item_get()
18158     * will return the selected item, if any, or NULL I none is selected. If the
18159     * list is multi-select then elm_genlist_selected_items_get() will return a
18160     * list (that is only valid as long as no items are modified (added, deleted,
18161     * selected or unselected)).
18162     *
18163     * @section Genlist_Usage_Hints Usage hints
18164     *
18165     * There are also convenience functions. elm_genlist_item_genlist_get() will
18166     * return the genlist object the item belongs to. elm_genlist_item_show()
18167     * will make the scroller scroll to show that specific item so its visible.
18168     * elm_genlist_item_data_get() returns the data pointer set by the item
18169     * creation functions.
18170     *
18171     * If an item changes (state of boolean changes, label or contents change),
18172     * then use elm_genlist_item_update() to have genlist update the item with
18173     * the new state. Genlist will re-realize the item thus call the functions
18174     * in the _Elm_Genlist_Item_Class for that item.
18175     *
18176     * To programmatically (un)select an item use elm_genlist_item_selected_set().
18177     * To get its selected state use elm_genlist_item_selected_get(). Similarly
18178     * to expand/contract an item and get its expanded state, use
18179     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18180     * again to make an item disabled (unable to be selected and appear
18181     * differently) use elm_genlist_item_disabled_set() to set this and
18182     * elm_genlist_item_disabled_get() to get the disabled state.
18183     *
18184     * In general to indicate how the genlist should expand items horizontally to
18185     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18186     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18187     * mode means that if items are too wide to fit, the scroller will scroll
18188     * horizontally. Otherwise items are expanded to fill the width of the
18189     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18190     * to the viewport width and limited to that size. This can be combined with
18191     * a different style that uses edjes' ellipsis feature (cutting text off like
18192     * this: "tex...").
18193     *
18194     * Items will only call their selection func and callback when first becoming
18195     * selected. Any further clicks will do nothing, unless you enable always
18196     * select with elm_genlist_always_select_mode_set(). This means even if
18197     * selected, every click will make the selected callbacks be called.
18198     * elm_genlist_no_select_mode_set() will turn off the ability to select
18199     * items entirely and they will neither appear selected nor call selected
18200     * callback functions.
18201     *
18202     * Remember that you can create new styles and add your own theme augmentation
18203     * per application with elm_theme_extension_add(). If you absolutely must
18204     * have a specific style that overrides any theme the user or system sets up
18205     * you can use elm_theme_overlay_add() to add such a file.
18206     *
18207     * @section Genlist_Implementation Implementation
18208     *
18209     * Evas tracks every object you create. Every time it processes an event
18210     * (mouse move, down, up etc.) it needs to walk through objects and find out
18211     * what event that affects. Even worse every time it renders display updates,
18212     * in order to just calculate what to re-draw, it needs to walk through many
18213     * many many objects. Thus, the more objects you keep active, the more
18214     * overhead Evas has in just doing its work. It is advisable to keep your
18215     * active objects to the minimum working set you need. Also remember that
18216     * object creation and deletion carries an overhead, so there is a
18217     * middle-ground, which is not easily determined. But don't keep massive lists
18218     * of objects you can't see or use. Genlist does this with list objects. It
18219     * creates and destroys them dynamically as you scroll around. It groups them
18220     * into blocks so it can determine the visibility etc. of a whole block at
18221     * once as opposed to having to walk the whole list. This 2-level list allows
18222     * for very large numbers of items to be in the list (tests have used up to
18223     * 2,000,000 items). Also genlist employs a queue for adding items. As items
18224     * may be different sizes, every item added needs to be calculated as to its
18225     * size and thus this presents a lot of overhead on populating the list, this
18226     * genlist employs a queue. Any item added is queued and spooled off over
18227     * time, actually appearing some time later, so if your list has many members
18228     * you may find it takes a while for them to all appear, with your process
18229     * consuming a lot of CPU while it is busy spooling.
18230     *
18231     * Genlist also implements a tree structure, but it does so with callbacks to
18232     * the application, with the application filling in tree structures when
18233     * requested (allowing for efficient building of a very deep tree that could
18234     * even be used for file-management). See the above smart signal callbacks for
18235     * details.
18236     *
18237     * @section Genlist_Smart_Events Genlist smart events
18238     *
18239     * Signals that you can add callbacks for are:
18240     * - @c "activated" - The user has double-clicked or pressed
18241     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
18242     *   item that was activated.
18243     * - @c "clicked,double" - The user has double-clicked an item.  The @c
18244     *   event_info parameter is the item that was double-clicked.
18245     * - @c "selected" - This is called when a user has made an item selected.
18246     *   The event_info parameter is the genlist item that was selected.
18247     * - @c "unselected" - This is called when a user has made an item
18248     *   unselected. The event_info parameter is the genlist item that was
18249     *   unselected.
18250     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18251     *   called and the item is now meant to be expanded. The event_info
18252     *   parameter is the genlist item that was indicated to expand.  It is the
18253     *   job of this callback to then fill in the child items.
18254     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18255     *   called and the item is now meant to be contracted. The event_info
18256     *   parameter is the genlist item that was indicated to contract. It is the
18257     *   job of this callback to then delete the child items.
18258     * - @c "expand,request" - This is called when a user has indicated they want
18259     *   to expand a tree branch item. The callback should decide if the item can
18260     *   expand (has any children) and then call elm_genlist_item_expanded_set()
18261     *   appropriately to set the state. The event_info parameter is the genlist
18262     *   item that was indicated to expand.
18263     * - @c "contract,request" - This is called when a user has indicated they
18264     *   want to contract a tree branch item. The callback should decide if the
18265     *   item can contract (has any children) and then call
18266     *   elm_genlist_item_expanded_set() appropriately to set the state. The
18267     *   event_info parameter is the genlist item that was indicated to contract.
18268     * - @c "realized" - This is called when the item in the list is created as a
18269     *   real evas object. event_info parameter is the genlist item that was
18270     *   created. The object may be deleted at any time, so it is up to the
18271     *   caller to not use the object pointer from elm_genlist_item_object_get()
18272     *   in a way where it may point to freed objects.
18273     * - @c "unrealized" - This is called just before an item is unrealized.
18274     *   After this call content objects provided will be deleted and the item
18275     *   object itself delete or be put into a floating cache.
18276     * - @c "drag,start,up" - This is called when the item in the list has been
18277     *   dragged (not scrolled) up.
18278     * - @c "drag,start,down" - This is called when the item in the list has been
18279     *   dragged (not scrolled) down.
18280     * - @c "drag,start,left" - This is called when the item in the list has been
18281     *   dragged (not scrolled) left.
18282     * - @c "drag,start,right" - This is called when the item in the list has
18283     *   been dragged (not scrolled) right.
18284     * - @c "drag,stop" - This is called when the item in the list has stopped
18285     *   being dragged.
18286     * - @c "drag" - This is called when the item in the list is being dragged.
18287     * - @c "longpressed" - This is called when the item is pressed for a certain
18288     *   amount of time. By default it's 1 second.
18289     * - @c "scroll,anim,start" - This is called when scrolling animation has
18290     *   started.
18291     * - @c "scroll,anim,stop" - This is called when scrolling animation has
18292     *   stopped.
18293     * - @c "scroll,drag,start" - This is called when dragging the content has
18294     *   started.
18295     * - @c "scroll,drag,stop" - This is called when dragging the content has
18296     *   stopped.
18297     * - @c "edge,top" - This is called when the genlist is scrolled until
18298     *   the top edge.
18299     * - @c "edge,bottom" - This is called when the genlist is scrolled
18300     *   until the bottom edge.
18301     * - @c "edge,left" - This is called when the genlist is scrolled
18302     *   until the left edge.
18303     * - @c "edge,right" - This is called when the genlist is scrolled
18304     *   until the right edge.
18305     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18306     *   swiped left.
18307     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18308     *   swiped right.
18309     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18310     *   swiped up.
18311     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18312     *   swiped down.
18313     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18314     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
18315     *   multi-touch pinched in.
18316     * - @c "swipe" - This is called when the genlist is swiped.
18317     * - @c "moved" - This is called when a genlist item is moved.
18318     * - @c "language,changed" - This is called when the program's language is
18319     *   changed.
18320     *
18321     * @section Genlist_Examples Examples
18322     *
18323     * Here is a list of examples that use the genlist, trying to show some of
18324     * its capabilities:
18325     * - @ref genlist_example_01
18326     * - @ref genlist_example_02
18327     * - @ref genlist_example_03
18328     * - @ref genlist_example_04
18329     * - @ref genlist_example_05
18330     */
18331
18332    /**
18333     * @addtogroup Genlist
18334     * @{
18335     */
18336
18337    /**
18338     * @enum _Elm_Genlist_Item_Flags
18339     * @typedef Elm_Genlist_Item_Flags
18340     *
18341     * Defines if the item is of any special type (has subitems or it's the
18342     * index of a group), or is just a simple item.
18343     *
18344     * @ingroup Genlist
18345     */
18346    typedef enum _Elm_Genlist_Item_Flags
18347      {
18348         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18349         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18350         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18351      } Elm_Genlist_Item_Flags;
18352    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
18353    #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18354    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18355    #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18356    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18357    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
18358    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. */
18359    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. */
18360    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
18361
18362    /**
18363     * @struct _Elm_Genlist_Item_Class
18364     *
18365     * Genlist item class definition structs.
18366     *
18367     * This struct contains the style and fetching functions that will define the
18368     * contents of each item.
18369     *
18370     * @see @ref Genlist_Item_Class
18371     */
18372    struct _Elm_Genlist_Item_Class
18373      {
18374         const char                *item_style; /**< style of this class. */
18375         struct Elm_Genlist_Item_Class_Func
18376           {
18377              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
18378              Elm_Genlist_Item_Content_Get_Cb   content_get; /**< Content fetching class function for genlist item classes. */
18379              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
18380              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
18381           } func;
18382      };
18383    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18384    /**
18385     * Add a new genlist widget to the given parent Elementary
18386     * (container) object
18387     *
18388     * @param parent The parent object
18389     * @return a new genlist widget handle or @c NULL, on errors
18390     *
18391     * This function inserts a new genlist widget on the canvas.
18392     *
18393     * @see elm_genlist_item_append()
18394     * @see elm_genlist_item_del()
18395     * @see elm_genlist_clear()
18396     *
18397     * @ingroup Genlist
18398     */
18399    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18400    /**
18401     * Remove all items from a given genlist widget.
18402     *
18403     * @param obj The genlist object
18404     *
18405     * This removes (and deletes) all items in @p obj, leaving it empty.
18406     *
18407     * @see elm_genlist_item_del(), to remove just one item.
18408     *
18409     * @ingroup Genlist
18410     */
18411    EINA_DEPRECATED EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18412    /**
18413     * Enable or disable multi-selection in the genlist
18414     *
18415     * @param obj The genlist object
18416     * @param multi Multi-select enable/disable. Default is disabled.
18417     *
18418     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18419     * the list. This allows more than 1 item to be selected. To retrieve the list
18420     * of selected items, use elm_genlist_selected_items_get().
18421     *
18422     * @see elm_genlist_selected_items_get()
18423     * @see elm_genlist_multi_select_get()
18424     *
18425     * @ingroup Genlist
18426     */
18427    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18428    /**
18429     * Gets if multi-selection in genlist is enabled or disabled.
18430     *
18431     * @param obj The genlist object
18432     * @return Multi-select enabled/disabled
18433     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18434     *
18435     * @see elm_genlist_multi_select_set()
18436     *
18437     * @ingroup Genlist
18438     */
18439    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18440    /**
18441     * This sets the horizontal stretching mode.
18442     *
18443     * @param obj The genlist object
18444     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18445     *
18446     * This sets the mode used for sizing items horizontally. Valid modes
18447     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18448     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18449     * the scroller will scroll horizontally. Otherwise items are expanded
18450     * to fill the width of the viewport of the scroller. If it is
18451     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18452     * limited to that size.
18453     *
18454     * @see elm_genlist_horizontal_get()
18455     *
18456     * @ingroup Genlist
18457     */
18458    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18459    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18460    /**
18461     * Gets the horizontal stretching mode.
18462     *
18463     * @param obj The genlist object
18464     * @return The mode to use
18465     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18466     *
18467     * @see elm_genlist_horizontal_set()
18468     *
18469     * @ingroup Genlist
18470     */
18471    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18472    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18473    /**
18474     * Set the always select mode.
18475     *
18476     * @param obj The genlist object
18477     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18478     * EINA_FALSE = off). Default is @c EINA_FALSE.
18479     *
18480     * Items will only call their selection func and callback when first
18481     * becoming selected. Any further clicks will do nothing, unless you
18482     * enable always select with elm_genlist_always_select_mode_set().
18483     * This means that, even if selected, every click will make the selected
18484     * callbacks be called.
18485     *
18486     * @see elm_genlist_always_select_mode_get()
18487     *
18488     * @ingroup Genlist
18489     */
18490    EINA_DEPRECATED EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18491    /**
18492     * Get the always select mode.
18493     *
18494     * @param obj The genlist object
18495     * @return The always select mode
18496     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18497     *
18498     * @see elm_genlist_always_select_mode_set()
18499     *
18500     * @ingroup Genlist
18501     */
18502    EINA_DEPRECATED EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18503    /**
18504     * Enable/disable the no select mode.
18505     *
18506     * @param obj The genlist object
18507     * @param no_select The no select mode
18508     * (EINA_TRUE = on, EINA_FALSE = off)
18509     *
18510     * This will turn off the ability to select items entirely and they
18511     * will neither appear selected nor call selected callback functions.
18512     *
18513     * @see elm_genlist_no_select_mode_get()
18514     *
18515     * @ingroup Genlist
18516     */
18517    EINA_DEPRECATED EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18518    /**
18519     * Gets whether the no select mode is enabled.
18520     *
18521     * @param obj The genlist object
18522     * @return The no select mode
18523     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18524     *
18525     * @see elm_genlist_no_select_mode_set()
18526     *
18527     * @ingroup Genlist
18528     */
18529    EINA_DEPRECATED EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18530    /**
18531     * Enable/disable compress mode.
18532     *
18533     * @param obj The genlist object
18534     * @param compress The compress mode
18535     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18536     *
18537     * This will enable the compress mode where items are "compressed"
18538     * horizontally to fit the genlist scrollable viewport width. This is
18539     * special for genlist.  Do not rely on
18540     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18541     * work as genlist needs to handle it specially.
18542     *
18543     * @see elm_genlist_compress_mode_get()
18544     *
18545     * @ingroup Genlist
18546     */
18547    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18548    /**
18549     * Get whether the compress mode is enabled.
18550     *
18551     * @param obj The genlist object
18552     * @return The compress mode
18553     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18554     *
18555     * @see elm_genlist_compress_mode_set()
18556     *
18557     * @ingroup Genlist
18558     */
18559    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18560    /**
18561     * Enable/disable height-for-width mode.
18562     *
18563     * @param obj The genlist object
18564     * @param setting The height-for-width mode (@c EINA_TRUE = on,
18565     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18566     *
18567     * With height-for-width mode the item width will be fixed (restricted
18568     * to a minimum of) to the list width when calculating its size in
18569     * order to allow the height to be calculated based on it. This allows,
18570     * for instance, text block to wrap lines if the Edje part is
18571     * configured with "text.min: 0 1".
18572     *
18573     * @note This mode will make list resize slower as it will have to
18574     *       recalculate every item height again whenever the list width
18575     *       changes!
18576     *
18577     * @note When height-for-width mode is enabled, it also enables
18578     *       compress mode (see elm_genlist_compress_mode_set()) and
18579     *       disables homogeneous (see elm_genlist_homogeneous_set()).
18580     *
18581     * @ingroup Genlist
18582     */
18583    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18584    /**
18585     * Get whether the height-for-width mode is enabled.
18586     *
18587     * @param obj The genlist object
18588     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18589     * off)
18590     *
18591     * @ingroup Genlist
18592     */
18593    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18594    /**
18595     * Enable/disable horizontal and vertical bouncing effect.
18596     *
18597     * @param obj The genlist object
18598     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18599     * EINA_FALSE = off). Default is @c EINA_FALSE.
18600     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18601     * EINA_FALSE = off). Default is @c EINA_TRUE.
18602     *
18603     * This will enable or disable the scroller bouncing effect for the
18604     * genlist. See elm_scroller_bounce_set() for details.
18605     *
18606     * @see elm_scroller_bounce_set()
18607     * @see elm_genlist_bounce_get()
18608     *
18609     * @ingroup Genlist
18610     */
18611    EINA_DEPRECATED EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18612    /**
18613     * Get whether the horizontal and vertical bouncing effect is enabled.
18614     *
18615     * @param obj The genlist object
18616     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18617     * option is set.
18618     * @param v_bounce Pointer to a bool to receive if the bounce vertically
18619     * option is set.
18620     *
18621     * @see elm_genlist_bounce_set()
18622     *
18623     * @ingroup Genlist
18624     */
18625    EINA_DEPRECATED EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18626    /**
18627     * Enable/disable homogenous mode.
18628     *
18629     * @param obj The genlist object
18630     * @param homogeneous Assume the items within the genlist are of the
18631     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18632     * EINA_FALSE.
18633     *
18634     * This will enable the homogeneous mode where items are of the same
18635     * height and width so that genlist may do the lazy-loading at its
18636     * maximum (which increases the performance for scrolling the list). This
18637     * implies 'compressed' mode.
18638     *
18639     * @see elm_genlist_compress_mode_set()
18640     * @see elm_genlist_homogeneous_get()
18641     *
18642     * @ingroup Genlist
18643     */
18644    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18645    /**
18646     * Get whether the homogenous mode is enabled.
18647     *
18648     * @param obj The genlist object
18649     * @return Assume the items within the genlist are of the same height
18650     * and width (EINA_TRUE = on, EINA_FALSE = off)
18651     *
18652     * @see elm_genlist_homogeneous_set()
18653     *
18654     * @ingroup Genlist
18655     */
18656    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18657    /**
18658     * Set the maximum number of items within an item block
18659     *
18660     * @param obj The genlist object
18661     * @param n   Maximum number of items within an item block. Default is 32.
18662     *
18663     * This will configure the block count to tune to the target with
18664     * particular performance matrix.
18665     *
18666     * A block of objects will be used to reduce the number of operations due to
18667     * many objects in the screen. It can determine the visibility, or if the
18668     * object has changed, it theme needs to be updated, etc. doing this kind of
18669     * calculation to the entire block, instead of per object.
18670     *
18671     * The default value for the block count is enough for most lists, so unless
18672     * you know you will have a lot of objects visible in the screen at the same
18673     * time, don't try to change this.
18674     *
18675     * @see elm_genlist_block_count_get()
18676     * @see @ref Genlist_Implementation
18677     *
18678     * @ingroup Genlist
18679     */
18680    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18681    /**
18682     * Get the maximum number of items within an item block
18683     *
18684     * @param obj The genlist object
18685     * @return Maximum number of items within an item block
18686     *
18687     * @see elm_genlist_block_count_set()
18688     *
18689     * @ingroup Genlist
18690     */
18691    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18692    /**
18693     * Set the timeout in seconds for the longpress event.
18694     *
18695     * @param obj The genlist object
18696     * @param timeout timeout in seconds. Default is 1.
18697     *
18698     * This option will change how long it takes to send an event "longpressed"
18699     * after the mouse down signal is sent to the list. If this event occurs, no
18700     * "clicked" event will be sent.
18701     *
18702     * @see elm_genlist_longpress_timeout_set()
18703     *
18704     * @ingroup Genlist
18705     */
18706    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18707    /**
18708     * Get the timeout in seconds for the longpress event.
18709     *
18710     * @param obj The genlist object
18711     * @return timeout in seconds
18712     *
18713     * @see elm_genlist_longpress_timeout_get()
18714     *
18715     * @ingroup Genlist
18716     */
18717    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18718    /**
18719     * Append a new item in a given genlist widget.
18720     *
18721     * @param obj The genlist object
18722     * @param itc The item class for the item
18723     * @param data The item data
18724     * @param parent The parent item, or NULL if none
18725     * @param flags Item flags
18726     * @param func Convenience function called when the item is selected
18727     * @param func_data Data passed to @p func above.
18728     * @return A handle to the item added or @c NULL if not possible
18729     *
18730     * This adds the given item to the end of the list or the end of
18731     * the children list if the @p parent is given.
18732     *
18733     * @see elm_genlist_item_prepend()
18734     * @see elm_genlist_item_insert_before()
18735     * @see elm_genlist_item_insert_after()
18736     * @see elm_genlist_item_del()
18737     *
18738     * @ingroup Genlist
18739     */
18740    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);
18741    /**
18742     * Prepend a new item in a given genlist widget.
18743     *
18744     * @param obj The genlist object
18745     * @param itc The item class for the item
18746     * @param data The item data
18747     * @param parent The parent item, or NULL if none
18748     * @param flags Item flags
18749     * @param func Convenience function called when the item is selected
18750     * @param func_data Data passed to @p func above.
18751     * @return A handle to the item added or NULL if not possible
18752     *
18753     * This adds an item to the beginning of the list or beginning of the
18754     * children of the parent if given.
18755     *
18756     * @see elm_genlist_item_append()
18757     * @see elm_genlist_item_insert_before()
18758     * @see elm_genlist_item_insert_after()
18759     * @see elm_genlist_item_del()
18760     *
18761     * @ingroup Genlist
18762     */
18763    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);
18764    /**
18765     * Insert an item before another in a genlist widget
18766     *
18767     * @param obj The genlist object
18768     * @param itc The item class for the item
18769     * @param data The item data
18770     * @param before The item to place this new one before.
18771     * @param flags Item flags
18772     * @param func Convenience function called when the item is selected
18773     * @param func_data Data passed to @p func above.
18774     * @return A handle to the item added or @c NULL if not possible
18775     *
18776     * This inserts an item before another in the list. It will be in the
18777     * same tree level or group as the item it is inserted before.
18778     *
18779     * @see elm_genlist_item_append()
18780     * @see elm_genlist_item_prepend()
18781     * @see elm_genlist_item_insert_after()
18782     * @see elm_genlist_item_del()
18783     *
18784     * @ingroup Genlist
18785     */
18786    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);
18787    /**
18788     * Insert an item after another in a genlist widget
18789     *
18790     * @param obj The genlist object
18791     * @param itc The item class for the item
18792     * @param data The item data
18793     * @param after The item to place this new one after.
18794     * @param flags Item flags
18795     * @param func Convenience function called when the item is selected
18796     * @param func_data Data passed to @p func above.
18797     * @return A handle to the item added or @c NULL if not possible
18798     *
18799     * This inserts an item after another in the list. It will be in the
18800     * same tree level or group as the item it is inserted after.
18801     *
18802     * @see elm_genlist_item_append()
18803     * @see elm_genlist_item_prepend()
18804     * @see elm_genlist_item_insert_before()
18805     * @see elm_genlist_item_del()
18806     *
18807     * @ingroup Genlist
18808     */
18809    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);
18810    /**
18811     * Insert a new item into the sorted genlist object
18812     *
18813     * @param obj The genlist object
18814     * @param itc The item class for the item
18815     * @param data The item data
18816     * @param parent The parent item, or NULL if none
18817     * @param flags Item flags
18818     * @param comp The function called for the sort
18819     * @param func Convenience function called when item selected
18820     * @param func_data Data passed to @p func above.
18821     * @return A handle to the item added or NULL if not possible
18822     *
18823     * @ingroup Genlist
18824     */
18825    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);
18826    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);
18827    /* operations to retrieve existing items */
18828    /**
18829     * Get the selectd item in the genlist.
18830     *
18831     * @param obj The genlist object
18832     * @return The selected item, or NULL if none is selected.
18833     *
18834     * This gets the selected item in the list (if multi-selection is enabled, only
18835     * the item that was first selected in the list is returned - which is not very
18836     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18837     * used).
18838     *
18839     * If no item is selected, NULL is returned.
18840     *
18841     * @see elm_genlist_selected_items_get()
18842     *
18843     * @ingroup Genlist
18844     */
18845    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18846    /**
18847     * Get a list of selected items in the genlist.
18848     *
18849     * @param obj The genlist object
18850     * @return The list of selected items, or NULL if none are selected.
18851     *
18852     * It returns a list of the selected items. This list pointer is only valid so
18853     * long as the selection doesn't change (no items are selected or unselected, or
18854     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18855     * pointers. The order of the items in this list is the order which they were
18856     * selected, i.e. the first item in this list is the first item that was
18857     * selected, and so on.
18858     *
18859     * @note If not in multi-select mode, consider using function
18860     * elm_genlist_selected_item_get() instead.
18861     *
18862     * @see elm_genlist_multi_select_set()
18863     * @see elm_genlist_selected_item_get()
18864     *
18865     * @ingroup Genlist
18866     */
18867    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18868    /**
18869     * Get the mode item style of items in the genlist
18870     * @param obj The genlist object
18871     * @return The mode item style string, or NULL if none is specified
18872     * 
18873     * This is a constant string and simply defines the name of the
18874     * style that will be used for mode animations. It can be
18875     * @c NULL if you don't plan to use Genlist mode. See
18876     * elm_genlist_item_mode_set() for more info.
18877     * 
18878     * @ingroup Genlist
18879     */
18880    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18881    /**
18882     * Set the mode item style of items in the genlist
18883     * @param obj The genlist object
18884     * @param style The mode item style string, or NULL if none is desired
18885     * 
18886     * This is a constant string and simply defines the name of the
18887     * style that will be used for mode animations. It can be
18888     * @c NULL if you don't plan to use Genlist mode. See
18889     * elm_genlist_item_mode_set() for more info.
18890     * 
18891     * @ingroup Genlist
18892     */
18893    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18894    /**
18895     * Get a list of realized items in genlist
18896     *
18897     * @param obj The genlist object
18898     * @return The list of realized items, nor NULL if none are realized.
18899     *
18900     * This returns a list of the realized items in the genlist. The list
18901     * contains Elm_Genlist_Item pointers. The list must be freed by the
18902     * caller when done with eina_list_free(). The item pointers in the
18903     * list are only valid so long as those items are not deleted or the
18904     * genlist is not deleted.
18905     *
18906     * @see elm_genlist_realized_items_update()
18907     *
18908     * @ingroup Genlist
18909     */
18910    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18911    /**
18912     * Get the item that is at the x, y canvas coords.
18913     *
18914     * @param obj The gelinst object.
18915     * @param x The input x coordinate
18916     * @param y The input y coordinate
18917     * @param posret The position relative to the item returned here
18918     * @return The item at the coordinates or NULL if none
18919     *
18920     * This returns the item at the given coordinates (which are canvas
18921     * relative, not object-relative). If an item is at that coordinate,
18922     * that item handle is returned, and if @p posret is not NULL, the
18923     * integer pointed to is set to a value of -1, 0 or 1, depending if
18924     * the coordinate is on the upper portion of that item (-1), on the
18925     * middle section (0) or on the lower part (1). If NULL is returned as
18926     * an item (no item found there), then posret may indicate -1 or 1
18927     * based if the coordinate is above or below all items respectively in
18928     * the genlist.
18929     *
18930     * @ingroup Genlist
18931     */
18932    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);
18933    /**
18934     * Get the first item in the genlist
18935     *
18936     * This returns the first item in the list.
18937     *
18938     * @param obj The genlist object
18939     * @return The first item, or NULL if none
18940     *
18941     * @ingroup Genlist
18942     */
18943    EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18944    /**
18945     * Get the last item in the genlist
18946     *
18947     * This returns the last item in the list.
18948     *
18949     * @return The last item, or NULL if none
18950     *
18951     * @ingroup Genlist
18952     */
18953    EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18954    /**
18955     * Set the scrollbar policy
18956     *
18957     * @param obj The genlist object
18958     * @param policy_h Horizontal scrollbar policy.
18959     * @param policy_v Vertical scrollbar policy.
18960     *
18961     * This sets the scrollbar visibility policy for the given genlist
18962     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18963     * made visible if it is needed, and otherwise kept hidden.
18964     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18965     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18966     * respectively for the horizontal and vertical scrollbars. Default is
18967     * #ELM_SMART_SCROLLER_POLICY_AUTO
18968     *
18969     * @see elm_genlist_scroller_policy_get()
18970     *
18971     * @ingroup Genlist
18972     */
18973    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18974    /**
18975     * Get the scrollbar policy
18976     *
18977     * @param obj The genlist object
18978     * @param policy_h Pointer to store the horizontal scrollbar policy.
18979     * @param policy_v Pointer to store the vertical scrollbar policy.
18980     *
18981     * @see elm_genlist_scroller_policy_set()
18982     *
18983     * @ingroup Genlist
18984     */
18985    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);
18986    /**
18987     * Get the @b next item in a genlist widget's internal list of items,
18988     * given a handle to one of those items.
18989     *
18990     * @param item The genlist item to fetch next from
18991     * @return The item after @p item, or @c NULL if there's none (and
18992     * on errors)
18993     *
18994     * This returns the item placed after the @p item, on the container
18995     * genlist.
18996     *
18997     * @see elm_genlist_item_prev_get()
18998     *
18999     * @ingroup Genlist
19000     */
19001    EINA_DEPRECATED EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19002    /**
19003     * Get the @b previous item in a genlist widget's internal list of items,
19004     * given a handle to one of those items.
19005     *
19006     * @param item The genlist item to fetch previous from
19007     * @return The item before @p item, or @c NULL if there's none (and
19008     * on errors)
19009     *
19010     * This returns the item placed before the @p item, on the container
19011     * genlist.
19012     *
19013     * @see elm_genlist_item_next_get()
19014     *
19015     * @ingroup Genlist
19016     */
19017    EINA_DEPRECATED EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19018    /**
19019     * Get the genlist object's handle which contains a given genlist
19020     * item
19021     *
19022     * @param item The item to fetch the container from
19023     * @return The genlist (parent) object
19024     *
19025     * This returns the genlist object itself that an item belongs to.
19026     *
19027     * @ingroup Genlist
19028     */
19029    EINA_DEPRECATED EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19030    /**
19031     * Get the parent item of the given item
19032     *
19033     * @param it The item
19034     * @return The parent of the item or @c NULL if it has no parent.
19035     *
19036     * This returns the item that was specified as parent of the item @p it on
19037     * elm_genlist_item_append() and insertion related functions.
19038     *
19039     * @ingroup Genlist
19040     */
19041    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19042    /**
19043     * Remove all sub-items (children) of the given item
19044     *
19045     * @param it The item
19046     *
19047     * This removes all items that are children (and their descendants) of the
19048     * given item @p it.
19049     *
19050     * @see elm_genlist_clear()
19051     * @see elm_genlist_item_del()
19052     *
19053     * @ingroup Genlist
19054     */
19055    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19056    /**
19057     * Set whether a given genlist item is selected or not
19058     *
19059     * @param it The item
19060     * @param selected Use @c EINA_TRUE, to make it selected, @c
19061     * EINA_FALSE to make it unselected
19062     *
19063     * This sets the selected state of an item. If multi selection is
19064     * not enabled on the containing genlist and @p selected is @c
19065     * EINA_TRUE, any other previously selected items will get
19066     * unselected in favor of this new one.
19067     *
19068     * @see elm_genlist_item_selected_get()
19069     *
19070     * @ingroup Genlist
19071     */
19072    EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19073    /**
19074     * Get whether a given genlist item is selected or not
19075     *
19076     * @param it The item
19077     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19078     *
19079     * @see elm_genlist_item_selected_set() for more details
19080     *
19081     * @ingroup Genlist
19082     */
19083    EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19084    /**
19085     * Sets the expanded state of an item.
19086     *
19087     * @param it The item
19088     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19089     *
19090     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19091     * expanded or not.
19092     *
19093     * The theme will respond to this change visually, and a signal "expanded" or
19094     * "contracted" will be sent from the genlist with a pointer to the item that
19095     * has been expanded/contracted.
19096     *
19097     * Calling this function won't show or hide any child of this item (if it is
19098     * a parent). You must manually delete and create them on the callbacks fo
19099     * the "expanded" or "contracted" signals.
19100     *
19101     * @see elm_genlist_item_expanded_get()
19102     *
19103     * @ingroup Genlist
19104     */
19105    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19106    /**
19107     * Get the expanded state of an item
19108     *
19109     * @param it The item
19110     * @return The expanded state
19111     *
19112     * This gets the expanded state of an item.
19113     *
19114     * @see elm_genlist_item_expanded_set()
19115     *
19116     * @ingroup Genlist
19117     */
19118    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19119    /**
19120     * Get the depth of expanded item
19121     *
19122     * @param it The genlist item object
19123     * @return The depth of expanded item
19124     *
19125     * @ingroup Genlist
19126     */
19127    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19128    /**
19129     * Set whether a given genlist item is disabled or not.
19130     *
19131     * @param it The item
19132     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19133     * to enable it back.
19134     *
19135     * A disabled item cannot be selected or unselected. It will also
19136     * change its appearance, to signal the user it's disabled.
19137     *
19138     * @see elm_genlist_item_disabled_get()
19139     *
19140     * @ingroup Genlist
19141     */
19142    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19143    /**
19144     * Get whether a given genlist item is disabled or not.
19145     *
19146     * @param it The item
19147     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19148     * (and on errors).
19149     *
19150     * @see elm_genlist_item_disabled_set() for more details
19151     *
19152     * @ingroup Genlist
19153     */
19154    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19155    /**
19156     * Sets the display only state of an item.
19157     *
19158     * @param it The item
19159     * @param display_only @c EINA_TRUE if the item is display only, @c
19160     * EINA_FALSE otherwise.
19161     *
19162     * A display only item cannot be selected or unselected. It is for
19163     * display only and not selecting or otherwise clicking, dragging
19164     * etc. by the user, thus finger size rules will not be applied to
19165     * this item.
19166     *
19167     * It's good to set group index items to display only state.
19168     *
19169     * @see elm_genlist_item_display_only_get()
19170     *
19171     * @ingroup Genlist
19172     */
19173    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19174    /**
19175     * Get the display only state of an item
19176     *
19177     * @param it The item
19178     * @return @c EINA_TRUE if the item is display only, @c
19179     * EINA_FALSE otherwise.
19180     *
19181     * @see elm_genlist_item_display_only_set()
19182     *
19183     * @ingroup Genlist
19184     */
19185    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19186    /**
19187     * Show the portion of a genlist's internal list containing a given
19188     * item, immediately.
19189     *
19190     * @param it The item to display
19191     *
19192     * This causes genlist to jump to the given item @p it and show it (by
19193     * immediately scrolling to that position), if it is not fully visible.
19194     *
19195     * @see elm_genlist_item_bring_in()
19196     * @see elm_genlist_item_top_show()
19197     * @see elm_genlist_item_middle_show()
19198     *
19199     * @ingroup Genlist
19200     */
19201    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19202    /**
19203     * Animatedly bring in, to the visible are of a genlist, a given
19204     * item on it.
19205     *
19206     * @param it The item to display
19207     *
19208     * This causes genlist to jump to the given item @p it and show it (by
19209     * animatedly scrolling), if it is not fully visible. This may use animation
19210     * to do so and take a period of time
19211     *
19212     * @see elm_genlist_item_show()
19213     * @see elm_genlist_item_top_bring_in()
19214     * @see elm_genlist_item_middle_bring_in()
19215     *
19216     * @ingroup Genlist
19217     */
19218    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19219    /**
19220     * Show the portion of a genlist's internal list containing a given
19221     * item, immediately.
19222     *
19223     * @param it The item to display
19224     *
19225     * This causes genlist to jump to the given item @p it and show it (by
19226     * immediately scrolling to that position), if it is not fully visible.
19227     *
19228     * The item will be positioned at the top of the genlist viewport.
19229     *
19230     * @see elm_genlist_item_show()
19231     * @see elm_genlist_item_top_bring_in()
19232     *
19233     * @ingroup Genlist
19234     */
19235    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19236    /**
19237     * Animatedly bring in, to the visible are of a genlist, a given
19238     * item on it.
19239     *
19240     * @param it The item
19241     *
19242     * This causes genlist to jump to the given item @p it and show it (by
19243     * animatedly scrolling), if it is not fully visible. This may use animation
19244     * to do so and take a period of time
19245     *
19246     * The item will be positioned at the top of the genlist viewport.
19247     *
19248     * @see elm_genlist_item_bring_in()
19249     * @see elm_genlist_item_top_show()
19250     *
19251     * @ingroup Genlist
19252     */
19253    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19254    /**
19255     * Show the portion of a genlist's internal list containing a given
19256     * item, immediately.
19257     *
19258     * @param it The item to display
19259     *
19260     * This causes genlist to jump to the given item @p it and show it (by
19261     * immediately scrolling to that position), if it is not fully visible.
19262     *
19263     * The item will be positioned at the middle of the genlist viewport.
19264     *
19265     * @see elm_genlist_item_show()
19266     * @see elm_genlist_item_middle_bring_in()
19267     *
19268     * @ingroup Genlist
19269     */
19270    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19271    /**
19272     * Animatedly bring in, to the visible are of a genlist, a given
19273     * item on it.
19274     *
19275     * @param it The item
19276     *
19277     * This causes genlist to jump to the given item @p it and show it (by
19278     * animatedly scrolling), if it is not fully visible. This may use animation
19279     * to do so and take a period of time
19280     *
19281     * The item will be positioned at the middle of the genlist viewport.
19282     *
19283     * @see elm_genlist_item_bring_in()
19284     * @see elm_genlist_item_middle_show()
19285     *
19286     * @ingroup Genlist
19287     */
19288    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19289    /**
19290     * Remove a genlist item from the its parent, deleting it.
19291     *
19292     * @param item The item to be removed.
19293     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19294     *
19295     * @see elm_genlist_clear(), to remove all items in a genlist at
19296     * once.
19297     *
19298     * @ingroup Genlist
19299     */
19300    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19301    /**
19302     * Return the data associated to a given genlist item
19303     *
19304     * @param item The genlist item.
19305     * @return the data associated to this item.
19306     *
19307     * This returns the @c data value passed on the
19308     * elm_genlist_item_append() and related item addition calls.
19309     *
19310     * @see elm_genlist_item_append()
19311     * @see elm_genlist_item_data_set()
19312     *
19313     * @ingroup Genlist
19314     */
19315    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19316    /**
19317     * Set the data associated to a given genlist item
19318     *
19319     * @param item The genlist item
19320     * @param data The new data pointer to set on it
19321     *
19322     * This @b overrides the @c data value passed on the
19323     * elm_genlist_item_append() and related item addition calls. This
19324     * function @b won't call elm_genlist_item_update() automatically,
19325     * so you'd issue it afterwards if you want to hove the item
19326     * updated to reflect the that new data.
19327     *
19328     * @see elm_genlist_item_data_get()
19329     *
19330     * @ingroup Genlist
19331     */
19332    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19333    /**
19334     * Tells genlist to "orphan" icons fetchs by the item class
19335     *
19336     * @param it The item
19337     *
19338     * This instructs genlist to release references to icons in the item,
19339     * meaning that they will no longer be managed by genlist and are
19340     * floating "orphans" that can be re-used elsewhere if the user wants
19341     * to.
19342     *
19343     * @ingroup Genlist
19344     */
19345    EAPI void               elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19346    EINA_DEPRECATED EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19347    /**
19348     * Get the real Evas object created to implement the view of a
19349     * given genlist item
19350     *
19351     * @param item The genlist item.
19352     * @return the Evas object implementing this item's view.
19353     *
19354     * This returns the actual Evas object used to implement the
19355     * specified genlist item's view. This may be @c NULL, as it may
19356     * not have been created or may have been deleted, at any time, by
19357     * the genlist. <b>Do not modify this object</b> (move, resize,
19358     * show, hide, etc.), as the genlist is controlling it. This
19359     * function is for querying, emitting custom signals or hooking
19360     * lower level callbacks for events on that object. Do not delete
19361     * this object under any circumstances.
19362     *
19363     * @see elm_genlist_item_data_get()
19364     *
19365     * @ingroup Genlist
19366     */
19367    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19368    /**
19369     * Update the contents of an item
19370     *
19371     * @param it The item
19372     *
19373     * This updates an item by calling all the item class functions again
19374     * to get the icons, labels and states. Use this when the original
19375     * item data has changed and the changes are desired to be reflected.
19376     *
19377     * Use elm_genlist_realized_items_update() to update all already realized
19378     * items.
19379     *
19380     * @see elm_genlist_realized_items_update()
19381     *
19382     * @ingroup Genlist
19383     */
19384    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19385    /**
19386     * Update the item class of an item
19387     *
19388     * @param it The item
19389     * @param itc The item class for the item
19390     *
19391     * This sets another class fo the item, changing the way that it is
19392     * displayed. After changing the item class, elm_genlist_item_update() is
19393     * called on the item @p it.
19394     *
19395     * @ingroup Genlist
19396     */
19397    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19398    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19399    /**
19400     * Set the text to be shown in a given genlist item's tooltips.
19401     *
19402     * @param item The genlist item
19403     * @param text The text to set in the content
19404     *
19405     * This call will setup the text to be used as tooltip to that item
19406     * (analogous to elm_object_tooltip_text_set(), but being item
19407     * tooltips with higher precedence than object tooltips). It can
19408     * have only one tooltip at a time, so any previous tooltip data
19409     * will get removed.
19410     *
19411     * In order to set an icon or something else as a tooltip, look at
19412     * elm_genlist_item_tooltip_content_cb_set().
19413     *
19414     * @ingroup Genlist
19415     */
19416    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19417    /**
19418     * Set the content to be shown in a given genlist item's tooltips
19419     *
19420     * @param item The genlist item.
19421     * @param func The function returning the tooltip contents.
19422     * @param data What to provide to @a func as callback data/context.
19423     * @param del_cb Called when data is not needed anymore, either when
19424     *        another callback replaces @p func, the tooltip is unset with
19425     *        elm_genlist_item_tooltip_unset() or the owner @p item
19426     *        dies. This callback receives as its first parameter the
19427     *        given @p data, being @c event_info the item handle.
19428     *
19429     * This call will setup the tooltip's contents to @p item
19430     * (analogous to elm_object_tooltip_content_cb_set(), but being
19431     * item tooltips with higher precedence than object tooltips). It
19432     * can have only one tooltip at a time, so any previous tooltip
19433     * content will get removed. @p func (with @p data) will be called
19434     * every time Elementary needs to show the tooltip and it should
19435     * return a valid Evas object, which will be fully managed by the
19436     * tooltip system, getting deleted when the tooltip is gone.
19437     *
19438     * In order to set just a text as a tooltip, look at
19439     * elm_genlist_item_tooltip_text_set().
19440     *
19441     * @ingroup Genlist
19442     */
19443    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);
19444    /**
19445     * Unset a tooltip from a given genlist item
19446     *
19447     * @param item genlist item to remove a previously set tooltip from.
19448     *
19449     * This call removes any tooltip set on @p item. The callback
19450     * provided as @c del_cb to
19451     * elm_genlist_item_tooltip_content_cb_set() will be called to
19452     * notify it is not used anymore (and have resources cleaned, if
19453     * need be).
19454     *
19455     * @see elm_genlist_item_tooltip_content_cb_set()
19456     *
19457     * @ingroup Genlist
19458     */
19459    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19460    /**
19461     * Set a different @b style for a given genlist item's tooltip.
19462     *
19463     * @param item genlist item with tooltip set
19464     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19465     * "default", @c "transparent", etc)
19466     *
19467     * Tooltips can have <b>alternate styles</b> to be displayed on,
19468     * which are defined by the theme set on Elementary. This function
19469     * works analogously as elm_object_tooltip_style_set(), but here
19470     * applied only to genlist item objects. The default style for
19471     * tooltips is @c "default".
19472     *
19473     * @note before you set a style you should define a tooltip with
19474     *       elm_genlist_item_tooltip_content_cb_set() or
19475     *       elm_genlist_item_tooltip_text_set()
19476     *
19477     * @see elm_genlist_item_tooltip_style_get()
19478     *
19479     * @ingroup Genlist
19480     */
19481    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19482    /**
19483     * Get the style set a given genlist item's tooltip.
19484     *
19485     * @param item genlist item with tooltip already set on.
19486     * @return style the theme style in use, which defaults to
19487     *         "default". If the object does not have a tooltip set,
19488     *         then @c NULL is returned.
19489     *
19490     * @see elm_genlist_item_tooltip_style_set() for more details
19491     *
19492     * @ingroup Genlist
19493     */
19494    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19495    /**
19496     * @brief Disable size restrictions on an object's tooltip
19497     * @param item The tooltip's anchor object
19498     * @param disable If EINA_TRUE, size restrictions are disabled
19499     * @return EINA_FALSE on failure, EINA_TRUE on success
19500     *
19501     * This function allows a tooltip to expand beyond its parant window's canvas.
19502     * It will instead be limited only by the size of the display.
19503     */
19504    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19505    /**
19506     * @brief Retrieve size restriction state of an object's tooltip
19507     * @param item The tooltip's anchor object
19508     * @return If EINA_TRUE, size restrictions are disabled
19509     *
19510     * This function returns whether a tooltip is allowed to expand beyond
19511     * its parant window's canvas.
19512     * It will instead be limited only by the size of the display.
19513     */
19514    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19515    /**
19516     * Set the type of mouse pointer/cursor decoration to be shown,
19517     * when the mouse pointer is over the given genlist widget item
19518     *
19519     * @param item genlist item to customize cursor on
19520     * @param cursor the cursor type's name
19521     *
19522     * This function works analogously as elm_object_cursor_set(), but
19523     * here the cursor's changing area is restricted to the item's
19524     * area, and not the whole widget's. Note that that item cursors
19525     * have precedence over widget cursors, so that a mouse over @p
19526     * item will always show cursor @p type.
19527     *
19528     * If this function is called twice for an object, a previously set
19529     * cursor will be unset on the second call.
19530     *
19531     * @see elm_object_cursor_set()
19532     * @see elm_genlist_item_cursor_get()
19533     * @see elm_genlist_item_cursor_unset()
19534     *
19535     * @ingroup Genlist
19536     */
19537    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19538    /**
19539     * Get the type of mouse pointer/cursor decoration set to be shown,
19540     * when the mouse pointer is over the given genlist widget item
19541     *
19542     * @param item genlist item with custom cursor set
19543     * @return the cursor type's name or @c NULL, if no custom cursors
19544     * were set to @p item (and on errors)
19545     *
19546     * @see elm_object_cursor_get()
19547     * @see elm_genlist_item_cursor_set() for more details
19548     * @see elm_genlist_item_cursor_unset()
19549     *
19550     * @ingroup Genlist
19551     */
19552    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19553    /**
19554     * Unset any custom mouse pointer/cursor decoration set to be
19555     * shown, when the mouse pointer is over the given genlist widget
19556     * item, thus making it show the @b default cursor again.
19557     *
19558     * @param item a genlist item
19559     *
19560     * Use this call to undo any custom settings on this item's cursor
19561     * decoration, bringing it back to defaults (no custom style set).
19562     *
19563     * @see elm_object_cursor_unset()
19564     * @see elm_genlist_item_cursor_set() for more details
19565     *
19566     * @ingroup Genlist
19567     */
19568    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19569    /**
19570     * Set a different @b style for a given custom cursor set for a
19571     * genlist item.
19572     *
19573     * @param item genlist item with custom cursor set
19574     * @param style the <b>theme style</b> to use (e.g. @c "default",
19575     * @c "transparent", etc)
19576     *
19577     * This function only makes sense when one is using custom mouse
19578     * cursor decorations <b>defined in a theme file</b> , which can
19579     * have, given a cursor name/type, <b>alternate styles</b> on
19580     * it. It works analogously as elm_object_cursor_style_set(), but
19581     * here applied only to genlist item objects.
19582     *
19583     * @warning Before you set a cursor style you should have defined a
19584     *       custom cursor previously on the item, with
19585     *       elm_genlist_item_cursor_set()
19586     *
19587     * @see elm_genlist_item_cursor_engine_only_set()
19588     * @see elm_genlist_item_cursor_style_get()
19589     *
19590     * @ingroup Genlist
19591     */
19592    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19593    /**
19594     * Get the current @b style set for a given genlist item's custom
19595     * cursor
19596     *
19597     * @param item genlist item with custom cursor set.
19598     * @return style the cursor style in use. If the object does not
19599     *         have a cursor set, then @c NULL is returned.
19600     *
19601     * @see elm_genlist_item_cursor_style_set() for more details
19602     *
19603     * @ingroup Genlist
19604     */
19605    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19606    /**
19607     * Set if the (custom) cursor for a given genlist item should be
19608     * searched in its theme, also, or should only rely on the
19609     * rendering engine.
19610     *
19611     * @param item item with custom (custom) cursor already set on
19612     * @param engine_only Use @c EINA_TRUE to have cursors looked for
19613     * only on those provided by the rendering engine, @c EINA_FALSE to
19614     * have them searched on the widget's theme, as well.
19615     *
19616     * @note This call is of use only if you've set a custom cursor
19617     * for genlist items, with elm_genlist_item_cursor_set().
19618     *
19619     * @note By default, cursors will only be looked for between those
19620     * provided by the rendering engine.
19621     *
19622     * @ingroup Genlist
19623     */
19624    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19625    /**
19626     * Get if the (custom) cursor for a given genlist item is being
19627     * searched in its theme, also, or is only relying on the rendering
19628     * engine.
19629     *
19630     * @param item a genlist item
19631     * @return @c EINA_TRUE, if cursors are being looked for only on
19632     * those provided by the rendering engine, @c EINA_FALSE if they
19633     * are being searched on the widget's theme, as well.
19634     *
19635     * @see elm_genlist_item_cursor_engine_only_set(), for more details
19636     *
19637     * @ingroup Genlist
19638     */
19639    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19640    /**
19641     * Update the contents of all realized items.
19642     *
19643     * @param obj The genlist object.
19644     *
19645     * This updates all realized items by calling all the item class functions again
19646     * to get the icons, labels and states. Use this when the original
19647     * item data has changed and the changes are desired to be reflected.
19648     *
19649     * To update just one item, use elm_genlist_item_update().
19650     *
19651     * @see elm_genlist_realized_items_get()
19652     * @see elm_genlist_item_update()
19653     *
19654     * @ingroup Genlist
19655     */
19656    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19657    /**
19658     * Activate a genlist mode on an item
19659     *
19660     * @param item The genlist item
19661     * @param mode Mode name
19662     * @param mode_set Boolean to define set or unset mode.
19663     *
19664     * A genlist mode is a different way of selecting an item. Once a mode is
19665     * activated on an item, any other selected item is immediately unselected.
19666     * This feature provides an easy way of implementing a new kind of animation
19667     * for selecting an item, without having to entirely rewrite the item style
19668     * theme. However, the elm_genlist_selected_* API can't be used to get what
19669     * item is activate for a mode.
19670     *
19671     * The current item style will still be used, but applying a genlist mode to
19672     * an item will select it using a different kind of animation.
19673     *
19674     * The current active item for a mode can be found by
19675     * elm_genlist_mode_item_get().
19676     *
19677     * The characteristics of genlist mode are:
19678     * - Only one mode can be active at any time, and for only one item.
19679     * - Genlist handles deactivating other items when one item is activated.
19680     * - A mode is defined in the genlist theme (edc), and more modes can easily
19681     *   be added.
19682     * - A mode style and the genlist item style are different things. They
19683     *   can be combined to provide a default style to the item, with some kind
19684     *   of animation for that item when the mode is activated.
19685     *
19686     * When a mode is activated on an item, a new view for that item is created.
19687     * The theme of this mode defines the animation that will be used to transit
19688     * the item from the old view to the new view. This second (new) view will be
19689     * active for that item while the mode is active on the item, and will be
19690     * destroyed after the mode is totally deactivated from that item.
19691     *
19692     * @see elm_genlist_mode_get()
19693     * @see elm_genlist_mode_item_get()
19694     *
19695     * @ingroup Genlist
19696     */
19697    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19698    /**
19699     * Get the last (or current) genlist mode used.
19700     *
19701     * @param obj The genlist object
19702     *
19703     * This function just returns the name of the last used genlist mode. It will
19704     * be the current mode if it's still active.
19705     *
19706     * @see elm_genlist_item_mode_set()
19707     * @see elm_genlist_mode_item_get()
19708     *
19709     * @ingroup Genlist
19710     */
19711    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19712    /**
19713     * Get active genlist mode item
19714     *
19715     * @param obj The genlist object
19716     * @return The active item for that current mode. Or @c NULL if no item is
19717     * activated with any mode.
19718     *
19719     * This function returns the item that was activated with a mode, by the
19720     * function elm_genlist_item_mode_set().
19721     *
19722     * @see elm_genlist_item_mode_set()
19723     * @see elm_genlist_mode_get()
19724     *
19725     * @ingroup Genlist
19726     */
19727    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19728
19729    /**
19730     * Set reorder mode
19731     *
19732     * @param obj The genlist object
19733     * @param reorder_mode The reorder mode
19734     * (EINA_TRUE = on, EINA_FALSE = off)
19735     *
19736     * @ingroup Genlist
19737     */
19738    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19739
19740    /**
19741     * Get the reorder mode
19742     *
19743     * @param obj The genlist object
19744     * @return The reorder mode
19745     * (EINA_TRUE = on, EINA_FALSE = off)
19746     *
19747     * @ingroup Genlist
19748     */
19749    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19750
19751    /**
19752     * @}
19753     */
19754
19755    /**
19756     * @defgroup Check Check
19757     *
19758     * @image html img/widget/check/preview-00.png
19759     * @image latex img/widget/check/preview-00.eps
19760     * @image html img/widget/check/preview-01.png
19761     * @image latex img/widget/check/preview-01.eps
19762     * @image html img/widget/check/preview-02.png
19763     * @image latex img/widget/check/preview-02.eps
19764     *
19765     * @brief The check widget allows for toggling a value between true and
19766     * false.
19767     *
19768     * Check objects are a lot like radio objects in layout and functionality
19769     * except they do not work as a group, but independently and only toggle the
19770     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19771     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19772     * returns the current state. For convenience, like the radio objects, you
19773     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19774     * for it to modify.
19775     *
19776     * Signals that you can add callbacks for are:
19777     * "changed" - This is called whenever the user changes the state of one of
19778     *             the check object(event_info is NULL).
19779     *
19780     * Default contents parts of the check widget that you can use for are:
19781     * @li "elm.swallow.content" - A icon of the check
19782     *
19783     * Default text parts of the check widget that you can use for are:
19784     * @li "elm.text" - Label of the check
19785     *
19786     * @ref tutorial_check should give you a firm grasp of how to use this widget
19787     * .
19788     * @{
19789     */
19790    /**
19791     * @brief Add a new Check object
19792     *
19793     * @param parent The parent object
19794     * @return The new object or NULL if it cannot be created
19795     */
19796    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19797    /**
19798     * @brief Set the text label of the check object
19799     *
19800     * @param obj The check object
19801     * @param label The text label string in UTF-8
19802     *
19803     * @deprecated use elm_object_text_set() instead.
19804     */
19805    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19806    /**
19807     * @brief Get the text label of the check object
19808     *
19809     * @param obj The check object
19810     * @return The text label string in UTF-8
19811     *
19812     * @deprecated use elm_object_text_get() instead.
19813     */
19814    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19815    /**
19816     * @brief Set the icon object of the check object
19817     *
19818     * @param obj The check object
19819     * @param icon The icon object
19820     *
19821     * Once the icon object is set, a previously set one will be deleted.
19822     * If you want to keep that old content object, use the
19823     * elm_object_content_unset() function.
19824     */
19825    EINA_DEPRECATED EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19826    /**
19827     * @brief Get the icon object of the check object
19828     *
19829     * @param obj The check object
19830     * @return The icon object
19831     */
19832    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19833    /**
19834     * @brief Unset the icon used for the check object
19835     *
19836     * @param obj The check object
19837     * @return The icon object that was being used
19838     *
19839     * Unparent and return the icon object which was set for this widget.
19840     */
19841    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19842    /**
19843     * @brief Set the on/off state of the check object
19844     *
19845     * @param obj The check object
19846     * @param state The state to use (1 == on, 0 == off)
19847     *
19848     * This sets the state of the check. If set
19849     * with elm_check_state_pointer_set() the state of that variable is also
19850     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19851     */
19852    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19853    /**
19854     * @brief Get the state of the check object
19855     *
19856     * @param obj The check object
19857     * @return The boolean state
19858     */
19859    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19860    /**
19861     * @brief Set a convenience pointer to a boolean to change
19862     *
19863     * @param obj The check object
19864     * @param statep Pointer to the boolean to modify
19865     *
19866     * This sets a pointer to a boolean, that, in addition to the check objects
19867     * state will also be modified directly. To stop setting the object pointed
19868     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19869     * then when this is called, the check objects state will also be modified to
19870     * reflect the value of the boolean @p statep points to, just like calling
19871     * elm_check_state_set().
19872     */
19873    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19874    EINA_DEPRECATED EAPI void         elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
19875    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);
19876
19877    /**
19878     * @}
19879     */
19880
19881    /**
19882     * @defgroup Radio Radio
19883     *
19884     * @image html img/widget/radio/preview-00.png
19885     * @image latex img/widget/radio/preview-00.eps
19886     *
19887     * @brief Radio is a widget that allows for 1 or more options to be displayed
19888     * and have the user choose only 1 of them.
19889     *
19890     * A radio object contains an indicator, an optional Label and an optional
19891     * icon object. While it's possible to have a group of only one radio they,
19892     * are normally used in groups of 2 or more. To add a radio to a group use
19893     * elm_radio_group_add(). The radio object(s) will select from one of a set
19894     * of integer values, so any value they are configuring needs to be mapped to
19895     * a set of integers. To configure what value that radio object represents,
19896     * use  elm_radio_state_value_set() to set the integer it represents. To set
19897     * the value the whole group(which one is currently selected) is to indicate
19898     * use elm_radio_value_set() on any group member, and to get the groups value
19899     * use elm_radio_value_get(). For convenience the radio objects are also able
19900     * to directly set an integer(int) to the value that is selected. To specify
19901     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19902     * The radio objects will modify this directly. That implies the pointer must
19903     * point to valid memory for as long as the radio objects exist.
19904     *
19905     * Signals that you can add callbacks for are:
19906     * @li changed - This is called whenever the user changes the state of one of
19907     * the radio objects within the group of radio objects that work together.
19908     *
19909     * Default contents parts of the radio widget that you can use for are:
19910     * @li "elm.swallow.content" - A icon of the radio
19911     *
19912     * @ref tutorial_radio show most of this API in action.
19913     * @{
19914     */
19915    /**
19916     * @brief Add a new radio to the parent
19917     *
19918     * @param parent The parent object
19919     * @return The new object or NULL if it cannot be created
19920     */
19921    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19922    /**
19923     * @brief Set the text label of the radio object
19924     *
19925     * @param obj The radio object
19926     * @param label The text label string in UTF-8
19927     *
19928     * @deprecated use elm_object_text_set() instead.
19929     */
19930    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19931    /**
19932     * @brief Get the text label of the radio object
19933     *
19934     * @param obj The radio object
19935     * @return The text label string in UTF-8
19936     *
19937     * @deprecated use elm_object_text_set() instead.
19938     */
19939    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19940    /**
19941     * @brief Set the icon object of the radio object
19942     *
19943     * @param obj The radio object
19944     * @param icon The icon object
19945     *
19946     * Once the icon object is set, a previously set one will be deleted. If you
19947     * want to keep that old content object, use the elm_radio_icon_unset()
19948     * function.
19949     */
19950    EINA_DEPRECATED EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19951    /**
19952     * @brief Get the icon object of the radio object
19953     *
19954     * @param obj The radio object
19955     * @return The icon object
19956     *
19957     * @see elm_radio_icon_set()
19958     */
19959    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19960    /**
19961     * @brief Unset the icon used for the radio object
19962     *
19963     * @param obj The radio object
19964     * @return The icon object that was being used
19965     *
19966     * Unparent and return the icon object which was set for this widget.
19967     *
19968     * @see elm_radio_icon_set()
19969     */
19970    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19971    /**
19972     * @brief Add this radio to a group of other radio objects
19973     *
19974     * @param obj The radio object
19975     * @param group Any object whose group the @p obj is to join.
19976     *
19977     * Radio objects work in groups. Each member should have a different integer
19978     * value assigned. In order to have them work as a group, they need to know
19979     * about each other. This adds the given radio object to the group of which
19980     * the group object indicated is a member.
19981     */
19982    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19983    /**
19984     * @brief Set the integer value that this radio object represents
19985     *
19986     * @param obj The radio object
19987     * @param value The value to use if this radio object is selected
19988     *
19989     * This sets the value of the radio.
19990     */
19991    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19992    /**
19993     * @brief Get the integer value that this radio object represents
19994     *
19995     * @param obj The radio object
19996     * @return The value used if this radio object is selected
19997     *
19998     * This gets the value of the radio.
19999     *
20000     * @see elm_radio_value_set()
20001     */
20002    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20003    /**
20004     * @brief Set the value of the radio.
20005     *
20006     * @param obj The radio object
20007     * @param value The value to use for the group
20008     *
20009     * This sets the value of the radio group and will also set the value if
20010     * pointed to, to the value supplied, but will not call any callbacks.
20011     */
20012    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20013    /**
20014     * @brief Get the state of the radio object
20015     *
20016     * @param obj The radio object
20017     * @return The integer state
20018     */
20019    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20020    /**
20021     * @brief Set a convenience pointer to a integer to change
20022     *
20023     * @param obj The radio object
20024     * @param valuep Pointer to the integer to modify
20025     *
20026     * This sets a pointer to a integer, that, in addition to the radio objects
20027     * state will also be modified directly. To stop setting the object pointed
20028     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20029     * when this is called, the radio objects state will also be modified to
20030     * reflect the value of the integer valuep points to, just like calling
20031     * elm_radio_value_set().
20032     */
20033    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20034    /**
20035     * @}
20036     */
20037
20038    /**
20039     * @defgroup Pager Pager
20040     *
20041     * @image html img/widget/pager/preview-00.png
20042     * @image latex img/widget/pager/preview-00.eps
20043     *
20044     * @brief Widget that allows flipping between 1 or more ā€œpagesā€ of objects.
20045     *
20046     * The flipping between ā€œpagesā€ of objects is animated. All content in pager
20047     * is kept in a stack, the last content to be added will be on the top of the
20048     * stack(be visible).
20049     *
20050     * Objects can be pushed or popped from the stack or deleted as normal.
20051     * Pushes and pops will animate (and a pop will delete the object once the
20052     * animation is finished). Any object already in the pager can be promoted to
20053     * the top(from its current stacking position) through the use of
20054     * elm_pager_content_promote(). Objects are pushed to the top with
20055     * elm_pager_content_push() and when the top item is no longer wanted, simply
20056     * pop it with elm_pager_content_pop() and it will also be deleted. If an
20057     * object is no longer needed and is not the top item, just delete it as
20058     * normal. You can query which objects are the top and bottom with
20059     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20060     *
20061     * Signals that you can add callbacks for are:
20062     * "hide,finished" - when the previous page is hided
20063     *
20064     * This widget has the following styles available:
20065     * @li default
20066     * @li fade
20067     * @li fade_translucide
20068     * @li fade_invisible
20069     * @note This styles affect only the flipping animations, the appearance when
20070     * not animating is unaffected by styles.
20071     *
20072     * @ref tutorial_pager gives a good overview of the usage of the API.
20073     * @{
20074     */
20075    /**
20076     * Add a new pager to the parent
20077     *
20078     * @param parent The parent object
20079     * @return The new object or NULL if it cannot be created
20080     *
20081     * @ingroup Pager
20082     */
20083    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20084    /**
20085     * @brief Push an object to the top of the pager stack (and show it).
20086     *
20087     * @param obj The pager object
20088     * @param content The object to push
20089     *
20090     * The object pushed becomes a child of the pager, it will be controlled and
20091     * deleted when the pager is deleted.
20092     *
20093     * @note If the content is already in the stack use
20094     * elm_pager_content_promote().
20095     * @warning Using this function on @p content already in the stack results in
20096     * undefined behavior.
20097     */
20098    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20099    /**
20100     * @brief Pop the object that is on top of the stack
20101     *
20102     * @param obj The pager object
20103     *
20104     * This pops the object that is on the top(visible) of the pager, makes it
20105     * disappear, then deletes the object. The object that was underneath it on
20106     * the stack will become visible.
20107     */
20108    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20109    /**
20110     * @brief Moves an object already in the pager stack to the top of the stack.
20111     *
20112     * @param obj The pager object
20113     * @param content The object to promote
20114     *
20115     * This will take the @p content and move it to the top of the stack as
20116     * if it had been pushed there.
20117     *
20118     * @note If the content isn't already in the stack use
20119     * elm_pager_content_push().
20120     * @warning Using this function on @p content not already in the stack
20121     * results in undefined behavior.
20122     */
20123    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20124    /**
20125     * @brief Return the object at the bottom of the pager stack
20126     *
20127     * @param obj The pager object
20128     * @return The bottom object or NULL if none
20129     */
20130    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20131    /**
20132     * @brief  Return the object at the top of the pager stack
20133     *
20134     * @param obj The pager object
20135     * @return The top object or NULL if none
20136     */
20137    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20138
20139    /**
20140     * @}
20141     */
20142
20143    /**
20144     * @defgroup Slideshow Slideshow
20145     *
20146     * @image html img/widget/slideshow/preview-00.png
20147     * @image latex img/widget/slideshow/preview-00.eps
20148     *
20149     * This widget, as the name indicates, is a pre-made image
20150     * slideshow panel, with API functions acting on (child) image
20151     * items presentation. Between those actions, are:
20152     * - advance to next/previous image
20153     * - select the style of image transition animation
20154     * - set the exhibition time for each image
20155     * - start/stop the slideshow
20156     *
20157     * The transition animations are defined in the widget's theme,
20158     * consequently new animations can be added without having to
20159     * update the widget's code.
20160     *
20161     * @section Slideshow_Items Slideshow items
20162     *
20163     * For slideshow items, just like for @ref Genlist "genlist" ones,
20164     * the user defines a @b classes, specifying functions that will be
20165     * called on the item's creation and deletion times.
20166     *
20167     * The #Elm_Slideshow_Item_Class structure contains the following
20168     * members:
20169     *
20170     * - @c func.get - When an item is displayed, this function is
20171     *   called, and it's where one should create the item object, de
20172     *   facto. For example, the object can be a pure Evas image object
20173     *   or an Elementary @ref Photocam "photocam" widget. See
20174     *   #SlideshowItemGetFunc.
20175     * - @c func.del - When an item is no more displayed, this function
20176     *   is called, where the user must delete any data associated to
20177     *   the item. See #SlideshowItemDelFunc.
20178     *
20179     * @section Slideshow_Caching Slideshow caching
20180     *
20181     * The slideshow provides facilities to have items adjacent to the
20182     * one being displayed <b>already "realized"</b> (i.e. loaded) for
20183     * you, so that the system does not have to decode image data
20184     * anymore at the time it has to actually switch images on its
20185     * viewport. The user is able to set the numbers of items to be
20186     * cached @b before and @b after the current item, in the widget's
20187     * item list.
20188     *
20189     * Smart events one can add callbacks for are:
20190     *
20191     * - @c "changed" - when the slideshow switches its view to a new
20192     *   item
20193     *
20194     * List of examples for the slideshow widget:
20195     * @li @ref slideshow_example
20196     */
20197
20198    /**
20199     * @addtogroup Slideshow
20200     * @{
20201     */
20202
20203    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20204    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20205    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
20206    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20207    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20208
20209    /**
20210     * @struct _Elm_Slideshow_Item_Class
20211     *
20212     * Slideshow item class definition. See @ref Slideshow_Items for
20213     * field details.
20214     */
20215    struct _Elm_Slideshow_Item_Class
20216      {
20217         struct _Elm_Slideshow_Item_Class_Func
20218           {
20219              SlideshowItemGetFunc get;
20220              SlideshowItemDelFunc del;
20221           } func;
20222      }; /**< #Elm_Slideshow_Item_Class member definitions */
20223
20224    /**
20225     * Add a new slideshow widget to the given parent Elementary
20226     * (container) object
20227     *
20228     * @param parent The parent object
20229     * @return A new slideshow widget handle or @c NULL, on errors
20230     *
20231     * This function inserts a new slideshow widget on the canvas.
20232     *
20233     * @ingroup Slideshow
20234     */
20235    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20236
20237    /**
20238     * Add (append) a new item in a given slideshow widget.
20239     *
20240     * @param obj The slideshow object
20241     * @param itc The item class for the item
20242     * @param data The item's data
20243     * @return A handle to the item added or @c NULL, on errors
20244     *
20245     * Add a new item to @p obj's internal list of items, appending it.
20246     * The item's class must contain the function really fetching the
20247     * image object to show for this item, which could be an Evas image
20248     * object or an Elementary photo, for example. The @p data
20249     * parameter is going to be passed to both class functions of the
20250     * item.
20251     *
20252     * @see #Elm_Slideshow_Item_Class
20253     * @see elm_slideshow_item_sorted_insert()
20254     *
20255     * @ingroup Slideshow
20256     */
20257    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20258
20259    /**
20260     * Insert a new item into the given slideshow widget, using the @p func
20261     * function to sort items (by item handles).
20262     *
20263     * @param obj The slideshow object
20264     * @param itc The item class for the item
20265     * @param data The item's data
20266     * @param func The comparing function to be used to sort slideshow
20267     * items <b>by #Elm_Slideshow_Item item handles</b>
20268     * @return Returns The slideshow item handle, on success, or
20269     * @c NULL, on errors
20270     *
20271     * Add a new item to @p obj's internal list of items, in a position
20272     * determined by the @p func comparing function. The item's class
20273     * must contain the function really fetching the image object to
20274     * show for this item, which could be an Evas image object or an
20275     * Elementary photo, for example. The @p data parameter is going to
20276     * be passed to both class functions of the item.
20277     *
20278     * @see #Elm_Slideshow_Item_Class
20279     * @see elm_slideshow_item_add()
20280     *
20281     * @ingroup Slideshow
20282     */
20283    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);
20284
20285    /**
20286     * Display a given slideshow widget's item, programmatically.
20287     *
20288     * @param obj The slideshow object
20289     * @param item The item to display on @p obj's viewport
20290     *
20291     * The change between the current item and @p item will use the
20292     * transition @p obj is set to use (@see
20293     * elm_slideshow_transition_set()).
20294     *
20295     * @ingroup Slideshow
20296     */
20297    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20298
20299    /**
20300     * Slide to the @b next item, in a given slideshow widget
20301     *
20302     * @param obj The slideshow object
20303     *
20304     * The sliding animation @p obj is set to use will be the
20305     * transition effect used, after this call is issued.
20306     *
20307     * @note If the end of the slideshow's internal list of items is
20308     * reached, it'll wrap around to the list's beginning, again.
20309     *
20310     * @ingroup Slideshow
20311     */
20312    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20313
20314    /**
20315     * Slide to the @b previous item, in a given slideshow widget
20316     *
20317     * @param obj The slideshow object
20318     *
20319     * The sliding animation @p obj is set to use will be the
20320     * transition effect used, after this call is issued.
20321     *
20322     * @note If the beginning of the slideshow's internal list of items
20323     * is reached, it'll wrap around to the list's end, again.
20324     *
20325     * @ingroup Slideshow
20326     */
20327    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20328
20329    /**
20330     * Returns the list of sliding transition/effect names available, for a
20331     * given slideshow widget.
20332     *
20333     * @param obj The slideshow object
20334     * @return The list of transitions (list of @b stringshared strings
20335     * as data)
20336     *
20337     * The transitions, which come from @p obj's theme, must be an EDC
20338     * data item named @c "transitions" on the theme file, with (prefix)
20339     * names of EDC programs actually implementing them.
20340     *
20341     * The available transitions for slideshows on the default theme are:
20342     * - @c "fade" - the current item fades out, while the new one
20343     *   fades in to the slideshow's viewport.
20344     * - @c "black_fade" - the current item fades to black, and just
20345     *   then, the new item will fade in.
20346     * - @c "horizontal" - the current item slides horizontally, until
20347     *   it gets out of the slideshow's viewport, while the new item
20348     *   comes from the left to take its place.
20349     * - @c "vertical" - the current item slides vertically, until it
20350     *   gets out of the slideshow's viewport, while the new item comes
20351     *   from the bottom to take its place.
20352     * - @c "square" - the new item starts to appear from the middle of
20353     *   the current one, but with a tiny size, growing until its
20354     *   target (full) size and covering the old one.
20355     *
20356     * @warning The stringshared strings get no new references
20357     * exclusive to the user grabbing the list, here, so if you'd like
20358     * to use them out of this call's context, you'd better @c
20359     * eina_stringshare_ref() them.
20360     *
20361     * @see elm_slideshow_transition_set()
20362     *
20363     * @ingroup Slideshow
20364     */
20365    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20366
20367    /**
20368     * Set the current slide transition/effect in use for a given
20369     * slideshow widget
20370     *
20371     * @param obj The slideshow object
20372     * @param transition The new transition's name string
20373     *
20374     * If @p transition is implemented in @p obj's theme (i.e., is
20375     * contained in the list returned by
20376     * elm_slideshow_transitions_get()), this new sliding effect will
20377     * be used on the widget.
20378     *
20379     * @see elm_slideshow_transitions_get() for more details
20380     *
20381     * @ingroup Slideshow
20382     */
20383    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20384
20385    /**
20386     * Get the current slide transition/effect in use for a given
20387     * slideshow widget
20388     *
20389     * @param obj The slideshow object
20390     * @return The current transition's name
20391     *
20392     * @see elm_slideshow_transition_set() for more details
20393     *
20394     * @ingroup Slideshow
20395     */
20396    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20397
20398    /**
20399     * Set the interval between each image transition on a given
20400     * slideshow widget, <b>and start the slideshow, itself</b>
20401     *
20402     * @param obj The slideshow object
20403     * @param timeout The new displaying timeout for images
20404     *
20405     * After this call, the slideshow widget will start cycling its
20406     * view, sequentially and automatically, with the images of the
20407     * items it has. The time between each new image displayed is going
20408     * to be @p timeout, in @b seconds. If a different timeout was set
20409     * previously and an slideshow was in progress, it will continue
20410     * with the new time between transitions, after this call.
20411     *
20412     * @note A value less than or equal to 0 on @p timeout will disable
20413     * the widget's internal timer, thus halting any slideshow which
20414     * could be happening on @p obj.
20415     *
20416     * @see elm_slideshow_timeout_get()
20417     *
20418     * @ingroup Slideshow
20419     */
20420    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20421
20422    /**
20423     * Get the interval set for image transitions on a given slideshow
20424     * widget.
20425     *
20426     * @param obj The slideshow object
20427     * @return Returns the timeout set on it
20428     *
20429     * @see elm_slideshow_timeout_set() for more details
20430     *
20431     * @ingroup Slideshow
20432     */
20433    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20434
20435    /**
20436     * Set if, after a slideshow is started, for a given slideshow
20437     * widget, its items should be displayed cyclically or not.
20438     *
20439     * @param obj The slideshow object
20440     * @param loop Use @c EINA_TRUE to make it cycle through items or
20441     * @c EINA_FALSE for it to stop at the end of @p obj's internal
20442     * list of items
20443     *
20444     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20445     * ignore what is set by this functions, i.e., they'll @b always
20446     * cycle through items. This affects only the "automatic"
20447     * slideshow, as set by elm_slideshow_timeout_set().
20448     *
20449     * @see elm_slideshow_loop_get()
20450     *
20451     * @ingroup Slideshow
20452     */
20453    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20454
20455    /**
20456     * Get if, after a slideshow is started, for a given slideshow
20457     * widget, its items are to be displayed cyclically or not.
20458     *
20459     * @param obj The slideshow object
20460     * @return @c EINA_TRUE, if the items in @p obj will be cycled
20461     * through or @c EINA_FALSE, otherwise
20462     *
20463     * @see elm_slideshow_loop_set() for more details
20464     *
20465     * @ingroup Slideshow
20466     */
20467    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20468
20469    /**
20470     * Remove all items from a given slideshow widget
20471     *
20472     * @param obj The slideshow object
20473     *
20474     * This removes (and deletes) all items in @p obj, leaving it
20475     * empty.
20476     *
20477     * @see elm_slideshow_item_del(), to remove just one item.
20478     *
20479     * @ingroup Slideshow
20480     */
20481    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20482
20483    /**
20484     * Get the internal list of items in a given slideshow widget.
20485     *
20486     * @param obj The slideshow object
20487     * @return The list of items (#Elm_Slideshow_Item as data) or
20488     * @c NULL on errors.
20489     *
20490     * This list is @b not to be modified in any way and must not be
20491     * freed. Use the list members with functions like
20492     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20493     *
20494     * @warning This list is only valid until @p obj object's internal
20495     * items list is changed. It should be fetched again with another
20496     * call to this function when changes happen.
20497     *
20498     * @ingroup Slideshow
20499     */
20500    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20501
20502    /**
20503     * Delete a given item from a slideshow widget.
20504     *
20505     * @param item The slideshow item
20506     *
20507     * @ingroup Slideshow
20508     */
20509    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20510
20511    /**
20512     * Return the data associated with a given slideshow item
20513     *
20514     * @param item The slideshow item
20515     * @return Returns the data associated to this item
20516     *
20517     * @ingroup Slideshow
20518     */
20519    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20520
20521    /**
20522     * Returns the currently displayed item, in a given slideshow widget
20523     *
20524     * @param obj The slideshow object
20525     * @return A handle to the item being displayed in @p obj or
20526     * @c NULL, if none is (and on errors)
20527     *
20528     * @ingroup Slideshow
20529     */
20530    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20531
20532    /**
20533     * Get the real Evas object created to implement the view of a
20534     * given slideshow item
20535     *
20536     * @param item The slideshow item.
20537     * @return the Evas object implementing this item's view.
20538     *
20539     * This returns the actual Evas object used to implement the
20540     * specified slideshow item's view. This may be @c NULL, as it may
20541     * not have been created or may have been deleted, at any time, by
20542     * the slideshow. <b>Do not modify this object</b> (move, resize,
20543     * show, hide, etc.), as the slideshow is controlling it. This
20544     * function is for querying, emitting custom signals or hooking
20545     * lower level callbacks for events on that object. Do not delete
20546     * this object under any circumstances.
20547     *
20548     * @see elm_slideshow_item_data_get()
20549     *
20550     * @ingroup Slideshow
20551     */
20552    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20553
20554    /**
20555     * Get the the item, in a given slideshow widget, placed at
20556     * position @p nth, in its internal items list
20557     *
20558     * @param obj The slideshow object
20559     * @param nth The number of the item to grab a handle to (0 being
20560     * the first)
20561     * @return The item stored in @p obj at position @p nth or @c NULL,
20562     * if there's no item with that index (and on errors)
20563     *
20564     * @ingroup Slideshow
20565     */
20566    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20567
20568    /**
20569     * Set the current slide layout in use for a given slideshow widget
20570     *
20571     * @param obj The slideshow object
20572     * @param layout The new layout's name string
20573     *
20574     * If @p layout is implemented in @p obj's theme (i.e., is contained
20575     * in the list returned by elm_slideshow_layouts_get()), this new
20576     * images layout will be used on the widget.
20577     *
20578     * @see elm_slideshow_layouts_get() for more details
20579     *
20580     * @ingroup Slideshow
20581     */
20582    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20583
20584    /**
20585     * Get the current slide layout in use for a given slideshow widget
20586     *
20587     * @param obj The slideshow object
20588     * @return The current layout's name
20589     *
20590     * @see elm_slideshow_layout_set() for more details
20591     *
20592     * @ingroup Slideshow
20593     */
20594    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20595
20596    /**
20597     * Returns the list of @b layout names available, for a given
20598     * slideshow widget.
20599     *
20600     * @param obj The slideshow object
20601     * @return The list of layouts (list of @b stringshared strings
20602     * as data)
20603     *
20604     * Slideshow layouts will change how the widget is to dispose each
20605     * image item in its viewport, with regard to cropping, scaling,
20606     * etc.
20607     *
20608     * The layouts, which come from @p obj's theme, must be an EDC
20609     * data item name @c "layouts" on the theme file, with (prefix)
20610     * names of EDC programs actually implementing them.
20611     *
20612     * The available layouts for slideshows on the default theme are:
20613     * - @c "fullscreen" - item images with original aspect, scaled to
20614     *   touch top and down slideshow borders or, if the image's heigh
20615     *   is not enough, left and right slideshow borders.
20616     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20617     *   one, but always leaving 10% of the slideshow's dimensions of
20618     *   distance between the item image's borders and the slideshow
20619     *   borders, for each axis.
20620     *
20621     * @warning The stringshared strings get no new references
20622     * exclusive to the user grabbing the list, here, so if you'd like
20623     * to use them out of this call's context, you'd better @c
20624     * eina_stringshare_ref() them.
20625     *
20626     * @see elm_slideshow_layout_set()
20627     *
20628     * @ingroup Slideshow
20629     */
20630    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20631
20632    /**
20633     * Set the number of items to cache, on a given slideshow widget,
20634     * <b>before the current item</b>
20635     *
20636     * @param obj The slideshow object
20637     * @param count Number of items to cache before the current one
20638     *
20639     * The default value for this property is @c 2. See
20640     * @ref Slideshow_Caching "slideshow caching" for more details.
20641     *
20642     * @see elm_slideshow_cache_before_get()
20643     *
20644     * @ingroup Slideshow
20645     */
20646    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20647
20648    /**
20649     * Retrieve the number of items to cache, on a given slideshow widget,
20650     * <b>before the current item</b>
20651     *
20652     * @param obj The slideshow object
20653     * @return The number of items set to be cached before the current one
20654     *
20655     * @see elm_slideshow_cache_before_set() for more details
20656     *
20657     * @ingroup Slideshow
20658     */
20659    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20660
20661    /**
20662     * Set the number of items to cache, on a given slideshow widget,
20663     * <b>after the current item</b>
20664     *
20665     * @param obj The slideshow object
20666     * @param count Number of items to cache after the current one
20667     *
20668     * The default value for this property is @c 2. See
20669     * @ref Slideshow_Caching "slideshow caching" for more details.
20670     *
20671     * @see elm_slideshow_cache_after_get()
20672     *
20673     * @ingroup Slideshow
20674     */
20675    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20676
20677    /**
20678     * Retrieve the number of items to cache, on a given slideshow widget,
20679     * <b>after the current item</b>
20680     *
20681     * @param obj The slideshow object
20682     * @return The number of items set to be cached after the current one
20683     *
20684     * @see elm_slideshow_cache_after_set() for more details
20685     *
20686     * @ingroup Slideshow
20687     */
20688    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20689
20690    /**
20691     * Get the number of items stored in a given slideshow widget
20692     *
20693     * @param obj The slideshow object
20694     * @return The number of items on @p obj, at the moment of this call
20695     *
20696     * @ingroup Slideshow
20697     */
20698    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20699
20700    /**
20701     * @}
20702     */
20703
20704    /**
20705     * @defgroup Fileselector File Selector
20706     *
20707     * @image html img/widget/fileselector/preview-00.png
20708     * @image latex img/widget/fileselector/preview-00.eps
20709     *
20710     * A file selector is a widget that allows a user to navigate
20711     * through a file system, reporting file selections back via its
20712     * API.
20713     *
20714     * It contains shortcut buttons for home directory (@c ~) and to
20715     * jump one directory upwards (..), as well as cancel/ok buttons to
20716     * confirm/cancel a given selection. After either one of those two
20717     * former actions, the file selector will issue its @c "done" smart
20718     * callback.
20719     *
20720     * There's a text entry on it, too, showing the name of the current
20721     * selection. There's the possibility of making it editable, so it
20722     * is useful on file saving dialogs on applications, where one
20723     * gives a file name to save contents to, in a given directory in
20724     * the system. This custom file name will be reported on the @c
20725     * "done" smart callback (explained in sequence).
20726     *
20727     * Finally, it has a view to display file system items into in two
20728     * possible forms:
20729     * - list
20730     * - grid
20731     *
20732     * If Elementary is built with support of the Ethumb thumbnailing
20733     * library, the second form of view will display preview thumbnails
20734     * of files which it supports.
20735     *
20736     * Smart callbacks one can register to:
20737     *
20738     * - @c "selected" - the user has clicked on a file (when not in
20739     *      folders-only mode) or directory (when in folders-only mode)
20740     * - @c "directory,open" - the list has been populated with new
20741     *      content (@c event_info is a pointer to the directory's
20742     *      path, a @b stringshared string)
20743     * - @c "done" - the user has clicked on the "ok" or "cancel"
20744     *      buttons (@c event_info is a pointer to the selection's
20745     *      path, a @b stringshared string)
20746     *
20747     * Here is an example on its usage:
20748     * @li @ref fileselector_example
20749     */
20750
20751    /**
20752     * @addtogroup Fileselector
20753     * @{
20754     */
20755
20756    /**
20757     * Defines how a file selector widget is to layout its contents
20758     * (file system entries).
20759     */
20760    typedef enum _Elm_Fileselector_Mode
20761      {
20762         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20763         ELM_FILESELECTOR_GRID, /**< layout as a grid */
20764         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20765      } Elm_Fileselector_Mode;
20766
20767    /**
20768     * Add a new file selector widget to the given parent Elementary
20769     * (container) object
20770     *
20771     * @param parent The parent object
20772     * @return a new file selector widget handle or @c NULL, on errors
20773     *
20774     * This function inserts a new file selector widget on the canvas.
20775     *
20776     * @ingroup Fileselector
20777     */
20778    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20779
20780    /**
20781     * Enable/disable the file name entry box where the user can type
20782     * in a name for a file, in a given file selector widget
20783     *
20784     * @param obj The file selector object
20785     * @param is_save @c EINA_TRUE to make the file selector a "saving
20786     * dialog", @c EINA_FALSE otherwise
20787     *
20788     * Having the entry editable is useful on file saving dialogs on
20789     * applications, where one gives a file name to save contents to,
20790     * in a given directory in the system. This custom file name will
20791     * be reported on the @c "done" smart callback.
20792     *
20793     * @see elm_fileselector_is_save_get()
20794     *
20795     * @ingroup Fileselector
20796     */
20797    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20798
20799    /**
20800     * Get whether the given file selector is in "saving dialog" mode
20801     *
20802     * @param obj The file selector object
20803     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20804     * mode, @c EINA_FALSE otherwise (and on errors)
20805     *
20806     * @see elm_fileselector_is_save_set() for more details
20807     *
20808     * @ingroup Fileselector
20809     */
20810    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20811
20812    /**
20813     * Enable/disable folder-only view for a given file selector widget
20814     *
20815     * @param obj The file selector object
20816     * @param only @c EINA_TRUE to make @p obj only display
20817     * directories, @c EINA_FALSE to make files to be displayed in it
20818     * too
20819     *
20820     * If enabled, the widget's view will only display folder items,
20821     * naturally.
20822     *
20823     * @see elm_fileselector_folder_only_get()
20824     *
20825     * @ingroup Fileselector
20826     */
20827    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20828
20829    /**
20830     * Get whether folder-only view is set for a given file selector
20831     * widget
20832     *
20833     * @param obj The file selector object
20834     * @return only @c EINA_TRUE if @p obj is only displaying
20835     * directories, @c EINA_FALSE if files are being displayed in it
20836     * too (and on errors)
20837     *
20838     * @see elm_fileselector_folder_only_get()
20839     *
20840     * @ingroup Fileselector
20841     */
20842    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20843
20844    /**
20845     * Enable/disable the "ok" and "cancel" buttons on a given file
20846     * selector widget
20847     *
20848     * @param obj The file selector object
20849     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20850     *
20851     * @note A file selector without those buttons will never emit the
20852     * @c "done" smart event, and is only usable if one is just hooking
20853     * to the other two events.
20854     *
20855     * @see elm_fileselector_buttons_ok_cancel_get()
20856     *
20857     * @ingroup Fileselector
20858     */
20859    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20860
20861    /**
20862     * Get whether the "ok" and "cancel" buttons on a given file
20863     * selector widget are being shown.
20864     *
20865     * @param obj The file selector object
20866     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20867     * otherwise (and on errors)
20868     *
20869     * @see elm_fileselector_buttons_ok_cancel_set() for more details
20870     *
20871     * @ingroup Fileselector
20872     */
20873    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20874
20875    /**
20876     * Enable/disable a tree view in the given file selector widget,
20877     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20878     *
20879     * @param obj The file selector object
20880     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20881     * disable
20882     *
20883     * In a tree view, arrows are created on the sides of directories,
20884     * allowing them to expand in place.
20885     *
20886     * @note If it's in other mode, the changes made by this function
20887     * will only be visible when one switches back to "list" mode.
20888     *
20889     * @see elm_fileselector_expandable_get()
20890     *
20891     * @ingroup Fileselector
20892     */
20893    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20894
20895    /**
20896     * Get whether tree view is enabled for the given file selector
20897     * widget
20898     *
20899     * @param obj The file selector object
20900     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20901     * otherwise (and or errors)
20902     *
20903     * @see elm_fileselector_expandable_set() for more details
20904     *
20905     * @ingroup Fileselector
20906     */
20907    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20908
20909    /**
20910     * Set, programmatically, the @b directory that a given file
20911     * selector widget will display contents from
20912     *
20913     * @param obj The file selector object
20914     * @param path The path to display in @p obj
20915     *
20916     * This will change the @b directory that @p obj is displaying. It
20917     * will also clear the text entry area on the @p obj object, which
20918     * displays select files' names.
20919     *
20920     * @see elm_fileselector_path_get()
20921     *
20922     * @ingroup Fileselector
20923     */
20924    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20925
20926    /**
20927     * Get the parent directory's path that a given file selector
20928     * widget is displaying
20929     *
20930     * @param obj The file selector object
20931     * @return The (full) path of the directory the file selector is
20932     * displaying, a @b stringshared string
20933     *
20934     * @see elm_fileselector_path_set()
20935     *
20936     * @ingroup Fileselector
20937     */
20938    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20939
20940    /**
20941     * Set, programmatically, the currently selected file/directory in
20942     * the given file selector widget
20943     *
20944     * @param obj The file selector object
20945     * @param path The (full) path to a file or directory
20946     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20947     * latter case occurs if the directory or file pointed to do not
20948     * exist.
20949     *
20950     * @see elm_fileselector_selected_get()
20951     *
20952     * @ingroup Fileselector
20953     */
20954    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20955
20956    /**
20957     * Get the currently selected item's (full) path, in the given file
20958     * selector widget
20959     *
20960     * @param obj The file selector object
20961     * @return The absolute path of the selected item, a @b
20962     * stringshared string
20963     *
20964     * @note Custom editions on @p obj object's text entry, if made,
20965     * will appear on the return string of this function, naturally.
20966     *
20967     * @see elm_fileselector_selected_set() for more details
20968     *
20969     * @ingroup Fileselector
20970     */
20971    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20972
20973    /**
20974     * Set the mode in which a given file selector widget will display
20975     * (layout) file system entries in its view
20976     *
20977     * @param obj The file selector object
20978     * @param mode The mode of the fileselector, being it one of
20979     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20980     * first one, naturally, will display the files in a list. The
20981     * latter will make the widget to display its entries in a grid
20982     * form.
20983     *
20984     * @note By using elm_fileselector_expandable_set(), the user may
20985     * trigger a tree view for that list.
20986     *
20987     * @note If Elementary is built with support of the Ethumb
20988     * thumbnailing library, the second form of view will display
20989     * preview thumbnails of files which it supports. You must have
20990     * elm_need_ethumb() called in your Elementary for thumbnailing to
20991     * work, though.
20992     *
20993     * @see elm_fileselector_expandable_set().
20994     * @see elm_fileselector_mode_get().
20995     *
20996     * @ingroup Fileselector
20997     */
20998    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20999
21000    /**
21001     * Get the mode in which a given file selector widget is displaying
21002     * (layouting) file system entries in its view
21003     *
21004     * @param obj The fileselector object
21005     * @return The mode in which the fileselector is at
21006     *
21007     * @see elm_fileselector_mode_set() for more details
21008     *
21009     * @ingroup Fileselector
21010     */
21011    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21012
21013    /**
21014     * @}
21015     */
21016
21017    /**
21018     * @defgroup Progressbar Progress bar
21019     *
21020     * The progress bar is a widget for visually representing the
21021     * progress status of a given job/task.
21022     *
21023     * A progress bar may be horizontal or vertical. It may display an
21024     * icon besides it, as well as primary and @b units labels. The
21025     * former is meant to label the widget as a whole, while the
21026     * latter, which is formatted with floating point values (and thus
21027     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21028     * units"</c>), is meant to label the widget's <b>progress
21029     * value</b>. Label, icon and unit strings/objects are @b optional
21030     * for progress bars.
21031     *
21032     * A progress bar may be @b inverted, in which state it gets its
21033     * values inverted, with high values being on the left or top and
21034     * low values on the right or bottom, as opposed to normally have
21035     * the low values on the former and high values on the latter,
21036     * respectively, for horizontal and vertical modes.
21037     *
21038     * The @b span of the progress, as set by
21039     * elm_progressbar_span_size_set(), is its length (horizontally or
21040     * vertically), unless one puts size hints on the widget to expand
21041     * on desired directions, by any container. That length will be
21042     * scaled by the object or applications scaling factor. At any
21043     * point code can query the progress bar for its value with
21044     * elm_progressbar_value_get().
21045     *
21046     * Available widget styles for progress bars:
21047     * - @c "default"
21048     * - @c "wheel" (simple style, no text, no progression, only
21049     *      "pulse" effect is available)
21050     *
21051     * Default contents parts of the progressbar widget that you can use for are:
21052     * @li "elm.swallow.content" - A icon of the progressbar
21053     * 
21054     * Here is an example on its usage:
21055     * @li @ref progressbar_example
21056     */
21057
21058    /**
21059     * Add a new progress bar widget to the given parent Elementary
21060     * (container) object
21061     *
21062     * @param parent The parent object
21063     * @return a new progress bar widget handle or @c NULL, on errors
21064     *
21065     * This function inserts a new progress bar widget on the canvas.
21066     *
21067     * @ingroup Progressbar
21068     */
21069    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21070
21071    /**
21072     * Set whether a given progress bar widget is at "pulsing mode" or
21073     * not.
21074     *
21075     * @param obj The progress bar object
21076     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21077     * @c EINA_FALSE to put it back to its default one
21078     *
21079     * By default, progress bars will display values from the low to
21080     * high value boundaries. There are, though, contexts in which the
21081     * state of progression of a given task is @b unknown.  For those,
21082     * one can set a progress bar widget to a "pulsing state", to give
21083     * the user an idea that some computation is being held, but
21084     * without exact progress values. In the default theme it will
21085     * animate its bar with the contents filling in constantly and back
21086     * to non-filled, in a loop. To start and stop this pulsing
21087     * animation, one has to explicitly call elm_progressbar_pulse().
21088     *
21089     * @see elm_progressbar_pulse_get()
21090     * @see elm_progressbar_pulse()
21091     *
21092     * @ingroup Progressbar
21093     */
21094    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21095
21096    /**
21097     * Get whether a given progress bar widget is at "pulsing mode" or
21098     * not.
21099     *
21100     * @param obj The progress bar object
21101     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21102     * if it's in the default one (and on errors)
21103     *
21104     * @ingroup Progressbar
21105     */
21106    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21107
21108    /**
21109     * Start/stop a given progress bar "pulsing" animation, if its
21110     * under that mode
21111     *
21112     * @param obj The progress bar object
21113     * @param state @c EINA_TRUE, to @b start the pulsing animation,
21114     * @c EINA_FALSE to @b stop it
21115     *
21116     * @note This call won't do anything if @p obj is not under "pulsing mode".
21117     *
21118     * @see elm_progressbar_pulse_set() for more details.
21119     *
21120     * @ingroup Progressbar
21121     */
21122    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21123
21124    /**
21125     * Set the progress value (in percentage) on a given progress bar
21126     * widget
21127     *
21128     * @param obj The progress bar object
21129     * @param val The progress value (@b must be between @c 0.0 and @c
21130     * 1.0)
21131     *
21132     * Use this call to set progress bar levels.
21133     *
21134     * @note If you passes a value out of the specified range for @p
21135     * val, it will be interpreted as the @b closest of the @b boundary
21136     * values in the range.
21137     *
21138     * @ingroup Progressbar
21139     */
21140    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21141
21142    /**
21143     * Get the progress value (in percentage) on a given progress bar
21144     * widget
21145     *
21146     * @param obj The progress bar object
21147     * @return The value of the progressbar
21148     *
21149     * @see elm_progressbar_value_set() for more details
21150     *
21151     * @ingroup Progressbar
21152     */
21153    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21154
21155    /**
21156     * Set the label of a given progress bar widget
21157     *
21158     * @param obj The progress bar object
21159     * @param label The text label string, in UTF-8
21160     *
21161     * @ingroup Progressbar
21162     * @deprecated use elm_object_text_set() instead.
21163     */
21164    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21165
21166    /**
21167     * Get the label of a given progress bar widget
21168     *
21169     * @param obj The progressbar object
21170     * @return The text label string, in UTF-8
21171     *
21172     * @ingroup Progressbar
21173     * @deprecated use elm_object_text_set() instead.
21174     */
21175    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21176
21177    /**
21178     * Set the icon object of a given progress bar widget
21179     *
21180     * @param obj The progress bar object
21181     * @param icon The icon object
21182     *
21183     * Use this call to decorate @p obj with an icon next to it.
21184     *
21185     * @note Once the icon object is set, a previously set one will be
21186     * deleted. If you want to keep that old content object, use the
21187     * elm_progressbar_icon_unset() function.
21188     *
21189     * @see elm_progressbar_icon_get()
21190     *
21191     * @ingroup Progressbar
21192     */
21193    EINA_DEPRECATED EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21194
21195    /**
21196     * Retrieve the icon object set for a given progress bar widget
21197     *
21198     * @param obj The progress bar object
21199     * @return The icon object's handle, if @p obj had one set, or @c NULL,
21200     * otherwise (and on errors)
21201     *
21202     * @see elm_progressbar_icon_set() for more details
21203     *
21204     * @ingroup Progressbar
21205     */
21206    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21207
21208    /**
21209     * Unset an icon set on a given progress bar widget
21210     *
21211     * @param obj The progress bar object
21212     * @return The icon object that was being used, if any was set, or
21213     * @c NULL, otherwise (and on errors)
21214     *
21215     * This call will unparent and return the icon object which was set
21216     * for this widget, previously, on success.
21217     *
21218     * @see elm_progressbar_icon_set() for more details
21219     *
21220     * @ingroup Progressbar
21221     */
21222    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21223
21224    /**
21225     * Set the (exact) length of the bar region of a given progress bar
21226     * widget
21227     *
21228     * @param obj The progress bar object
21229     * @param size The length of the progress bar's bar region
21230     *
21231     * This sets the minimum width (when in horizontal mode) or height
21232     * (when in vertical mode) of the actual bar area of the progress
21233     * bar @p obj. This in turn affects the object's minimum size. Use
21234     * this when you're not setting other size hints expanding on the
21235     * given direction (like weight and alignment hints) and you would
21236     * like it to have a specific size.
21237     *
21238     * @note Icon, label and unit text around @p obj will require their
21239     * own space, which will make @p obj to require more the @p size,
21240     * actually.
21241     *
21242     * @see elm_progressbar_span_size_get()
21243     *
21244     * @ingroup Progressbar
21245     */
21246    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21247
21248    /**
21249     * Get the length set for the bar region of a given progress bar
21250     * widget
21251     *
21252     * @param obj The progress bar object
21253     * @return The length of the progress bar's bar region
21254     *
21255     * If that size was not set previously, with
21256     * elm_progressbar_span_size_set(), this call will return @c 0.
21257     *
21258     * @ingroup Progressbar
21259     */
21260    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21261
21262    /**
21263     * Set the format string for a given progress bar widget's units
21264     * label
21265     *
21266     * @param obj The progress bar object
21267     * @param format The format string for @p obj's units label
21268     *
21269     * If @c NULL is passed on @p format, it will make @p obj's units
21270     * area to be hidden completely. If not, it'll set the <b>format
21271     * string</b> for the units label's @b text. The units label is
21272     * provided a floating point value, so the units text is up display
21273     * at most one floating point falue. Note that the units label is
21274     * optional. Use a format string such as "%1.2f meters" for
21275     * example.
21276     *
21277     * @note The default format string for a progress bar is an integer
21278     * percentage, as in @c "%.0f %%".
21279     *
21280     * @see elm_progressbar_unit_format_get()
21281     *
21282     * @ingroup Progressbar
21283     */
21284    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21285
21286    /**
21287     * Retrieve the format string set for a given progress bar widget's
21288     * units label
21289     *
21290     * @param obj The progress bar object
21291     * @return The format set string for @p obj's units label or
21292     * @c NULL, if none was set (and on errors)
21293     *
21294     * @see elm_progressbar_unit_format_set() for more details
21295     *
21296     * @ingroup Progressbar
21297     */
21298    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21299
21300    /**
21301     * Set the orientation of a given progress bar widget
21302     *
21303     * @param obj The progress bar object
21304     * @param horizontal Use @c EINA_TRUE to make @p obj to be
21305     * @b horizontal, @c EINA_FALSE to make it @b vertical
21306     *
21307     * Use this function to change how your progress bar is to be
21308     * disposed: vertically or horizontally.
21309     *
21310     * @see elm_progressbar_horizontal_get()
21311     *
21312     * @ingroup Progressbar
21313     */
21314    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21315
21316    /**
21317     * Retrieve the orientation of a given progress bar widget
21318     *
21319     * @param obj The progress bar object
21320     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21321     * @c EINA_FALSE if it's @b vertical (and on errors)
21322     *
21323     * @see elm_progressbar_horizontal_set() for more details
21324     *
21325     * @ingroup Progressbar
21326     */
21327    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21328
21329    /**
21330     * Invert a given progress bar widget's displaying values order
21331     *
21332     * @param obj The progress bar object
21333     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21334     * @c EINA_FALSE to bring it back to default, non-inverted values.
21335     *
21336     * A progress bar may be @b inverted, in which state it gets its
21337     * values inverted, with high values being on the left or top and
21338     * low values on the right or bottom, as opposed to normally have
21339     * the low values on the former and high values on the latter,
21340     * respectively, for horizontal and vertical modes.
21341     *
21342     * @see elm_progressbar_inverted_get()
21343     *
21344     * @ingroup Progressbar
21345     */
21346    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21347
21348    /**
21349     * Get whether a given progress bar widget's displaying values are
21350     * inverted or not
21351     *
21352     * @param obj The progress bar object
21353     * @return @c EINA_TRUE, if @p obj has inverted values,
21354     * @c EINA_FALSE otherwise (and on errors)
21355     *
21356     * @see elm_progressbar_inverted_set() for more details
21357     *
21358     * @ingroup Progressbar
21359     */
21360    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21361
21362    /**
21363     * @defgroup Separator Separator
21364     *
21365     * @brief Separator is a very thin object used to separate other objects.
21366     *
21367     * A separator can be vertical or horizontal.
21368     *
21369     * @ref tutorial_separator is a good example of how to use a separator.
21370     * @{
21371     */
21372    /**
21373     * @brief Add a separator object to @p parent
21374     *
21375     * @param parent The parent object
21376     *
21377     * @return The separator object, or NULL upon failure
21378     */
21379    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21380    /**
21381     * @brief Set the horizontal mode of a separator object
21382     *
21383     * @param obj The separator object
21384     * @param horizontal If true, the separator is horizontal
21385     */
21386    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21387    /**
21388     * @brief Get the horizontal mode of a separator object
21389     *
21390     * @param obj The separator object
21391     * @return If true, the separator is horizontal
21392     *
21393     * @see elm_separator_horizontal_set()
21394     */
21395    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21396    /**
21397     * @}
21398     */
21399
21400    /**
21401     * @defgroup Spinner Spinner
21402     * @ingroup Elementary
21403     *
21404     * @image html img/widget/spinner/preview-00.png
21405     * @image latex img/widget/spinner/preview-00.eps
21406     *
21407     * A spinner is a widget which allows the user to increase or decrease
21408     * numeric values using arrow buttons, or edit values directly, clicking
21409     * over it and typing the new value.
21410     *
21411     * By default the spinner will not wrap and has a label
21412     * of "%.0f" (just showing the integer value of the double).
21413     *
21414     * A spinner has a label that is formatted with floating
21415     * point values and thus accepts a printf-style format string, like
21416     * ā€œ%1.2f unitsā€.
21417     *
21418     * It also allows specific values to be replaced by pre-defined labels.
21419     *
21420     * Smart callbacks one can register to:
21421     *
21422     * - "changed" - Whenever the spinner value is changed.
21423     * - "delay,changed" - A short time after the value is changed by the user.
21424     *    This will be called only when the user stops dragging for a very short
21425     *    period or when they release their finger/mouse, so it avoids possibly
21426     *    expensive reactions to the value change.
21427     *
21428     * Available styles for it:
21429     * - @c "default";
21430     * - @c "vertical": up/down buttons at the right side and text left aligned.
21431     *
21432     * Here is an example on its usage:
21433     * @ref spinner_example
21434     */
21435
21436    /**
21437     * @addtogroup Spinner
21438     * @{
21439     */
21440
21441    /**
21442     * Add a new spinner widget to the given parent Elementary
21443     * (container) object.
21444     *
21445     * @param parent The parent object.
21446     * @return a new spinner widget handle or @c NULL, on errors.
21447     *
21448     * This function inserts a new spinner widget on the canvas.
21449     *
21450     * @ingroup Spinner
21451     *
21452     */
21453    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21454
21455    /**
21456     * Set the format string of the displayed label.
21457     *
21458     * @param obj The spinner object.
21459     * @param fmt The format string for the label display.
21460     *
21461     * If @c NULL, this sets the format to "%.0f". If not it sets the format
21462     * string for the label text. The label text is provided a floating point
21463     * value, so the label text can display up to 1 floating point value.
21464     * Note that this is optional.
21465     *
21466     * Use a format string such as "%1.2f meters" for example, and it will
21467     * display values like: "3.14 meters" for a value equal to 3.14159.
21468     *
21469     * Default is "%0.f".
21470     *
21471     * @see elm_spinner_label_format_get()
21472     *
21473     * @ingroup Spinner
21474     */
21475    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21476
21477    /**
21478     * Get the label format of the spinner.
21479     *
21480     * @param obj The spinner object.
21481     * @return The text label format string in UTF-8.
21482     *
21483     * @see elm_spinner_label_format_set() for details.
21484     *
21485     * @ingroup Spinner
21486     */
21487    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21488
21489    /**
21490     * Set the minimum and maximum values for the spinner.
21491     *
21492     * @param obj The spinner object.
21493     * @param min The minimum value.
21494     * @param max The maximum value.
21495     *
21496     * Define the allowed range of values to be selected by the user.
21497     *
21498     * If actual value is less than @p min, it will be updated to @p min. If it
21499     * is bigger then @p max, will be updated to @p max. Actual value can be
21500     * get with elm_spinner_value_get().
21501     *
21502     * By default, min is equal to 0, and max is equal to 100.
21503     *
21504     * @warning Maximum must be greater than minimum.
21505     *
21506     * @see elm_spinner_min_max_get()
21507     *
21508     * @ingroup Spinner
21509     */
21510    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21511
21512    /**
21513     * Get the minimum and maximum values of the spinner.
21514     *
21515     * @param obj The spinner object.
21516     * @param min Pointer where to store the minimum value.
21517     * @param max Pointer where to store the maximum value.
21518     *
21519     * @note If only one value is needed, the other pointer can be passed
21520     * as @c NULL.
21521     *
21522     * @see elm_spinner_min_max_set() for details.
21523     *
21524     * @ingroup Spinner
21525     */
21526    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21527
21528    /**
21529     * Set the step used to increment or decrement the spinner value.
21530     *
21531     * @param obj The spinner object.
21532     * @param step The step value.
21533     *
21534     * This value will be incremented or decremented to the displayed value.
21535     * It will be incremented while the user keep right or top arrow pressed,
21536     * and will be decremented while the user keep left or bottom arrow pressed.
21537     *
21538     * The interval to increment / decrement can be set with
21539     * elm_spinner_interval_set().
21540     *
21541     * By default step value is equal to 1.
21542     *
21543     * @see elm_spinner_step_get()
21544     *
21545     * @ingroup Spinner
21546     */
21547    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21548
21549    /**
21550     * Get the step used to increment or decrement the spinner value.
21551     *
21552     * @param obj The spinner object.
21553     * @return The step value.
21554     *
21555     * @see elm_spinner_step_get() for more details.
21556     *
21557     * @ingroup Spinner
21558     */
21559    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21560
21561    /**
21562     * Set the value the spinner displays.
21563     *
21564     * @param obj The spinner object.
21565     * @param val The value to be displayed.
21566     *
21567     * Value will be presented on the label following format specified with
21568     * elm_spinner_format_set().
21569     *
21570     * @warning The value must to be between min and max values. This values
21571     * are set by elm_spinner_min_max_set().
21572     *
21573     * @see elm_spinner_value_get().
21574     * @see elm_spinner_format_set().
21575     * @see elm_spinner_min_max_set().
21576     *
21577     * @ingroup Spinner
21578     */
21579    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21580
21581    /**
21582     * Get the value displayed by the spinner.
21583     *
21584     * @param obj The spinner object.
21585     * @return The value displayed.
21586     *
21587     * @see elm_spinner_value_set() for details.
21588     *
21589     * @ingroup Spinner
21590     */
21591    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21592
21593    /**
21594     * Set whether the spinner should wrap when it reaches its
21595     * minimum or maximum value.
21596     *
21597     * @param obj The spinner object.
21598     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21599     * disable it.
21600     *
21601     * Disabled by default. If disabled, when the user tries to increment the
21602     * value,
21603     * but displayed value plus step value is bigger than maximum value,
21604     * the spinner
21605     * won't allow it. The same happens when the user tries to decrement it,
21606     * but the value less step is less than minimum value.
21607     *
21608     * When wrap is enabled, in such situations it will allow these changes,
21609     * but will get the value that would be less than minimum and subtracts
21610     * from maximum. Or add the value that would be more than maximum to
21611     * the minimum.
21612     *
21613     * E.g.:
21614     * @li min value = 10
21615     * @li max value = 50
21616     * @li step value = 20
21617     * @li displayed value = 20
21618     *
21619     * When the user decrement value (using left or bottom arrow), it will
21620     * displays @c 40, because max - (min - (displayed - step)) is
21621     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21622     *
21623     * @see elm_spinner_wrap_get().
21624     *
21625     * @ingroup Spinner
21626     */
21627    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21628
21629    /**
21630     * Get whether the spinner should wrap when it reaches its
21631     * minimum or maximum value.
21632     *
21633     * @param obj The spinner object
21634     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21635     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21636     *
21637     * @see elm_spinner_wrap_set() for details.
21638     *
21639     * @ingroup Spinner
21640     */
21641    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21642
21643    /**
21644     * Set whether the spinner can be directly edited by the user or not.
21645     *
21646     * @param obj The spinner object.
21647     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21648     * don't allow users to edit it directly.
21649     *
21650     * Spinner objects can have edition @b disabled, in which state they will
21651     * be changed only by arrows.
21652     * Useful for contexts
21653     * where you don't want your users to interact with it writting the value.
21654     * Specially
21655     * when using special values, the user can see real value instead
21656     * of special label on edition.
21657     *
21658     * It's enabled by default.
21659     *
21660     * @see elm_spinner_editable_get()
21661     *
21662     * @ingroup Spinner
21663     */
21664    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21665
21666    /**
21667     * Get whether the spinner can be directly edited by the user or not.
21668     *
21669     * @param obj The spinner object.
21670     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21671     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21672     *
21673     * @see elm_spinner_editable_set() for details.
21674     *
21675     * @ingroup Spinner
21676     */
21677    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21678
21679    /**
21680     * Set a special string to display in the place of the numerical value.
21681     *
21682     * @param obj The spinner object.
21683     * @param value The value to be replaced.
21684     * @param label The label to be used.
21685     *
21686     * It's useful for cases when a user should select an item that is
21687     * better indicated by a label than a value. For example, weekdays or months.
21688     *
21689     * E.g.:
21690     * @code
21691     * sp = elm_spinner_add(win);
21692     * elm_spinner_min_max_set(sp, 1, 3);
21693     * elm_spinner_special_value_add(sp, 1, "January");
21694     * elm_spinner_special_value_add(sp, 2, "February");
21695     * elm_spinner_special_value_add(sp, 3, "March");
21696     * evas_object_show(sp);
21697     * @endcode
21698     *
21699     * @ingroup Spinner
21700     */
21701    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21702
21703    /**
21704     * Set the interval on time updates for an user mouse button hold
21705     * on spinner widgets' arrows.
21706     *
21707     * @param obj The spinner object.
21708     * @param interval The (first) interval value in seconds.
21709     *
21710     * This interval value is @b decreased while the user holds the
21711     * mouse pointer either incrementing or decrementing spinner's value.
21712     *
21713     * This helps the user to get to a given value distant from the
21714     * current one easier/faster, as it will start to change quicker and
21715     * quicker on mouse button holds.
21716     *
21717     * The calculation for the next change interval value, starting from
21718     * the one set with this call, is the previous interval divided by
21719     * @c 1.05, so it decreases a little bit.
21720     *
21721     * The default starting interval value for automatic changes is
21722     * @c 0.85 seconds.
21723     *
21724     * @see elm_spinner_interval_get()
21725     *
21726     * @ingroup Spinner
21727     */
21728    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21729
21730    /**
21731     * Get the interval on time updates for an user mouse button hold
21732     * on spinner widgets' arrows.
21733     *
21734     * @param obj The spinner object.
21735     * @return The (first) interval value, in seconds, set on it.
21736     *
21737     * @see elm_spinner_interval_set() for more details.
21738     *
21739     * @ingroup Spinner
21740     */
21741    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21742
21743    /**
21744     * @}
21745     */
21746
21747    /**
21748     * @defgroup Index Index
21749     *
21750     * @image html img/widget/index/preview-00.png
21751     * @image latex img/widget/index/preview-00.eps
21752     *
21753     * An index widget gives you an index for fast access to whichever
21754     * group of other UI items one might have. It's a list of text
21755     * items (usually letters, for alphabetically ordered access).
21756     *
21757     * Index widgets are by default hidden and just appear when the
21758     * user clicks over it's reserved area in the canvas. In its
21759     * default theme, it's an area one @ref Fingers "finger" wide on
21760     * the right side of the index widget's container.
21761     *
21762     * When items on the index are selected, smart callbacks get
21763     * called, so that its user can make other container objects to
21764     * show a given area or child object depending on the index item
21765     * selected. You'd probably be using an index together with @ref
21766     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21767     * "general grids".
21768     *
21769     * Smart events one  can add callbacks for are:
21770     * - @c "changed" - When the selected index item changes. @c
21771     *      event_info is the selected item's data pointer.
21772     * - @c "delay,changed" - When the selected index item changes, but
21773     *      after a small idling period. @c event_info is the selected
21774     *      item's data pointer.
21775     * - @c "selected" - When the user releases a mouse button and
21776     *      selects an item. @c event_info is the selected item's data
21777     *      pointer.
21778     * - @c "level,up" - when the user moves a finger from the first
21779     *      level to the second level
21780     * - @c "level,down" - when the user moves a finger from the second
21781     *      level to the first level
21782     *
21783     * The @c "delay,changed" event is so that it'll wait a small time
21784     * before actually reporting those events and, moreover, just the
21785     * last event happening on those time frames will actually be
21786     * reported.
21787     *
21788     * Here are some examples on its usage:
21789     * @li @ref index_example_01
21790     * @li @ref index_example_02
21791     */
21792
21793    /**
21794     * @addtogroup Index
21795     * @{
21796     */
21797
21798    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21799
21800    /**
21801     * Add a new index widget to the given parent Elementary
21802     * (container) object
21803     *
21804     * @param parent The parent object
21805     * @return a new index widget handle or @c NULL, on errors
21806     *
21807     * This function inserts a new index widget on the canvas.
21808     *
21809     * @ingroup Index
21810     */
21811    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21812
21813    /**
21814     * Set whether a given index widget is or not visible,
21815     * programatically.
21816     *
21817     * @param obj The index object
21818     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21819     *
21820     * Not to be confused with visible as in @c evas_object_show() --
21821     * visible with regard to the widget's auto hiding feature.
21822     *
21823     * @see elm_index_active_get()
21824     *
21825     * @ingroup Index
21826     */
21827    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21828
21829    /**
21830     * Get whether a given index widget is currently visible or not.
21831     *
21832     * @param obj The index object
21833     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21834     *
21835     * @see elm_index_active_set() for more details
21836     *
21837     * @ingroup Index
21838     */
21839    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21840
21841    /**
21842     * Set the items level for a given index widget.
21843     *
21844     * @param obj The index object.
21845     * @param level @c 0 or @c 1, the currently implemented levels.
21846     *
21847     * @see elm_index_item_level_get()
21848     *
21849     * @ingroup Index
21850     */
21851    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21852
21853    /**
21854     * Get the items level set for a given index widget.
21855     *
21856     * @param obj The index object.
21857     * @return @c 0 or @c 1, which are the levels @p obj might be at.
21858     *
21859     * @see elm_index_item_level_set() for more information
21860     *
21861     * @ingroup Index
21862     */
21863    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21864
21865    /**
21866     * Returns the last selected item's data, for a given index widget.
21867     *
21868     * @param obj The index object.
21869     * @return The item @b data associated to the last selected item on
21870     * @p obj (or @c NULL, on errors).
21871     *
21872     * @warning The returned value is @b not an #Elm_Index_Item item
21873     * handle, but the data associated to it (see the @c item parameter
21874     * in elm_index_item_append(), as an example).
21875     *
21876     * @ingroup Index
21877     */
21878    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21879
21880    /**
21881     * Append a new item on a given index widget.
21882     *
21883     * @param obj The index object.
21884     * @param letter Letter under which the item should be indexed
21885     * @param item The item data to set for the index's item
21886     *
21887     * Despite the most common usage of the @p letter argument is for
21888     * single char strings, one could use arbitrary strings as index
21889     * entries.
21890     *
21891     * @c item will be the pointer returned back on @c "changed", @c
21892     * "delay,changed" and @c "selected" smart events.
21893     *
21894     * @ingroup Index
21895     */
21896    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21897
21898    /**
21899     * Prepend a new item on a given index widget.
21900     *
21901     * @param obj The index object.
21902     * @param letter Letter under which the item should be indexed
21903     * @param item The item data to set for the index's item
21904     *
21905     * Despite the most common usage of the @p letter argument is for
21906     * single char strings, one could use arbitrary strings as index
21907     * entries.
21908     *
21909     * @c item will be the pointer returned back on @c "changed", @c
21910     * "delay,changed" and @c "selected" smart events.
21911     *
21912     * @ingroup Index
21913     */
21914    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21915
21916    /**
21917     * Append a new item, on a given index widget, <b>after the item
21918     * having @p relative as data</b>.
21919     *
21920     * @param obj The index object.
21921     * @param letter Letter under which the item should be indexed
21922     * @param item The item data to set for the index's item
21923     * @param relative The item data of the index item to be the
21924     * predecessor of this new one
21925     *
21926     * Despite the most common usage of the @p letter argument is for
21927     * single char strings, one could use arbitrary strings as index
21928     * entries.
21929     *
21930     * @c item will be the pointer returned back on @c "changed", @c
21931     * "delay,changed" and @c "selected" smart events.
21932     *
21933     * @note If @p relative is @c NULL or if it's not found to be data
21934     * set on any previous item on @p obj, this function will behave as
21935     * elm_index_item_append().
21936     *
21937     * @ingroup Index
21938     */
21939    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21940
21941    /**
21942     * Prepend a new item, on a given index widget, <b>after the item
21943     * having @p relative as data</b>.
21944     *
21945     * @param obj The index object.
21946     * @param letter Letter under which the item should be indexed
21947     * @param item The item data to set for the index's item
21948     * @param relative The item data of the index item to be the
21949     * successor of this new one
21950     *
21951     * Despite the most common usage of the @p letter argument is for
21952     * single char strings, one could use arbitrary strings as index
21953     * entries.
21954     *
21955     * @c item will be the pointer returned back on @c "changed", @c
21956     * "delay,changed" and @c "selected" smart events.
21957     *
21958     * @note If @p relative is @c NULL or if it's not found to be data
21959     * set on any previous item on @p obj, this function will behave as
21960     * elm_index_item_prepend().
21961     *
21962     * @ingroup Index
21963     */
21964    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21965
21966    /**
21967     * Insert a new item into the given index widget, using @p cmp_func
21968     * function to sort items (by item handles).
21969     *
21970     * @param obj The index object.
21971     * @param letter Letter under which the item should be indexed
21972     * @param item The item data to set for the index's item
21973     * @param cmp_func The comparing function to be used to sort index
21974     * items <b>by #Elm_Index_Item item handles</b>
21975     * @param cmp_data_func A @b fallback function to be called for the
21976     * sorting of index items <b>by item data</b>). It will be used
21977     * when @p cmp_func returns @c 0 (equality), which means an index
21978     * item with provided item data already exists. To decide which
21979     * data item should be pointed to by the index item in question, @p
21980     * cmp_data_func will be used. If @p cmp_data_func returns a
21981     * non-negative value, the previous index item data will be
21982     * replaced by the given @p item pointer. If the previous data need
21983     * to be freed, it should be done by the @p cmp_data_func function,
21984     * because all references to it will be lost. If this function is
21985     * not provided (@c NULL is given), index items will be @b
21986     * duplicated, if @p cmp_func returns @c 0.
21987     *
21988     * Despite the most common usage of the @p letter argument is for
21989     * single char strings, one could use arbitrary strings as index
21990     * entries.
21991     *
21992     * @c item will be the pointer returned back on @c "changed", @c
21993     * "delay,changed" and @c "selected" smart events.
21994     *
21995     * @ingroup Index
21996     */
21997    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);
21998
21999    /**
22000     * Remove an item from a given index widget, <b>to be referenced by
22001     * it's data value</b>.
22002     *
22003     * @param obj The index object
22004     * @param item The item's data pointer for the item to be removed
22005     * from @p obj
22006     *
22007     * If a deletion callback is set, via elm_index_item_del_cb_set(),
22008     * that callback function will be called by this one.
22009     *
22010     * @warning The item to be removed from @p obj will be found via
22011     * its item data pointer, and not by an #Elm_Index_Item handle.
22012     *
22013     * @ingroup Index
22014     */
22015    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22016
22017    /**
22018     * Find a given index widget's item, <b>using item data</b>.
22019     *
22020     * @param obj The index object
22021     * @param item The item data pointed to by the desired index item
22022     * @return The index item handle, if found, or @c NULL otherwise
22023     *
22024     * @ingroup Index
22025     */
22026    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22027
22028    /**
22029     * Removes @b all items from a given index widget.
22030     *
22031     * @param obj The index object.
22032     *
22033     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22034     * that callback function will be called for each item in @p obj.
22035     *
22036     * @ingroup Index
22037     */
22038    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22039
22040    /**
22041     * Go to a given items level on a index widget
22042     *
22043     * @param obj The index object
22044     * @param level The index level (one of @c 0 or @c 1)
22045     *
22046     * @ingroup Index
22047     */
22048    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22049
22050    /**
22051     * Return the data associated with a given index widget item
22052     *
22053     * @param it The index widget item handle
22054     * @return The data associated with @p it
22055     *
22056     * @see elm_index_item_data_set()
22057     *
22058     * @ingroup Index
22059     */
22060    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22061
22062    /**
22063     * Set the data associated with a given index widget item
22064     *
22065     * @param it The index widget item handle
22066     * @param data The new data pointer to set to @p it
22067     *
22068     * This sets new item data on @p it.
22069     *
22070     * @warning The old data pointer won't be touched by this function, so
22071     * the user had better to free that old data himself/herself.
22072     *
22073     * @ingroup Index
22074     */
22075    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22076
22077    /**
22078     * Set the function to be called when a given index widget item is freed.
22079     *
22080     * @param it The item to set the callback on
22081     * @param func The function to call on the item's deletion
22082     *
22083     * When called, @p func will have both @c data and @c event_info
22084     * arguments with the @p it item's data value and, naturally, the
22085     * @c obj argument with a handle to the parent index widget.
22086     *
22087     * @ingroup Index
22088     */
22089    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22090
22091    /**
22092     * Get the letter (string) set on a given index widget item.
22093     *
22094     * @param it The index item handle
22095     * @return The letter string set on @p it
22096     *
22097     * @ingroup Index
22098     */
22099    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22100
22101    /**
22102     * @}
22103     */
22104
22105    /**
22106     * @defgroup Photocam Photocam
22107     *
22108     * @image html img/widget/photocam/preview-00.png
22109     * @image latex img/widget/photocam/preview-00.eps
22110     *
22111     * This is a widget specifically for displaying high-resolution digital
22112     * camera photos giving speedy feedback (fast load), low memory footprint
22113     * and zooming and panning as well as fitting logic. It is entirely focused
22114     * on jpeg images, and takes advantage of properties of the jpeg format (via
22115     * evas loader features in the jpeg loader).
22116     *
22117     * Signals that you can add callbacks for are:
22118     * @li "clicked" - This is called when a user has clicked the photo without
22119     *                 dragging around.
22120     * @li "press" - This is called when a user has pressed down on the photo.
22121     * @li "longpressed" - This is called when a user has pressed down on the
22122     *                     photo for a long time without dragging around.
22123     * @li "clicked,double" - This is called when a user has double-clicked the
22124     *                        photo.
22125     * @li "load" - Photo load begins.
22126     * @li "loaded" - This is called when the image file load is complete for the
22127     *                first view (low resolution blurry version).
22128     * @li "load,detail" - Photo detailed data load begins.
22129     * @li "loaded,detail" - This is called when the image file load is complete
22130     *                      for the detailed image data (full resolution needed).
22131     * @li "zoom,start" - Zoom animation started.
22132     * @li "zoom,stop" - Zoom animation stopped.
22133     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22134     * @li "scroll" - the content has been scrolled (moved)
22135     * @li "scroll,anim,start" - scrolling animation has started
22136     * @li "scroll,anim,stop" - scrolling animation has stopped
22137     * @li "scroll,drag,start" - dragging the contents around has started
22138     * @li "scroll,drag,stop" - dragging the contents around has stopped
22139     *
22140     * @ref tutorial_photocam shows the API in action.
22141     * @{
22142     */
22143    /**
22144     * @brief Types of zoom available.
22145     */
22146    typedef enum _Elm_Photocam_Zoom_Mode
22147      {
22148         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22149         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22150         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22151         ELM_PHOTOCAM_ZOOM_MODE_LAST
22152      } Elm_Photocam_Zoom_Mode;
22153    /**
22154     * @brief Add a new Photocam object
22155     *
22156     * @param parent The parent object
22157     * @return The new object or NULL if it cannot be created
22158     */
22159    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22160    /**
22161     * @brief Set the photo file to be shown
22162     *
22163     * @param obj The photocam object
22164     * @param file The photo file
22165     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22166     *
22167     * This sets (and shows) the specified file (with a relative or absolute
22168     * path) and will return a load error (same error that
22169     * evas_object_image_load_error_get() will return). The image will change and
22170     * adjust its size at this point and begin a background load process for this
22171     * photo that at some time in the future will be displayed at the full
22172     * quality needed.
22173     */
22174    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22175    /**
22176     * @brief Returns the path of the current image file
22177     *
22178     * @param obj The photocam object
22179     * @return Returns the path
22180     *
22181     * @see elm_photocam_file_set()
22182     */
22183    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22184    /**
22185     * @brief Set the zoom level of the photo
22186     *
22187     * @param obj The photocam object
22188     * @param zoom The zoom level to set
22189     *
22190     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22191     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22192     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22193     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22194     * 16, 32, etc.).
22195     */
22196    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22197    /**
22198     * @brief Get the zoom level of the photo
22199     *
22200     * @param obj The photocam object
22201     * @return The current zoom level
22202     *
22203     * This returns the current zoom level of the photocam object. Note that if
22204     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22205     * (which is the default), the zoom level may be changed at any time by the
22206     * photocam object itself to account for photo size and photocam viewpoer
22207     * size.
22208     *
22209     * @see elm_photocam_zoom_set()
22210     * @see elm_photocam_zoom_mode_set()
22211     */
22212    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22213    /**
22214     * @brief Set the zoom mode
22215     *
22216     * @param obj The photocam object
22217     * @param mode The desired mode
22218     *
22219     * This sets the zoom mode to manual or one of several automatic levels.
22220     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22221     * elm_photocam_zoom_set() and will stay at that level until changed by code
22222     * or until zoom mode is changed. This is the default mode. The Automatic
22223     * modes will allow the photocam object to automatically adjust zoom mode
22224     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22225     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22226     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22227     * pixels within the frame are left unfilled.
22228     */
22229    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22230    /**
22231     * @brief Get the zoom mode
22232     *
22233     * @param obj The photocam object
22234     * @return The current zoom mode
22235     *
22236     * This gets the current zoom mode of the photocam object.
22237     *
22238     * @see elm_photocam_zoom_mode_set()
22239     */
22240    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22241    /**
22242     * @brief Get the current image pixel width and height
22243     *
22244     * @param obj The photocam object
22245     * @param w A pointer to the width return
22246     * @param h A pointer to the height return
22247     *
22248     * This gets the current photo pixel width and height (for the original).
22249     * The size will be returned in the integers @p w and @p h that are pointed
22250     * to.
22251     */
22252    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22253    /**
22254     * @brief Get the area of the image that is currently shown
22255     *
22256     * @param obj
22257     * @param x A pointer to the X-coordinate of region
22258     * @param y A pointer to the Y-coordinate of region
22259     * @param w A pointer to the width
22260     * @param h A pointer to the height
22261     *
22262     * @see elm_photocam_image_region_show()
22263     * @see elm_photocam_image_region_bring_in()
22264     */
22265    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22266    /**
22267     * @brief Set the viewed portion of the image
22268     *
22269     * @param obj The photocam object
22270     * @param x X-coordinate of region in image original pixels
22271     * @param y Y-coordinate of region in image original pixels
22272     * @param w Width of region in image original pixels
22273     * @param h Height of region in image original pixels
22274     *
22275     * This shows the region of the image without using animation.
22276     */
22277    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22278    /**
22279     * @brief Bring in the viewed portion of the image
22280     *
22281     * @param obj The photocam object
22282     * @param x X-coordinate of region in image original pixels
22283     * @param y Y-coordinate of region in image original pixels
22284     * @param w Width of region in image original pixels
22285     * @param h Height of region in image original pixels
22286     *
22287     * This shows the region of the image using animation.
22288     */
22289    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22290    /**
22291     * @brief Set the paused state for photocam
22292     *
22293     * @param obj The photocam object
22294     * @param paused The pause state to set
22295     *
22296     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22297     * photocam. The default is off. This will stop zooming using animation on
22298     * zoom levels changes and change instantly. This will stop any existing
22299     * animations that are running.
22300     */
22301    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22302    /**
22303     * @brief Get the paused state for photocam
22304     *
22305     * @param obj The photocam object
22306     * @return The current paused state
22307     *
22308     * This gets the current paused state for the photocam object.
22309     *
22310     * @see elm_photocam_paused_set()
22311     */
22312    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22313    /**
22314     * @brief Get the internal low-res image used for photocam
22315     *
22316     * @param obj The photocam object
22317     * @return The internal image object handle, or NULL if none exists
22318     *
22319     * This gets the internal image object inside photocam. Do not modify it. It
22320     * is for inspection only, and hooking callbacks to. Nothing else. It may be
22321     * deleted at any time as well.
22322     */
22323    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22324    /**
22325     * @brief Set the photocam scrolling bouncing.
22326     *
22327     * @param obj The photocam object
22328     * @param h_bounce bouncing for horizontal
22329     * @param v_bounce bouncing for vertical
22330     */
22331    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22332    /**
22333     * @brief Get the photocam scrolling bouncing.
22334     *
22335     * @param obj The photocam object
22336     * @param h_bounce bouncing for horizontal
22337     * @param v_bounce bouncing for vertical
22338     *
22339     * @see elm_photocam_bounce_set()
22340     */
22341    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22342    /**
22343     * @}
22344     */
22345
22346    /**
22347     * @defgroup Map Map
22348     * @ingroup Elementary
22349     *
22350     * @image html img/widget/map/preview-00.png
22351     * @image latex img/widget/map/preview-00.eps
22352     *
22353     * This is a widget specifically for displaying a map. It uses basically
22354     * OpenStreetMap provider http://www.openstreetmap.org/,
22355     * but custom providers can be added.
22356     *
22357     * It supports some basic but yet nice features:
22358     * @li zoom and scroll
22359     * @li markers with content to be displayed when user clicks over it
22360     * @li group of markers
22361     * @li routes
22362     *
22363     * Smart callbacks one can listen to:
22364     *
22365     * - "clicked" - This is called when a user has clicked the map without
22366     *   dragging around.
22367     * - "press" - This is called when a user has pressed down on the map.
22368     * - "longpressed" - This is called when a user has pressed down on the map
22369     *   for a long time without dragging around.
22370     * - "clicked,double" - This is called when a user has double-clicked
22371     *   the map.
22372     * - "load,detail" - Map detailed data load begins.
22373     * - "loaded,detail" - This is called when all currently visible parts of
22374     *   the map are loaded.
22375     * - "zoom,start" - Zoom animation started.
22376     * - "zoom,stop" - Zoom animation stopped.
22377     * - "zoom,change" - Zoom changed when using an auto zoom mode.
22378     * - "scroll" - the content has been scrolled (moved).
22379     * - "scroll,anim,start" - scrolling animation has started.
22380     * - "scroll,anim,stop" - scrolling animation has stopped.
22381     * - "scroll,drag,start" - dragging the contents around has started.
22382     * - "scroll,drag,stop" - dragging the contents around has stopped.
22383     * - "downloaded" - This is called when all currently required map images
22384     *   are downloaded.
22385     * - "route,load" - This is called when route request begins.
22386     * - "route,loaded" - This is called when route request ends.
22387     * - "name,load" - This is called when name request begins.
22388     * - "name,loaded- This is called when name request ends.
22389     *
22390     * Available style for map widget:
22391     * - @c "default"
22392     *
22393     * Available style for markers:
22394     * - @c "radio"
22395     * - @c "radio2"
22396     * - @c "empty"
22397     *
22398     * Available style for marker bubble:
22399     * - @c "default"
22400     *
22401     * List of examples:
22402     * @li @ref map_example_01
22403     * @li @ref map_example_02
22404     * @li @ref map_example_03
22405     */
22406
22407    /**
22408     * @addtogroup Map
22409     * @{
22410     */
22411
22412    /**
22413     * @enum _Elm_Map_Zoom_Mode
22414     * @typedef Elm_Map_Zoom_Mode
22415     *
22416     * Set map's zoom behavior. It can be set to manual or automatic.
22417     *
22418     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22419     *
22420     * Values <b> don't </b> work as bitmask, only one can be choosen.
22421     *
22422     * @note Valid sizes are 2^zoom, consequently the map may be smaller
22423     * than the scroller view.
22424     *
22425     * @see elm_map_zoom_mode_set()
22426     * @see elm_map_zoom_mode_get()
22427     *
22428     * @ingroup Map
22429     */
22430    typedef enum _Elm_Map_Zoom_Mode
22431      {
22432         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22433         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22434         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22435         ELM_MAP_ZOOM_MODE_LAST
22436      } Elm_Map_Zoom_Mode;
22437
22438    /**
22439     * @enum _Elm_Map_Route_Sources
22440     * @typedef Elm_Map_Route_Sources
22441     *
22442     * Set route service to be used. By default used source is
22443     * #ELM_MAP_ROUTE_SOURCE_YOURS.
22444     *
22445     * @see elm_map_route_source_set()
22446     * @see elm_map_route_source_get()
22447     *
22448     * @ingroup Map
22449     */
22450    typedef enum _Elm_Map_Route_Sources
22451      {
22452         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22453         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. */
22454         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22455         ELM_MAP_ROUTE_SOURCE_LAST
22456      } Elm_Map_Route_Sources;
22457
22458    typedef enum _Elm_Map_Name_Sources
22459      {
22460         ELM_MAP_NAME_SOURCE_NOMINATIM,
22461         ELM_MAP_NAME_SOURCE_LAST
22462      } Elm_Map_Name_Sources;
22463
22464    /**
22465     * @enum _Elm_Map_Route_Type
22466     * @typedef Elm_Map_Route_Type
22467     *
22468     * Set type of transport used on route.
22469     *
22470     * @see elm_map_route_add()
22471     *
22472     * @ingroup Map
22473     */
22474    typedef enum _Elm_Map_Route_Type
22475      {
22476         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22477         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22478         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22479         ELM_MAP_ROUTE_TYPE_LAST
22480      } Elm_Map_Route_Type;
22481
22482    /**
22483     * @enum _Elm_Map_Route_Method
22484     * @typedef Elm_Map_Route_Method
22485     *
22486     * Set the routing method, what should be priorized, time or distance.
22487     *
22488     * @see elm_map_route_add()
22489     *
22490     * @ingroup Map
22491     */
22492    typedef enum _Elm_Map_Route_Method
22493      {
22494         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22495         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22496         ELM_MAP_ROUTE_METHOD_LAST
22497      } Elm_Map_Route_Method;
22498
22499    typedef enum _Elm_Map_Name_Method
22500      {
22501         ELM_MAP_NAME_METHOD_SEARCH,
22502         ELM_MAP_NAME_METHOD_REVERSE,
22503         ELM_MAP_NAME_METHOD_LAST
22504      } Elm_Map_Name_Method;
22505
22506    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(). */
22507    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(). */
22508    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(). */
22509    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(). */
22510    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
22511    typedef struct _Elm_Map_Track           Elm_Map_Track;
22512
22513    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. */
22514    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22515    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22516    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22517
22518    typedef char        *(*ElmMapModuleSourceFunc) (void);
22519    typedef int          (*ElmMapModuleZoomMinFunc) (void);
22520    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
22521    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22522    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
22523    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22524    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22525    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22526    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22527
22528    /**
22529     * Add a new map widget to the given parent Elementary (container) object.
22530     *
22531     * @param parent The parent object.
22532     * @return a new map widget handle or @c NULL, on errors.
22533     *
22534     * This function inserts a new map widget on the canvas.
22535     *
22536     * @ingroup Map
22537     */
22538    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22539
22540    /**
22541     * Set the zoom level of the map.
22542     *
22543     * @param obj The map object.
22544     * @param zoom The zoom level to set.
22545     *
22546     * This sets the zoom level.
22547     *
22548     * It will respect limits defined by elm_map_source_zoom_min_set() and
22549     * elm_map_source_zoom_max_set().
22550     *
22551     * By default these values are 0 (world map) and 18 (maximum zoom).
22552     *
22553     * This function should be used when zoom mode is set to
22554     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22555     * with elm_map_zoom_mode_set().
22556     *
22557     * @see elm_map_zoom_mode_set().
22558     * @see elm_map_zoom_get().
22559     *
22560     * @ingroup Map
22561     */
22562    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22563
22564    /**
22565     * Get the zoom level of the map.
22566     *
22567     * @param obj The map object.
22568     * @return The current zoom level.
22569     *
22570     * This returns the current zoom level of the map object.
22571     *
22572     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22573     * (which is the default), the zoom level may be changed at any time by the
22574     * map object itself to account for map size and map viewport size.
22575     *
22576     * @see elm_map_zoom_set() for details.
22577     *
22578     * @ingroup Map
22579     */
22580    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22581
22582    /**
22583     * Set the zoom mode used by the map object.
22584     *
22585     * @param obj The map object.
22586     * @param mode The zoom mode of the map, being it one of
22587     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22588     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22589     *
22590     * This sets the zoom mode to manual or one of the automatic levels.
22591     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22592     * elm_map_zoom_set() and will stay at that level until changed by code
22593     * or until zoom mode is changed. This is the default mode.
22594     *
22595     * The Automatic modes will allow the map object to automatically
22596     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22597     * adjust zoom so the map fits inside the scroll frame with no pixels
22598     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22599     * ensure no pixels within the frame are left unfilled. Do not forget that
22600     * the valid sizes are 2^zoom, consequently the map may be smaller than
22601     * the scroller view.
22602     *
22603     * @see elm_map_zoom_set()
22604     *
22605     * @ingroup Map
22606     */
22607    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22608
22609    /**
22610     * Get the zoom mode used by the map object.
22611     *
22612     * @param obj The map object.
22613     * @return The zoom mode of the map, being it one of
22614     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22615     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22616     *
22617     * This function returns the current zoom mode used by the map object.
22618     *
22619     * @see elm_map_zoom_mode_set() for more details.
22620     *
22621     * @ingroup Map
22622     */
22623    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22624
22625    /**
22626     * Get the current coordinates of the map.
22627     *
22628     * @param obj The map object.
22629     * @param lon Pointer where to store longitude.
22630     * @param lat Pointer where to store latitude.
22631     *
22632     * This gets the current center coordinates of the map object. It can be
22633     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22634     *
22635     * @see elm_map_geo_region_bring_in()
22636     * @see elm_map_geo_region_show()
22637     *
22638     * @ingroup Map
22639     */
22640    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22641
22642    /**
22643     * Animatedly bring in given coordinates to the center of the map.
22644     *
22645     * @param obj The map object.
22646     * @param lon Longitude to center at.
22647     * @param lat Latitude to center at.
22648     *
22649     * This causes map to jump to the given @p lat and @p lon coordinates
22650     * and show it (by scrolling) in the center of the viewport, if it is not
22651     * already centered. This will use animation to do so and take a period
22652     * of time to complete.
22653     *
22654     * @see elm_map_geo_region_show() for a function to avoid animation.
22655     * @see elm_map_geo_region_get()
22656     *
22657     * @ingroup Map
22658     */
22659    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22660
22661    /**
22662     * Show the given coordinates at the center of the map, @b immediately.
22663     *
22664     * @param obj The map object.
22665     * @param lon Longitude to center at.
22666     * @param lat Latitude to center at.
22667     *
22668     * This causes map to @b redraw its viewport's contents to the
22669     * region contining the given @p lat and @p lon, that will be moved to the
22670     * center of the map.
22671     *
22672     * @see elm_map_geo_region_bring_in() for a function to move with animation.
22673     * @see elm_map_geo_region_get()
22674     *
22675     * @ingroup Map
22676     */
22677    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22678
22679    /**
22680     * Pause or unpause the map.
22681     *
22682     * @param obj The map object.
22683     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22684     * to unpause it.
22685     *
22686     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22687     * for map.
22688     *
22689     * The default is off.
22690     *
22691     * This will stop zooming using animation, changing zoom levels will
22692     * change instantly. This will stop any existing animations that are running.
22693     *
22694     * @see elm_map_paused_get()
22695     *
22696     * @ingroup Map
22697     */
22698    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22699
22700    /**
22701     * Get a value whether map is paused or not.
22702     *
22703     * @param obj The map object.
22704     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22705     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22706     *
22707     * This gets the current paused state for the map object.
22708     *
22709     * @see elm_map_paused_set() for details.
22710     *
22711     * @ingroup Map
22712     */
22713    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22714
22715    /**
22716     * Set to show markers during zoom level changes or not.
22717     *
22718     * @param obj The map object.
22719     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22720     * to show them.
22721     *
22722     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22723     * for map.
22724     *
22725     * The default is off.
22726     *
22727     * This will stop zooming using animation, changing zoom levels will
22728     * change instantly. This will stop any existing animations that are running.
22729     *
22730     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22731     * for the markers.
22732     *
22733     * The default  is off.
22734     *
22735     * Enabling it will force the map to stop displaying the markers during
22736     * zoom level changes. Set to on if you have a large number of markers.
22737     *
22738     * @see elm_map_paused_markers_get()
22739     *
22740     * @ingroup Map
22741     */
22742    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22743
22744    /**
22745     * Get a value whether markers will be displayed on zoom level changes or not
22746     *
22747     * @param obj The map object.
22748     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22749     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22750     *
22751     * This gets the current markers paused state for the map object.
22752     *
22753     * @see elm_map_paused_markers_set() for details.
22754     *
22755     * @ingroup Map
22756     */
22757    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22758
22759    /**
22760     * Get the information of downloading status.
22761     *
22762     * @param obj The map object.
22763     * @param try_num Pointer where to store number of tiles being downloaded.
22764     * @param finish_num Pointer where to store number of tiles successfully
22765     * downloaded.
22766     *
22767     * This gets the current downloading status for the map object, the number
22768     * of tiles being downloaded and the number of tiles already downloaded.
22769     *
22770     * @ingroup Map
22771     */
22772    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22773
22774    /**
22775     * Convert a pixel coordinate (x,y) into a geographic coordinate
22776     * (longitude, latitude).
22777     *
22778     * @param obj The map object.
22779     * @param x the coordinate.
22780     * @param y the coordinate.
22781     * @param size the size in pixels of the map.
22782     * The map is a square and generally his size is : pow(2.0, zoom)*256.
22783     * @param lon Pointer where to store the longitude that correspond to x.
22784     * @param lat Pointer where to store the latitude that correspond to y.
22785     *
22786     * @note Origin pixel point is the top left corner of the viewport.
22787     * Map zoom and size are taken on account.
22788     *
22789     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22790     *
22791     * @ingroup Map
22792     */
22793    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);
22794
22795    /**
22796     * Convert a geographic coordinate (longitude, latitude) into a pixel
22797     * coordinate (x, y).
22798     *
22799     * @param obj The map object.
22800     * @param lon the longitude.
22801     * @param lat the latitude.
22802     * @param size the size in pixels of the map. The map is a square
22803     * and generally his size is : pow(2.0, zoom)*256.
22804     * @param x Pointer where to store the horizontal pixel coordinate that
22805     * correspond to the longitude.
22806     * @param y Pointer where to store the vertical pixel coordinate that
22807     * correspond to the latitude.
22808     *
22809     * @note Origin pixel point is the top left corner of the viewport.
22810     * Map zoom and size are taken on account.
22811     *
22812     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22813     *
22814     * @ingroup Map
22815     */
22816    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);
22817
22818    /**
22819     * Convert a geographic coordinate (longitude, latitude) into a name
22820     * (address).
22821     *
22822     * @param obj The map object.
22823     * @param lon the longitude.
22824     * @param lat the latitude.
22825     * @return name A #Elm_Map_Name handle for this coordinate.
22826     *
22827     * To get the string for this address, elm_map_name_address_get()
22828     * should be used.
22829     *
22830     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22831     *
22832     * @ingroup Map
22833     */
22834    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22835
22836    /**
22837     * Convert a name (address) into a geographic coordinate
22838     * (longitude, latitude).
22839     *
22840     * @param obj The map object.
22841     * @param name The address.
22842     * @return name A #Elm_Map_Name handle for this address.
22843     *
22844     * To get the longitude and latitude, elm_map_name_region_get()
22845     * should be used.
22846     *
22847     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22848     *
22849     * @ingroup Map
22850     */
22851    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22852
22853    /**
22854     * Convert a pixel coordinate into a rotated pixel coordinate.
22855     *
22856     * @param obj The map object.
22857     * @param x horizontal coordinate of the point to rotate.
22858     * @param y vertical coordinate of the point to rotate.
22859     * @param cx rotation's center horizontal position.
22860     * @param cy rotation's center vertical position.
22861     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22862     * @param xx Pointer where to store rotated x.
22863     * @param yy Pointer where to store rotated y.
22864     *
22865     * @ingroup Map
22866     */
22867    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);
22868
22869    /**
22870     * Add a new marker to the map object.
22871     *
22872     * @param obj The map object.
22873     * @param lon The longitude of the marker.
22874     * @param lat The latitude of the marker.
22875     * @param clas The class, to use when marker @b isn't grouped to others.
22876     * @param clas_group The class group, to use when marker is grouped to others
22877     * @param data The data passed to the callbacks.
22878     *
22879     * @return The created marker or @c NULL upon failure.
22880     *
22881     * A marker will be created and shown in a specific point of the map, defined
22882     * by @p lon and @p lat.
22883     *
22884     * It will be displayed using style defined by @p class when this marker
22885     * is displayed alone (not grouped). A new class can be created with
22886     * elm_map_marker_class_new().
22887     *
22888     * If the marker is grouped to other markers, it will be displayed with
22889     * style defined by @p class_group. Markers with the same group are grouped
22890     * if they are close. A new group class can be created with
22891     * elm_map_marker_group_class_new().
22892     *
22893     * Markers created with this method can be deleted with
22894     * elm_map_marker_remove().
22895     *
22896     * A marker can have associated content to be displayed by a bubble,
22897     * when a user click over it, as well as an icon. These objects will
22898     * be fetch using class' callback functions.
22899     *
22900     * @see elm_map_marker_class_new()
22901     * @see elm_map_marker_group_class_new()
22902     * @see elm_map_marker_remove()
22903     *
22904     * @ingroup Map
22905     */
22906    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);
22907
22908    /**
22909     * Set the maximum numbers of markers' content to be displayed in a group.
22910     *
22911     * @param obj The map object.
22912     * @param max The maximum numbers of items displayed in a bubble.
22913     *
22914     * A bubble will be displayed when the user clicks over the group,
22915     * and will place the content of markers that belong to this group
22916     * inside it.
22917     *
22918     * A group can have a long list of markers, consequently the creation
22919     * of the content of the bubble can be very slow.
22920     *
22921     * In order to avoid this, a maximum number of items is displayed
22922     * in a bubble.
22923     *
22924     * By default this number is 30.
22925     *
22926     * Marker with the same group class are grouped if they are close.
22927     *
22928     * @see elm_map_marker_add()
22929     *
22930     * @ingroup Map
22931     */
22932    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22933
22934    /**
22935     * Remove a marker from the map.
22936     *
22937     * @param marker The marker to remove.
22938     *
22939     * @see elm_map_marker_add()
22940     *
22941     * @ingroup Map
22942     */
22943    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22944
22945    /**
22946     * Get the current coordinates of the marker.
22947     *
22948     * @param marker marker.
22949     * @param lat Pointer where to store the marker's latitude.
22950     * @param lon Pointer where to store the marker's longitude.
22951     *
22952     * These values are set when adding markers, with function
22953     * elm_map_marker_add().
22954     *
22955     * @see elm_map_marker_add()
22956     *
22957     * @ingroup Map
22958     */
22959    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22960
22961    /**
22962     * Animatedly bring in given marker to the center of the map.
22963     *
22964     * @param marker The marker to center at.
22965     *
22966     * This causes map to jump to the given @p marker's coordinates
22967     * and show it (by scrolling) in the center of the viewport, if it is not
22968     * already centered. This will use animation to do so and take a period
22969     * of time to complete.
22970     *
22971     * @see elm_map_marker_show() for a function to avoid animation.
22972     * @see elm_map_marker_region_get()
22973     *
22974     * @ingroup Map
22975     */
22976    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22977
22978    /**
22979     * Show the given marker at the center of the map, @b immediately.
22980     *
22981     * @param marker The marker to center at.
22982     *
22983     * This causes map to @b redraw its viewport's contents to the
22984     * region contining the given @p marker's coordinates, that will be
22985     * moved to the center of the map.
22986     *
22987     * @see elm_map_marker_bring_in() for a function to move with animation.
22988     * @see elm_map_markers_list_show() if more than one marker need to be
22989     * displayed.
22990     * @see elm_map_marker_region_get()
22991     *
22992     * @ingroup Map
22993     */
22994    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22995
22996    /**
22997     * Move and zoom the map to display a list of markers.
22998     *
22999     * @param markers A list of #Elm_Map_Marker handles.
23000     *
23001     * The map will be centered on the center point of the markers in the list.
23002     * Then the map will be zoomed in order to fit the markers using the maximum
23003     * zoom which allows display of all the markers.
23004     *
23005     * @warning All the markers should belong to the same map object.
23006     *
23007     * @see elm_map_marker_show() to show a single marker.
23008     * @see elm_map_marker_bring_in()
23009     *
23010     * @ingroup Map
23011     */
23012    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23013
23014    /**
23015     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23016     *
23017     * @param marker The marker wich content should be returned.
23018     * @return Return the evas object if it exists, else @c NULL.
23019     *
23020     * To set callback function #ElmMapMarkerGetFunc for the marker class,
23021     * elm_map_marker_class_get_cb_set() should be used.
23022     *
23023     * This content is what will be inside the bubble that will be displayed
23024     * when an user clicks over the marker.
23025     *
23026     * This returns the actual Evas object used to be placed inside
23027     * the bubble. This may be @c NULL, as it may
23028     * not have been created or may have been deleted, at any time, by
23029     * the map. <b>Do not modify this object</b> (move, resize,
23030     * show, hide, etc.), as the map is controlling it. This
23031     * function is for querying, emitting custom signals or hooking
23032     * lower level callbacks for events on that object. Do not delete
23033     * this object under any circumstances.
23034     *
23035     * @ingroup Map
23036     */
23037    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23038
23039    /**
23040     * Update the marker
23041     *
23042     * @param marker The marker to be updated.
23043     *
23044     * If a content is set to this marker, it will call function to delete it,
23045     * #ElmMapMarkerDelFunc, and then will fetch the content again with
23046     * #ElmMapMarkerGetFunc.
23047     *
23048     * These functions are set for the marker class with
23049     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23050     *
23051     * @ingroup Map
23052     */
23053    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23054
23055    /**
23056     * Close all the bubbles opened by the user.
23057     *
23058     * @param obj The map object.
23059     *
23060     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23061     * when the user clicks on a marker.
23062     *
23063     * This functions is set for the marker class with
23064     * elm_map_marker_class_get_cb_set().
23065     *
23066     * @ingroup Map
23067     */
23068    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23069
23070    /**
23071     * Create a new group class.
23072     *
23073     * @param obj The map object.
23074     * @return Returns the new group class.
23075     *
23076     * Each marker must be associated to a group class. Markers in the same
23077     * group are grouped if they are close.
23078     *
23079     * The group class defines the style of the marker when a marker is grouped
23080     * to others markers. When it is alone, another class will be used.
23081     *
23082     * A group class will need to be provided when creating a marker with
23083     * elm_map_marker_add().
23084     *
23085     * Some properties and functions can be set by class, as:
23086     * - style, with elm_map_group_class_style_set()
23087     * - data - to be associated to the group class. It can be set using
23088     *   elm_map_group_class_data_set().
23089     * - min zoom to display markers, set with
23090     *   elm_map_group_class_zoom_displayed_set().
23091     * - max zoom to group markers, set using
23092     *   elm_map_group_class_zoom_grouped_set().
23093     * - visibility - set if markers will be visible or not, set with
23094     *   elm_map_group_class_hide_set().
23095     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23096     *   It can be set using elm_map_group_class_icon_cb_set().
23097     *
23098     * @see elm_map_marker_add()
23099     * @see elm_map_group_class_style_set()
23100     * @see elm_map_group_class_data_set()
23101     * @see elm_map_group_class_zoom_displayed_set()
23102     * @see elm_map_group_class_zoom_grouped_set()
23103     * @see elm_map_group_class_hide_set()
23104     * @see elm_map_group_class_icon_cb_set()
23105     *
23106     * @ingroup Map
23107     */
23108    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23109
23110    /**
23111     * Set the marker's style of a group class.
23112     *
23113     * @param clas The group class.
23114     * @param style The style to be used by markers.
23115     *
23116     * Each marker must be associated to a group class, and will use the style
23117     * defined by such class when grouped to other markers.
23118     *
23119     * The following styles are provided by default theme:
23120     * @li @c radio - blue circle
23121     * @li @c radio2 - green circle
23122     * @li @c empty
23123     *
23124     * @see elm_map_group_class_new() for more details.
23125     * @see elm_map_marker_add()
23126     *
23127     * @ingroup Map
23128     */
23129    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23130
23131    /**
23132     * Set the icon callback function of a group class.
23133     *
23134     * @param clas The group class.
23135     * @param icon_get The callback function that will return the icon.
23136     *
23137     * Each marker must be associated to a group class, and it can display a
23138     * custom icon. The function @p icon_get must return this icon.
23139     *
23140     * @see elm_map_group_class_new() for more details.
23141     * @see elm_map_marker_add()
23142     *
23143     * @ingroup Map
23144     */
23145    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23146
23147    /**
23148     * Set the data associated to the group class.
23149     *
23150     * @param clas The group class.
23151     * @param data The new user data.
23152     *
23153     * This data will be passed for callback functions, like icon get callback,
23154     * that can be set with elm_map_group_class_icon_cb_set().
23155     *
23156     * If a data was previously set, the object will lose the pointer for it,
23157     * so if needs to be freed, you must do it yourself.
23158     *
23159     * @see elm_map_group_class_new() for more details.
23160     * @see elm_map_group_class_icon_cb_set()
23161     * @see elm_map_marker_add()
23162     *
23163     * @ingroup Map
23164     */
23165    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23166
23167    /**
23168     * Set the minimum zoom from where the markers are displayed.
23169     *
23170     * @param clas The group class.
23171     * @param zoom The minimum zoom.
23172     *
23173     * Markers only will be displayed when the map is displayed at @p zoom
23174     * or bigger.
23175     *
23176     * @see elm_map_group_class_new() for more details.
23177     * @see elm_map_marker_add()
23178     *
23179     * @ingroup Map
23180     */
23181    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23182
23183    /**
23184     * Set the zoom from where the markers are no more grouped.
23185     *
23186     * @param clas The group class.
23187     * @param zoom The maximum zoom.
23188     *
23189     * Markers only will be grouped when the map is displayed at
23190     * less than @p zoom.
23191     *
23192     * @see elm_map_group_class_new() for more details.
23193     * @see elm_map_marker_add()
23194     *
23195     * @ingroup Map
23196     */
23197    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23198
23199    /**
23200     * Set if the markers associated to the group class @clas are hidden or not.
23201     *
23202     * @param clas The group class.
23203     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23204     * to show them.
23205     *
23206     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23207     * is to show them.
23208     *
23209     * @ingroup Map
23210     */
23211    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23212
23213    /**
23214     * Create a new marker class.
23215     *
23216     * @param obj The map object.
23217     * @return Returns the new group class.
23218     *
23219     * Each marker must be associated to a class.
23220     *
23221     * The marker class defines the style of the marker when a marker is
23222     * displayed alone, i.e., not grouped to to others markers. When grouped
23223     * it will use group class style.
23224     *
23225     * A marker class will need to be provided when creating a marker with
23226     * elm_map_marker_add().
23227     *
23228     * Some properties and functions can be set by class, as:
23229     * - style, with elm_map_marker_class_style_set()
23230     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23231     *   It can be set using elm_map_marker_class_icon_cb_set().
23232     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23233     *   Set using elm_map_marker_class_get_cb_set().
23234     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23235     *   Set using elm_map_marker_class_del_cb_set().
23236     *
23237     * @see elm_map_marker_add()
23238     * @see elm_map_marker_class_style_set()
23239     * @see elm_map_marker_class_icon_cb_set()
23240     * @see elm_map_marker_class_get_cb_set()
23241     * @see elm_map_marker_class_del_cb_set()
23242     *
23243     * @ingroup Map
23244     */
23245    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23246
23247    /**
23248     * Set the marker's style of a marker class.
23249     *
23250     * @param clas The marker class.
23251     * @param style The style to be used by markers.
23252     *
23253     * Each marker must be associated to a marker class, and will use the style
23254     * defined by such class when alone, i.e., @b not grouped to other markers.
23255     *
23256     * The following styles are provided by default theme:
23257     * @li @c radio
23258     * @li @c radio2
23259     * @li @c empty
23260     *
23261     * @see elm_map_marker_class_new() for more details.
23262     * @see elm_map_marker_add()
23263     *
23264     * @ingroup Map
23265     */
23266    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23267
23268    /**
23269     * Set the icon callback function of a marker class.
23270     *
23271     * @param clas The marker class.
23272     * @param icon_get The callback function that will return the icon.
23273     *
23274     * Each marker must be associated to a marker class, and it can display a
23275     * custom icon. The function @p icon_get must return this icon.
23276     *
23277     * @see elm_map_marker_class_new() for more details.
23278     * @see elm_map_marker_add()
23279     *
23280     * @ingroup Map
23281     */
23282    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23283
23284    /**
23285     * Set the bubble content callback function of a marker class.
23286     *
23287     * @param clas The marker class.
23288     * @param get The callback function that will return the content.
23289     *
23290     * Each marker must be associated to a marker class, and it can display a
23291     * a content on a bubble that opens when the user click over the marker.
23292     * The function @p get must return this content object.
23293     *
23294     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23295     * can be used.
23296     *
23297     * @see elm_map_marker_class_new() for more details.
23298     * @see elm_map_marker_class_del_cb_set()
23299     * @see elm_map_marker_add()
23300     *
23301     * @ingroup Map
23302     */
23303    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23304
23305    /**
23306     * Set the callback function used to delete bubble content of a marker class.
23307     *
23308     * @param clas The marker class.
23309     * @param del The callback function that will delete the content.
23310     *
23311     * Each marker must be associated to a marker class, and it can display a
23312     * a content on a bubble that opens when the user click over the marker.
23313     * The function to return such content can be set with
23314     * elm_map_marker_class_get_cb_set().
23315     *
23316     * If this content must be freed, a callback function need to be
23317     * set for that task with this function.
23318     *
23319     * If this callback is defined it will have to delete (or not) the
23320     * object inside, but if the callback is not defined the object will be
23321     * destroyed with evas_object_del().
23322     *
23323     * @see elm_map_marker_class_new() for more details.
23324     * @see elm_map_marker_class_get_cb_set()
23325     * @see elm_map_marker_add()
23326     *
23327     * @ingroup Map
23328     */
23329    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23330
23331    /**
23332     * Get the list of available sources.
23333     *
23334     * @param obj The map object.
23335     * @return The source names list.
23336     *
23337     * It will provide a list with all available sources, that can be set as
23338     * current source with elm_map_source_name_set(), or get with
23339     * elm_map_source_name_get().
23340     *
23341     * Available sources:
23342     * @li "Mapnik"
23343     * @li "Osmarender"
23344     * @li "CycleMap"
23345     * @li "Maplint"
23346     *
23347     * @see elm_map_source_name_set() for more details.
23348     * @see elm_map_source_name_get()
23349     *
23350     * @ingroup Map
23351     */
23352    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23353
23354    /**
23355     * Set the source of the map.
23356     *
23357     * @param obj The map object.
23358     * @param source The source to be used.
23359     *
23360     * Map widget retrieves images that composes the map from a web service.
23361     * This web service can be set with this method.
23362     *
23363     * A different service can return a different maps with different
23364     * information and it can use different zoom values.
23365     *
23366     * The @p source_name need to match one of the names provided by
23367     * elm_map_source_names_get().
23368     *
23369     * The current source can be get using elm_map_source_name_get().
23370     *
23371     * @see elm_map_source_names_get()
23372     * @see elm_map_source_name_get()
23373     *
23374     *
23375     * @ingroup Map
23376     */
23377    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23378
23379    /**
23380     * Get the name of currently used source.
23381     *
23382     * @param obj The map object.
23383     * @return Returns the name of the source in use.
23384     *
23385     * @see elm_map_source_name_set() for more details.
23386     *
23387     * @ingroup Map
23388     */
23389    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23390
23391    /**
23392     * Set the source of the route service to be used by the map.
23393     *
23394     * @param obj The map object.
23395     * @param source The route service to be used, being it one of
23396     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23397     * and #ELM_MAP_ROUTE_SOURCE_ORS.
23398     *
23399     * Each one has its own algorithm, so the route retrieved may
23400     * differ depending on the source route. Now, only the default is working.
23401     *
23402     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23403     * http://www.yournavigation.org/.
23404     *
23405     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23406     * assumptions. Its routing core is based on Contraction Hierarchies.
23407     *
23408     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23409     *
23410     * @see elm_map_route_source_get().
23411     *
23412     * @ingroup Map
23413     */
23414    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23415
23416    /**
23417     * Get the current route source.
23418     *
23419     * @param obj The map object.
23420     * @return The source of the route service used by the map.
23421     *
23422     * @see elm_map_route_source_set() for details.
23423     *
23424     * @ingroup Map
23425     */
23426    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23427
23428    /**
23429     * Set the minimum zoom of the source.
23430     *
23431     * @param obj The map object.
23432     * @param zoom New minimum zoom value to be used.
23433     *
23434     * By default, it's 0.
23435     *
23436     * @ingroup Map
23437     */
23438    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23439
23440    /**
23441     * Get the minimum zoom of the source.
23442     *
23443     * @param obj The map object.
23444     * @return Returns the minimum zoom of the source.
23445     *
23446     * @see elm_map_source_zoom_min_set() for details.
23447     *
23448     * @ingroup Map
23449     */
23450    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23451
23452    /**
23453     * Set the maximum zoom of the source.
23454     *
23455     * @param obj The map object.
23456     * @param zoom New maximum zoom value to be used.
23457     *
23458     * By default, it's 18.
23459     *
23460     * @ingroup Map
23461     */
23462    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23463
23464    /**
23465     * Get the maximum zoom of the source.
23466     *
23467     * @param obj The map object.
23468     * @return Returns the maximum zoom of the source.
23469     *
23470     * @see elm_map_source_zoom_min_set() for details.
23471     *
23472     * @ingroup Map
23473     */
23474    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23475
23476    /**
23477     * Set the user agent used by the map object to access routing services.
23478     *
23479     * @param obj The map object.
23480     * @param user_agent The user agent to be used by the map.
23481     *
23482     * User agent is a client application implementing a network protocol used
23483     * in communications within a clientā€“server distributed computing system
23484     *
23485     * The @p user_agent identification string will transmitted in a header
23486     * field @c User-Agent.
23487     *
23488     * @see elm_map_user_agent_get()
23489     *
23490     * @ingroup Map
23491     */
23492    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23493
23494    /**
23495     * Get the user agent used by the map object.
23496     *
23497     * @param obj The map object.
23498     * @return The user agent identification string used by the map.
23499     *
23500     * @see elm_map_user_agent_set() for details.
23501     *
23502     * @ingroup Map
23503     */
23504    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23505
23506    /**
23507     * Add a new route to the map object.
23508     *
23509     * @param obj The map object.
23510     * @param type The type of transport to be considered when tracing a route.
23511     * @param method The routing method, what should be priorized.
23512     * @param flon The start longitude.
23513     * @param flat The start latitude.
23514     * @param tlon The destination longitude.
23515     * @param tlat The destination latitude.
23516     *
23517     * @return The created route or @c NULL upon failure.
23518     *
23519     * A route will be traced by point on coordinates (@p flat, @p flon)
23520     * to point on coordinates (@p tlat, @p tlon), using the route service
23521     * set with elm_map_route_source_set().
23522     *
23523     * It will take @p type on consideration to define the route,
23524     * depending if the user will be walking or driving, the route may vary.
23525     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23526     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23527     *
23528     * Another parameter is what the route should priorize, the minor distance
23529     * or the less time to be spend on the route. So @p method should be one
23530     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23531     *
23532     * Routes created with this method can be deleted with
23533     * elm_map_route_remove(), colored with elm_map_route_color_set(),
23534     * and distance can be get with elm_map_route_distance_get().
23535     *
23536     * @see elm_map_route_remove()
23537     * @see elm_map_route_color_set()
23538     * @see elm_map_route_distance_get()
23539     * @see elm_map_route_source_set()
23540     *
23541     * @ingroup Map
23542     */
23543    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);
23544
23545    /**
23546     * Remove a route from the map.
23547     *
23548     * @param route The route to remove.
23549     *
23550     * @see elm_map_route_add()
23551     *
23552     * @ingroup Map
23553     */
23554    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23555
23556    /**
23557     * Set the route color.
23558     *
23559     * @param route The route object.
23560     * @param r Red channel value, from 0 to 255.
23561     * @param g Green channel value, from 0 to 255.
23562     * @param b Blue channel value, from 0 to 255.
23563     * @param a Alpha channel value, from 0 to 255.
23564     *
23565     * It uses an additive color model, so each color channel represents
23566     * how much of each primary colors must to be used. 0 represents
23567     * ausence of this color, so if all of the three are set to 0,
23568     * the color will be black.
23569     *
23570     * These component values should be integers in the range 0 to 255,
23571     * (single 8-bit byte).
23572     *
23573     * This sets the color used for the route. By default, it is set to
23574     * solid red (r = 255, g = 0, b = 0, a = 255).
23575     *
23576     * For alpha channel, 0 represents completely transparent, and 255, opaque.
23577     *
23578     * @see elm_map_route_color_get()
23579     *
23580     * @ingroup Map
23581     */
23582    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23583
23584    /**
23585     * Get the route color.
23586     *
23587     * @param route The route object.
23588     * @param r Pointer where to store the red channel value.
23589     * @param g Pointer where to store the green channel value.
23590     * @param b Pointer where to store the blue channel value.
23591     * @param a Pointer where to store the alpha channel value.
23592     *
23593     * @see elm_map_route_color_set() for details.
23594     *
23595     * @ingroup Map
23596     */
23597    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23598
23599    /**
23600     * Get the route distance in kilometers.
23601     *
23602     * @param route The route object.
23603     * @return The distance of route (unit : km).
23604     *
23605     * @ingroup Map
23606     */
23607    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23608
23609    /**
23610     * Get the information of route nodes.
23611     *
23612     * @param route The route object.
23613     * @return Returns a string with the nodes of route.
23614     *
23615     * @ingroup Map
23616     */
23617    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23618
23619    /**
23620     * Get the information of route waypoint.
23621     *
23622     * @param route the route object.
23623     * @return Returns a string with information about waypoint of route.
23624     *
23625     * @ingroup Map
23626     */
23627    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23628
23629    /**
23630     * Get the address of the name.
23631     *
23632     * @param name The name handle.
23633     * @return Returns the address string of @p name.
23634     *
23635     * This gets the coordinates of the @p name, created with one of the
23636     * conversion functions.
23637     *
23638     * @see elm_map_utils_convert_name_into_coord()
23639     * @see elm_map_utils_convert_coord_into_name()
23640     *
23641     * @ingroup Map
23642     */
23643    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23644
23645    /**
23646     * Get the current coordinates of the name.
23647     *
23648     * @param name The name handle.
23649     * @param lat Pointer where to store the latitude.
23650     * @param lon Pointer where to store The longitude.
23651     *
23652     * This gets the coordinates of the @p name, created with one of the
23653     * conversion functions.
23654     *
23655     * @see elm_map_utils_convert_name_into_coord()
23656     * @see elm_map_utils_convert_coord_into_name()
23657     *
23658     * @ingroup Map
23659     */
23660    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23661
23662    /**
23663     * Remove a name from the map.
23664     *
23665     * @param name The name to remove.
23666     *
23667     * Basically the struct handled by @p name will be freed, so convertions
23668     * between address and coordinates will be lost.
23669     *
23670     * @see elm_map_utils_convert_name_into_coord()
23671     * @see elm_map_utils_convert_coord_into_name()
23672     *
23673     * @ingroup Map
23674     */
23675    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23676
23677    /**
23678     * Rotate the map.
23679     *
23680     * @param obj The map object.
23681     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23682     * @param cx Rotation's center horizontal position.
23683     * @param cy Rotation's center vertical position.
23684     *
23685     * @see elm_map_rotate_get()
23686     *
23687     * @ingroup Map
23688     */
23689    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23690
23691    /**
23692     * Get the rotate degree of the map
23693     *
23694     * @param obj The map object
23695     * @param degree Pointer where to store degrees from 0.0 to 360.0
23696     * to rotate arount Z axis.
23697     * @param cx Pointer where to store rotation's center horizontal position.
23698     * @param cy Pointer where to store rotation's center vertical position.
23699     *
23700     * @see elm_map_rotate_set() to set map rotation.
23701     *
23702     * @ingroup Map
23703     */
23704    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);
23705
23706    /**
23707     * Enable or disable mouse wheel to be used to zoom in / out the map.
23708     *
23709     * @param obj The map object.
23710     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23711     * to enable it.
23712     *
23713     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23714     *
23715     * It's disabled by default.
23716     *
23717     * @see elm_map_wheel_disabled_get()
23718     *
23719     * @ingroup Map
23720     */
23721    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23722
23723    /**
23724     * Get a value whether mouse wheel is enabled or not.
23725     *
23726     * @param obj The map object.
23727     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23728     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23729     *
23730     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23731     *
23732     * @see elm_map_wheel_disabled_set() for details.
23733     *
23734     * @ingroup Map
23735     */
23736    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23737
23738 #ifdef ELM_EMAP
23739    /**
23740     * Add a track on the map
23741     *
23742     * @param obj The map object.
23743     * @param emap The emap route object.
23744     * @return The route object. This is an elm object of type Route.
23745     *
23746     * @see elm_route_add() for details.
23747     *
23748     * @ingroup Map
23749     */
23750    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23751 #endif
23752
23753    /**
23754     * Remove a track from the map
23755     *
23756     * @param obj The map object.
23757     * @param route The track to remove.
23758     *
23759     * @ingroup Map
23760     */
23761    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23762
23763    /**
23764     * @}
23765     */
23766
23767    /* Route */
23768    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23769 #ifdef ELM_EMAP
23770    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23771 #endif
23772    EAPI double elm_route_lon_min_get(Evas_Object *obj);
23773    EAPI double elm_route_lat_min_get(Evas_Object *obj);
23774    EAPI double elm_route_lon_max_get(Evas_Object *obj);
23775    EAPI double elm_route_lat_max_get(Evas_Object *obj);
23776
23777
23778    /**
23779     * @defgroup Panel Panel
23780     *
23781     * @image html img/widget/panel/preview-00.png
23782     * @image latex img/widget/panel/preview-00.eps
23783     *
23784     * @brief A panel is a type of animated container that contains subobjects.
23785     * It can be expanded or contracted by clicking the button on it's edge.
23786     *
23787     * Orientations are as follows:
23788     * @li ELM_PANEL_ORIENT_TOP
23789     * @li ELM_PANEL_ORIENT_LEFT
23790     * @li ELM_PANEL_ORIENT_RIGHT
23791     *
23792     * To set/get/unset the content of the panel, you can use
23793     * elm_object_content_set/get/unset APIs.
23794     * Once the content object is set, a previously set one will be deleted.
23795     * If you want to keep that old content object, use the
23796     * elm_object_content_unset() function
23797     *
23798     * @ref tutorial_panel shows one way to use this widget.
23799     * @{
23800     */
23801    typedef enum _Elm_Panel_Orient
23802      {
23803         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23804         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23805         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23806         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23807      } Elm_Panel_Orient;
23808    /**
23809     * @brief Adds a panel object
23810     *
23811     * @param parent The parent object
23812     *
23813     * @return The panel object, or NULL on failure
23814     */
23815    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23816    /**
23817     * @brief Sets the orientation of the panel
23818     *
23819     * @param parent The parent object
23820     * @param orient The panel orientation. Can be one of the following:
23821     * @li ELM_PANEL_ORIENT_TOP
23822     * @li ELM_PANEL_ORIENT_LEFT
23823     * @li ELM_PANEL_ORIENT_RIGHT
23824     *
23825     * Sets from where the panel will (dis)appear.
23826     */
23827    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23828    /**
23829     * @brief Get the orientation of the panel.
23830     *
23831     * @param obj The panel object
23832     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23833     */
23834    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23835    /**
23836     * @brief Set the content of the panel.
23837     *
23838     * @param obj The panel object
23839     * @param content The panel content
23840     *
23841     * Once the content object is set, a previously set one will be deleted.
23842     * If you want to keep that old content object, use the
23843     * elm_panel_content_unset() function.
23844     */
23845    EINA_DEPRECATED EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23846    /**
23847     * @brief Get the content of the panel.
23848     *
23849     * @param obj The panel object
23850     * @return The content that is being used
23851     *
23852     * Return the content object which is set for this widget.
23853     *
23854     * @see elm_panel_content_set()
23855     */
23856    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23857    /**
23858     * @brief Unset the content of the panel.
23859     *
23860     * @param obj The panel object
23861     * @return The content that was being used
23862     *
23863     * Unparent and return the content object which was set for this widget.
23864     *
23865     * @see elm_panel_content_set()
23866     */
23867    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23868    /**
23869     * @brief Set the state of the panel.
23870     *
23871     * @param obj The panel object
23872     * @param hidden If true, the panel will run the animation to contract
23873     */
23874    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23875    /**
23876     * @brief Get the state of the panel.
23877     *
23878     * @param obj The panel object
23879     * @param hidden If true, the panel is in the "hide" state
23880     */
23881    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23882    /**
23883     * @brief Toggle the hidden state of the panel from code
23884     *
23885     * @param obj The panel object
23886     */
23887    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23888    /**
23889     * @}
23890     */
23891
23892    /**
23893     * @defgroup Panes Panes
23894     * @ingroup Elementary
23895     *
23896     * @image html img/widget/panes/preview-00.png
23897     * @image latex img/widget/panes/preview-00.eps width=\textwidth
23898     *
23899     * @image html img/panes.png
23900     * @image latex img/panes.eps width=\textwidth
23901     *
23902     * The panes adds a dragable bar between two contents. When dragged
23903     * this bar will resize contents size.
23904     *
23905     * Panes can be displayed vertically or horizontally, and contents
23906     * size proportion can be customized (homogeneous by default).
23907     *
23908     * Smart callbacks one can listen to:
23909     * - "press" - The panes has been pressed (button wasn't released yet).
23910     * - "unpressed" - The panes was released after being pressed.
23911     * - "clicked" - The panes has been clicked>
23912     * - "clicked,double" - The panes has been double clicked
23913     *
23914     * Available styles for it:
23915     * - @c "default"
23916     *
23917     * Default contents parts of the panes widget that you can use for are:
23918     * @li "elm.swallow.left" - A leftside content of the panes
23919     * @li "elm.swallow.right" - A rightside content of the panes
23920     *
23921     * If panes is displayed vertically, left content will be displayed at
23922     * top.
23923     * 
23924     * Here is an example on its usage:
23925     * @li @ref panes_example
23926     */
23927
23928 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
23929 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
23930
23931    /**
23932     * @addtogroup Panes
23933     * @{
23934     */
23935
23936    /**
23937     * Add a new panes widget to the given parent Elementary
23938     * (container) object.
23939     *
23940     * @param parent The parent object.
23941     * @return a new panes widget handle or @c NULL, on errors.
23942     *
23943     * This function inserts a new panes widget on the canvas.
23944     *
23945     * @ingroup Panes
23946     */
23947    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23948
23949    /**
23950     * Set the left content of the panes widget.
23951     *
23952     * @param obj The panes object.
23953     * @param content The new left content object.
23954     *
23955     * Once the content object is set, a previously set one will be deleted.
23956     * If you want to keep that old content object, use the
23957     * elm_panes_content_left_unset() function.
23958     *
23959     * If panes is displayed vertically, left content will be displayed at
23960     * top.
23961     *
23962     * @see elm_panes_content_left_get()
23963     * @see elm_panes_content_right_set() to set content on the other side.
23964     *
23965     * @ingroup Panes
23966     */
23967    EINA_DEPRECATED EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23968
23969    /**
23970     * Set the right content of the panes widget.
23971     *
23972     * @param obj The panes object.
23973     * @param content The new right content object.
23974     *
23975     * Once the content object is set, a previously set one will be deleted.
23976     * If you want to keep that old content object, use the
23977     * elm_panes_content_right_unset() function.
23978     *
23979     * If panes is displayed vertically, left content will be displayed at
23980     * bottom.
23981     *
23982     * @see elm_panes_content_right_get()
23983     * @see elm_panes_content_left_set() to set content on the other side.
23984     *
23985     * @ingroup Panes
23986     */
23987    EINA_DEPRECATED EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23988
23989    /**
23990     * Get the left content of the panes.
23991     *
23992     * @param obj The panes object.
23993     * @return The left content object that is being used.
23994     *
23995     * Return the left content object which is set for this widget.
23996     *
23997     * @see elm_panes_content_left_set() for details.
23998     *
23999     * @ingroup Panes
24000     */
24001    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24002
24003    /**
24004     * Get the right content of the panes.
24005     *
24006     * @param obj The panes object
24007     * @return The right content object that is being used
24008     *
24009     * Return the right content object which is set for this widget.
24010     *
24011     * @see elm_panes_content_right_set() for details.
24012     *
24013     * @ingroup Panes
24014     */
24015    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24016
24017    /**
24018     * Unset the left content used for the panes.
24019     *
24020     * @param obj The panes object.
24021     * @return The left content object that was being used.
24022     *
24023     * Unparent and return the left content object which was set for this widget.
24024     *
24025     * @see elm_panes_content_left_set() for details.
24026     * @see elm_panes_content_left_get().
24027     *
24028     * @ingroup Panes
24029     */
24030    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24031
24032    /**
24033     * Unset the right content used for the panes.
24034     *
24035     * @param obj The panes object.
24036     * @return The right content object that was being used.
24037     *
24038     * Unparent and return the right content object which was set for this
24039     * widget.
24040     *
24041     * @see elm_panes_content_right_set() for details.
24042     * @see elm_panes_content_right_get().
24043     *
24044     * @ingroup Panes
24045     */
24046    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24047
24048    /**
24049     * Get the size proportion of panes widget's left side.
24050     *
24051     * @param obj The panes object.
24052     * @return float value between 0.0 and 1.0 representing size proportion
24053     * of left side.
24054     *
24055     * @see elm_panes_content_left_size_set() for more details.
24056     *
24057     * @ingroup Panes
24058     */
24059    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24060
24061    /**
24062     * Set the size proportion of panes widget's left side.
24063     *
24064     * @param obj The panes object.
24065     * @param size Value between 0.0 and 1.0 representing size proportion
24066     * of left side.
24067     *
24068     * By default it's homogeneous, i.e., both sides have the same size.
24069     *
24070     * If something different is required, it can be set with this function.
24071     * For example, if the left content should be displayed over
24072     * 75% of the panes size, @p size should be passed as @c 0.75.
24073     * This way, right content will be resized to 25% of panes size.
24074     *
24075     * If displayed vertically, left content is displayed at top, and
24076     * right content at bottom.
24077     *
24078     * @note This proportion will change when user drags the panes bar.
24079     *
24080     * @see elm_panes_content_left_size_get()
24081     *
24082     * @ingroup Panes
24083     */
24084    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24085
24086   /**
24087    * Set the orientation of a given panes widget.
24088    *
24089    * @param obj The panes object.
24090    * @param horizontal Use @c EINA_TRUE to make @p obj to be
24091    * @b horizontal, @c EINA_FALSE to make it @b vertical.
24092    *
24093    * Use this function to change how your panes is to be
24094    * disposed: vertically or horizontally.
24095    *
24096    * By default it's displayed horizontally.
24097    *
24098    * @see elm_panes_horizontal_get()
24099    *
24100    * @ingroup Panes
24101    */
24102    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24103
24104    /**
24105     * Retrieve the orientation of a given panes widget.
24106     *
24107     * @param obj The panes object.
24108     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24109     * @c EINA_FALSE if it's @b vertical (and on errors).
24110     *
24111     * @see elm_panes_horizontal_set() for more details.
24112     *
24113     * @ingroup Panes
24114     */
24115    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24116    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24117    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24118
24119    /**
24120     * @}
24121     */
24122
24123    /**
24124     * @defgroup Flip Flip
24125     *
24126     * @image html img/widget/flip/preview-00.png
24127     * @image latex img/widget/flip/preview-00.eps
24128     *
24129     * This widget holds 2 content objects(Evas_Object): one on the front and one
24130     * on the back. It allows you to flip from front to back and vice-versa using
24131     * various animations.
24132     *
24133     * If either the front or back contents are not set the flip will treat that
24134     * as transparent. So if you wore to set the front content but not the back,
24135     * and then call elm_flip_go() you would see whatever is below the flip.
24136     *
24137     * For a list of supported animations see elm_flip_go().
24138     *
24139     * Signals that you can add callbacks for are:
24140     * "animate,begin" - when a flip animation was started
24141     * "animate,done" - when a flip animation is finished
24142     *
24143     * @ref tutorial_flip show how to use most of the API.
24144     *
24145     * @{
24146     */
24147    typedef enum _Elm_Flip_Mode
24148      {
24149         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24150         ELM_FLIP_ROTATE_X_CENTER_AXIS,
24151         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24152         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24153         ELM_FLIP_CUBE_LEFT,
24154         ELM_FLIP_CUBE_RIGHT,
24155         ELM_FLIP_CUBE_UP,
24156         ELM_FLIP_CUBE_DOWN,
24157         ELM_FLIP_PAGE_LEFT,
24158         ELM_FLIP_PAGE_RIGHT,
24159         ELM_FLIP_PAGE_UP,
24160         ELM_FLIP_PAGE_DOWN
24161      } Elm_Flip_Mode;
24162    typedef enum _Elm_Flip_Interaction
24163      {
24164         ELM_FLIP_INTERACTION_NONE,
24165         ELM_FLIP_INTERACTION_ROTATE,
24166         ELM_FLIP_INTERACTION_CUBE,
24167         ELM_FLIP_INTERACTION_PAGE
24168      } Elm_Flip_Interaction;
24169    typedef enum _Elm_Flip_Direction
24170      {
24171         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24172         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24173         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24174         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24175      } Elm_Flip_Direction;
24176    /**
24177     * @brief Add a new flip to the parent
24178     *
24179     * @param parent The parent object
24180     * @return The new object or NULL if it cannot be created
24181     */
24182    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24183    /**
24184     * @brief Set the front content of the flip widget.
24185     *
24186     * @param obj The flip object
24187     * @param content The new front content object
24188     *
24189     * Once the content object is set, a previously set one will be deleted.
24190     * If you want to keep that old content object, use the
24191     * elm_flip_content_front_unset() function.
24192     */
24193    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24194    /**
24195     * @brief Set the back content of the flip widget.
24196     *
24197     * @param obj The flip object
24198     * @param content The new back content object
24199     *
24200     * Once the content object is set, a previously set one will be deleted.
24201     * If you want to keep that old content object, use the
24202     * elm_flip_content_back_unset() function.
24203     */
24204    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24205    /**
24206     * @brief Get the front content used for the flip
24207     *
24208     * @param obj The flip object
24209     * @return The front content object that is being used
24210     *
24211     * Return the front content object which is set for this widget.
24212     */
24213    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24214    /**
24215     * @brief Get the back content used for the flip
24216     *
24217     * @param obj The flip object
24218     * @return The back content object that is being used
24219     *
24220     * Return the back content object which is set for this widget.
24221     */
24222    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24223    /**
24224     * @brief Unset the front content used for the flip
24225     *
24226     * @param obj The flip object
24227     * @return The front content object that was being used
24228     *
24229     * Unparent and return the front content object which was set for this widget.
24230     */
24231    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24232    /**
24233     * @brief Unset the back content used for the flip
24234     *
24235     * @param obj The flip object
24236     * @return The back content object that was being used
24237     *
24238     * Unparent and return the back content object which was set for this widget.
24239     */
24240    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24241    /**
24242     * @brief Get flip front visibility state
24243     *
24244     * @param obj The flip objct
24245     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24246     * showing.
24247     */
24248    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24249    /**
24250     * @brief Set flip perspective
24251     *
24252     * @param obj The flip object
24253     * @param foc The coordinate to set the focus on
24254     * @param x The X coordinate
24255     * @param y The Y coordinate
24256     *
24257     * @warning This function currently does nothing.
24258     */
24259    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24260    /**
24261     * @brief Runs the flip animation
24262     *
24263     * @param obj The flip object
24264     * @param mode The mode type
24265     *
24266     * Flips the front and back contents using the @p mode animation. This
24267     * efectively hides the currently visible content and shows the hidden one.
24268     *
24269     * There a number of possible animations to use for the flipping:
24270     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24271     * around a horizontal axis in the middle of its height, the other content
24272     * is shown as the other side of the flip.
24273     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24274     * around a vertical axis in the middle of its width, the other content is
24275     * shown as the other side of the flip.
24276     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24277     * around a diagonal axis in the middle of its width, the other content is
24278     * shown as the other side of the flip.
24279     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24280     * around a diagonal axis in the middle of its height, the other content is
24281     * shown as the other side of the flip.
24282     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24283     * as if the flip was a cube, the other content is show as the right face of
24284     * the cube.
24285     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24286     * right as if the flip was a cube, the other content is show as the left
24287     * face of the cube.
24288     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24289     * flip was a cube, the other content is show as the bottom face of the cube.
24290     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24291     * the flip was a cube, the other content is show as the upper face of the
24292     * cube.
24293     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24294     * if the flip was a book, the other content is shown as the page below that.
24295     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24296     * as if the flip was a book, the other content is shown as the page below
24297     * that.
24298     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24299     * flip was a book, the other content is shown as the page below that.
24300     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24301     * flip was a book, the other content is shown as the page below that.
24302     *
24303     * @image html elm_flip.png
24304     * @image latex elm_flip.eps width=\textwidth
24305     */
24306    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24307    /**
24308     * @brief Set the interactive flip mode
24309     *
24310     * @param obj The flip object
24311     * @param mode The interactive flip mode to use
24312     *
24313     * This sets if the flip should be interactive (allow user to click and
24314     * drag a side of the flip to reveal the back page and cause it to flip).
24315     * By default a flip is not interactive. You may also need to set which
24316     * sides of the flip are "active" for flipping and how much space they use
24317     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24318     * and elm_flip_interacton_direction_hitsize_set()
24319     *
24320     * The four avilable mode of interaction are:
24321     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24322     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24323     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24324     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24325     *
24326     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24327     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24328     * happen, those can only be acheived with elm_flip_go();
24329     */
24330    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24331    /**
24332     * @brief Get the interactive flip mode
24333     *
24334     * @param obj The flip object
24335     * @return The interactive flip mode
24336     *
24337     * Returns the interactive flip mode set by elm_flip_interaction_set()
24338     */
24339    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24340    /**
24341     * @brief Set which directions of the flip respond to interactive flip
24342     *
24343     * @param obj The flip object
24344     * @param dir The direction to change
24345     * @param enabled If that direction is enabled or not
24346     *
24347     * By default all directions are disabled, so you may want to enable the
24348     * desired directions for flipping if you need interactive flipping. You must
24349     * call this function once for each direction that should be enabled.
24350     *
24351     * @see elm_flip_interaction_set()
24352     */
24353    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24354    /**
24355     * @brief Get the enabled state of that flip direction
24356     *
24357     * @param obj The flip object
24358     * @param dir The direction to check
24359     * @return If that direction is enabled or not
24360     *
24361     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24362     *
24363     * @see elm_flip_interaction_set()
24364     */
24365    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24366    /**
24367     * @brief Set the amount of the flip that is sensitive to interactive flip
24368     *
24369     * @param obj The flip object
24370     * @param dir The direction to modify
24371     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24372     *
24373     * Set the amount of the flip that is sensitive to interactive flip, with 0
24374     * representing no area in the flip and 1 representing the entire flip. There
24375     * is however a consideration to be made in that the area will never be
24376     * smaller than the finger size set(as set in your Elementary configuration).
24377     *
24378     * @see elm_flip_interaction_set()
24379     */
24380    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24381    /**
24382     * @brief Get the amount of the flip that is sensitive to interactive flip
24383     *
24384     * @param obj The flip object
24385     * @param dir The direction to check
24386     * @return The size set for that direction
24387     *
24388     * Returns the amount os sensitive area set by
24389     * elm_flip_interacton_direction_hitsize_set().
24390     */
24391    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24392    /**
24393     * @}
24394     */
24395
24396    /* scrolledentry */
24397    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24398    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24399    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24400    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24401    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24402    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24403    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24404    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24405    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24406    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24407    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24408    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24409    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24410    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24411    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24412    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24413    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24414    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24415    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24416    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24417    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24418    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24419    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24420    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24421    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24422    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24423    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24424    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24425    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24426    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24427    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24428    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24429    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24430    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24431    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24432    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);
24433    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24434    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24435    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);
24436    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24437    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);
24438    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24439    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24440    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24441    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24442    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24443    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24444    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24445    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24446    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);
24447    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);
24448    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);
24449    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);
24450    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);
24451    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);
24452    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24453    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24454    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24455    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24456    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24457    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24458    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24459
24460    /**
24461     * @defgroup Conformant Conformant
24462     * @ingroup Elementary
24463     *
24464     * @image html img/widget/conformant/preview-00.png
24465     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24466     *
24467     * @image html img/conformant.png
24468     * @image latex img/conformant.eps width=\textwidth
24469     *
24470     * The aim is to provide a widget that can be used in elementary apps to
24471     * account for space taken up by the indicator, virtual keypad & softkey
24472     * windows when running the illume2 module of E17.
24473     *
24474     * So conformant content will be sized and positioned considering the
24475     * space required for such stuff, and when they popup, as a keyboard
24476     * shows when an entry is selected, conformant content won't change.
24477     *
24478     * Available styles for it:
24479     * - @c "default"
24480     *
24481     * Default contents parts of the conformant widget that you can use for are:
24482     * @li "elm.swallow.content" - A content of the conformant
24483     *
24484     * See how to use this widget in this example:
24485     * @ref conformant_example
24486     */
24487
24488    /**
24489     * @addtogroup Conformant
24490     * @{
24491     */
24492
24493    /**
24494     * Add a new conformant widget to the given parent Elementary
24495     * (container) object.
24496     *
24497     * @param parent The parent object.
24498     * @return A new conformant widget handle or @c NULL, on errors.
24499     *
24500     * This function inserts a new conformant widget on the canvas.
24501     *
24502     * @ingroup Conformant
24503     */
24504    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24505
24506    /**
24507     * Set the content of the conformant widget.
24508     *
24509     * @param obj The conformant object.
24510     * @param content The content to be displayed by the conformant.
24511     *
24512     * Content will be sized and positioned considering the space required
24513     * to display a virtual keyboard. So it won't fill all the conformant
24514     * size. This way is possible to be sure that content won't resize
24515     * or be re-positioned after the keyboard is displayed.
24516     *
24517     * Once the content object is set, a previously set one will be deleted.
24518     * If you want to keep that old content object, use the
24519     * elm_object_content_unset() function.
24520     *
24521     * @see elm_object_content_unset()
24522     * @see elm_object_content_get()
24523     *
24524     * @ingroup Conformant
24525     */
24526    EINA_DEPRECATED EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24527
24528    /**
24529     * Get the content of the conformant widget.
24530     *
24531     * @param obj The conformant object.
24532     * @return The content that is being used.
24533     *
24534     * Return the content object which is set for this widget.
24535     * It won't be unparent from conformant. For that, use
24536     * elm_object_content_unset().
24537     *
24538     * @see elm_object_content_set().
24539     * @see elm_object_content_unset()
24540     *
24541     * @ingroup Conformant
24542     */
24543    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24544
24545    /**
24546     * Unset the content of the conformant widget.
24547     *
24548     * @param obj The conformant object.
24549     * @return The content that was being used.
24550     *
24551     * Unparent and return the content object which was set for this widget.
24552     *
24553     * @see elm_object_content_set().
24554     *
24555     * @ingroup Conformant
24556     */
24557    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24558
24559    /**
24560     * Returns the Evas_Object that represents the content area.
24561     *
24562     * @param obj The conformant object.
24563     * @return The content area of the widget.
24564     *
24565     * @ingroup Conformant
24566     */
24567    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24568
24569    /**
24570     * @}
24571     */
24572
24573    /**
24574     * @defgroup Mapbuf Mapbuf
24575     * @ingroup Elementary
24576     *
24577     * @image html img/widget/mapbuf/preview-00.png
24578     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24579     *
24580     * This holds one content object and uses an Evas Map of transformation
24581     * points to be later used with this content. So the content will be
24582     * moved, resized, etc as a single image. So it will improve performance
24583     * when you have a complex interafce, with a lot of elements, and will
24584     * need to resize or move it frequently (the content object and its
24585     * children).
24586     *
24587     * To set/get/unset the content of the mapbuf, you can use 
24588     * elm_object_content_set/get/unset APIs. 
24589     * Once the content object is set, a previously set one will be deleted.
24590     * If you want to keep that old content object, use the
24591     * elm_object_content_unset() function.
24592     *
24593     * To enable map, elm_mapbuf_enabled_set() should be used.
24594     * 
24595     * See how to use this widget in this example:
24596     * @ref mapbuf_example
24597     */
24598
24599    /**
24600     * @addtogroup Mapbuf
24601     * @{
24602     */
24603
24604    /**
24605     * Add a new mapbuf widget to the given parent Elementary
24606     * (container) object.
24607     *
24608     * @param parent The parent object.
24609     * @return A new mapbuf widget handle or @c NULL, on errors.
24610     *
24611     * This function inserts a new mapbuf widget on the canvas.
24612     *
24613     * @ingroup Mapbuf
24614     */
24615    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24616
24617    /**
24618     * Set the content of the mapbuf.
24619     *
24620     * @param obj The mapbuf object.
24621     * @param content The content that will be filled in this mapbuf object.
24622     *
24623     * Once the content object is set, a previously set one will be deleted.
24624     * If you want to keep that old content object, use the
24625     * elm_mapbuf_content_unset() function.
24626     *
24627     * To enable map, elm_mapbuf_enabled_set() should be used.
24628     *
24629     * @ingroup Mapbuf
24630     */
24631    EINA_DEPRECATED EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24632
24633    /**
24634     * Get the content of the mapbuf.
24635     *
24636     * @param obj The mapbuf object.
24637     * @return The content that is being used.
24638     *
24639     * Return the content object which is set for this widget.
24640     *
24641     * @see elm_mapbuf_content_set() for details.
24642     *
24643     * @ingroup Mapbuf
24644     */
24645    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24646
24647    /**
24648     * Unset the content of the mapbuf.
24649     *
24650     * @param obj The mapbuf object.
24651     * @return The content that was being used.
24652     *
24653     * Unparent and return the content object which was set for this widget.
24654     *
24655     * @see elm_mapbuf_content_set() for details.
24656     *
24657     * @ingroup Mapbuf
24658     */
24659    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24660
24661    /**
24662     * Enable or disable the map.
24663     *
24664     * @param obj The mapbuf object.
24665     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24666     *
24667     * This enables the map that is set or disables it. On enable, the object
24668     * geometry will be saved, and the new geometry will change (position and
24669     * size) to reflect the map geometry set.
24670     *
24671     * Also, when enabled, alpha and smooth states will be used, so if the
24672     * content isn't solid, alpha should be enabled, for example, otherwise
24673     * a black retangle will fill the content.
24674     *
24675     * When disabled, the stored map will be freed and geometry prior to
24676     * enabling the map will be restored.
24677     *
24678     * It's disabled by default.
24679     *
24680     * @see elm_mapbuf_alpha_set()
24681     * @see elm_mapbuf_smooth_set()
24682     *
24683     * @ingroup Mapbuf
24684     */
24685    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24686
24687    /**
24688     * Get a value whether map is enabled or not.
24689     *
24690     * @param obj The mapbuf object.
24691     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24692     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24693     *
24694     * @see elm_mapbuf_enabled_set() for details.
24695     *
24696     * @ingroup Mapbuf
24697     */
24698    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24699
24700    /**
24701     * Enable or disable smooth map rendering.
24702     *
24703     * @param obj The mapbuf object.
24704     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24705     * to disable it.
24706     *
24707     * This sets smoothing for map rendering. If the object is a type that has
24708     * its own smoothing settings, then both the smooth settings for this object
24709     * and the map must be turned off.
24710     *
24711     * By default smooth maps are enabled.
24712     *
24713     * @ingroup Mapbuf
24714     */
24715    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24716
24717    /**
24718     * Get a value whether smooth map rendering is enabled or not.
24719     *
24720     * @param obj The mapbuf object.
24721     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24722     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24723     *
24724     * @see elm_mapbuf_smooth_set() for details.
24725     *
24726     * @ingroup Mapbuf
24727     */
24728    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24729
24730    /**
24731     * Set or unset alpha flag for map rendering.
24732     *
24733     * @param obj The mapbuf object.
24734     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24735     * to disable it.
24736     *
24737     * This sets alpha flag for map rendering. If the object is a type that has
24738     * its own alpha settings, then this will take precedence. Only image objects
24739     * have this currently. It stops alpha blending of the map area, and is
24740     * useful if you know the object and/or all sub-objects is 100% solid.
24741     *
24742     * Alpha is enabled by default.
24743     *
24744     * @ingroup Mapbuf
24745     */
24746    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24747
24748    /**
24749     * Get a value whether alpha blending is enabled or not.
24750     *
24751     * @param obj The mapbuf object.
24752     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24753     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24754     *
24755     * @see elm_mapbuf_alpha_set() for details.
24756     *
24757     * @ingroup Mapbuf
24758     */
24759    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24760
24761    /**
24762     * @}
24763     */
24764
24765    /**
24766     * @defgroup Flipselector Flip Selector
24767     *
24768     * @image html img/widget/flipselector/preview-00.png
24769     * @image latex img/widget/flipselector/preview-00.eps
24770     *
24771     * A flip selector is a widget to show a set of @b text items, one
24772     * at a time, with the same sheet switching style as the @ref Clock
24773     * "clock" widget, when one changes the current displaying sheet
24774     * (thus, the "flip" in the name).
24775     *
24776     * User clicks to flip sheets which are @b held for some time will
24777     * make the flip selector to flip continuosly and automatically for
24778     * the user. The interval between flips will keep growing in time,
24779     * so that it helps the user to reach an item which is distant from
24780     * the current selection.
24781     *
24782     * Smart callbacks one can register to:
24783     * - @c "selected" - when the widget's selected text item is changed
24784     * - @c "overflowed" - when the widget's current selection is changed
24785     *   from the first item in its list to the last
24786     * - @c "underflowed" - when the widget's current selection is changed
24787     *   from the last item in its list to the first
24788     *
24789     * Available styles for it:
24790     * - @c "default"
24791     *
24792     * Here is an example on its usage:
24793     * @li @ref flipselector_example
24794     */
24795
24796    /**
24797     * @addtogroup Flipselector
24798     * @{
24799     */
24800
24801    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24802
24803    /**
24804     * Add a new flip selector widget to the given parent Elementary
24805     * (container) widget
24806     *
24807     * @param parent The parent object
24808     * @return a new flip selector widget handle or @c NULL, on errors
24809     *
24810     * This function inserts a new flip selector widget on the canvas.
24811     *
24812     * @ingroup Flipselector
24813     */
24814    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24815
24816    /**
24817     * Programmatically select the next item of a flip selector widget
24818     *
24819     * @param obj The flipselector object
24820     *
24821     * @note The selection will be animated. Also, if it reaches the
24822     * end of its list of member items, it will continue with the first
24823     * one onwards.
24824     *
24825     * @ingroup Flipselector
24826     */
24827    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24828
24829    /**
24830     * Programmatically select the previous item of a flip selector
24831     * widget
24832     *
24833     * @param obj The flipselector object
24834     *
24835     * @note The selection will be animated.  Also, if it reaches the
24836     * beginning of its list of member items, it will continue with the
24837     * last one backwards.
24838     *
24839     * @ingroup Flipselector
24840     */
24841    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24842
24843    /**
24844     * Append a (text) item to a flip selector widget
24845     *
24846     * @param obj The flipselector object
24847     * @param label The (text) label of the new item
24848     * @param func Convenience callback function to take place when
24849     * item is selected
24850     * @param data Data passed to @p func, above
24851     * @return A handle to the item added or @c NULL, on errors
24852     *
24853     * The widget's list of labels to show will be appended with the
24854     * given value. If the user wishes so, a callback function pointer
24855     * can be passed, which will get called when this same item is
24856     * selected.
24857     *
24858     * @note The current selection @b won't be modified by appending an
24859     * element to the list.
24860     *
24861     * @note The maximum length of the text label is going to be
24862     * determined <b>by the widget's theme</b>. Strings larger than
24863     * that value are going to be @b truncated.
24864     *
24865     * @ingroup Flipselector
24866     */
24867    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24868
24869    /**
24870     * Prepend a (text) item to a flip selector widget
24871     *
24872     * @param obj The flipselector object
24873     * @param label The (text) label of the new item
24874     * @param func Convenience callback function to take place when
24875     * item is selected
24876     * @param data Data passed to @p func, above
24877     * @return A handle to the item added or @c NULL, on errors
24878     *
24879     * The widget's list of labels to show will be prepended with the
24880     * given value. If the user wishes so, a callback function pointer
24881     * can be passed, which will get called when this same item is
24882     * selected.
24883     *
24884     * @note The current selection @b won't be modified by prepending
24885     * an element to the list.
24886     *
24887     * @note The maximum length of the text label is going to be
24888     * determined <b>by the widget's theme</b>. Strings larger than
24889     * that value are going to be @b truncated.
24890     *
24891     * @ingroup Flipselector
24892     */
24893    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24894
24895    /**
24896     * Get the internal list of items in a given flip selector widget.
24897     *
24898     * @param obj The flipselector object
24899     * @return The list of items (#Elm_Flipselector_Item as data) or
24900     * @c NULL on errors.
24901     *
24902     * This list is @b not to be modified in any way and must not be
24903     * freed. Use the list members with functions like
24904     * elm_flipselector_item_label_set(),
24905     * elm_flipselector_item_label_get(),
24906     * elm_flipselector_item_del(),
24907     * elm_flipselector_item_selected_get(),
24908     * elm_flipselector_item_selected_set().
24909     *
24910     * @warning This list is only valid until @p obj object's internal
24911     * items list is changed. It should be fetched again with another
24912     * call to this function when changes happen.
24913     *
24914     * @ingroup Flipselector
24915     */
24916    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24917
24918    /**
24919     * Get the first item in the given flip selector widget's list of
24920     * items.
24921     *
24922     * @param obj The flipselector object
24923     * @return The first item or @c NULL, if it has no items (and on
24924     * errors)
24925     *
24926     * @see elm_flipselector_item_append()
24927     * @see elm_flipselector_last_item_get()
24928     *
24929     * @ingroup Flipselector
24930     */
24931    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24932
24933    /**
24934     * Get the last item in the given flip selector widget's list of
24935     * items.
24936     *
24937     * @param obj The flipselector object
24938     * @return The last item or @c NULL, if it has no items (and on
24939     * errors)
24940     *
24941     * @see elm_flipselector_item_prepend()
24942     * @see elm_flipselector_first_item_get()
24943     *
24944     * @ingroup Flipselector
24945     */
24946    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24947
24948    /**
24949     * Get the currently selected item in a flip selector widget.
24950     *
24951     * @param obj The flipselector object
24952     * @return The selected item or @c NULL, if the widget has no items
24953     * (and on erros)
24954     *
24955     * @ingroup Flipselector
24956     */
24957    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24958
24959    /**
24960     * Set whether a given flip selector widget's item should be the
24961     * currently selected one.
24962     *
24963     * @param item The flip selector item
24964     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24965     *
24966     * This sets whether @p item is or not the selected (thus, under
24967     * display) one. If @p item is different than one under display,
24968     * the latter will be unselected. If the @p item is set to be
24969     * unselected, on the other hand, the @b first item in the widget's
24970     * internal members list will be the new selected one.
24971     *
24972     * @see elm_flipselector_item_selected_get()
24973     *
24974     * @ingroup Flipselector
24975     */
24976    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24977
24978    /**
24979     * Get whether a given flip selector widget's item is the currently
24980     * selected one.
24981     *
24982     * @param item The flip selector item
24983     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24984     * (or on errors).
24985     *
24986     * @see elm_flipselector_item_selected_set()
24987     *
24988     * @ingroup Flipselector
24989     */
24990    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24991
24992    /**
24993     * Delete a given item from a flip selector widget.
24994     *
24995     * @param item The item to delete
24996     *
24997     * @ingroup Flipselector
24998     */
24999    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25000
25001    /**
25002     * Get the label of a given flip selector widget's item.
25003     *
25004     * @param item The item to get label from
25005     * @return The text label of @p item or @c NULL, on errors
25006     *
25007     * @see elm_flipselector_item_label_set()
25008     *
25009     * @ingroup Flipselector
25010     */
25011    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25012
25013    /**
25014     * Set the label of a given flip selector widget's item.
25015     *
25016     * @param item The item to set label on
25017     * @param label The text label string, in UTF-8 encoding
25018     *
25019     * @see elm_flipselector_item_label_get()
25020     *
25021     * @ingroup Flipselector
25022     */
25023    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25024
25025    /**
25026     * Gets the item before @p item in a flip selector widget's
25027     * internal list of items.
25028     *
25029     * @param item The item to fetch previous from
25030     * @return The item before the @p item, in its parent's list. If
25031     *         there is no previous item for @p item or there's an
25032     *         error, @c NULL is returned.
25033     *
25034     * @see elm_flipselector_item_next_get()
25035     *
25036     * @ingroup Flipselector
25037     */
25038    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25039
25040    /**
25041     * Gets the item after @p item in a flip selector widget's
25042     * internal list of items.
25043     *
25044     * @param item The item to fetch next from
25045     * @return The item after the @p item, in its parent's list. If
25046     *         there is no next item for @p item or there's an
25047     *         error, @c NULL is returned.
25048     *
25049     * @see elm_flipselector_item_next_get()
25050     *
25051     * @ingroup Flipselector
25052     */
25053    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25054
25055    /**
25056     * Set the interval on time updates for an user mouse button hold
25057     * on a flip selector widget.
25058     *
25059     * @param obj The flip selector object
25060     * @param interval The (first) interval value in seconds
25061     *
25062     * This interval value is @b decreased while the user holds the
25063     * mouse pointer either flipping up or flipping doww a given flip
25064     * selector.
25065     *
25066     * This helps the user to get to a given item distant from the
25067     * current one easier/faster, as it will start to flip quicker and
25068     * quicker on mouse button holds.
25069     *
25070     * The calculation for the next flip interval value, starting from
25071     * the one set with this call, is the previous interval divided by
25072     * 1.05, so it decreases a little bit.
25073     *
25074     * The default starting interval value for automatic flips is
25075     * @b 0.85 seconds.
25076     *
25077     * @see elm_flipselector_interval_get()
25078     *
25079     * @ingroup Flipselector
25080     */
25081    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25082
25083    /**
25084     * Get the interval on time updates for an user mouse button hold
25085     * on a flip selector widget.
25086     *
25087     * @param obj The flip selector object
25088     * @return The (first) interval value, in seconds, set on it
25089     *
25090     * @see elm_flipselector_interval_set() for more details
25091     *
25092     * @ingroup Flipselector
25093     */
25094    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25095    /**
25096     * @}
25097     */
25098
25099    /**
25100     * @addtogroup Calendar
25101     * @{
25102     */
25103
25104    /**
25105     * @enum _Elm_Calendar_Mark_Repeat
25106     * @typedef Elm_Calendar_Mark_Repeat
25107     *
25108     * Event periodicity, used to define if a mark should be repeated
25109     * @b beyond event's day. It's set when a mark is added.
25110     *
25111     * So, for a mark added to 13th May with periodicity set to WEEKLY,
25112     * there will be marks every week after this date. Marks will be displayed
25113     * at 13th, 20th, 27th, 3rd June ...
25114     *
25115     * Values don't work as bitmask, only one can be choosen.
25116     *
25117     * @see elm_calendar_mark_add()
25118     *
25119     * @ingroup Calendar
25120     */
25121    typedef enum _Elm_Calendar_Mark_Repeat
25122      {
25123         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25124         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25125         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25126         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*/
25127         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. */
25128      } Elm_Calendar_Mark_Repeat;
25129
25130    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(). */
25131
25132    /**
25133     * Add a new calendar widget to the given parent Elementary
25134     * (container) object.
25135     *
25136     * @param parent The parent object.
25137     * @return a new calendar widget handle or @c NULL, on errors.
25138     *
25139     * This function inserts a new calendar widget on the canvas.
25140     *
25141     * @ref calendar_example_01
25142     *
25143     * @ingroup Calendar
25144     */
25145    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25146
25147    /**
25148     * Get weekdays names displayed by the calendar.
25149     *
25150     * @param obj The calendar object.
25151     * @return Array of seven strings to be used as weekday names.
25152     *
25153     * By default, weekdays abbreviations get from system are displayed:
25154     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25155     * The first string is related to Sunday, the second to Monday...
25156     *
25157     * @see elm_calendar_weekdays_name_set()
25158     *
25159     * @ref calendar_example_05
25160     *
25161     * @ingroup Calendar
25162     */
25163    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25164
25165    /**
25166     * Set weekdays names to be displayed by the calendar.
25167     *
25168     * @param obj The calendar object.
25169     * @param weekdays Array of seven strings to be used as weekday names.
25170     * @warning It must have 7 elements, or it will access invalid memory.
25171     * @warning The strings must be NULL terminated ('@\0').
25172     *
25173     * By default, weekdays abbreviations get from system are displayed:
25174     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25175     *
25176     * The first string should be related to Sunday, the second to Monday...
25177     *
25178     * The usage should be like this:
25179     * @code
25180     *   const char *weekdays[] =
25181     *   {
25182     *      "Sunday", "Monday", "Tuesday", "Wednesday",
25183     *      "Thursday", "Friday", "Saturday"
25184     *   };
25185     *   elm_calendar_weekdays_names_set(calendar, weekdays);
25186     * @endcode
25187     *
25188     * @see elm_calendar_weekdays_name_get()
25189     *
25190     * @ref calendar_example_02
25191     *
25192     * @ingroup Calendar
25193     */
25194    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25195
25196    /**
25197     * Set the minimum and maximum values for the year
25198     *
25199     * @param obj The calendar object
25200     * @param min The minimum year, greater than 1901;
25201     * @param max The maximum year;
25202     *
25203     * Maximum must be greater than minimum, except if you don't wan't to set
25204     * maximum year.
25205     * Default values are 1902 and -1.
25206     *
25207     * If the maximum year is a negative value, it will be limited depending
25208     * on the platform architecture (year 2037 for 32 bits);
25209     *
25210     * @see elm_calendar_min_max_year_get()
25211     *
25212     * @ref calendar_example_03
25213     *
25214     * @ingroup Calendar
25215     */
25216    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25217
25218    /**
25219     * Get the minimum and maximum values for the year
25220     *
25221     * @param obj The calendar object.
25222     * @param min The minimum year.
25223     * @param max The maximum year.
25224     *
25225     * Default values are 1902 and -1.
25226     *
25227     * @see elm_calendar_min_max_year_get() for more details.
25228     *
25229     * @ref calendar_example_05
25230     *
25231     * @ingroup Calendar
25232     */
25233    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25234
25235    /**
25236     * Enable or disable day selection
25237     *
25238     * @param obj The calendar object.
25239     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25240     * disable it.
25241     *
25242     * Enabled by default. If disabled, the user still can select months,
25243     * but not days. Selected days are highlighted on calendar.
25244     * It should be used if you won't need such selection for the widget usage.
25245     *
25246     * When a day is selected, or month is changed, smart callbacks for
25247     * signal "changed" will be called.
25248     *
25249     * @see elm_calendar_day_selection_enable_get()
25250     *
25251     * @ref calendar_example_04
25252     *
25253     * @ingroup Calendar
25254     */
25255    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25256
25257    /**
25258     * Get a value whether day selection is enabled or not.
25259     *
25260     * @see elm_calendar_day_selection_enable_set() for details.
25261     *
25262     * @param obj The calendar object.
25263     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25264     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25265     *
25266     * @ref calendar_example_05
25267     *
25268     * @ingroup Calendar
25269     */
25270    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25271
25272
25273    /**
25274     * Set selected date to be highlighted on calendar.
25275     *
25276     * @param obj The calendar object.
25277     * @param selected_time A @b tm struct to represent the selected date.
25278     *
25279     * Set the selected date, changing the displayed month if needed.
25280     * Selected date changes when the user goes to next/previous month or
25281     * select a day pressing over it on calendar.
25282     *
25283     * @see elm_calendar_selected_time_get()
25284     *
25285     * @ref calendar_example_04
25286     *
25287     * @ingroup Calendar
25288     */
25289    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25290
25291    /**
25292     * Get selected date.
25293     *
25294     * @param obj The calendar object
25295     * @param selected_time A @b tm struct to point to selected date
25296     * @return EINA_FALSE means an error ocurred and returned time shouldn't
25297     * be considered.
25298     *
25299     * Get date selected by the user or set by function
25300     * elm_calendar_selected_time_set().
25301     * Selected date changes when the user goes to next/previous month or
25302     * select a day pressing over it on calendar.
25303     *
25304     * @see elm_calendar_selected_time_get()
25305     *
25306     * @ref calendar_example_05
25307     *
25308     * @ingroup Calendar
25309     */
25310    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25311
25312    /**
25313     * Set a function to format the string that will be used to display
25314     * month and year;
25315     *
25316     * @param obj The calendar object
25317     * @param format_function Function to set the month-year string given
25318     * the selected date
25319     *
25320     * By default it uses strftime with "%B %Y" format string.
25321     * It should allocate the memory that will be used by the string,
25322     * that will be freed by the widget after usage.
25323     * A pointer to the string and a pointer to the time struct will be provided.
25324     *
25325     * Example:
25326     * @code
25327     * static char *
25328     * _format_month_year(struct tm *selected_time)
25329     * {
25330     *    char buf[32];
25331     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25332     *    return strdup(buf);
25333     * }
25334     *
25335     * elm_calendar_format_function_set(calendar, _format_month_year);
25336     * @endcode
25337     *
25338     * @ref calendar_example_02
25339     *
25340     * @ingroup Calendar
25341     */
25342    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25343
25344    /**
25345     * Add a new mark to the calendar
25346     *
25347     * @param obj The calendar object
25348     * @param mark_type A string used to define the type of mark. It will be
25349     * emitted to the theme, that should display a related modification on these
25350     * days representation.
25351     * @param mark_time A time struct to represent the date of inclusion of the
25352     * mark. For marks that repeats it will just be displayed after the inclusion
25353     * date in the calendar.
25354     * @param repeat Repeat the event following this periodicity. Can be a unique
25355     * mark (that don't repeat), daily, weekly, monthly or annually.
25356     * @return The created mark or @p NULL upon failure.
25357     *
25358     * Add a mark that will be drawn in the calendar respecting the insertion
25359     * time and periodicity. It will emit the type as signal to the widget theme.
25360     * Default theme supports "holiday" and "checked", but it can be extended.
25361     *
25362     * It won't immediately update the calendar, drawing the marks.
25363     * For this, call elm_calendar_marks_draw(). However, when user selects
25364     * next or previous month calendar forces marks drawn.
25365     *
25366     * Marks created with this method can be deleted with
25367     * elm_calendar_mark_del().
25368     *
25369     * Example
25370     * @code
25371     * struct tm selected_time;
25372     * time_t current_time;
25373     *
25374     * current_time = time(NULL) + 5 * 84600;
25375     * localtime_r(&current_time, &selected_time);
25376     * elm_calendar_mark_add(cal, "holiday", selected_time,
25377     *     ELM_CALENDAR_ANNUALLY);
25378     *
25379     * current_time = time(NULL) + 1 * 84600;
25380     * localtime_r(&current_time, &selected_time);
25381     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25382     *
25383     * elm_calendar_marks_draw(cal);
25384     * @endcode
25385     *
25386     * @see elm_calendar_marks_draw()
25387     * @see elm_calendar_mark_del()
25388     *
25389     * @ref calendar_example_06
25390     *
25391     * @ingroup Calendar
25392     */
25393    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);
25394
25395    /**
25396     * Delete mark from the calendar.
25397     *
25398     * @param mark The mark to be deleted.
25399     *
25400     * If deleting all calendar marks is required, elm_calendar_marks_clear()
25401     * should be used instead of getting marks list and deleting each one.
25402     *
25403     * @see elm_calendar_mark_add()
25404     *
25405     * @ref calendar_example_06
25406     *
25407     * @ingroup Calendar
25408     */
25409    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25410
25411    /**
25412     * Remove all calendar's marks
25413     *
25414     * @param obj The calendar object.
25415     *
25416     * @see elm_calendar_mark_add()
25417     * @see elm_calendar_mark_del()
25418     *
25419     * @ingroup Calendar
25420     */
25421    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25422
25423
25424    /**
25425     * Get a list of all the calendar marks.
25426     *
25427     * @param obj The calendar object.
25428     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25429     *
25430     * @see elm_calendar_mark_add()
25431     * @see elm_calendar_mark_del()
25432     * @see elm_calendar_marks_clear()
25433     *
25434     * @ingroup Calendar
25435     */
25436    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25437
25438    /**
25439     * Draw calendar marks.
25440     *
25441     * @param obj The calendar object.
25442     *
25443     * Should be used after adding, removing or clearing marks.
25444     * It will go through the entire marks list updating the calendar.
25445     * If lots of marks will be added, add all the marks and then call
25446     * this function.
25447     *
25448     * When the month is changed, i.e. user selects next or previous month,
25449     * marks will be drawed.
25450     *
25451     * @see elm_calendar_mark_add()
25452     * @see elm_calendar_mark_del()
25453     * @see elm_calendar_marks_clear()
25454     *
25455     * @ref calendar_example_06
25456     *
25457     * @ingroup Calendar
25458     */
25459    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25460
25461    /**
25462     * Set a day text color to the same that represents Saturdays.
25463     *
25464     * @param obj The calendar object.
25465     * @param pos The text position. Position is the cell counter, from left
25466     * to right, up to down. It starts on 0 and ends on 41.
25467     *
25468     * @deprecated use elm_calendar_mark_add() instead like:
25469     *
25470     * @code
25471     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25472     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25473     * @endcode
25474     *
25475     * @see elm_calendar_mark_add()
25476     *
25477     * @ingroup Calendar
25478     */
25479    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25480
25481    /**
25482     * Set a day text color to the same that represents Sundays.
25483     *
25484     * @param obj The calendar object.
25485     * @param pos The text position. Position is the cell counter, from left
25486     * to right, up to down. It starts on 0 and ends on 41.
25487
25488     * @deprecated use elm_calendar_mark_add() instead like:
25489     *
25490     * @code
25491     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25492     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25493     * @endcode
25494     *
25495     * @see elm_calendar_mark_add()
25496     *
25497     * @ingroup Calendar
25498     */
25499    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25500
25501    /**
25502     * Set a day text color to the same that represents Weekdays.
25503     *
25504     * @param obj The calendar object
25505     * @param pos The text position. Position is the cell counter, from left
25506     * to right, up to down. It starts on 0 and ends on 41.
25507     *
25508     * @deprecated use elm_calendar_mark_add() instead like:
25509     *
25510     * @code
25511     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25512     *
25513     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25514     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25515     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25516     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25517     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25518     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25519     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25520     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25521     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25522     * @endcode
25523     *
25524     * @see elm_calendar_mark_add()
25525     *
25526     * @ingroup Calendar
25527     */
25528    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25529
25530    /**
25531     * Set the interval on time updates for an user mouse button hold
25532     * on calendar widgets' month selection.
25533     *
25534     * @param obj The calendar object
25535     * @param interval The (first) interval value in seconds
25536     *
25537     * This interval value is @b decreased while the user holds the
25538     * mouse pointer either selecting next or previous month.
25539     *
25540     * This helps the user to get to a given month distant from the
25541     * current one easier/faster, as it will start to change quicker and
25542     * quicker on mouse button holds.
25543     *
25544     * The calculation for the next change interval value, starting from
25545     * the one set with this call, is the previous interval divided by
25546     * 1.05, so it decreases a little bit.
25547     *
25548     * The default starting interval value for automatic changes is
25549     * @b 0.85 seconds.
25550     *
25551     * @see elm_calendar_interval_get()
25552     *
25553     * @ingroup Calendar
25554     */
25555    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25556
25557    /**
25558     * Get the interval on time updates for an user mouse button hold
25559     * on calendar widgets' month selection.
25560     *
25561     * @param obj The calendar object
25562     * @return The (first) interval value, in seconds, set on it
25563     *
25564     * @see elm_calendar_interval_set() for more details
25565     *
25566     * @ingroup Calendar
25567     */
25568    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25569
25570    /**
25571     * @}
25572     */
25573
25574    /**
25575     * @defgroup Diskselector Diskselector
25576     * @ingroup Elementary
25577     *
25578     * @image html img/widget/diskselector/preview-00.png
25579     * @image latex img/widget/diskselector/preview-00.eps
25580     *
25581     * A diskselector is a kind of list widget. It scrolls horizontally,
25582     * and can contain label and icon objects. Three items are displayed
25583     * with the selected one in the middle.
25584     *
25585     * It can act like a circular list with round mode and labels can be
25586     * reduced for a defined length for side items.
25587     *
25588     * Smart callbacks one can listen to:
25589     * - "selected" - when item is selected, i.e. scroller stops.
25590     *
25591     * Available styles for it:
25592     * - @c "default"
25593     *
25594     * List of examples:
25595     * @li @ref diskselector_example_01
25596     * @li @ref diskselector_example_02
25597     */
25598
25599    /**
25600     * @addtogroup Diskselector
25601     * @{
25602     */
25603
25604    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(). */
25605
25606    /**
25607     * Add a new diskselector widget to the given parent Elementary
25608     * (container) object.
25609     *
25610     * @param parent The parent object.
25611     * @return a new diskselector widget handle or @c NULL, on errors.
25612     *
25613     * This function inserts a new diskselector widget on the canvas.
25614     *
25615     * @ingroup Diskselector
25616     */
25617    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25618
25619    /**
25620     * Enable or disable round mode.
25621     *
25622     * @param obj The diskselector object.
25623     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25624     * disable it.
25625     *
25626     * Disabled by default. If round mode is enabled the items list will
25627     * work like a circle list, so when the user reaches the last item,
25628     * the first one will popup.
25629     *
25630     * @see elm_diskselector_round_get()
25631     *
25632     * @ingroup Diskselector
25633     */
25634    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25635
25636    /**
25637     * Get a value whether round mode is enabled or not.
25638     *
25639     * @see elm_diskselector_round_set() for details.
25640     *
25641     * @param obj The diskselector object.
25642     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25643     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25644     *
25645     * @ingroup Diskselector
25646     */
25647    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25648
25649    /**
25650     * Get the side labels max length.
25651     *
25652     * @deprecated use elm_diskselector_side_label_length_get() instead:
25653     *
25654     * @param obj The diskselector object.
25655     * @return The max length defined for side labels, or 0 if not a valid
25656     * diskselector.
25657     *
25658     * @ingroup Diskselector
25659     */
25660    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25661
25662    /**
25663     * Set the side labels max length.
25664     *
25665     * @deprecated use elm_diskselector_side_label_length_set() instead:
25666     *
25667     * @param obj The diskselector object.
25668     * @param len The max length defined for side labels.
25669     *
25670     * @ingroup Diskselector
25671     */
25672    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25673
25674    /**
25675     * Get the side labels max length.
25676     *
25677     * @see elm_diskselector_side_label_length_set() for details.
25678     *
25679     * @param obj The diskselector object.
25680     * @return The max length defined for side labels, or 0 if not a valid
25681     * diskselector.
25682     *
25683     * @ingroup Diskselector
25684     */
25685    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25686
25687    /**
25688     * Set the side labels max length.
25689     *
25690     * @param obj The diskselector object.
25691     * @param len The max length defined for side labels.
25692     *
25693     * Length is the number of characters of items' label that will be
25694     * visible when it's set on side positions. It will just crop
25695     * the string after defined size. E.g.:
25696     *
25697     * An item with label "January" would be displayed on side position as
25698     * "Jan" if max length is set to 3, or "Janu", if this property
25699     * is set to 4.
25700     *
25701     * When it's selected, the entire label will be displayed, except for
25702     * width restrictions. In this case label will be cropped and "..."
25703     * will be concatenated.
25704     *
25705     * Default side label max length is 3.
25706     *
25707     * This property will be applyed over all items, included before or
25708     * later this function call.
25709     *
25710     * @ingroup Diskselector
25711     */
25712    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25713
25714    /**
25715     * Set the number of items to be displayed.
25716     *
25717     * @param obj The diskselector object.
25718     * @param num The number of items the diskselector will display.
25719     *
25720     * Default value is 3, and also it's the minimun. If @p num is less
25721     * than 3, it will be set to 3.
25722     *
25723     * Also, it can be set on theme, using data item @c display_item_num
25724     * on group "elm/diskselector/item/X", where X is style set.
25725     * E.g.:
25726     *
25727     * group { name: "elm/diskselector/item/X";
25728     * data {
25729     *     item: "display_item_num" "5";
25730     *     }
25731     *
25732     * @ingroup Diskselector
25733     */
25734    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25735
25736    /**
25737     * Get the number of items in the diskselector object.
25738     *
25739     * @param obj The diskselector object.
25740     *
25741     * @ingroup Diskselector
25742     */
25743    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25744
25745    /**
25746     * Set bouncing behaviour when the scrolled content reaches an edge.
25747     *
25748     * Tell the internal scroller object whether it should bounce or not
25749     * when it reaches the respective edges for each axis.
25750     *
25751     * @param obj The diskselector object.
25752     * @param h_bounce Whether to bounce or not in the horizontal axis.
25753     * @param v_bounce Whether to bounce or not in the vertical axis.
25754     *
25755     * @see elm_scroller_bounce_set()
25756     *
25757     * @ingroup Diskselector
25758     */
25759    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25760
25761    /**
25762     * Get the bouncing behaviour of the internal scroller.
25763     *
25764     * Get whether the internal scroller should bounce when the edge of each
25765     * axis is reached scrolling.
25766     *
25767     * @param obj The diskselector object.
25768     * @param h_bounce Pointer where to store the bounce state of the horizontal
25769     * axis.
25770     * @param v_bounce Pointer where to store the bounce state of the vertical
25771     * axis.
25772     *
25773     * @see elm_scroller_bounce_get()
25774     * @see elm_diskselector_bounce_set()
25775     *
25776     * @ingroup Diskselector
25777     */
25778    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25779
25780    /**
25781     * Get the scrollbar policy.
25782     *
25783     * @see elm_diskselector_scroller_policy_get() for details.
25784     *
25785     * @param obj The diskselector object.
25786     * @param policy_h Pointer where to store horizontal scrollbar policy.
25787     * @param policy_v Pointer where to store vertical scrollbar policy.
25788     *
25789     * @ingroup Diskselector
25790     */
25791    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);
25792
25793    /**
25794     * Set the scrollbar policy.
25795     *
25796     * @param obj The diskselector object.
25797     * @param policy_h Horizontal scrollbar policy.
25798     * @param policy_v Vertical scrollbar policy.
25799     *
25800     * This sets the scrollbar visibility policy for the given scroller.
25801     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25802     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25803     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25804     * This applies respectively for the horizontal and vertical scrollbars.
25805     *
25806     * The both are disabled by default, i.e., are set to
25807     * #ELM_SCROLLER_POLICY_OFF.
25808     *
25809     * @ingroup Diskselector
25810     */
25811    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25812
25813    /**
25814     * Remove all diskselector's items.
25815     *
25816     * @param obj The diskselector object.
25817     *
25818     * @see elm_diskselector_item_del()
25819     * @see elm_diskselector_item_append()
25820     *
25821     * @ingroup Diskselector
25822     */
25823    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25824
25825    /**
25826     * Get a list of all the diskselector items.
25827     *
25828     * @param obj The diskselector object.
25829     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25830     * or @c NULL on failure.
25831     *
25832     * @see elm_diskselector_item_append()
25833     * @see elm_diskselector_item_del()
25834     * @see elm_diskselector_clear()
25835     *
25836     * @ingroup Diskselector
25837     */
25838    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25839
25840    /**
25841     * Appends a new item to the diskselector object.
25842     *
25843     * @param obj The diskselector object.
25844     * @param label The label of the diskselector item.
25845     * @param icon The icon object to use at left side of the item. An
25846     * icon can be any Evas object, but usually it is an icon created
25847     * with elm_icon_add().
25848     * @param func The function to call when the item is selected.
25849     * @param data The data to associate with the item for related callbacks.
25850     *
25851     * @return The created item or @c NULL upon failure.
25852     *
25853     * A new item will be created and appended to the diskselector, i.e., will
25854     * be set as last item. Also, if there is no selected item, it will
25855     * be selected. This will always happens for the first appended item.
25856     *
25857     * If no icon is set, label will be centered on item position, otherwise
25858     * the icon will be placed at left of the label, that will be shifted
25859     * to the right.
25860     *
25861     * Items created with this method can be deleted with
25862     * elm_diskselector_item_del().
25863     *
25864     * Associated @p data can be properly freed when item is deleted if a
25865     * callback function is set with elm_diskselector_item_del_cb_set().
25866     *
25867     * If a function is passed as argument, it will be called everytime this item
25868     * is selected, i.e., the user stops the diskselector with this
25869     * item on center position. If such function isn't needed, just passing
25870     * @c NULL as @p func is enough. The same should be done for @p data.
25871     *
25872     * Simple example (with no function callback or data associated):
25873     * @code
25874     * disk = elm_diskselector_add(win);
25875     * ic = elm_icon_add(win);
25876     * elm_icon_file_set(ic, "path/to/image", NULL);
25877     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25878     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25879     * @endcode
25880     *
25881     * @see elm_diskselector_item_del()
25882     * @see elm_diskselector_item_del_cb_set()
25883     * @see elm_diskselector_clear()
25884     * @see elm_icon_add()
25885     *
25886     * @ingroup Diskselector
25887     */
25888    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);
25889
25890
25891    /**
25892     * Delete them item from the diskselector.
25893     *
25894     * @param it The item of diskselector to be deleted.
25895     *
25896     * If deleting all diskselector items is required, elm_diskselector_clear()
25897     * should be used instead of getting items list and deleting each one.
25898     *
25899     * @see elm_diskselector_clear()
25900     * @see elm_diskselector_item_append()
25901     * @see elm_diskselector_item_del_cb_set()
25902     *
25903     * @ingroup Diskselector
25904     */
25905    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25906
25907    /**
25908     * Set the function called when a diskselector item is freed.
25909     *
25910     * @param it The item to set the callback on
25911     * @param func The function called
25912     *
25913     * If there is a @p func, then it will be called prior item's memory release.
25914     * That will be called with the following arguments:
25915     * @li item's data;
25916     * @li item's Evas object;
25917     * @li item itself;
25918     *
25919     * This way, a data associated to a diskselector item could be properly
25920     * freed.
25921     *
25922     * @ingroup Diskselector
25923     */
25924    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25925
25926    /**
25927     * Get the data associated to the item.
25928     *
25929     * @param it The diskselector item
25930     * @return The data associated to @p it
25931     *
25932     * The return value is a pointer to data associated to @p item when it was
25933     * created, with function elm_diskselector_item_append(). If no data
25934     * was passed as argument, it will return @c NULL.
25935     *
25936     * @see elm_diskselector_item_append()
25937     *
25938     * @ingroup Diskselector
25939     */
25940    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25941
25942    /**
25943     * Set the icon associated to the item.
25944     *
25945     * @param it The diskselector item
25946     * @param icon The icon object to associate with @p it
25947     *
25948     * The icon object to use at left side of the item. An
25949     * icon can be any Evas object, but usually it is an icon created
25950     * with elm_icon_add().
25951     *
25952     * Once the icon object is set, a previously set one will be deleted.
25953     * @warning Setting the same icon for two items will cause the icon to
25954     * dissapear from the first item.
25955     *
25956     * If an icon was passed as argument on item creation, with function
25957     * elm_diskselector_item_append(), it will be already
25958     * associated to the item.
25959     *
25960     * @see elm_diskselector_item_append()
25961     * @see elm_diskselector_item_icon_get()
25962     *
25963     * @ingroup Diskselector
25964     */
25965    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25966
25967    /**
25968     * Get the icon associated to the item.
25969     *
25970     * @param it The diskselector item
25971     * @return The icon associated to @p it
25972     *
25973     * The return value is a pointer to the icon associated to @p item when it was
25974     * created, with function elm_diskselector_item_append(), or later
25975     * with function elm_diskselector_item_icon_set. If no icon
25976     * was passed as argument, it will return @c NULL.
25977     *
25978     * @see elm_diskselector_item_append()
25979     * @see elm_diskselector_item_icon_set()
25980     *
25981     * @ingroup Diskselector
25982     */
25983    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25984
25985    /**
25986     * Set the label of item.
25987     *
25988     * @param it The item of diskselector.
25989     * @param label The label of item.
25990     *
25991     * The label to be displayed by the item.
25992     *
25993     * If no icon is set, label will be centered on item position, otherwise
25994     * the icon will be placed at left of the label, that will be shifted
25995     * to the right.
25996     *
25997     * An item with label "January" would be displayed on side position as
25998     * "Jan" if max length is set to 3 with function
25999     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26000     * is set to 4.
26001     *
26002     * When this @p item is selected, the entire label will be displayed,
26003     * except for width restrictions.
26004     * In this case label will be cropped and "..." will be concatenated,
26005     * but only for display purposes. It will keep the entire string, so
26006     * if diskselector is resized the remaining characters will be displayed.
26007     *
26008     * If a label was passed as argument on item creation, with function
26009     * elm_diskselector_item_append(), it will be already
26010     * displayed by the item.
26011     *
26012     * @see elm_diskselector_side_label_lenght_set()
26013     * @see elm_diskselector_item_label_get()
26014     * @see elm_diskselector_item_append()
26015     *
26016     * @ingroup Diskselector
26017     */
26018    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26019
26020    /**
26021     * Get the label of item.
26022     *
26023     * @param it The item of diskselector.
26024     * @return The label of item.
26025     *
26026     * The return value is a pointer to the label associated to @p item when it was
26027     * created, with function elm_diskselector_item_append(), or later
26028     * with function elm_diskselector_item_label_set. If no label
26029     * was passed as argument, it will return @c NULL.
26030     *
26031     * @see elm_diskselector_item_label_set() for more details.
26032     * @see elm_diskselector_item_append()
26033     *
26034     * @ingroup Diskselector
26035     */
26036    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26037
26038    /**
26039     * Get the selected item.
26040     *
26041     * @param obj The diskselector object.
26042     * @return The selected diskselector item.
26043     *
26044     * The selected item can be unselected with function
26045     * elm_diskselector_item_selected_set(), and the first item of
26046     * diskselector will be selected.
26047     *
26048     * The selected item always will be centered on diskselector, with
26049     * full label displayed, i.e., max lenght set to side labels won't
26050     * apply on the selected item. More details on
26051     * elm_diskselector_side_label_length_set().
26052     *
26053     * @ingroup Diskselector
26054     */
26055    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26056
26057    /**
26058     * Set the selected state of an item.
26059     *
26060     * @param it The diskselector item
26061     * @param selected The selected state
26062     *
26063     * This sets the selected state of the given item @p it.
26064     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26065     *
26066     * If a new item is selected the previosly selected will be unselected.
26067     * Previoulsy selected item can be get with function
26068     * elm_diskselector_selected_item_get().
26069     *
26070     * If the item @p it is unselected, the first item of diskselector will
26071     * be selected.
26072     *
26073     * Selected items will be visible on center position of diskselector.
26074     * So if it was on another position before selected, or was invisible,
26075     * diskselector will animate items until the selected item reaches center
26076     * position.
26077     *
26078     * @see elm_diskselector_item_selected_get()
26079     * @see elm_diskselector_selected_item_get()
26080     *
26081     * @ingroup Diskselector
26082     */
26083    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26084
26085    /*
26086     * Get whether the @p item is selected or not.
26087     *
26088     * @param it The diskselector item.
26089     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26090     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26091     *
26092     * @see elm_diskselector_selected_item_set() for details.
26093     * @see elm_diskselector_item_selected_get()
26094     *
26095     * @ingroup Diskselector
26096     */
26097    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26098
26099    /**
26100     * Get the first item of the diskselector.
26101     *
26102     * @param obj The diskselector object.
26103     * @return The first item, or @c NULL if none.
26104     *
26105     * The list of items follows append order. So it will return the first
26106     * item appended to the widget that wasn't deleted.
26107     *
26108     * @see elm_diskselector_item_append()
26109     * @see elm_diskselector_items_get()
26110     *
26111     * @ingroup Diskselector
26112     */
26113    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26114
26115    /**
26116     * Get the last item of the diskselector.
26117     *
26118     * @param obj The diskselector object.
26119     * @return The last item, or @c NULL if none.
26120     *
26121     * The list of items follows append order. So it will return last first
26122     * item appended to the widget that wasn't deleted.
26123     *
26124     * @see elm_diskselector_item_append()
26125     * @see elm_diskselector_items_get()
26126     *
26127     * @ingroup Diskselector
26128     */
26129    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26130
26131    /**
26132     * Get the item before @p item in diskselector.
26133     *
26134     * @param it The diskselector item.
26135     * @return The item before @p item, or @c NULL if none or on failure.
26136     *
26137     * The list of items follows append order. So it will return item appended
26138     * just before @p item and that wasn't deleted.
26139     *
26140     * If it is the first item, @c NULL will be returned.
26141     * First item can be get by elm_diskselector_first_item_get().
26142     *
26143     * @see elm_diskselector_item_append()
26144     * @see elm_diskselector_items_get()
26145     *
26146     * @ingroup Diskselector
26147     */
26148    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26149
26150    /**
26151     * Get the item after @p item in diskselector.
26152     *
26153     * @param it The diskselector item.
26154     * @return The item after @p item, or @c NULL if none or on failure.
26155     *
26156     * The list of items follows append order. So it will return item appended
26157     * just after @p item and that wasn't deleted.
26158     *
26159     * If it is the last item, @c NULL will be returned.
26160     * Last item can be get by elm_diskselector_last_item_get().
26161     *
26162     * @see elm_diskselector_item_append()
26163     * @see elm_diskselector_items_get()
26164     *
26165     * @ingroup Diskselector
26166     */
26167    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26168
26169    /**
26170     * Set the text to be shown in the diskselector item.
26171     *
26172     * @param item Target item
26173     * @param text The text to set in the content
26174     *
26175     * Setup the text as tooltip to object. The item can have only one tooltip,
26176     * so any previous tooltip data is removed.
26177     *
26178     * @see elm_object_tooltip_text_set() for more details.
26179     *
26180     * @ingroup Diskselector
26181     */
26182    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26183
26184    /**
26185     * Set the content to be shown in the tooltip item.
26186     *
26187     * Setup the tooltip to item. The item can have only one tooltip,
26188     * so any previous tooltip data is removed. @p func(with @p data) will
26189     * be called every time that need show the tooltip and it should
26190     * return a valid Evas_Object. This object is then managed fully by
26191     * tooltip system and is deleted when the tooltip is gone.
26192     *
26193     * @param item the diskselector item being attached a tooltip.
26194     * @param func the function used to create the tooltip contents.
26195     * @param data what to provide to @a func as callback data/context.
26196     * @param del_cb called when data is not needed anymore, either when
26197     *        another callback replaces @p func, the tooltip is unset with
26198     *        elm_diskselector_item_tooltip_unset() or the owner @a item
26199     *        dies. This callback receives as the first parameter the
26200     *        given @a data, and @c event_info is the item.
26201     *
26202     * @see elm_object_tooltip_content_cb_set() for more details.
26203     *
26204     * @ingroup Diskselector
26205     */
26206    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);
26207
26208    /**
26209     * Unset tooltip from item.
26210     *
26211     * @param item diskselector item to remove previously set tooltip.
26212     *
26213     * Remove tooltip from item. The callback provided as del_cb to
26214     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26215     * it is not used anymore.
26216     *
26217     * @see elm_object_tooltip_unset() for more details.
26218     * @see elm_diskselector_item_tooltip_content_cb_set()
26219     *
26220     * @ingroup Diskselector
26221     */
26222    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26223
26224
26225    /**
26226     * Sets a different style for this item tooltip.
26227     *
26228     * @note before you set a style you should define a tooltip with
26229     *       elm_diskselector_item_tooltip_content_cb_set() or
26230     *       elm_diskselector_item_tooltip_text_set()
26231     *
26232     * @param item diskselector item with tooltip already set.
26233     * @param style the theme style to use (default, transparent, ...)
26234     *
26235     * @see elm_object_tooltip_style_set() for more details.
26236     *
26237     * @ingroup Diskselector
26238     */
26239    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26240
26241    /**
26242     * Get the style for this item tooltip.
26243     *
26244     * @param item diskselector item with tooltip already set.
26245     * @return style the theme style in use, defaults to "default". If the
26246     *         object does not have a tooltip set, then NULL is returned.
26247     *
26248     * @see elm_object_tooltip_style_get() for more details.
26249     * @see elm_diskselector_item_tooltip_style_set()
26250     *
26251     * @ingroup Diskselector
26252     */
26253    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26254
26255    /**
26256     * Set the cursor to be shown when mouse is over the diskselector item
26257     *
26258     * @param item Target item
26259     * @param cursor the cursor name to be used.
26260     *
26261     * @see elm_object_cursor_set() for more details.
26262     *
26263     * @ingroup Diskselector
26264     */
26265    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26266
26267    /**
26268     * Get the cursor to be shown when mouse is over the diskselector item
26269     *
26270     * @param item diskselector item with cursor already set.
26271     * @return the cursor name.
26272     *
26273     * @see elm_object_cursor_get() for more details.
26274     * @see elm_diskselector_cursor_set()
26275     *
26276     * @ingroup Diskselector
26277     */
26278    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26279
26280
26281    /**
26282     * Unset the cursor to be shown when mouse is over the diskselector item
26283     *
26284     * @param item Target item
26285     *
26286     * @see elm_object_cursor_unset() for more details.
26287     * @see elm_diskselector_cursor_set()
26288     *
26289     * @ingroup Diskselector
26290     */
26291    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26292
26293    /**
26294     * Sets a different style for this item cursor.
26295     *
26296     * @note before you set a style you should define a cursor with
26297     *       elm_diskselector_item_cursor_set()
26298     *
26299     * @param item diskselector item with cursor already set.
26300     * @param style the theme style to use (default, transparent, ...)
26301     *
26302     * @see elm_object_cursor_style_set() for more details.
26303     *
26304     * @ingroup Diskselector
26305     */
26306    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26307
26308
26309    /**
26310     * Get the style for this item cursor.
26311     *
26312     * @param item diskselector item with cursor already set.
26313     * @return style the theme style in use, defaults to "default". If the
26314     *         object does not have a cursor set, then @c NULL is returned.
26315     *
26316     * @see elm_object_cursor_style_get() for more details.
26317     * @see elm_diskselector_item_cursor_style_set()
26318     *
26319     * @ingroup Diskselector
26320     */
26321    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26322
26323
26324    /**
26325     * Set if the cursor set should be searched on the theme or should use
26326     * the provided by the engine, only.
26327     *
26328     * @note before you set if should look on theme you should define a cursor
26329     * with elm_diskselector_item_cursor_set().
26330     * By default it will only look for cursors provided by the engine.
26331     *
26332     * @param item widget item with cursor already set.
26333     * @param engine_only boolean to define if cursors set with
26334     * elm_diskselector_item_cursor_set() should be searched only
26335     * between cursors provided by the engine or searched on widget's
26336     * theme as well.
26337     *
26338     * @see elm_object_cursor_engine_only_set() for more details.
26339     *
26340     * @ingroup Diskselector
26341     */
26342    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26343
26344    /**
26345     * Get the cursor engine only usage for this item cursor.
26346     *
26347     * @param item widget item with cursor already set.
26348     * @return engine_only boolean to define it cursors should be looked only
26349     * between the provided by the engine or searched on widget's theme as well.
26350     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26351     *
26352     * @see elm_object_cursor_engine_only_get() for more details.
26353     * @see elm_diskselector_item_cursor_engine_only_set()
26354     *
26355     * @ingroup Diskselector
26356     */
26357    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26358
26359    /**
26360     * @}
26361     */
26362
26363    /**
26364     * @defgroup Colorselector Colorselector
26365     *
26366     * @{
26367     *
26368     * @image html img/widget/colorselector/preview-00.png
26369     * @image latex img/widget/colorselector/preview-00.eps
26370     *
26371     * @brief Widget for user to select a color.
26372     *
26373     * Signals that you can add callbacks for are:
26374     * "changed" - When the color value changes(event_info is NULL).
26375     *
26376     * See @ref tutorial_colorselector.
26377     */
26378    /**
26379     * @brief Add a new colorselector to the parent
26380     *
26381     * @param parent The parent object
26382     * @return The new object or NULL if it cannot be created
26383     *
26384     * @ingroup Colorselector
26385     */
26386    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26387    /**
26388     * Set a color for the colorselector
26389     *
26390     * @param obj   Colorselector object
26391     * @param r     r-value of color
26392     * @param g     g-value of color
26393     * @param b     b-value of color
26394     * @param a     a-value of color
26395     *
26396     * @ingroup Colorselector
26397     */
26398    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26399    /**
26400     * Get a color from the colorselector
26401     *
26402     * @param obj   Colorselector object
26403     * @param r     integer pointer for r-value of color
26404     * @param g     integer pointer for g-value of color
26405     * @param b     integer pointer for b-value of color
26406     * @param a     integer pointer for a-value of color
26407     *
26408     * @ingroup Colorselector
26409     */
26410    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26411    /**
26412     * @}
26413     */
26414
26415    /**
26416     * @defgroup Ctxpopup Ctxpopup
26417     *
26418     * @image html img/widget/ctxpopup/preview-00.png
26419     * @image latex img/widget/ctxpopup/preview-00.eps
26420     *
26421     * @brief Context popup widet.
26422     *
26423     * A ctxpopup is a widget that, when shown, pops up a list of items.
26424     * It automatically chooses an area inside its parent object's view
26425     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26426     * optimally fit into it. In the default theme, it will also point an
26427     * arrow to it's top left position at the time one shows it. Ctxpopup
26428     * items have a label and/or an icon. It is intended for a small
26429     * number of items (hence the use of list, not genlist).
26430     *
26431     * @note Ctxpopup is a especialization of @ref Hover.
26432     *
26433     * Signals that you can add callbacks for are:
26434     * "dismissed" - the ctxpopup was dismissed
26435     *
26436     * Default contents parts of the ctxpopup widget that you can use for are:
26437     * @li "elm.swallow.content" - A content of the ctxpopup
26438     *
26439     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26440     * @{
26441     */
26442    typedef enum _Elm_Ctxpopup_Direction
26443      {
26444         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26445                                           area */
26446         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26447                                            the clicked area */
26448         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26449                                           the clicked area */
26450         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26451                                         area */
26452         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26453      } Elm_Ctxpopup_Direction;
26454
26455    /**
26456     * @brief Add a new Ctxpopup object to the parent.
26457     *
26458     * @param parent Parent object
26459     * @return New object or @c NULL, if it cannot be created
26460     */
26461    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26462    /**
26463     * @brief Set the Ctxpopup's parent
26464     *
26465     * @param obj The ctxpopup object
26466     * @param area The parent to use
26467     *
26468     * Set the parent object.
26469     *
26470     * @note elm_ctxpopup_add() will automatically call this function
26471     * with its @c parent argument.
26472     *
26473     * @see elm_ctxpopup_add()
26474     * @see elm_hover_parent_set()
26475     */
26476    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26477    /**
26478     * @brief Get the Ctxpopup's parent
26479     *
26480     * @param obj The ctxpopup object
26481     *
26482     * @see elm_ctxpopup_hover_parent_set() for more information
26483     */
26484    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26485    /**
26486     * @brief Clear all items in the given ctxpopup object.
26487     *
26488     * @param obj Ctxpopup object
26489     */
26490    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26491    /**
26492     * @brief Change the ctxpopup's orientation to horizontal or vertical.
26493     *
26494     * @param obj Ctxpopup object
26495     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26496     */
26497    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26498    /**
26499     * @brief Get the value of current ctxpopup object's orientation.
26500     *
26501     * @param obj Ctxpopup object
26502     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26503     *
26504     * @see elm_ctxpopup_horizontal_set()
26505     */
26506    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26507    /**
26508     * @brief Add a new item to a ctxpopup object.
26509     *
26510     * @param obj Ctxpopup object
26511     * @param icon Icon to be set on new item
26512     * @param label The Label of the new item
26513     * @param func Convenience function called when item selected
26514     * @param data Data passed to @p func
26515     * @return A handle to the item added or @c NULL, on errors
26516     *
26517     * @warning Ctxpopup can't hold both an item list and a content at the same
26518     * time. When an item is added, any previous content will be removed.
26519     *
26520     * @see elm_ctxpopup_content_set()
26521     */
26522    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);
26523    /**
26524     * @brief Delete the given item in a ctxpopup object.
26525     *
26526     * @param it Ctxpopup item to be deleted
26527     *
26528     * @see elm_ctxpopup_item_append()
26529     */
26530    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26531    /**
26532     * @brief Set the ctxpopup item's state as disabled or enabled.
26533     *
26534     * @param it Ctxpopup item to be enabled/disabled
26535     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26536     *
26537     * When disabled the item is greyed out to indicate it's state.
26538     */
26539    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26540    /**
26541     * @brief Get the ctxpopup item's disabled/enabled state.
26542     *
26543     * @param it Ctxpopup item to be enabled/disabled
26544     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26545     *
26546     * @see elm_ctxpopup_item_disabled_set()
26547     */
26548    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26549    /**
26550     * @brief Get the icon object for the given ctxpopup item.
26551     *
26552     * @param it Ctxpopup item
26553     * @return icon object or @c NULL, if the item does not have icon or an error
26554     * occurred
26555     *
26556     * @see elm_ctxpopup_item_append()
26557     * @see elm_ctxpopup_item_icon_set()
26558     */
26559    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26560    /**
26561     * @brief Sets the side icon associated with the ctxpopup item
26562     *
26563     * @param it Ctxpopup item
26564     * @param icon Icon object to be set
26565     *
26566     * Once the icon object is set, a previously set one will be deleted.
26567     * @warning Setting the same icon for two items will cause the icon to
26568     * dissapear from the first item.
26569     *
26570     * @see elm_ctxpopup_item_append()
26571     */
26572    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26573    /**
26574     * @brief Get the label for the given ctxpopup item.
26575     *
26576     * @param it Ctxpopup item
26577     * @return label string or @c NULL, if the item does not have label or an
26578     * error occured
26579     *
26580     * @see elm_ctxpopup_item_append()
26581     * @see elm_ctxpopup_item_label_set()
26582     */
26583    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26584    /**
26585     * @brief (Re)set the label on the given ctxpopup item.
26586     *
26587     * @param it Ctxpopup item
26588     * @param label String to set as label
26589     */
26590    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26591    /**
26592     * @brief Set an elm widget as the content of the ctxpopup.
26593     *
26594     * @param obj Ctxpopup object
26595     * @param content Content to be swallowed
26596     *
26597     * If the content object is already set, a previous one will bedeleted. If
26598     * you want to keep that old content object, use the
26599     * elm_ctxpopup_content_unset() function.
26600     *
26601     * @deprecated use elm_object_content_set()
26602     *
26603     * @warning Ctxpopup can't hold both a item list and a content at the same
26604     * time. When a content is set, any previous items will be removed.
26605     */
26606    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26607    /**
26608     * @brief Unset the ctxpopup content
26609     *
26610     * @param obj Ctxpopup object
26611     * @return The content that was being used
26612     *
26613     * Unparent and return the content object which was set for this widget.
26614     *
26615     * @deprecated use elm_object_content_unset()
26616     *
26617     * @see elm_ctxpopup_content_set()
26618     */
26619    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26620    /**
26621     * @brief Set the direction priority of a ctxpopup.
26622     *
26623     * @param obj Ctxpopup object
26624     * @param first 1st priority of direction
26625     * @param second 2nd priority of direction
26626     * @param third 3th priority of direction
26627     * @param fourth 4th priority of direction
26628     *
26629     * This functions gives a chance to user to set the priority of ctxpopup
26630     * showing direction. This doesn't guarantee the ctxpopup will appear in the
26631     * requested direction.
26632     *
26633     * @see Elm_Ctxpopup_Direction
26634     */
26635    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);
26636    /**
26637     * @brief Get the direction priority of a ctxpopup.
26638     *
26639     * @param obj Ctxpopup object
26640     * @param first 1st priority of direction to be returned
26641     * @param second 2nd priority of direction to be returned
26642     * @param third 3th priority of direction to be returned
26643     * @param fourth 4th priority of direction to be returned
26644     *
26645     * @see elm_ctxpopup_direction_priority_set() for more information.
26646     */
26647    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);
26648
26649    /**
26650     * @brief Get the current direction of a ctxpopup.
26651     *
26652     * @param obj Ctxpopup object
26653     * @return current direction of a ctxpopup
26654     *
26655     * @warning Once the ctxpopup showed up, the direction would be determined
26656     */
26657    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26658
26659    /**
26660     * @}
26661     */
26662
26663    /* transit */
26664    /**
26665     *
26666     * @defgroup Transit Transit
26667     * @ingroup Elementary
26668     *
26669     * Transit is designed to apply various animated transition effects to @c
26670     * Evas_Object, such like translation, rotation, etc. For using these
26671     * effects, create an @ref Elm_Transit and add the desired transition effects.
26672     *
26673     * Once the effects are added into transit, they will be automatically
26674     * managed (their callback will be called until the duration is ended, and
26675     * they will be deleted on completion).
26676     *
26677     * Example:
26678     * @code
26679     * Elm_Transit *trans = elm_transit_add();
26680     * elm_transit_object_add(trans, obj);
26681     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26682     * elm_transit_duration_set(transit, 1);
26683     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26684     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26685     * elm_transit_repeat_times_set(transit, 3);
26686     * @endcode
26687     *
26688     * Some transition effects are used to change the properties of objects. They
26689     * are:
26690     * @li @ref elm_transit_effect_translation_add
26691     * @li @ref elm_transit_effect_color_add
26692     * @li @ref elm_transit_effect_rotation_add
26693     * @li @ref elm_transit_effect_wipe_add
26694     * @li @ref elm_transit_effect_zoom_add
26695     * @li @ref elm_transit_effect_resizing_add
26696     *
26697     * Other transition effects are used to make one object disappear and another
26698     * object appear on its old place. These effects are:
26699     *
26700     * @li @ref elm_transit_effect_flip_add
26701     * @li @ref elm_transit_effect_resizable_flip_add
26702     * @li @ref elm_transit_effect_fade_add
26703     * @li @ref elm_transit_effect_blend_add
26704     *
26705     * It's also possible to make a transition chain with @ref
26706     * elm_transit_chain_transit_add.
26707     *
26708     * @warning We strongly recommend to use elm_transit just when edje can not do
26709     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26710     * animations can be manipulated inside the theme.
26711     *
26712     * List of examples:
26713     * @li @ref transit_example_01_explained
26714     * @li @ref transit_example_02_explained
26715     * @li @ref transit_example_03_c
26716     * @li @ref transit_example_04_c
26717     *
26718     * @{
26719     */
26720
26721    /**
26722     * @enum Elm_Transit_Tween_Mode
26723     *
26724     * The type of acceleration used in the transition.
26725     */
26726    typedef enum
26727      {
26728         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26729         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26730                                              over time, then decrease again
26731                                              and stop slowly */
26732         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26733                                              speed over time */
26734         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26735                                             over time */
26736      } Elm_Transit_Tween_Mode;
26737
26738    /**
26739     * @enum Elm_Transit_Effect_Flip_Axis
26740     *
26741     * The axis where flip effect should be applied.
26742     */
26743    typedef enum
26744      {
26745         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26746         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26747      } Elm_Transit_Effect_Flip_Axis;
26748    /**
26749     * @enum Elm_Transit_Effect_Wipe_Dir
26750     *
26751     * The direction where the wipe effect should occur.
26752     */
26753    typedef enum
26754      {
26755         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26756         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26757         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26758         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26759      } Elm_Transit_Effect_Wipe_Dir;
26760    /** @enum Elm_Transit_Effect_Wipe_Type
26761     *
26762     * Whether the wipe effect should show or hide the object.
26763     */
26764    typedef enum
26765      {
26766         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26767                                              animation */
26768         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26769                                             animation */
26770      } Elm_Transit_Effect_Wipe_Type;
26771
26772    /**
26773     * @typedef Elm_Transit
26774     *
26775     * The Transit created with elm_transit_add(). This type has the information
26776     * about the objects which the transition will be applied, and the
26777     * transition effects that will be used. It also contains info about
26778     * duration, number of repetitions, auto-reverse, etc.
26779     */
26780    typedef struct _Elm_Transit Elm_Transit;
26781    typedef void Elm_Transit_Effect;
26782    /**
26783     * @typedef Elm_Transit_Effect_Transition_Cb
26784     *
26785     * Transition callback called for this effect on each transition iteration.
26786     */
26787    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26788    /**
26789     * Elm_Transit_Effect_End_Cb
26790     *
26791     * Transition callback called for this effect when the transition is over.
26792     */
26793    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26794
26795    /**
26796     * Elm_Transit_Del_Cb
26797     *
26798     * A callback called when the transit is deleted.
26799     */
26800    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26801
26802    /**
26803     * Add new transit.
26804     *
26805     * @note Is not necessary to delete the transit object, it will be deleted at
26806     * the end of its operation.
26807     * @note The transit will start playing when the program enter in the main loop, is not
26808     * necessary to give a start to the transit.
26809     *
26810     * @return The transit object.
26811     *
26812     * @ingroup Transit
26813     */
26814    EAPI Elm_Transit                *elm_transit_add(void);
26815
26816    /**
26817     * Stops the animation and delete the @p transit object.
26818     *
26819     * Call this function if you wants to stop the animation before the duration
26820     * time. Make sure the @p transit object is still alive with
26821     * elm_transit_del_cb_set() function.
26822     * All added effects will be deleted, calling its repective data_free_cb
26823     * functions. The function setted by elm_transit_del_cb_set() will be called.
26824     *
26825     * @see elm_transit_del_cb_set()
26826     *
26827     * @param transit The transit object to be deleted.
26828     *
26829     * @ingroup Transit
26830     * @warning Just call this function if you are sure the transit is alive.
26831     */
26832    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26833
26834    /**
26835     * Add a new effect to the transit.
26836     *
26837     * @note The cb function and the data are the key to the effect. If you try to
26838     * add an already added effect, nothing is done.
26839     * @note After the first addition of an effect in @p transit, if its
26840     * effect list become empty again, the @p transit will be killed by
26841     * elm_transit_del(transit) function.
26842     *
26843     * Exemple:
26844     * @code
26845     * Elm_Transit *transit = elm_transit_add();
26846     * elm_transit_effect_add(transit,
26847     *                        elm_transit_effect_blend_op,
26848     *                        elm_transit_effect_blend_context_new(),
26849     *                        elm_transit_effect_blend_context_free);
26850     * @endcode
26851     *
26852     * @param transit The transit object.
26853     * @param transition_cb The operation function. It is called when the
26854     * animation begins, it is the function that actually performs the animation.
26855     * It is called with the @p data, @p transit and the time progression of the
26856     * animation (a double value between 0.0 and 1.0).
26857     * @param effect The context data of the effect.
26858     * @param end_cb The function to free the context data, it will be called
26859     * at the end of the effect, it must finalize the animation and free the
26860     * @p data.
26861     *
26862     * @ingroup Transit
26863     * @warning The transit free the context data at the and of the transition with
26864     * the data_free_cb function, do not use the context data in another transit.
26865     */
26866    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);
26867
26868    /**
26869     * Delete an added effect.
26870     *
26871     * This function will remove the effect from the @p transit, calling the
26872     * data_free_cb to free the @p data.
26873     *
26874     * @see elm_transit_effect_add()
26875     *
26876     * @note If the effect is not found, nothing is done.
26877     * @note If the effect list become empty, this function will call
26878     * elm_transit_del(transit), that is, it will kill the @p transit.
26879     *
26880     * @param transit The transit object.
26881     * @param transition_cb The operation function.
26882     * @param effect The context data of the effect.
26883     *
26884     * @ingroup Transit
26885     */
26886    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);
26887
26888    /**
26889     * Add new object to apply the effects.
26890     *
26891     * @note After the first addition of an object in @p transit, if its
26892     * object list become empty again, the @p transit will be killed by
26893     * elm_transit_del(transit) function.
26894     * @note If the @p obj belongs to another transit, the @p obj will be
26895     * removed from it and it will only belong to the @p transit. If the old
26896     * transit stays without objects, it will die.
26897     * @note When you add an object into the @p transit, its state from
26898     * evas_object_pass_events_get(obj) is saved, and it is applied when the
26899     * transit ends, if you change this state whith evas_object_pass_events_set()
26900     * after add the object, this state will change again when @p transit stops to
26901     * run.
26902     *
26903     * @param transit The transit object.
26904     * @param obj Object to be animated.
26905     *
26906     * @ingroup Transit
26907     * @warning It is not allowed to add a new object after transit begins to go.
26908     */
26909    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26910
26911    /**
26912     * Removes an added object from the transit.
26913     *
26914     * @note If the @p obj is not in the @p transit, nothing is done.
26915     * @note If the list become empty, this function will call
26916     * elm_transit_del(transit), that is, it will kill the @p transit.
26917     *
26918     * @param transit The transit object.
26919     * @param obj Object to be removed from @p transit.
26920     *
26921     * @ingroup Transit
26922     * @warning It is not allowed to remove objects after transit begins to go.
26923     */
26924    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26925
26926    /**
26927     * Get the objects of the transit.
26928     *
26929     * @param transit The transit object.
26930     * @return a Eina_List with the objects from the transit.
26931     *
26932     * @ingroup Transit
26933     */
26934    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26935
26936    /**
26937     * Enable/disable keeping up the objects states.
26938     * If it is not kept, the objects states will be reset when transition ends.
26939     *
26940     * @note @p transit can not be NULL.
26941     * @note One state includes geometry, color, map data.
26942     *
26943     * @param transit The transit object.
26944     * @param state_keep Keeping or Non Keeping.
26945     *
26946     * @ingroup Transit
26947     */
26948    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26949
26950    /**
26951     * Get a value whether the objects states will be reset or not.
26952     *
26953     * @note @p transit can not be NULL
26954     *
26955     * @see elm_transit_objects_final_state_keep_set()
26956     *
26957     * @param transit The transit object.
26958     * @return EINA_TRUE means the states of the objects will be reset.
26959     * If @p transit is NULL, EINA_FALSE is returned
26960     *
26961     * @ingroup Transit
26962     */
26963    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26964
26965    /**
26966     * Set the event enabled when transit is operating.
26967     *
26968     * If @p enabled is EINA_TRUE, the objects of the transit will receives
26969     * events from mouse and keyboard during the animation.
26970     * @note When you add an object with elm_transit_object_add(), its state from
26971     * evas_object_pass_events_get(obj) is saved, and it is applied when the
26972     * transit ends, if you change this state with evas_object_pass_events_set()
26973     * after adding the object, this state will change again when @p transit stops
26974     * to run.
26975     *
26976     * @param transit The transit object.
26977     * @param enabled Events are received when enabled is @c EINA_TRUE, and
26978     * ignored otherwise.
26979     *
26980     * @ingroup Transit
26981     */
26982    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26983
26984    /**
26985     * Get the value of event enabled status.
26986     *
26987     * @see elm_transit_event_enabled_set()
26988     *
26989     * @param transit The Transit object
26990     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26991     * EINA_FALSE is returned
26992     *
26993     * @ingroup Transit
26994     */
26995    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26996
26997    /**
26998     * Set the user-callback function when the transit is deleted.
26999     *
27000     * @note Using this function twice will overwrite the first function setted.
27001     * @note the @p transit object will be deleted after call @p cb function.
27002     *
27003     * @param transit The transit object.
27004     * @param cb Callback function pointer. This function will be called before
27005     * the deletion of the transit.
27006     * @param data Callback funtion user data. It is the @p op parameter.
27007     *
27008     * @ingroup Transit
27009     */
27010    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27011
27012    /**
27013     * Set reverse effect automatically.
27014     *
27015     * If auto reverse is setted, after running the effects with the progress
27016     * parameter from 0 to 1, it will call the effecs again with the progress
27017     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27018     * where the duration was setted with the function elm_transit_add and
27019     * the repeat with the function elm_transit_repeat_times_set().
27020     *
27021     * @param transit The transit object.
27022     * @param reverse EINA_TRUE means the auto_reverse is on.
27023     *
27024     * @ingroup Transit
27025     */
27026    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27027
27028    /**
27029     * Get if the auto reverse is on.
27030     *
27031     * @see elm_transit_auto_reverse_set()
27032     *
27033     * @param transit The transit object.
27034     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27035     * EINA_FALSE is returned
27036     *
27037     * @ingroup Transit
27038     */
27039    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27040
27041    /**
27042     * Set the transit repeat count. Effect will be repeated by repeat count.
27043     *
27044     * This function sets the number of repetition the transit will run after
27045     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27046     * If the @p repeat is a negative number, it will repeat infinite times.
27047     *
27048     * @note If this function is called during the transit execution, the transit
27049     * will run @p repeat times, ignoring the times it already performed.
27050     *
27051     * @param transit The transit object
27052     * @param repeat Repeat count
27053     *
27054     * @ingroup Transit
27055     */
27056    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27057
27058    /**
27059     * Get the transit repeat count.
27060     *
27061     * @see elm_transit_repeat_times_set()
27062     *
27063     * @param transit The Transit object.
27064     * @return The repeat count. If @p transit is NULL
27065     * 0 is returned
27066     *
27067     * @ingroup Transit
27068     */
27069    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27070
27071    /**
27072     * Set the transit animation acceleration type.
27073     *
27074     * This function sets the tween mode of the transit that can be:
27075     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27076     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27077     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27078     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27079     *
27080     * @param transit The transit object.
27081     * @param tween_mode The tween type.
27082     *
27083     * @ingroup Transit
27084     */
27085    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27086
27087    /**
27088     * Get the transit animation acceleration type.
27089     *
27090     * @note @p transit can not be NULL
27091     *
27092     * @param transit The transit object.
27093     * @return The tween type. If @p transit is NULL
27094     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27095     *
27096     * @ingroup Transit
27097     */
27098    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27099
27100    /**
27101     * Set the transit animation time
27102     *
27103     * @note @p transit can not be NULL
27104     *
27105     * @param transit The transit object.
27106     * @param duration The animation time.
27107     *
27108     * @ingroup Transit
27109     */
27110    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27111
27112    /**
27113     * Get the transit animation time
27114     *
27115     * @note @p transit can not be NULL
27116     *
27117     * @param transit The transit object.
27118     *
27119     * @return The transit animation time.
27120     *
27121     * @ingroup Transit
27122     */
27123    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27124
27125    /**
27126     * Starts the transition.
27127     * Once this API is called, the transit begins to measure the time.
27128     *
27129     * @note @p transit can not be NULL
27130     *
27131     * @param transit The transit object.
27132     *
27133     * @ingroup Transit
27134     */
27135    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27136
27137    /**
27138     * Pause/Resume the transition.
27139     *
27140     * If you call elm_transit_go again, the transit will be started from the
27141     * beginning, and will be unpaused.
27142     *
27143     * @note @p transit can not be NULL
27144     *
27145     * @param transit The transit object.
27146     * @param paused Whether the transition should be paused or not.
27147     *
27148     * @ingroup Transit
27149     */
27150    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27151
27152    /**
27153     * Get the value of paused status.
27154     *
27155     * @see elm_transit_paused_set()
27156     *
27157     * @note @p transit can not be NULL
27158     *
27159     * @param transit The transit object.
27160     * @return EINA_TRUE means transition is paused. If @p transit is NULL
27161     * EINA_FALSE is returned
27162     *
27163     * @ingroup Transit
27164     */
27165    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27166
27167    /**
27168     * Get the time progression of the animation (a double value between 0.0 and 1.0).
27169     *
27170     * The value returned is a fraction (current time / total time). It
27171     * represents the progression position relative to the total.
27172     *
27173     * @note @p transit can not be NULL
27174     *
27175     * @param transit The transit object.
27176     *
27177     * @return The time progression value. If @p transit is NULL
27178     * 0 is returned
27179     *
27180     * @ingroup Transit
27181     */
27182    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27183
27184    /**
27185     * Makes the chain relationship between two transits.
27186     *
27187     * @note @p transit can not be NULL. Transit would have multiple chain transits.
27188     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27189     *
27190     * @param transit The transit object.
27191     * @param chain_transit The chain transit object. This transit will be operated
27192     *        after transit is done.
27193     *
27194     * This function adds @p chain_transit transition to a chain after the @p
27195     * transit, and will be started as soon as @p transit ends. See @ref
27196     * transit_example_02_explained for a full example.
27197     *
27198     * @ingroup Transit
27199     */
27200    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27201
27202    /**
27203     * Cut off the chain relationship between two transits.
27204     *
27205     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27206     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27207     *
27208     * @param transit The transit object.
27209     * @param chain_transit The chain transit object.
27210     *
27211     * This function remove the @p chain_transit transition from the @p transit.
27212     *
27213     * @ingroup Transit
27214     */
27215    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27216
27217    /**
27218     * Get the current chain transit list.
27219     *
27220     * @note @p transit can not be NULL.
27221     *
27222     * @param transit The transit object.
27223     * @return chain transit list.
27224     *
27225     * @ingroup Transit
27226     */
27227    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
27228
27229    /**
27230     * Add the Resizing Effect to Elm_Transit.
27231     *
27232     * @note This API is one of the facades. It creates resizing effect context
27233     * and add it's required APIs to elm_transit_effect_add.
27234     *
27235     * @see elm_transit_effect_add()
27236     *
27237     * @param transit Transit object.
27238     * @param from_w Object width size when effect begins.
27239     * @param from_h Object height size when effect begins.
27240     * @param to_w Object width size when effect ends.
27241     * @param to_h Object height size when effect ends.
27242     * @return Resizing effect context data.
27243     *
27244     * @ingroup Transit
27245     */
27246    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);
27247
27248    /**
27249     * Add the Translation Effect to Elm_Transit.
27250     *
27251     * @note This API is one of the facades. It creates translation effect context
27252     * and add it's required APIs to elm_transit_effect_add.
27253     *
27254     * @see elm_transit_effect_add()
27255     *
27256     * @param transit Transit object.
27257     * @param from_dx X Position variation when effect begins.
27258     * @param from_dy Y Position variation when effect begins.
27259     * @param to_dx X Position variation when effect ends.
27260     * @param to_dy Y Position variation when effect ends.
27261     * @return Translation effect context data.
27262     *
27263     * @ingroup Transit
27264     * @warning It is highly recommended just create a transit with this effect when
27265     * the window that the objects of the transit belongs has already been created.
27266     * This is because this effect needs the geometry information about the objects,
27267     * and if the window was not created yet, it can get a wrong information.
27268     */
27269    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);
27270
27271    /**
27272     * Add the Zoom Effect to Elm_Transit.
27273     *
27274     * @note This API is one of the facades. It creates zoom effect context
27275     * and add it's required APIs to elm_transit_effect_add.
27276     *
27277     * @see elm_transit_effect_add()
27278     *
27279     * @param transit Transit object.
27280     * @param from_rate Scale rate when effect begins (1 is current rate).
27281     * @param to_rate Scale rate when effect ends.
27282     * @return Zoom effect context data.
27283     *
27284     * @ingroup Transit
27285     * @warning It is highly recommended just create a transit with this effect when
27286     * the window that the objects of the transit belongs has already been created.
27287     * This is because this effect needs the geometry information about the objects,
27288     * and if the window was not created yet, it can get a wrong information.
27289     */
27290    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27291
27292    /**
27293     * Add the Flip Effect to Elm_Transit.
27294     *
27295     * @note This API is one of the facades. It creates flip effect context
27296     * and add it's required APIs to elm_transit_effect_add.
27297     * @note This effect is applied to each pair of objects in the order they are listed
27298     * in the transit list of objects. The first object in the pair will be the
27299     * "front" object and the second will be the "back" object.
27300     *
27301     * @see elm_transit_effect_add()
27302     *
27303     * @param transit Transit object.
27304     * @param axis Flipping Axis(X or Y).
27305     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27306     * @return Flip effect context data.
27307     *
27308     * @ingroup Transit
27309     * @warning It is highly recommended just create a transit with this effect when
27310     * the window that the objects of the transit belongs has already been created.
27311     * This is because this effect needs the geometry information about the objects,
27312     * and if the window was not created yet, it can get a wrong information.
27313     */
27314    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27315
27316    /**
27317     * Add the Resizable Flip Effect to Elm_Transit.
27318     *
27319     * @note This API is one of the facades. It creates resizable flip effect context
27320     * and add it's required APIs to elm_transit_effect_add.
27321     * @note This effect is applied to each pair of objects in the order they are listed
27322     * in the transit list of objects. The first object in the pair will be the
27323     * "front" object and the second will be the "back" object.
27324     *
27325     * @see elm_transit_effect_add()
27326     *
27327     * @param transit Transit object.
27328     * @param axis Flipping Axis(X or Y).
27329     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27330     * @return Resizable flip effect context data.
27331     *
27332     * @ingroup Transit
27333     * @warning It is highly recommended just create a transit with this effect when
27334     * the window that the objects of the transit belongs has already been created.
27335     * This is because this effect needs the geometry information about the objects,
27336     * and if the window was not created yet, it can get a wrong information.
27337     */
27338    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27339
27340    /**
27341     * Add the Wipe Effect to Elm_Transit.
27342     *
27343     * @note This API is one of the facades. It creates wipe effect context
27344     * and add it's required APIs to elm_transit_effect_add.
27345     *
27346     * @see elm_transit_effect_add()
27347     *
27348     * @param transit Transit object.
27349     * @param type Wipe type. Hide or show.
27350     * @param dir Wipe Direction.
27351     * @return Wipe effect context data.
27352     *
27353     * @ingroup Transit
27354     * @warning It is highly recommended just create a transit with this effect when
27355     * the window that the objects of the transit belongs has already been created.
27356     * This is because this effect needs the geometry information about the objects,
27357     * and if the window was not created yet, it can get a wrong information.
27358     */
27359    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27360
27361    /**
27362     * Add the Color Effect to Elm_Transit.
27363     *
27364     * @note This API is one of the facades. It creates color effect context
27365     * and add it's required APIs to elm_transit_effect_add.
27366     *
27367     * @see elm_transit_effect_add()
27368     *
27369     * @param transit        Transit object.
27370     * @param  from_r        RGB R when effect begins.
27371     * @param  from_g        RGB G when effect begins.
27372     * @param  from_b        RGB B when effect begins.
27373     * @param  from_a        RGB A when effect begins.
27374     * @param  to_r          RGB R when effect ends.
27375     * @param  to_g          RGB G when effect ends.
27376     * @param  to_b          RGB B when effect ends.
27377     * @param  to_a          RGB A when effect ends.
27378     * @return               Color effect context data.
27379     *
27380     * @ingroup Transit
27381     */
27382    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);
27383
27384    /**
27385     * Add the Fade Effect to Elm_Transit.
27386     *
27387     * @note This API is one of the facades. It creates fade effect context
27388     * and add it's required APIs to elm_transit_effect_add.
27389     * @note This effect is applied to each pair of objects in the order they are listed
27390     * in the transit list of objects. The first object in the pair will be the
27391     * "before" object and the second will be the "after" object.
27392     *
27393     * @see elm_transit_effect_add()
27394     *
27395     * @param transit Transit object.
27396     * @return Fade effect context data.
27397     *
27398     * @ingroup Transit
27399     * @warning It is highly recommended just create a transit with this effect when
27400     * the window that the objects of the transit belongs has already been created.
27401     * This is because this effect needs the color information about the objects,
27402     * and if the window was not created yet, it can get a wrong information.
27403     */
27404    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27405
27406    /**
27407     * Add the Blend Effect to Elm_Transit.
27408     *
27409     * @note This API is one of the facades. It creates blend effect context
27410     * and add it's required APIs to elm_transit_effect_add.
27411     * @note This effect is applied to each pair of objects in the order they are listed
27412     * in the transit list of objects. The first object in the pair will be the
27413     * "before" object and the second will be the "after" object.
27414     *
27415     * @see elm_transit_effect_add()
27416     *
27417     * @param transit Transit object.
27418     * @return Blend effect context data.
27419     *
27420     * @ingroup Transit
27421     * @warning It is highly recommended just create a transit with this effect when
27422     * the window that the objects of the transit belongs has already been created.
27423     * This is because this effect needs the color information about the objects,
27424     * and if the window was not created yet, it can get a wrong information.
27425     */
27426    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27427
27428    /**
27429     * Add the Rotation Effect to Elm_Transit.
27430     *
27431     * @note This API is one of the facades. It creates rotation effect context
27432     * and add it's required APIs to elm_transit_effect_add.
27433     *
27434     * @see elm_transit_effect_add()
27435     *
27436     * @param transit Transit object.
27437     * @param from_degree Degree when effect begins.
27438     * @param to_degree Degree when effect is ends.
27439     * @return Rotation effect context data.
27440     *
27441     * @ingroup Transit
27442     * @warning It is highly recommended just create a transit with this effect when
27443     * the window that the objects of the transit belongs has already been created.
27444     * This is because this effect needs the geometry information about the objects,
27445     * and if the window was not created yet, it can get a wrong information.
27446     */
27447    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27448
27449    /**
27450     * Add the ImageAnimation Effect to Elm_Transit.
27451     *
27452     * @note This API is one of the facades. It creates image animation effect context
27453     * and add it's required APIs to elm_transit_effect_add.
27454     * The @p images parameter is a list images paths. This list and
27455     * its contents will be deleted at the end of the effect by
27456     * elm_transit_effect_image_animation_context_free() function.
27457     *
27458     * Example:
27459     * @code
27460     * char buf[PATH_MAX];
27461     * Eina_List *images = NULL;
27462     * Elm_Transit *transi = elm_transit_add();
27463     *
27464     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27465     * images = eina_list_append(images, eina_stringshare_add(buf));
27466     *
27467     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27468     * images = eina_list_append(images, eina_stringshare_add(buf));
27469     * elm_transit_effect_image_animation_add(transi, images);
27470     *
27471     * @endcode
27472     *
27473     * @see elm_transit_effect_add()
27474     *
27475     * @param transit Transit object.
27476     * @param images Eina_List of images file paths. This list and
27477     * its contents will be deleted at the end of the effect by
27478     * elm_transit_effect_image_animation_context_free() function.
27479     * @return Image Animation effect context data.
27480     *
27481     * @ingroup Transit
27482     */
27483    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27484    /**
27485     * @}
27486     */
27487
27488    typedef struct _Elm_Store                      Elm_Store;
27489    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
27490    typedef struct _Elm_Store_Item                 Elm_Store_Item;
27491    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
27492    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
27493    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27494    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
27495    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
27496    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
27497    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
27498    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
27499
27500    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27501    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27502    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27503    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27504
27505    typedef enum
27506      {
27507         ELM_STORE_ITEM_MAPPING_NONE = 0,
27508         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27509         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27510         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27511         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27512         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27513         // can add more here as needed by common apps
27514         ELM_STORE_ITEM_MAPPING_LAST
27515      } Elm_Store_Item_Mapping_Type;
27516
27517    struct _Elm_Store_Item_Mapping_Icon
27518      {
27519         // FIXME: allow edje file icons
27520         int                   w, h;
27521         Elm_Icon_Lookup_Order lookup_order;
27522         Eina_Bool             standard_name : 1;
27523         Eina_Bool             no_scale : 1;
27524         Eina_Bool             smooth : 1;
27525         Eina_Bool             scale_up : 1;
27526         Eina_Bool             scale_down : 1;
27527      };
27528
27529    struct _Elm_Store_Item_Mapping_Empty
27530      {
27531         Eina_Bool             dummy;
27532      };
27533
27534    struct _Elm_Store_Item_Mapping_Photo
27535      {
27536         int                   size;
27537      };
27538
27539    struct _Elm_Store_Item_Mapping_Custom
27540      {
27541         Elm_Store_Item_Mapping_Cb func;
27542      };
27543
27544    struct _Elm_Store_Item_Mapping
27545      {
27546         Elm_Store_Item_Mapping_Type     type;
27547         const char                     *part;
27548         int                             offset;
27549         union
27550           {
27551              Elm_Store_Item_Mapping_Empty  empty;
27552              Elm_Store_Item_Mapping_Icon   icon;
27553              Elm_Store_Item_Mapping_Photo  photo;
27554              Elm_Store_Item_Mapping_Custom custom;
27555              // add more types here
27556           } details;
27557      };
27558
27559    struct _Elm_Store_Item_Info
27560      {
27561         Elm_Genlist_Item_Class       *item_class;
27562         const Elm_Store_Item_Mapping *mapping;
27563         void                         *data;
27564         char                         *sort_id;
27565      };
27566
27567    struct _Elm_Store_Item_Info_Filesystem
27568      {
27569         Elm_Store_Item_Info  base;
27570         char                *path;
27571      };
27572
27573 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27574 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27575
27576    EAPI void                    elm_store_free(Elm_Store *st);
27577
27578    EAPI Elm_Store              *elm_store_filesystem_new(void);
27579    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27580    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27581    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27582
27583    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27584
27585    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27586    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27587    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27588    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27589    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27590    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27591
27592    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27593    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27594    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27595    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27596    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27597    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27598    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27599
27600    /**
27601     * @defgroup SegmentControl SegmentControl
27602     * @ingroup Elementary
27603     *
27604     * @image html img/widget/segment_control/preview-00.png
27605     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27606     *
27607     * @image html img/segment_control.png
27608     * @image latex img/segment_control.eps width=\textwidth
27609     *
27610     * Segment control widget is a horizontal control made of multiple segment
27611     * items, each segment item functioning similar to discrete two state button.
27612     * A segment control groups the items together and provides compact
27613     * single button with multiple equal size segments.
27614     *
27615     * Segment item size is determined by base widget
27616     * size and the number of items added.
27617     * Only one segment item can be at selected state. A segment item can display
27618     * combination of Text and any Evas_Object like Images or other widget.
27619     *
27620     * Smart callbacks one can listen to:
27621     * - "changed" - When the user clicks on a segment item which is not
27622     *   previously selected and get selected. The event_info parameter is the
27623     *   segment item pointer.
27624     *
27625     * Available styles for it:
27626     * - @c "default"
27627     *
27628     * Here is an example on its usage:
27629     * @li @ref segment_control_example
27630     */
27631
27632    /**
27633     * @addtogroup SegmentControl
27634     * @{
27635     */
27636
27637    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27638
27639    /**
27640     * Add a new segment control widget to the given parent Elementary
27641     * (container) object.
27642     *
27643     * @param parent The parent object.
27644     * @return a new segment control widget handle or @c NULL, on errors.
27645     *
27646     * This function inserts a new segment control widget on the canvas.
27647     *
27648     * @ingroup SegmentControl
27649     */
27650    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27651
27652    /**
27653     * Append a new item to the segment control object.
27654     *
27655     * @param obj The segment control object.
27656     * @param icon The icon object to use for the left side of the item. An
27657     * icon can be any Evas object, but usually it is an icon created
27658     * with elm_icon_add().
27659     * @param label The label of the item.
27660     *        Note that, NULL is different from empty string "".
27661     * @return The created item or @c NULL upon failure.
27662     *
27663     * A new item will be created and appended to the segment control, i.e., will
27664     * be set as @b last item.
27665     *
27666     * If it should be inserted at another position,
27667     * elm_segment_control_item_insert_at() should be used instead.
27668     *
27669     * Items created with this function can be deleted with function
27670     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27671     *
27672     * @note @p label set to @c NULL is different from empty string "".
27673     * If an item
27674     * only has icon, it will be displayed bigger and centered. If it has
27675     * icon and label, even that an empty string, icon will be smaller and
27676     * positioned at left.
27677     *
27678     * Simple example:
27679     * @code
27680     * sc = elm_segment_control_add(win);
27681     * ic = elm_icon_add(win);
27682     * elm_icon_file_set(ic, "path/to/image", NULL);
27683     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27684     * elm_segment_control_item_add(sc, ic, "label");
27685     * evas_object_show(sc);
27686     * @endcode
27687     *
27688     * @see elm_segment_control_item_insert_at()
27689     * @see elm_segment_control_item_del()
27690     *
27691     * @ingroup SegmentControl
27692     */
27693    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27694
27695    /**
27696     * Insert a new item to the segment control object at specified position.
27697     *
27698     * @param obj The segment control object.
27699     * @param icon The icon object to use for the left side of the item. An
27700     * icon can be any Evas object, but usually it is an icon created
27701     * with elm_icon_add().
27702     * @param label The label of the item.
27703     * @param index Item position. Value should be between 0 and items count.
27704     * @return The created item or @c NULL upon failure.
27705
27706     * Index values must be between @c 0, when item will be prepended to
27707     * segment control, and items count, that can be get with
27708     * elm_segment_control_item_count_get(), case when item will be appended
27709     * to segment control, just like elm_segment_control_item_add().
27710     *
27711     * Items created with this function can be deleted with function
27712     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27713     *
27714     * @note @p label set to @c NULL is different from empty string "".
27715     * If an item
27716     * only has icon, it will be displayed bigger and centered. If it has
27717     * icon and label, even that an empty string, icon will be smaller and
27718     * positioned at left.
27719     *
27720     * @see elm_segment_control_item_add()
27721     * @see elm_segment_control_item_count_get()
27722     * @see elm_segment_control_item_del()
27723     *
27724     * @ingroup SegmentControl
27725     */
27726    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);
27727
27728    /**
27729     * Remove a segment control item from its parent, deleting it.
27730     *
27731     * @param it The item to be removed.
27732     *
27733     * Items can be added with elm_segment_control_item_add() or
27734     * elm_segment_control_item_insert_at().
27735     *
27736     * @ingroup SegmentControl
27737     */
27738    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27739
27740    /**
27741     * Remove a segment control item at given index from its parent,
27742     * deleting it.
27743     *
27744     * @param obj The segment control object.
27745     * @param index The position of the segment control item to be deleted.
27746     *
27747     * Items can be added with elm_segment_control_item_add() or
27748     * elm_segment_control_item_insert_at().
27749     *
27750     * @ingroup SegmentControl
27751     */
27752    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27753
27754    /**
27755     * Get the Segment items count from segment control.
27756     *
27757     * @param obj The segment control object.
27758     * @return Segment items count.
27759     *
27760     * It will just return the number of items added to segment control @p obj.
27761     *
27762     * @ingroup SegmentControl
27763     */
27764    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27765
27766    /**
27767     * Get the item placed at specified index.
27768     *
27769     * @param obj The segment control object.
27770     * @param index The index of the segment item.
27771     * @return The segment control item or @c NULL on failure.
27772     *
27773     * Index is the position of an item in segment control widget. Its
27774     * range is from @c 0 to <tt> count - 1 </tt>.
27775     * Count is the number of items, that can be get with
27776     * elm_segment_control_item_count_get().
27777     *
27778     * @ingroup SegmentControl
27779     */
27780    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27781
27782    /**
27783     * Get the label of item.
27784     *
27785     * @param obj The segment control object.
27786     * @param index The index of the segment item.
27787     * @return The label of the item at @p index.
27788     *
27789     * The return value is a pointer to the label associated to the item when
27790     * it was created, with function elm_segment_control_item_add(), or later
27791     * with function elm_segment_control_item_label_set. If no label
27792     * was passed as argument, it will return @c NULL.
27793     *
27794     * @see elm_segment_control_item_label_set() for more details.
27795     * @see elm_segment_control_item_add()
27796     *
27797     * @ingroup SegmentControl
27798     */
27799    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27800
27801    /**
27802     * Set the label of item.
27803     *
27804     * @param it The item of segment control.
27805     * @param text The label of item.
27806     *
27807     * The label to be displayed by the item.
27808     * Label will be at right of the icon (if set).
27809     *
27810     * If a label was passed as argument on item creation, with function
27811     * elm_control_segment_item_add(), it will be already
27812     * displayed by the item.
27813     *
27814     * @see elm_segment_control_item_label_get()
27815     * @see elm_segment_control_item_add()
27816     *
27817     * @ingroup SegmentControl
27818     */
27819    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27820
27821    /**
27822     * Get the icon associated to the item.
27823     *
27824     * @param obj The segment control object.
27825     * @param index The index of the segment item.
27826     * @return The left side icon associated to the item at @p index.
27827     *
27828     * The return value is a pointer to the icon associated to the item when
27829     * it was created, with function elm_segment_control_item_add(), or later
27830     * with function elm_segment_control_item_icon_set(). If no icon
27831     * was passed as argument, it will return @c NULL.
27832     *
27833     * @see elm_segment_control_item_add()
27834     * @see elm_segment_control_item_icon_set()
27835     *
27836     * @ingroup SegmentControl
27837     */
27838    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27839
27840    /**
27841     * Set the icon associated to the item.
27842     *
27843     * @param it The segment control item.
27844     * @param icon The icon object to associate with @p it.
27845     *
27846     * The icon object to use at left side of the item. An
27847     * icon can be any Evas object, but usually it is an icon created
27848     * with elm_icon_add().
27849     *
27850     * Once the icon object is set, a previously set one will be deleted.
27851     * @warning Setting the same icon for two items will cause the icon to
27852     * dissapear from the first item.
27853     *
27854     * If an icon was passed as argument on item creation, with function
27855     * elm_segment_control_item_add(), it will be already
27856     * associated to the item.
27857     *
27858     * @see elm_segment_control_item_add()
27859     * @see elm_segment_control_item_icon_get()
27860     *
27861     * @ingroup SegmentControl
27862     */
27863    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27864
27865    /**
27866     * Get the index of an item.
27867     *
27868     * @param it The segment control item.
27869     * @return The position of item in segment control widget.
27870     *
27871     * Index is the position of an item in segment control widget. Its
27872     * range is from @c 0 to <tt> count - 1 </tt>.
27873     * Count is the number of items, that can be get with
27874     * elm_segment_control_item_count_get().
27875     *
27876     * @ingroup SegmentControl
27877     */
27878    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27879
27880    /**
27881     * Get the base object of the item.
27882     *
27883     * @param it The segment control item.
27884     * @return The base object associated with @p it.
27885     *
27886     * Base object is the @c Evas_Object that represents that item.
27887     *
27888     * @ingroup SegmentControl
27889     */
27890    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27891
27892    /**
27893     * Get the selected item.
27894     *
27895     * @param obj The segment control object.
27896     * @return The selected item or @c NULL if none of segment items is
27897     * selected.
27898     *
27899     * The selected item can be unselected with function
27900     * elm_segment_control_item_selected_set().
27901     *
27902     * The selected item always will be highlighted on segment control.
27903     *
27904     * @ingroup SegmentControl
27905     */
27906    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27907
27908    /**
27909     * Set the selected state of an item.
27910     *
27911     * @param it The segment control item
27912     * @param select The selected state
27913     *
27914     * This sets the selected state of the given item @p it.
27915     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27916     *
27917     * If a new item is selected the previosly selected will be unselected.
27918     * Previoulsy selected item can be get with function
27919     * elm_segment_control_item_selected_get().
27920     *
27921     * The selected item always will be highlighted on segment control.
27922     *
27923     * @see elm_segment_control_item_selected_get()
27924     *
27925     * @ingroup SegmentControl
27926     */
27927    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27928
27929    /**
27930     * @}
27931     */
27932
27933    /**
27934     * @defgroup Grid Grid
27935     *
27936     * The grid is a grid layout widget that lays out a series of children as a
27937     * fixed "grid" of widgets using a given percentage of the grid width and
27938     * height each using the child object.
27939     *
27940     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27941     * widgets size itself. The default is 100 x 100, so that means the
27942     * position and sizes of children will effectively be percentages (0 to 100)
27943     * of the width or height of the grid widget
27944     *
27945     * @{
27946     */
27947
27948    /**
27949     * Add a new grid to the parent
27950     *
27951     * @param parent The parent object
27952     * @return The new object or NULL if it cannot be created
27953     *
27954     * @ingroup Grid
27955     */
27956    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27957
27958    /**
27959     * Set the virtual size of the grid
27960     *
27961     * @param obj The grid object
27962     * @param w The virtual width of the grid
27963     * @param h The virtual height of the grid
27964     *
27965     * @ingroup Grid
27966     */
27967    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
27968
27969    /**
27970     * Get the virtual size of the grid
27971     *
27972     * @param obj The grid object
27973     * @param w Pointer to integer to store the virtual width of the grid
27974     * @param h Pointer to integer to store the virtual height of the grid
27975     *
27976     * @ingroup Grid
27977     */
27978    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27979
27980    /**
27981     * Pack child at given position and size
27982     *
27983     * @param obj The grid object
27984     * @param subobj The child to pack
27985     * @param x The virtual x coord at which to pack it
27986     * @param y The virtual y coord at which to pack it
27987     * @param w The virtual width at which to pack it
27988     * @param h The virtual height at which to pack it
27989     *
27990     * @ingroup Grid
27991     */
27992    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27993
27994    /**
27995     * Unpack a child from a grid object
27996     *
27997     * @param obj The grid object
27998     * @param subobj The child to unpack
27999     *
28000     * @ingroup Grid
28001     */
28002    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28003
28004    /**
28005     * Faster way to remove all child objects from a grid object.
28006     *
28007     * @param obj The grid object
28008     * @param clear If true, it will delete just removed children
28009     *
28010     * @ingroup Grid
28011     */
28012    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28013
28014    /**
28015     * Set packing of an existing child at to position and size
28016     *
28017     * @param subobj The child to set packing of
28018     * @param x The virtual x coord at which to pack it
28019     * @param y The virtual y coord at which to pack it
28020     * @param w The virtual width at which to pack it
28021     * @param h The virtual height at which to pack it
28022     *
28023     * @ingroup Grid
28024     */
28025    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28026
28027    /**
28028     * get packing of a child
28029     *
28030     * @param subobj The child to query
28031     * @param x Pointer to integer to store the virtual x coord
28032     * @param y Pointer to integer to store the virtual y coord
28033     * @param w Pointer to integer to store the virtual width
28034     * @param h Pointer to integer to store the virtual height
28035     *
28036     * @ingroup Grid
28037     */
28038    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28039
28040    /**
28041     * @}
28042     */
28043
28044    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28045    EINA_DEPRECATED EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28046    EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28047    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28048    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
28049    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
28050
28051    /**
28052     * @defgroup Video Video
28053     *
28054     * @addtogroup Video
28055     * @{
28056     *
28057     * Elementary comes with two object that help design application that need
28058     * to display video. The main one, Elm_Video, display a video by using Emotion.
28059     * It does embedded the video inside an Edje object, so you can do some
28060     * animation depending on the video state change. It does also implement a
28061     * ressource management policy to remove this burden from the application writer.
28062     *
28063     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28064     * It take care of updating its content according to Emotion event and provide a
28065     * way to theme itself. It also does automatically raise the priority of the
28066     * linked Elm_Video so it will use the video decoder if available. It also does
28067     * activate the remember function on the linked Elm_Video object.
28068     *
28069     * Signals that you can add callback for are :
28070     *
28071     * "forward,clicked" - the user clicked the forward button.
28072     * "info,clicked" - the user clicked the info button.
28073     * "next,clicked" - the user clicked the next button.
28074     * "pause,clicked" - the user clicked the pause button.
28075     * "play,clicked" - the user clicked the play button.
28076     * "prev,clicked" - the user clicked the prev button.
28077     * "rewind,clicked" - the user clicked the rewind button.
28078     * "stop,clicked" - the user clicked the stop button.
28079     * 
28080     * To set the video of the player, you can use elm_object_content_set() API.
28081     * 
28082     */
28083
28084    /**
28085     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28086     *
28087     * @param parent The parent object
28088     * @return a new player widget handle or @c NULL, on errors.
28089     *
28090     * This function inserts a new player widget on the canvas.
28091     *
28092     * @see elm_object_content_set()
28093     *
28094     * @ingroup Video
28095     */
28096    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28097
28098    /**
28099     * @brief Link a Elm_Payer with an Elm_Video object.
28100     *
28101     * @param player the Elm_Player object.
28102     * @param video The Elm_Video object.
28103     *
28104     * This mean that action on the player widget will affect the
28105     * video object and the state of the video will be reflected in
28106     * the player itself.
28107     *
28108     * @see elm_player_add()
28109     * @see elm_video_add()
28110     *
28111     * @ingroup Video
28112     */
28113    EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28114
28115    /**
28116     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28117     *
28118     * @param parent The parent object
28119     * @return a new video widget handle or @c NULL, on errors.
28120     *
28121     * This function inserts a new video widget on the canvas.
28122     *
28123     * @seeelm_video_file_set()
28124     * @see elm_video_uri_set()
28125     *
28126     * @ingroup Video
28127     */
28128    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28129
28130    /**
28131     * @brief Define the file that will be the video source.
28132     *
28133     * @param video The video object to define the file for.
28134     * @param filename The file to target.
28135     *
28136     * This function will explicitly define a filename as a source
28137     * for the video of the Elm_Video object.
28138     *
28139     * @see elm_video_uri_set()
28140     * @see elm_video_add()
28141     * @see elm_player_add()
28142     *
28143     * @ingroup Video
28144     */
28145    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28146
28147    /**
28148     * @brief Define the uri that will be the video source.
28149     *
28150     * @param video The video object to define the file for.
28151     * @param uri The uri to target.
28152     *
28153     * This function will define an uri as a source for the video of the
28154     * Elm_Video object. URI could be remote source of video, like http:// or local source
28155     * like for example WebCam who are most of the time v4l2:// (but that depend and
28156     * you should use Emotion API to request and list the available Webcam on your system).
28157     *
28158     * @see elm_video_file_set()
28159     * @see elm_video_add()
28160     * @see elm_player_add()
28161     *
28162     * @ingroup Video
28163     */
28164    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28165
28166    /**
28167     * @brief Get the underlying Emotion object.
28168     *
28169     * @param video The video object to proceed the request on.
28170     * @return the underlying Emotion object.
28171     *
28172     * @ingroup Video
28173     */
28174    EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28175
28176    /**
28177     * @brief Start to play the video
28178     *
28179     * @param video The video object to proceed the request on.
28180     *
28181     * Start to play the video and cancel all suspend state.
28182     *
28183     * @ingroup Video
28184     */
28185    EAPI void elm_video_play(Evas_Object *video);
28186
28187    /**
28188     * @brief Pause the video
28189     *
28190     * @param video The video object to proceed the request on.
28191     *
28192     * Pause the video and start a timer to trigger suspend mode.
28193     *
28194     * @ingroup Video
28195     */
28196    EAPI void elm_video_pause(Evas_Object *video);
28197
28198    /**
28199     * @brief Stop the video
28200     *
28201     * @param video The video object to proceed the request on.
28202     *
28203     * Stop the video and put the emotion in deep sleep mode.
28204     *
28205     * @ingroup Video
28206     */
28207    EAPI void elm_video_stop(Evas_Object *video);
28208
28209    /**
28210     * @brief Is the video actually playing.
28211     *
28212     * @param video The video object to proceed the request on.
28213     * @return EINA_TRUE if the video is actually playing.
28214     *
28215     * You should consider watching event on the object instead of polling
28216     * the object state.
28217     *
28218     * @ingroup Video
28219     */
28220    EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28221
28222    /**
28223     * @brief Is it possible to seek inside the video.
28224     *
28225     * @param video The video object to proceed the request on.
28226     * @return EINA_TRUE if is possible to seek inside the video.
28227     *
28228     * @ingroup Video
28229     */
28230    EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28231
28232    /**
28233     * @brief Is the audio muted.
28234     *
28235     * @param video The video object to proceed the request on.
28236     * @return EINA_TRUE if the audio is muted.
28237     *
28238     * @ingroup Video
28239     */
28240    EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28241
28242    /**
28243     * @brief Change the mute state of the Elm_Video object.
28244     *
28245     * @param video The video object to proceed the request on.
28246     * @param mute The new mute state.
28247     *
28248     * @ingroup Video
28249     */
28250    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28251
28252    /**
28253     * @brief Get the audio level of the current video.
28254     *
28255     * @param video The video object to proceed the request on.
28256     * @return the current audio level.
28257     *
28258     * @ingroup Video
28259     */
28260    EAPI double elm_video_audio_level_get(const Evas_Object *video);
28261
28262    /**
28263     * @brief Set the audio level of anElm_Video object.
28264     *
28265     * @param video The video object to proceed the request on.
28266     * @param volume The new audio volume.
28267     *
28268     * @ingroup Video
28269     */
28270    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28271
28272    EAPI double elm_video_play_position_get(const Evas_Object *video);
28273    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28274    EAPI double elm_video_play_length_get(const Evas_Object *video);
28275    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28276    EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28277    EAPI const char *elm_video_title_get(const Evas_Object *video);
28278    /**
28279     * @}
28280     */
28281
28282    /**
28283     * @defgroup Naviframe Naviframe
28284     * @ingroup Elementary
28285     *
28286     * @brief Naviframe is a kind of view manager for the applications.
28287     *
28288     * Naviframe provides functions to switch different pages with stack
28289     * mechanism. It means if one page(item) needs to be changed to the new one,
28290     * then naviframe would push the new page to it's internal stack. Of course,
28291     * it can be back to the previous page by popping the top page. Naviframe
28292     * provides some transition effect while the pages are switching (same as
28293     * pager).
28294     *
28295     * Since each item could keep the different styles, users could keep the
28296     * same look & feel for the pages or different styles for the items in it's
28297     * application.
28298     *
28299     * Signals that you can add callback for are:
28300     * @li "transition,finished" - When the transition is finished in changing
28301     *     the item
28302     * @li "title,clicked" - User clicked title area
28303     *
28304     * Default contents parts of the naviframe items that you can use for are:
28305     * @li "elm.swallow.content" - A main content of the page
28306     * @li "elm.swallow.icon" - A icon in the title area
28307     * @li "elm.swallow.prev_btn" - A button to go to the previous page
28308     * @li "elm.swallow.next_btn" - A button to go to the next page
28309     *
28310     * Default text parts of the naviframe items that you can use for are:
28311     * @li "elm.text.title" - Title label in the title area
28312     * @li "elm.text.subtitle" - Sub-title label in the title area
28313     *
28314     * @ref tutorial_naviframe gives a good overview of the usage of the API.
28315     */
28316
28317 #define ELM_NAVIFRAME_ITEM_CONTENT_ICON "elm.swallow.icon"
28318 #define ELM_NAVIFRAME_ITEM_CONTENT_PREV_BTN "elm.swallow.prev_btn"
28319 #define ELM_NAVIFRAME_ITEM_CONTNET_NEXT_BTN "elm.swallow.next_btn"
28320 #define ELM_NAVIFRAME_ITEM_TEXT_SUBTITLE "elm.text.subtitle"
28321
28322    /**
28323     * @addtogroup Naviframe
28324     * @{
28325     */
28326
28327    /**
28328     * @brief Add a new Naviframe object to the parent.
28329     *
28330     * @param parent Parent object
28331     * @return New object or @c NULL, if it cannot be created
28332     *
28333     * @ingroup Naviframe
28334     */
28335    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28336    /**
28337     * @brief Push a new item to the top of the naviframe stack (and show it).
28338     *
28339     * @param obj The naviframe object
28340     * @param title_label The label in the title area. The name of the title
28341     *        label part is "elm.text.title"
28342     * @param prev_btn The button to go to the previous item. If it is NULL,
28343     *        then naviframe will create a back button automatically. The name of
28344     *        the prev_btn part is "elm.swallow.prev_btn"
28345     * @param next_btn The button to go to the next item. Or It could be just an
28346     *        extra function button. The name of the next_btn part is
28347     *        "elm.swallow.next_btn"
28348     * @param content The main content object. The name of content part is
28349     *        "elm.swallow.content"
28350     * @param item_style The current item style name. @c NULL would be default.
28351     * @return The created item or @c NULL upon failure.
28352     *
28353     * The item pushed becomes one page of the naviframe, this item will be
28354     * deleted when it is popped.
28355     *
28356     * @see also elm_naviframe_item_style_set()
28357     *
28358     * The following styles are available for this item:
28359     * @li @c "default"
28360     *
28361     * @ingroup Naviframe
28362     */
28363    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);
28364    /**
28365     * @brief Pop an item that is on top of the stack
28366     *
28367     * @param obj The naviframe object
28368     * @return @c NULL or the content object(if the
28369     *         elm_naviframe_content_preserve_on_pop_get is true).
28370     *
28371     * This pops an item that is on the top(visible) of the naviframe, makes it
28372     * disappear, then deletes the item. The item that was underneath it on the
28373     * stack will become visible.
28374     *
28375     * @see also elm_naviframe_content_preserve_on_pop_get()
28376     *
28377     * @ingroup Naviframe
28378     */
28379    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28380    /**
28381     * @brief Pop the items between the top and the above one on the given item.
28382     *
28383     * @param it The naviframe item
28384     *
28385     * @ingroup Naviframe
28386     */
28387    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28388    /**
28389    * Promote an item already in the naviframe stack to the top of the stack
28390    *
28391    * @param it The naviframe item
28392    *
28393    * This will take the indicated item and promote it to the top of the stack
28394    * as if it had been pushed there. The item must already be inside the
28395    * naviframe stack to work.
28396    *
28397    */
28398    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28399    /**
28400     * @brief Delete the given item instantly.
28401     *
28402     * @param it The naviframe item
28403     *
28404     * This just deletes the given item from the naviframe item list instantly.
28405     * So this would not emit any signals for view transitions but just change
28406     * the current view if the given item is a top one.
28407     *
28408     * @ingroup Naviframe
28409     */
28410    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28411    /**
28412     * @brief preserve the content objects when items are popped.
28413     *
28414     * @param obj The naviframe object
28415     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28416     *
28417     * @see also elm_naviframe_content_preserve_on_pop_get()
28418     *
28419     * @ingroup Naviframe
28420     */
28421    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28422    /**
28423     * @brief Get a value whether preserve mode is enabled or not.
28424     *
28425     * @param obj The naviframe object
28426     * @return If @c EINA_TRUE, preserve mode is enabled
28427     *
28428     * @see also elm_naviframe_content_preserve_on_pop_set()
28429     *
28430     * @ingroup Naviframe
28431     */
28432    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28433    /**
28434     * @brief Get a top item on the naviframe stack
28435     *
28436     * @param obj The naviframe object
28437     * @return The top item on the naviframe stack or @c NULL, if the stack is
28438     *         empty
28439     *
28440     * @ingroup Naviframe
28441     */
28442    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28443    /**
28444     * @brief Get a bottom item on the naviframe stack
28445     *
28446     * @param obj The naviframe object
28447     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28448     *         empty
28449     *
28450     * @ingroup Naviframe
28451     */
28452    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28453    /**
28454     * @brief Set an item style
28455     *
28456     * @param obj The naviframe item
28457     * @param item_style The current item style name. @c NULL would be default
28458     *
28459     * The following styles are available for this item:
28460     * @li @c "default"
28461     *
28462     * @see also elm_naviframe_item_style_get()
28463     *
28464     * @ingroup Naviframe
28465     */
28466    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28467    /**
28468     * @brief Get an item style
28469     *
28470     * @param obj The naviframe item
28471     * @return The current item style name
28472     *
28473     * @see also elm_naviframe_item_style_set()
28474     *
28475     * @ingroup Naviframe
28476     */
28477    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28478    /**
28479     * @brief Show/Hide the title area
28480     *
28481     * @param it The naviframe item
28482     * @param visible If @c EINA_TRUE, title area will be visible, hidden
28483     *        otherwise
28484     *
28485     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
28486     *
28487     * @see also elm_naviframe_item_title_visible_get()
28488     *
28489     * @ingroup Naviframe
28490     */
28491    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28492    /**
28493     * @brief Get a value whether title area is visible or not.
28494     *
28495     * @param it The naviframe item
28496     * @return If @c EINA_TRUE, title area is visible
28497     *
28498     * @see also elm_naviframe_item_title_visible_set()
28499     *
28500     * @ingroup Naviframe
28501     */
28502    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28503
28504    /**
28505     * @brief Set creating prev button automatically or not
28506     *
28507     * @param obj The naviframe object
28508     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28509     *        be created internally when you pass the @c NULL to the prev_btn
28510     *        parameter in elm_naviframe_item_push
28511     *
28512     * @see also elm_naviframe_item_push()
28513     */
28514    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28515    /**
28516     * @brief Get a value whether prev button(back button) will be auto pushed or
28517     *        not.
28518     *
28519     * @param obj The naviframe object
28520     * @return If @c EINA_TRUE, prev button will be auto pushed.
28521     *
28522     * @see also elm_naviframe_item_push()
28523     *           elm_naviframe_prev_btn_auto_pushed_set()
28524     */
28525    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
28526
28527    /**
28528     * @}
28529     */
28530
28531 #ifdef __cplusplus
28532 }
28533 #endif
28534
28535 #endif