From: Hyoyoung Chang <hyoyoung.chang@samsung.com>
[framework/uifw/elementary.git] / src / lib / Elementary.h.in
1 /*
2  *
3  * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
4  */
5
6 /**
7 @file Elementary.h.in
8 @brief Elementary Widget Library
9 */
10
11 /**
12 @mainpage Elementary
13 @image html  elementary.png
14 @version 0.7.0
15 @date 2008-2011
16
17 @section intro What is Elementary?
18
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
21
22 It is meant to make the programmers work almost brainless but give them lots
23 of flexibility.
24
25 @li @ref Start - Go here to quickly get started with writing Apps
26
27 @section organization Organization
28
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers in which the widgets will be
33                           layouted.
34
35 @section license License
36
37 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
38 all files in the source tree.
39
40 @section ack Acknowledgements
41 There is a lot that goes into making a widget set, and they don't happen out of
42 nothing. It's like trying to make everyone everywhere happy, regardless of age,
43 gender, race or nationality - and that is really tough. So thanks to people and
44 organisations behind this, as listed in the @ref authors page.
45 */
46
47
48 /**
49  * @defgroup Start Getting Started
50  *
51  * To write an Elementary app, you can get started with the following:
52  *
53 @code
54 #include <Elementary.h>
55 EAPI_MAIN int
56 elm_main(int argc, char **argv)
57 {
58    // create window(s) here and do any application init
59    elm_run(); // run main loop
60    elm_shutdown(); // after mainloop finishes running, shutdown
61    return 0; // exit 0 for exit code
62 }
63 ELM_MAIN()
64 @endcode
65  *
66  * To use autotools (which helps in many ways in the long run, like being able
67  * to immediately create releases of your software directly from your tree
68  * and ensure everything needed to build it is there) you will need a
69  * configure.ac, Makefile.am and autogen.sh file.
70  *
71  * configure.ac:
72  *
73 @verbatim
74 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_PREREQ(2.52)
76 AC_CONFIG_SRCDIR(configure.ac)
77 AM_CONFIG_HEADER(config.h)
78 AC_PROG_CC
79 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
80 PKG_CHECK_MODULES([ELEMENTARY], elementary)
81 AC_OUTPUT(Makefile)
82 @endverbatim
83  *
84  * Makefile.am:
85  *
86 @verbatim
87 AUTOMAKE_OPTIONS = 1.4 foreign
88 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89
90 INCLUDES = -I$(top_srcdir)
91
92 bin_PROGRAMS = myapp
93
94 myapp_SOURCES = main.c
95 myapp_LDADD = @ELEMENTARY_LIBS@
96 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
97 @endverbatim
98  *
99  * autogen.sh:
100  *
101 @verbatim
102 #!/bin/sh
103 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
104 echo "Running autoheader..." ; autoheader || exit 1
105 echo "Running autoconf..." ; autoconf || exit 1
106 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
107 ./configure "$@"
108 @endverbatim
109  *
110  * To generate all the things needed to bootstrap just run:
111  *
112 @verbatim
113 ./autogen.sh
114 @endverbatim
115  *
116  * This will generate Makefile.in's, the confgure script and everything else.
117  * After this it works like all normal autotools projects:
118 @verbatim
119 ./configure
120 make
121 sudo make install
122 @endverbatim
123  *
124  * Note sudo was assumed to get root permissions, as this would install in
125  * /usr/local which is system-owned. Use any way you like to gain root, or
126  * specify a different prefix with configure:
127  *
128 @verbatim
129 ./confiugre --prefix=$HOME/mysoftware
130 @endverbatim
131  *
132  * Also remember that autotools buys you some useful commands like:
133 @verbatim
134 make uninstall
135 @endverbatim
136  *
137  * This uninstalls the software after it was installed with "make install".
138  * It is very useful to clear up what you built if you wish to clean the
139  * system.
140  *
141 @verbatim
142 make distcheck
143 @endverbatim
144  *
145  * This firstly checks if your build tree is "clean" and ready for
146  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
147  * ready to upload and distribute to the world, that contains the generated
148  * Makefile.in's and configure script. The users do not need to run
149  * autogen.sh - just configure and on. They don't need autotools installed.
150  * This tarball also builds cleanly, has all the sources it needs to build
151  * included (that is sources for your application, not libraries it depends
152  * on like Elementary). It builds cleanly in a buildroot and does not
153  * contain any files that are temporarily generated like binaries and other
154  * build-generated files, so the tarball is clean, and no need to worry
155  * about cleaning up your tree before packaging.
156  *
157 @verbatim
158 make clean
159 @endverbatim
160  *
161  * This cleans up all build files (binaries, objects etc.) from the tree.
162  *
163 @verbatim
164 make distclean
165 @endverbatim
166  *
167  * This cleans out all files from the build and from configure's output too.
168  *
169 @verbatim
170 make maintainer-clean
171 @endverbatim
172  *
173  * This deletes all the files autogen.sh will produce so the tree is clean
174  * to be put into a revision-control system (like CVS, SVN or GIT for example).
175  *
176  * There is a more advanced way of making use of the quicklaunch infrastructure
177  * in Elementary (which will not be covered here due to its more advanced
178  * nature).
179  *
180  * Now let's actually create an interactive "Hello World" gui that you can
181  * click the ok button to exit. It's more code because this now does something
182  * much more significant, but it's still very simple:
183  *
184 @code
185 #include <Elementary.h>
186
187 static void
188 on_done(void *data, Evas_Object *obj, void *event_info)
189 {
190    // quit the mainloop (elm_run function will return)
191    elm_exit();
192 }
193
194 EAPI_MAIN int
195 elm_main(int argc, char **argv)
196 {
197    Evas_Object *win, *bg, *box, *lab, *btn;
198
199    // new window - do the usual and give it a name, title and delete handler
200    win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
201    elm_win_title_set(win, "Hello");
202    // when the user clicks "close" on a window there is a request to delete
203    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
204
205    // add a standard bg
206    bg = elm_bg_add(win);
207    // add object as a resize object for the window (controls window minimum
208    // size as well as gets resized if window is resized)
209    elm_win_resize_object_add(win, bg);
210    evas_object_show(bg);
211
212    // add a box object - default is vertical. a box holds children in a row,
213    // either horizontally or vertically. nothing more.
214    box = elm_box_add(win);
215    // make the box hotizontal
216    elm_box_horizontal_set(box, EINA_TRUE);
217    // add object as a resize object for the window (controls window minimum
218    // size as well as gets resized if window is resized)
219    elm_win_resize_object_add(win, box);
220    evas_object_show(box);
221
222    // add a label widget, set the text and put it in the pad frame
223    lab = elm_label_add(win);
224    // set default text of the label
225    elm_object_text_set(lab, "Hello out there world!");
226    // pack the label at the end of the box
227    elm_box_pack_end(box, lab);
228    evas_object_show(lab);
229
230    // add an ok button
231    btn = elm_button_add(win);
232    // set default text of button to "OK"
233    elm_object_text_set(btn, "OK");
234    // pack the button at the end of the box
235    elm_box_pack_end(box, btn);
236    evas_object_show(btn);
237    // call on_done when button is clicked
238    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
239
240    // now we are done, show the window
241    evas_object_show(win);
242
243    // run the mainloop and process events and callbacks
244    elm_run();
245    return 0;
246 }
247 ELM_MAIN()
248 @endcode
249    *
250    */
251
252 /**
253 @page authors Authors
254 @author Carsten Haitzler <raster@@rasterman.com>
255 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
256 @author Cedric Bail <cedric.bail@@free.fr>
257 @author Vincent Torri <vtorri@@univ-evry.fr>
258 @author Daniel Kolesa <quaker66@@gmail.com>
259 @author Jaime Thomas <avi.thomas@@gmail.com>
260 @author Swisscom - http://www.swisscom.ch/
261 @author Christopher Michael <devilhorns@@comcast.net>
262 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
263 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
264 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
265 @author Brian Wang <brian.wang.0721@@gmail.com>
266 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
267 @author Samsung Electronics <tbd>
268 @author Samsung SAIT <tbd>
269 @author Brett Nash <nash@@nash.id.au>
270 @author Bruno Dilly <bdilly@@profusion.mobi>
271 @author Rafael Fonseca <rfonseca@@profusion.mobi>
272 @author Chuneon Park <hermet@@hermet.pe.kr>
273 @author Woohyun Jung <wh0705.jung@@samsung.com>
274 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
275 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
276 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
277 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
278 @author Gustavo Lima Chaves <glima@@profusion.mobi>
279 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
280 @author Tiago Falcão <tiago@@profusion.mobi>
281 @author Otavio Pontes <otavio@@profusion.mobi>
282 @author Viktor Kojouharov <vkojouharov@@gmail.com>
283 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
284 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
285 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
286 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
287 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
288 @author Jihoon Kim <jihoon48.kim@@samsung.com>
289 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
290 @author Tom Hacohen <tom@@stosb.com>
291 @author Aharon Hillel <a.hillel@@partner.samsung.com>
292 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
293 @author Shinwoo Kim <kimcinoo@@gmail.com>
294 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
295 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
296 @author Sung W. Park <sungwoo@gmail.com>
297 @author Thierry el Borgi <thierry@substantiel.fr>
298 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
299 @author Chanwook Jung <joey.jung@samsung.com>
300 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
301 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
302 @author Kim Yunhan <spbear@gmail.com>
303
304 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
305 contact with the developers and maintainers.
306  */
307
308 #ifndef ELEMENTARY_H
309 #define ELEMENTARY_H
310
311 /**
312  * @file Elementary.h
313  * @brief Elementary's API
314  *
315  * Elementary API.
316  */
317
318 @ELM_UNIX_DEF@ ELM_UNIX
319 @ELM_WIN32_DEF@ ELM_WIN32
320 @ELM_WINCE_DEF@ ELM_WINCE
321 @ELM_EDBUS_DEF@ ELM_EDBUS
322 @ELM_EFREET_DEF@ ELM_EFREET
323 @ELM_ETHUMB_DEF@ ELM_ETHUMB
324 @ELM_WEB_DEF@ ELM_WEB
325 @ELM_EMAP_DEF@ ELM_EMAP
326 @ELM_DEBUG_DEF@ ELM_DEBUG
327 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
328 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
329
330 /* Standard headers for standard system calls etc. */
331 #include <stdio.h>
332 #include <stdlib.h>
333 #include <unistd.h>
334 #include <string.h>
335 #include <sys/types.h>
336 #include <sys/stat.h>
337 #include <sys/time.h>
338 #include <sys/param.h>
339 #include <dlfcn.h>
340 #include <math.h>
341 #include <fnmatch.h>
342 #include <limits.h>
343 #include <ctype.h>
344 #include <time.h>
345 #include <dirent.h>
346 #include <pwd.h>
347 #include <errno.h>
348
349 #ifdef ELM_UNIX
350 # include <locale.h>
351 # ifdef ELM_LIBINTL_H
352 #  include <libintl.h>
353 # endif
354 # include <signal.h>
355 # include <grp.h>
356 # include <glob.h>
357 #endif
358
359 #ifdef ELM_ALLOCA_H
360 # include <alloca.h>
361 #endif
362
363 #if defined (ELM_WIN32) || defined (ELM_WINCE)
364 # include <malloc.h>
365 # ifndef alloca
366 #  define alloca _alloca
367 # endif
368 #endif
369
370
371 /* EFL headers */
372 #include <Eina.h>
373 #include <Eet.h>
374 #include <Evas.h>
375 #include <Evas_GL.h>
376 #include <Ecore.h>
377 #include <Ecore_Evas.h>
378 #include <Ecore_File.h>
379 #include <Ecore_IMF.h>
380 #include <Ecore_Con.h>
381 #include <Edje.h>
382
383 #ifdef ELM_EDBUS
384 # include <E_DBus.h>
385 #endif
386
387 #ifdef ELM_EFREET
388 # include <Efreet.h>
389 # include <Efreet_Mime.h>
390 # include <Efreet_Trash.h>
391 #endif
392
393 #ifdef ELM_ETHUMB
394 # include <Ethumb_Client.h>
395 #endif
396
397 #ifdef ELM_EMAP
398 # include <EMap.h>
399 #endif
400
401 #ifdef EAPI
402 # undef EAPI
403 #endif
404
405 #ifdef _WIN32
406 # ifdef ELEMENTARY_BUILD
407 #  ifdef DLL_EXPORT
408 #   define EAPI __declspec(dllexport)
409 #  else
410 #   define EAPI
411 #  endif /* ! DLL_EXPORT */
412 # else
413 #  define EAPI __declspec(dllimport)
414 # endif /* ! EFL_EVAS_BUILD */
415 #else
416 # ifdef __GNUC__
417 #  if __GNUC__ >= 4
418 #   define EAPI __attribute__ ((visibility("default")))
419 #  else
420 #   define EAPI
421 #  endif
422 # else
423 #  define EAPI
424 # endif
425 #endif /* ! _WIN32 */
426
427 #ifdef _WIN32
428 # define EAPI_MAIN
429 #else
430 # define EAPI_MAIN EAPI
431 #endif
432
433 /* allow usage from c++ */
434 #ifdef __cplusplus
435 extern "C" {
436 #endif
437
438 #define ELM_VERSION_MAJOR @VMAJ@
439 #define ELM_VERSION_MINOR @VMIN@
440
441    typedef struct _Elm_Version
442      {
443         int major;
444         int minor;
445         int micro;
446         int revision;
447      } Elm_Version;
448
449    EAPI extern Elm_Version *elm_version;
450
451 /* handy macros */
452 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
453 #define ELM_PI 3.14159265358979323846
454
455    /**
456     * @defgroup General General
457     *
458     * @brief General Elementary API. Functions that don't relate to
459     * Elementary objects specifically.
460     *
461     * Here are documented functions which init/shutdown the library,
462     * that apply to generic Elementary objects, that deal with
463     * configuration, et cetera.
464     *
465     * @ref general_functions_example_page "This" example contemplates
466     * some of these functions.
467     */
468
469    /**
470     * @addtogroup General
471     * @{
472     */
473
474   /**
475    * Defines couple of standard Evas_Object layers to be used
476    * with evas_object_layer_set().
477    *
478    * @note whenever extending with new values, try to keep some padding
479    *       to siblings so there is room for further extensions.
480    */
481   typedef enum _Elm_Object_Layer
482     {
483        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
484        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
485        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
486        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
487        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
488        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
489     } Elm_Object_Layer;
490
491 /**************************************************************************/
492    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
493
494    /**
495     * Emitted when any Elementary's policy value is changed.
496     */
497    EAPI extern int ELM_EVENT_POLICY_CHANGED;
498
499    /**
500     * @typedef Elm_Event_Policy_Changed
501     *
502     * Data on the event when an Elementary policy has changed
503     */
504     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
505
506    /**
507     * @struct _Elm_Event_Policy_Changed
508     *
509     * Data on the event when an Elementary policy has changed
510     */
511     struct _Elm_Event_Policy_Changed
512      {
513         unsigned int policy; /**< the policy identifier */
514         int          new_value; /**< value the policy had before the change */
515         int          old_value; /**< new value the policy got */
516     };
517
518    /**
519     * Policy identifiers.
520     */
521     typedef enum _Elm_Policy
522     {
523         ELM_POLICY_QUIT, /**< under which circumstances the application
524                           * should quit automatically. @see
525                           * Elm_Policy_Quit.
526                           */
527         ELM_POLICY_LAST
528     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
529  */
530
531    typedef enum _Elm_Policy_Quit
532      {
533         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
534                                    * automatically */
535         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
536                                             * application's last
537                                             * window is closed */
538      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
539
540    typedef enum _Elm_Focus_Direction
541      {
542         ELM_FOCUS_PREVIOUS,
543         ELM_FOCUS_NEXT
544      } Elm_Focus_Direction;
545
546    typedef enum _Elm_Text_Format
547      {
548         ELM_TEXT_FORMAT_PLAIN_UTF8,
549         ELM_TEXT_FORMAT_MARKUP_UTF8
550      } Elm_Text_Format;
551
552    /**
553     * Line wrapping types.
554     */
555    typedef enum _Elm_Wrap_Type
556      {
557         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
558         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
559         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
560         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
561         ELM_WRAP_LAST
562      } Elm_Wrap_Type;
563
564    typedef enum
565      {
566         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
567         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
568         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
569         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
570         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
571         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
572         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
573         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
574         ELM_INPUT_PANEL_LAYOUT_INVALID
575      } Elm_Input_Panel_Layout;
576
577    /**
578     * @typedef Elm_Object_Item
579     * An Elementary Object item handle.
580     * @ingroup General
581     */
582    typedef struct _Elm_Object_Item Elm_Object_Item;
583
584
585    /**
586     * Called back when a widget's tooltip is activated and needs content.
587     * @param data user-data given to elm_object_tooltip_content_cb_set()
588     * @param obj owner widget.
589     * @param tooltip The tooltip object (affix content to this!)
590     */
591    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
592
593    /**
594     * Called back when a widget's item tooltip is activated and needs content.
595     * @param data user-data given to elm_object_tooltip_content_cb_set()
596     * @param obj owner widget.
597     * @param tooltip The tooltip object (affix content to this!)
598     * @param item context dependent item. As an example, if tooltip was
599     *        set on Elm_List_Item, then it is of this type.
600     */
601    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
602
603    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. */
604
605 #ifndef ELM_LIB_QUICKLAUNCH
606 #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 */
607 #else
608 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
609 #endif
610
611 /**************************************************************************/
612    /* General calls */
613
614    /**
615     * Initialize Elementary
616     *
617     * @param[in] argc System's argument count value
618     * @param[in] argv System's pointer to array of argument strings
619     * @return The init counter value.
620     *
621     * This function initializes Elementary and increments a counter of
622     * the number of calls to it. It returns the new counter's value.
623     *
624     * @warning This call is exported only for use by the @c ELM_MAIN()
625     * macro. There is no need to use this if you use this macro (which
626     * is highly advisable). An elm_main() should contain the entry
627     * point code for your application, having the same prototype as
628     * elm_init(), and @b not being static (putting the @c EAPI symbol
629     * in front of its type declaration is advisable). The @c
630     * ELM_MAIN() call should be placed just after it.
631     *
632     * Example:
633     * @dontinclude bg_example_01.c
634     * @skip static void
635     * @until ELM_MAIN
636     *
637     * See the full @ref bg_example_01_c "example".
638     *
639     * @see elm_shutdown().
640     * @ingroup General
641     */
642    EAPI int          elm_init(int argc, char **argv);
643
644    /**
645     * Shut down Elementary
646     *
647     * @return The init counter value.
648     *
649     * This should be called at the end of your application, just
650     * before it ceases to do any more processing. This will clean up
651     * any permanent resources your application may have allocated via
652     * Elementary that would otherwise persist.
653     *
654     * @see elm_init() for an example
655     *
656     * @ingroup General
657     */
658    EAPI int          elm_shutdown(void);
659
660    /**
661     * Run Elementary's main loop
662     *
663     * This call should be issued just after all initialization is
664     * completed. This function will not return until elm_exit() is
665     * called. It will keep looping, running the main
666     * (event/processing) loop for Elementary.
667     *
668     * @see elm_init() for an example
669     *
670     * @ingroup General
671     */
672    EAPI void         elm_run(void);
673
674    /**
675     * Exit Elementary's main loop
676     *
677     * If this call is issued, it will flag the main loop to cease
678     * processing and return back to its parent function (usually your
679     * elm_main() function).
680     *
681     * @see elm_init() for an example. There, just after a request to
682     * close the window comes, the main loop will be left.
683     *
684     * @note By using the #ELM_POLICY_QUIT on your Elementary
685     * applications, you'll this function called automatically for you.
686     *
687     * @ingroup General
688     */
689    EAPI void         elm_exit(void);
690
691    /**
692     * Provide information in order to make Elementary determine the @b
693     * run time location of the software in question, so other data files
694     * such as images, sound files, executable utilities, libraries,
695     * modules and locale files can be found.
696     *
697     * @param mainfunc This is your application's main function name,
698     *        whose binary's location is to be found. Providing @c NULL
699     *        will make Elementary not to use it
700     * @param dom This will be used as the application's "domain", in the
701     *        form of a prefix to any environment variables that may
702     *        override prefix detection and the directory name, inside the
703     *        standard share or data directories, where the software's
704     *        data files will be looked for.
705     * @param checkfile This is an (optional) magic file's path to check
706     *        for existence (and it must be located in the data directory,
707     *        under the share directory provided above). Its presence will
708     *        help determine the prefix found was correct. Pass @c NULL if
709     *        the check is not to be done.
710     *
711     * This function allows one to re-locate the application somewhere
712     * else after compilation, if the developer wishes for easier
713     * distribution of pre-compiled binaries.
714     *
715     * The prefix system is designed to locate where the given software is
716     * installed (under a common path prefix) at run time and then report
717     * specific locations of this prefix and common directories inside
718     * this prefix like the binary, library, data and locale directories,
719     * through the @c elm_app_*_get() family of functions.
720     *
721     * Call elm_app_info_set() early on before you change working
722     * directory or anything about @c argv[0], so it gets accurate
723     * information.
724     *
725     * It will then try and trace back which file @p mainfunc comes from,
726     * if provided, to determine the application's prefix directory.
727     *
728     * The @p dom parameter provides a string prefix to prepend before
729     * environment variables, allowing a fallback to @b specific
730     * environment variables to locate the software. You would most
731     * probably provide a lowercase string there, because it will also
732     * serve as directory domain, explained next. For environment
733     * variables purposes, this string is made uppercase. For example if
734     * @c "myapp" is provided as the prefix, then the program would expect
735     * @c "MYAPP_PREFIX" as a master environment variable to specify the
736     * exact install prefix for the software, or more specific environment
737     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
738     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
739     * the user or scripts before launching. If not provided (@c NULL),
740     * environment variables will not be used to override compiled-in
741     * defaults or auto detections.
742     *
743     * The @p dom string also provides a subdirectory inside the system
744     * shared data directory for data files. For example, if the system
745     * directory is @c /usr/local/share, then this directory name is
746     * appended, creating @c /usr/local/share/myapp, if it @p was @c
747     * "myapp". It is expected the application installs data files in
748     * this directory.
749     *
750     * The @p checkfile is a file name or path of something inside the
751     * share or data directory to be used to test that the prefix
752     * detection worked. For example, your app will install a wallpaper
753     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
754     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
755     * checkfile string.
756     *
757     * @see elm_app_compile_bin_dir_set()
758     * @see elm_app_compile_lib_dir_set()
759     * @see elm_app_compile_data_dir_set()
760     * @see elm_app_compile_locale_set()
761     * @see elm_app_prefix_dir_get()
762     * @see elm_app_bin_dir_get()
763     * @see elm_app_lib_dir_get()
764     * @see elm_app_data_dir_get()
765     * @see elm_app_locale_dir_get()
766     */
767    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
768
769    /**
770     * Provide information on the @b fallback application's binaries
771     * directory, on scenarios where they get overriden by
772     * elm_app_info_set().
773     *
774     * @param dir The path to the default binaries directory (compile time
775     * one)
776     *
777     * @note Elementary will as well use this path to determine actual
778     * names of binaries' directory paths, maybe changing it to be @c
779     * something/local/bin instead of @c something/bin, only, for
780     * example.
781     *
782     * @warning You should call this function @b before
783     * elm_app_info_set().
784     */
785    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
786
787    /**
788     * Provide information on the @b fallback application's libraries
789     * directory, on scenarios where they get overriden by
790     * elm_app_info_set().
791     *
792     * @param dir The path to the default libraries directory (compile
793     * time one)
794     *
795     * @note Elementary will as well use this path to determine actual
796     * names of libraries' directory paths, maybe changing it to be @c
797     * something/lib32 or @c something/lib64 instead of @c something/lib,
798     * only, for example.
799     *
800     * @warning You should call this function @b before
801     * elm_app_info_set().
802     */
803    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
804
805    /**
806     * Provide information on the @b fallback application's data
807     * directory, on scenarios where they get overriden by
808     * elm_app_info_set().
809     *
810     * @param dir The path to the default data directory (compile time
811     * one)
812     *
813     * @note Elementary will as well use this path to determine actual
814     * names of data directory paths, maybe changing it to be @c
815     * something/local/share instead of @c something/share, only, for
816     * example.
817     *
818     * @warning You should call this function @b before
819     * elm_app_info_set().
820     */
821    EAPI void         elm_app_compile_data_dir_set(const char *dir);
822
823    /**
824     * Provide information on the @b fallback application's locale
825     * directory, on scenarios where they get overriden by
826     * elm_app_info_set().
827     *
828     * @param dir The path to the default locale directory (compile time
829     * one)
830     *
831     * @warning You should call this function @b before
832     * elm_app_info_set().
833     */
834    EAPI void         elm_app_compile_locale_set(const char *dir);
835
836    /**
837     * Retrieve the application's run time prefix directory, as set by
838     * elm_app_info_set() and the way (environment) the application was
839     * run from.
840     *
841     * @return The directory prefix the application is actually using
842     */
843    EAPI const char  *elm_app_prefix_dir_get(void);
844
845    /**
846     * Retrieve the application's run time binaries prefix directory, as
847     * set by elm_app_info_set() and the way (environment) the application
848     * was run from.
849     *
850     * @return The binaries directory prefix the application is actually
851     * using
852     */
853    EAPI const char  *elm_app_bin_dir_get(void);
854
855    /**
856     * Retrieve the application's run time libraries prefix directory, as
857     * set by elm_app_info_set() and the way (environment) the application
858     * was run from.
859     *
860     * @return The libraries directory prefix the application is actually
861     * using
862     */
863    EAPI const char  *elm_app_lib_dir_get(void);
864
865    /**
866     * Retrieve the application's run time data prefix directory, as
867     * set by elm_app_info_set() and the way (environment) the application
868     * was run from.
869     *
870     * @return The data directory prefix the application is actually
871     * using
872     */
873    EAPI const char  *elm_app_data_dir_get(void);
874
875    /**
876     * Retrieve the application's run time locale prefix directory, as
877     * set by elm_app_info_set() and the way (environment) the application
878     * was run from.
879     *
880     * @return The locale directory prefix the application is actually
881     * using
882     */
883    EAPI const char  *elm_app_locale_dir_get(void);
884
885    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
886    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
887    EAPI int          elm_quicklaunch_init(int argc, char **argv);
888    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
889    EAPI int          elm_quicklaunch_sub_shutdown(void);
890    EAPI int          elm_quicklaunch_shutdown(void);
891    EAPI void         elm_quicklaunch_seed(void);
892    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
893    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
894    EAPI void         elm_quicklaunch_cleanup(void);
895    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
896    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
897
898    EAPI Eina_Bool    elm_need_efreet(void);
899    EAPI Eina_Bool    elm_need_e_dbus(void);
900
901    /**
902     * This must be called before any other function that handle with
903     * elm_thumb objects or ethumb_client instances.
904     *
905     * @ingroup Thumb
906     */
907    EAPI Eina_Bool    elm_need_ethumb(void);
908
909    /**
910     * This must be called before any other function that handle with
911     * elm_web objects or ewk_view instances.
912     *
913     * @ingroup Web
914     */
915    EAPI Eina_Bool    elm_need_web(void);
916
917    /**
918     * Set a new policy's value (for a given policy group/identifier).
919     *
920     * @param policy policy identifier, as in @ref Elm_Policy.
921     * @param value policy value, which depends on the identifier
922     *
923     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
924     *
925     * Elementary policies define applications' behavior,
926     * somehow. These behaviors are divided in policy groups (see
927     * #Elm_Policy enumeration). This call will emit the Ecore event
928     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
929     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
930     * then.
931     *
932     * @note Currently, we have only one policy identifier/group
933     * (#ELM_POLICY_QUIT), which has two possible values.
934     *
935     * @ingroup General
936     */
937    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
938
939    /**
940     * Gets the policy value set for given policy identifier.
941     *
942     * @param policy policy identifier, as in #Elm_Policy.
943     * @return The currently set policy value, for that
944     * identifier. Will be @c 0 if @p policy passed is invalid.
945     *
946     * @ingroup General
947     */
948    EAPI int          elm_policy_get(unsigned int policy);
949
950    /**
951     * Set a label of an object
952     *
953     * @param obj The Elementary object
954     * @param part The text part name to set (NULL for the default label)
955     * @param label The new text of the label
956     *
957     * @note Elementary objects may have many labels (e.g. Action Slider)
958     *
959     * @ingroup General
960     */
961    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
962
963 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
964
965    /**
966     * Get a label of an object
967     *
968     * @param obj The Elementary object
969     * @param part The text part name to get (NULL for the default label)
970     * @return text of the label or NULL for any error
971     *
972     * @note Elementary objects may have many labels (e.g. Action Slider)
973     *
974     * @ingroup General
975     */
976    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
977
978 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
979
980    /**
981     * Set a content of an object
982     *
983     * @param obj The Elementary object
984     * @param part The content part name to set (NULL for the default content)
985     * @param content The new content of the object
986     *
987     * @note Elementary objects may have many contents
988     *
989     * @ingroup General
990     */
991    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
992
993 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
994
995    /**
996     * Get a content of an object
997     *
998     * @param obj The Elementary object
999     * @param item The content part name to get (NULL for the default content)
1000     * @return content of the object or NULL for any error
1001     *
1002     * @note Elementary objects may have many contents
1003     *
1004     * @ingroup General
1005     */
1006    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1007
1008 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1009
1010    /**
1011     * Unset a content of an object
1012     *
1013     * @param obj The Elementary object
1014     * @param item The content part name to unset (NULL for the default content)
1015     *
1016     * @note Elementary objects may have many contents
1017     *
1018     * @ingroup General
1019     */
1020    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1021
1022 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1023
1024    /**
1025     * Get the wiget object's handle which contains a given item
1026     *
1027     * @param item The Elementary object item 
1028     * @return The widget object
1029     *
1030     * @note This returns the widget object itself that an item belongs to.
1031     *
1032     * @ingroup General
1033     */
1034    EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1035
1036    /**
1037     * Set a content of an object item
1038     *
1039     * @param it The Elementary object item
1040     * @param part The content part name to set (NULL for the default content)
1041     * @param content The new content of the object item
1042     *
1043     * @note Elementary object items may have many contents
1044     *
1045     * @ingroup General
1046     */
1047    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1048
1049 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1050
1051    /**
1052     * Get a content of an object item
1053     *
1054     * @param it The Elementary object item
1055     * @param part The content part name to unset (NULL for the default content)
1056     * @return content of the object item or NULL for any error
1057     *
1058     * @note Elementary object items may have many contents
1059     *
1060     * @ingroup General
1061     */
1062    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1063
1064 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1065
1066    /**
1067     * Unset a content of an object item
1068     *
1069     * @param it The Elementary object item
1070     * @param part The content part name to unset (NULL for the default content)
1071     *
1072     * @note Elementary object items may have many contents
1073     *
1074     * @ingroup General
1075     */
1076    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1077
1078 #define elm_object_item_content_unset(it) elm_object_item_content_part_unset((it), NULL)
1079
1080    /**
1081     * Set a label of an object item
1082     *
1083     * @param it The Elementary object item
1084     * @param part The text part name to set (NULL for the default label)
1085     * @param label The new text of the label
1086     *
1087     * @note Elementary object items may have many labels
1088     *
1089     * @ingroup General
1090     */
1091    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1092
1093 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1094
1095    /**
1096     * Get a label of an object
1097     *
1098     * @param it The Elementary object item
1099     * @param part The text part name to get (NULL for the default label)
1100     * @return text of the label or NULL for any error
1101     *
1102     * @note Elementary object items may have many labels
1103     *
1104     * @ingroup General
1105     */
1106    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1107
1108 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1109
1110    /**
1111     * Set the text to read out when in accessibility mode
1112     *
1113     * @param obj The object which is to be described
1114     * @param txt The text that describes the widget to people with poor or no vision
1115     *
1116     * @ingroup General
1117     */
1118    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1119
1120    /**
1121     * Set the text to read out when in accessibility mode
1122     *
1123     * @param it The object item which is to be described
1124     * @param txt The text that describes the widget to people with poor or no vision
1125     *
1126     * @ingroup General
1127     */
1128    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1129
1130    /**
1131     * Get the data associated with an object item
1132     * @param it The object item
1133     * @return The data associated with @p it
1134     *
1135     * @ingroup General
1136     */
1137    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1138
1139    /**
1140     * Set the data associated with an object item
1141     * @param it The object item
1142     * @param data The data to be associated with @p it
1143     *
1144     * @ingroup General
1145     */
1146    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1147
1148    /**
1149     * Send a signal to the edje object of the widget item.
1150     *
1151     * This function sends a signal to the edje object of the obj item. An
1152     * edje program can respond to a signal by specifying matching
1153     * 'signal' and 'source' fields.
1154     *
1155     * @param it The Elementary object item
1156     * @param emission The signal's name.
1157     * @param source The signal's source.
1158     * @ingroup General
1159     */
1160    EAPI void             elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1161
1162    /**
1163     * @}
1164     */
1165
1166    /**
1167     * @defgroup Caches Caches
1168     *
1169     * These are functions which let one fine-tune some cache values for
1170     * Elementary applications, thus allowing for performance adjustments.
1171     *
1172     * @{
1173     */
1174
1175    /**
1176     * @brief Flush all caches.
1177     *
1178     * Frees all data that was in cache and is not currently being used to reduce
1179     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1180     * to calling all of the following functions:
1181     * @li edje_file_cache_flush()
1182     * @li edje_collection_cache_flush()
1183     * @li eet_clearcache()
1184     * @li evas_image_cache_flush()
1185     * @li evas_font_cache_flush()
1186     * @li evas_render_dump()
1187     * @note Evas caches are flushed for every canvas associated with a window.
1188     *
1189     * @ingroup Caches
1190     */
1191    EAPI void         elm_all_flush(void);
1192
1193    /**
1194     * Get the configured cache flush interval time
1195     *
1196     * This gets the globally configured cache flush interval time, in
1197     * ticks
1198     *
1199     * @return The cache flush interval time
1200     * @ingroup Caches
1201     *
1202     * @see elm_all_flush()
1203     */
1204    EAPI int          elm_cache_flush_interval_get(void);
1205
1206    /**
1207     * Set the configured cache flush interval time
1208     *
1209     * This sets the globally configured cache flush interval time, in ticks
1210     *
1211     * @param size The cache flush interval time
1212     * @ingroup Caches
1213     *
1214     * @see elm_all_flush()
1215     */
1216    EAPI void         elm_cache_flush_interval_set(int size);
1217
1218    /**
1219     * Set the configured cache flush interval time for all applications on the
1220     * display
1221     *
1222     * This sets the globally configured cache flush interval time -- in ticks
1223     * -- for all applications on the display.
1224     *
1225     * @param size The cache flush interval time
1226     * @ingroup Caches
1227     */
1228    EAPI void         elm_cache_flush_interval_all_set(int size);
1229
1230    /**
1231     * Get the configured cache flush enabled state
1232     *
1233     * This gets the globally configured cache flush state - if it is enabled
1234     * or not. When cache flushing is enabled, elementary will regularly
1235     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1236     * memory and allow usage to re-seed caches and data in memory where it
1237     * can do so. An idle application will thus minimise its memory usage as
1238     * data will be freed from memory and not be re-loaded as it is idle and
1239     * not rendering or doing anything graphically right now.
1240     *
1241     * @return The cache flush state
1242     * @ingroup Caches
1243     *
1244     * @see elm_all_flush()
1245     */
1246    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1247
1248    /**
1249     * Set the configured cache flush enabled state
1250     *
1251     * This sets the globally configured cache flush enabled state
1252     *
1253     * @param size The cache flush enabled state
1254     * @ingroup Caches
1255     *
1256     * @see elm_all_flush()
1257     */
1258    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1259
1260    /**
1261     * Set the configured cache flush enabled state for all applications on the
1262     * display
1263     *
1264     * This sets the globally configured cache flush enabled state for all
1265     * applications on the display.
1266     *
1267     * @param size The cache flush enabled state
1268     * @ingroup Caches
1269     */
1270    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1271
1272    /**
1273     * Get the configured font cache size
1274     *
1275     * This gets the globally configured font cache size, in bytes
1276     *
1277     * @return The font cache size
1278     * @ingroup Caches
1279     */
1280    EAPI int          elm_font_cache_get(void);
1281
1282    /**
1283     * Set the configured font cache size
1284     *
1285     * This sets the globally configured font cache size, in bytes
1286     *
1287     * @param size The font cache size
1288     * @ingroup Caches
1289     */
1290    EAPI void         elm_font_cache_set(int size);
1291
1292    /**
1293     * Set the configured font cache size for all applications on the
1294     * display
1295     *
1296     * This sets the globally configured font cache size -- in bytes
1297     * -- for all applications on the display.
1298     *
1299     * @param size The font cache size
1300     * @ingroup Caches
1301     */
1302    EAPI void         elm_font_cache_all_set(int size);
1303
1304    /**
1305     * Get the configured image cache size
1306     *
1307     * This gets the globally configured image cache size, in bytes
1308     *
1309     * @return The image cache size
1310     * @ingroup Caches
1311     */
1312    EAPI int          elm_image_cache_get(void);
1313
1314    /**
1315     * Set the configured image cache size
1316     *
1317     * This sets the globally configured image cache size, in bytes
1318     *
1319     * @param size The image cache size
1320     * @ingroup Caches
1321     */
1322    EAPI void         elm_image_cache_set(int size);
1323
1324    /**
1325     * Set the configured image cache size for all applications on the
1326     * display
1327     *
1328     * This sets the globally configured image cache size -- in bytes
1329     * -- for all applications on the display.
1330     *
1331     * @param size The image cache size
1332     * @ingroup Caches
1333     */
1334    EAPI void         elm_image_cache_all_set(int size);
1335
1336    /**
1337     * Get the configured edje file cache size.
1338     *
1339     * This gets the globally configured edje file cache size, in number
1340     * of files.
1341     *
1342     * @return The edje file cache size
1343     * @ingroup Caches
1344     */
1345    EAPI int          elm_edje_file_cache_get(void);
1346
1347    /**
1348     * Set the configured edje file cache size
1349     *
1350     * This sets the globally configured edje file cache size, in number
1351     * of files.
1352     *
1353     * @param size The edje file cache size
1354     * @ingroup Caches
1355     */
1356    EAPI void         elm_edje_file_cache_set(int size);
1357
1358    /**
1359     * Set the configured edje file cache size for all applications on the
1360     * display
1361     *
1362     * This sets the globally configured edje file cache size -- in number
1363     * of files -- for all applications on the display.
1364     *
1365     * @param size The edje file cache size
1366     * @ingroup Caches
1367     */
1368    EAPI void         elm_edje_file_cache_all_set(int size);
1369
1370    /**
1371     * Get the configured edje collections (groups) cache size.
1372     *
1373     * This gets the globally configured edje collections cache size, in
1374     * number of collections.
1375     *
1376     * @return The edje collections cache size
1377     * @ingroup Caches
1378     */
1379    EAPI int          elm_edje_collection_cache_get(void);
1380
1381    /**
1382     * Set the configured edje collections (groups) cache size
1383     *
1384     * This sets the globally configured edje collections cache size, in
1385     * number of collections.
1386     *
1387     * @param size The edje collections cache size
1388     * @ingroup Caches
1389     */
1390    EAPI void         elm_edje_collection_cache_set(int size);
1391
1392    /**
1393     * Set the configured edje collections (groups) cache size for all
1394     * applications on the display
1395     *
1396     * This sets the globally configured edje collections cache size -- in
1397     * number of collections -- for all applications on the display.
1398     *
1399     * @param size The edje collections cache size
1400     * @ingroup Caches
1401     */
1402    EAPI void         elm_edje_collection_cache_all_set(int size);
1403
1404    /**
1405     * @}
1406     */
1407
1408    /**
1409     * @defgroup Scaling Widget Scaling
1410     *
1411     * Different widgets can be scaled independently. These functions
1412     * allow you to manipulate this scaling on a per-widget basis. The
1413     * object and all its children get their scaling factors multiplied
1414     * by the scale factor set. This is multiplicative, in that if a
1415     * child also has a scale size set it is in turn multiplied by its
1416     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1417     * double size, @c 0.5 is half, etc.
1418     *
1419     * @ref general_functions_example_page "This" example contemplates
1420     * some of these functions.
1421     */
1422
1423    /**
1424     * Get the global scaling factor
1425     *
1426     * This gets the globally configured scaling factor that is applied to all
1427     * objects.
1428     *
1429     * @return The scaling factor
1430     * @ingroup Scaling
1431     */
1432    EAPI double       elm_scale_get(void);
1433
1434    /**
1435     * Set the global scaling factor
1436     *
1437     * This sets the globally configured scaling factor that is applied to all
1438     * objects.
1439     *
1440     * @param scale The scaling factor to set
1441     * @ingroup Scaling
1442     */
1443    EAPI void         elm_scale_set(double scale);
1444
1445    /**
1446     * Set the global scaling factor for all applications on the display
1447     *
1448     * This sets the globally configured scaling factor that is applied to all
1449     * objects for all applications.
1450     * @param scale The scaling factor to set
1451     * @ingroup Scaling
1452     */
1453    EAPI void         elm_scale_all_set(double scale);
1454
1455    /**
1456     * Set the scaling factor for a given Elementary object
1457     *
1458     * @param obj The Elementary to operate on
1459     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1460     * no scaling)
1461     *
1462     * @ingroup Scaling
1463     */
1464    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1465
1466    /**
1467     * Get the scaling factor for a given Elementary object
1468     *
1469     * @param obj The object
1470     * @return The scaling factor set by elm_object_scale_set()
1471     *
1472     * @ingroup Scaling
1473     */
1474    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1475
1476    /**
1477     * @defgroup Password_last_show Password last input show
1478     *
1479     * Last show feature of password mode enables user to view
1480     * the last input entered for few seconds before masking it.
1481     * These functions allow to set this feature in password mode
1482     * of entry widget and also allow to manipulate the duration
1483     * for which the input has to be visible.
1484     *
1485     * @{
1486     */
1487
1488    /**
1489     * Get show last setting of password mode.
1490     *
1491     * This gets the show last input setting of password mode which might be
1492     * enabled or disabled.
1493     *
1494     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1495     *            if it's disabled.
1496     * @ingroup Password_last_show
1497     */
1498    EAPI Eina_Bool elm_password_show_last_get(void);
1499
1500    /**
1501     * Set show last setting in password mode.
1502     *
1503     * This enables or disables show last setting of password mode.
1504     *
1505     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1506     * @see elm_password_show_last_timeout_set()
1507     * @ingroup Password_last_show
1508     */
1509    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1510
1511    /**
1512     * Get's the timeout value in last show password mode.
1513     *
1514     * This gets the time out value for which the last input entered in password
1515     * mode will be visible.
1516     *
1517     * @return The timeout value of last show password mode.
1518     * @ingroup Password_last_show
1519     */
1520    EAPI double elm_password_show_last_timeout_get(void);
1521
1522    /**
1523     * Set's the timeout value in last show password mode.
1524     *
1525     * This sets the time out value for which the last input entered in password
1526     * mode will be visible.
1527     *
1528     * @param password_show_last_timeout The timeout value.
1529     * @see elm_password_show_last_set()
1530     * @ingroup Password_last_show
1531     */
1532    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1533
1534    /**
1535     * @}
1536     */
1537
1538    /**
1539     * @defgroup UI-Mirroring Selective Widget mirroring
1540     *
1541     * These functions allow you to set ui-mirroring on specific
1542     * widgets or the whole interface. Widgets can be in one of two
1543     * modes, automatic and manual.  Automatic means they'll be changed
1544     * according to the system mirroring mode and manual means only
1545     * explicit changes will matter. You are not supposed to change
1546     * mirroring state of a widget set to automatic, will mostly work,
1547     * but the behavior is not really defined.
1548     *
1549     * @{
1550     */
1551
1552    EAPI Eina_Bool    elm_mirrored_get(void);
1553    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1554
1555    /**
1556     * Get the system mirrored mode. This determines the default mirrored mode
1557     * of widgets.
1558     *
1559     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1560     */
1561    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1562
1563    /**
1564     * Set the system mirrored mode. This determines the default mirrored mode
1565     * of widgets.
1566     *
1567     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1568     */
1569    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1570
1571    /**
1572     * Returns the widget's mirrored mode setting.
1573     *
1574     * @param obj The widget.
1575     * @return mirrored mode setting of the object.
1576     *
1577     **/
1578    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1579
1580    /**
1581     * Sets the widget's mirrored mode setting.
1582     * When widget in automatic mode, it follows the system mirrored mode set by
1583     * elm_mirrored_set().
1584     * @param obj The widget.
1585     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1586     */
1587    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1588
1589    /**
1590     * @}
1591     */
1592
1593    /**
1594     * Set the style to use by a widget
1595     *
1596     * Sets the style name that will define the appearance of a widget. Styles
1597     * vary from widget to widget and may also be defined by other themes
1598     * by means of extensions and overlays.
1599     *
1600     * @param obj The Elementary widget to style
1601     * @param style The style name to use
1602     *
1603     * @see elm_theme_extension_add()
1604     * @see elm_theme_extension_del()
1605     * @see elm_theme_overlay_add()
1606     * @see elm_theme_overlay_del()
1607     *
1608     * @ingroup Styles
1609     */
1610    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1611    /**
1612     * Get the style used by the widget
1613     *
1614     * This gets the style being used for that widget. Note that the string
1615     * pointer is only valid as longas the object is valid and the style doesn't
1616     * change.
1617     *
1618     * @param obj The Elementary widget to query for its style
1619     * @return The style name used
1620     *
1621     * @see elm_object_style_set()
1622     *
1623     * @ingroup Styles
1624     */
1625    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1626
1627    /**
1628     * @defgroup Styles Styles
1629     *
1630     * Widgets can have different styles of look. These generic API's
1631     * set styles of widgets, if they support them (and if the theme(s)
1632     * do).
1633     *
1634     * @ref general_functions_example_page "This" example contemplates
1635     * some of these functions.
1636     */
1637
1638    /**
1639     * Set the disabled state of an Elementary object.
1640     *
1641     * @param obj The Elementary object to operate on
1642     * @param disabled The state to put in in: @c EINA_TRUE for
1643     *        disabled, @c EINA_FALSE for enabled
1644     *
1645     * Elementary objects can be @b disabled, in which state they won't
1646     * receive input and, in general, will be themed differently from
1647     * their normal state, usually greyed out. Useful for contexts
1648     * where you don't want your users to interact with some of the
1649     * parts of you interface.
1650     *
1651     * This sets the state for the widget, either disabling it or
1652     * enabling it back.
1653     *
1654     * @ingroup Styles
1655     */
1656    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1657
1658    /**
1659     * Get the disabled state of an Elementary object.
1660     *
1661     * @param obj The Elementary object to operate on
1662     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1663     *            if it's enabled (or on errors)
1664     *
1665     * This gets the state of the widget, which might be enabled or disabled.
1666     *
1667     * @ingroup Styles
1668     */
1669    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1670
1671    /**
1672     * @defgroup WidgetNavigation Widget Tree Navigation.
1673     *
1674     * How to check if an Evas Object is an Elementary widget? How to
1675     * get the first elementary widget that is parent of the given
1676     * object?  These are all covered in widget tree navigation.
1677     *
1678     * @ref general_functions_example_page "This" example contemplates
1679     * some of these functions.
1680     */
1681
1682    /**
1683     * Check if the given Evas Object is an Elementary widget.
1684     *
1685     * @param obj the object to query.
1686     * @return @c EINA_TRUE if it is an elementary widget variant,
1687     *         @c EINA_FALSE otherwise
1688     * @ingroup WidgetNavigation
1689     */
1690    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1691
1692    /**
1693     * Get the first parent of the given object that is an Elementary
1694     * widget.
1695     *
1696     * @param obj the Elementary object to query parent from.
1697     * @return the parent object that is an Elementary widget, or @c
1698     *         NULL, if it was not found.
1699     *
1700     * Use this to query for an object's parent widget.
1701     *
1702     * @note Most of Elementary users wouldn't be mixing non-Elementary
1703     * smart objects in the objects tree of an application, as this is
1704     * an advanced usage of Elementary with Evas. So, except for the
1705     * application's window, which is the root of that tree, all other
1706     * objects would have valid Elementary widget parents.
1707     *
1708     * @ingroup WidgetNavigation
1709     */
1710    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1711
1712    /**
1713     * Get the top level parent of an Elementary widget.
1714     *
1715     * @param obj The object to query.
1716     * @return The top level Elementary widget, or @c NULL if parent cannot be
1717     * found.
1718     * @ingroup WidgetNavigation
1719     */
1720    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1721
1722    /**
1723     * Get the string that represents this Elementary widget.
1724     *
1725     * @note Elementary is weird and exposes itself as a single
1726     *       Evas_Object_Smart_Class of type "elm_widget", so
1727     *       evas_object_type_get() always return that, making debug and
1728     *       language bindings hard. This function tries to mitigate this
1729     *       problem, but the solution is to change Elementary to use
1730     *       proper inheritance.
1731     *
1732     * @param obj the object to query.
1733     * @return Elementary widget name, or @c NULL if not a valid widget.
1734     * @ingroup WidgetNavigation
1735     */
1736    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1737
1738    /**
1739     * @defgroup Config Elementary Config
1740     *
1741     * Elementary configuration is formed by a set options bounded to a
1742     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1743     * "finger size", etc. These are functions with which one syncronizes
1744     * changes made to those values to the configuration storing files, de
1745     * facto. You most probably don't want to use the functions in this
1746     * group unlees you're writing an elementary configuration manager.
1747     *
1748     * @{
1749     */
1750
1751    /**
1752     * Save back Elementary's configuration, so that it will persist on
1753     * future sessions.
1754     *
1755     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1756     * @ingroup Config
1757     *
1758     * This function will take effect -- thus, do I/O -- immediately. Use
1759     * it when you want to apply all configuration changes at once. The
1760     * current configuration set will get saved onto the current profile
1761     * configuration file.
1762     *
1763     */
1764    EAPI Eina_Bool    elm_config_save(void);
1765
1766    /**
1767     * Reload Elementary's configuration, bounded to current selected
1768     * profile.
1769     *
1770     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1771     * @ingroup Config
1772     *
1773     * Useful when you want to force reloading of configuration values for
1774     * a profile. If one removes user custom configuration directories,
1775     * for example, it will force a reload with system values insted.
1776     *
1777     */
1778    EAPI void         elm_config_reload(void);
1779
1780    /**
1781     * @}
1782     */
1783
1784    /**
1785     * @defgroup Profile Elementary Profile
1786     *
1787     * Profiles are pre-set options that affect the whole look-and-feel of
1788     * Elementary-based applications. There are, for example, profiles
1789     * aimed at desktop computer applications and others aimed at mobile,
1790     * touchscreen-based ones. You most probably don't want to use the
1791     * functions in this group unlees you're writing an elementary
1792     * configuration manager.
1793     *
1794     * @{
1795     */
1796
1797    /**
1798     * Get Elementary's profile in use.
1799     *
1800     * This gets the global profile that is applied to all Elementary
1801     * applications.
1802     *
1803     * @return The profile's name
1804     * @ingroup Profile
1805     */
1806    EAPI const char  *elm_profile_current_get(void);
1807
1808    /**
1809     * Get an Elementary's profile directory path in the filesystem. One
1810     * may want to fetch a system profile's dir or an user one (fetched
1811     * inside $HOME).
1812     *
1813     * @param profile The profile's name
1814     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1815     *                or a system one (@c EINA_FALSE)
1816     * @return The profile's directory path.
1817     * @ingroup Profile
1818     *
1819     * @note You must free it with elm_profile_dir_free().
1820     */
1821    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1822
1823    /**
1824     * Free an Elementary's profile directory path, as returned by
1825     * elm_profile_dir_get().
1826     *
1827     * @param p_dir The profile's path
1828     * @ingroup Profile
1829     *
1830     */
1831    EAPI void         elm_profile_dir_free(const char *p_dir);
1832
1833    /**
1834     * Get Elementary's list of available profiles.
1835     *
1836     * @return The profiles list. List node data are the profile name
1837     *         strings.
1838     * @ingroup Profile
1839     *
1840     * @note One must free this list, after usage, with the function
1841     *       elm_profile_list_free().
1842     */
1843    EAPI Eina_List   *elm_profile_list_get(void);
1844
1845    /**
1846     * Free Elementary's list of available profiles.
1847     *
1848     * @param l The profiles list, as returned by elm_profile_list_get().
1849     * @ingroup Profile
1850     *
1851     */
1852    EAPI void         elm_profile_list_free(Eina_List *l);
1853
1854    /**
1855     * Set Elementary's profile.
1856     *
1857     * This sets the global profile that is applied to Elementary
1858     * applications. Just the process the call comes from will be
1859     * affected.
1860     *
1861     * @param profile The profile's name
1862     * @ingroup Profile
1863     *
1864     */
1865    EAPI void         elm_profile_set(const char *profile);
1866
1867    /**
1868     * Set Elementary's profile.
1869     *
1870     * This sets the global profile that is applied to all Elementary
1871     * applications. All running Elementary windows will be affected.
1872     *
1873     * @param profile The profile's name
1874     * @ingroup Profile
1875     *
1876     */
1877    EAPI void         elm_profile_all_set(const char *profile);
1878
1879    /**
1880     * @}
1881     */
1882
1883    /**
1884     * @defgroup Engine Elementary Engine
1885     *
1886     * These are functions setting and querying which rendering engine
1887     * Elementary will use for drawing its windows' pixels.
1888     *
1889     * The following are the available engines:
1890     * @li "software_x11"
1891     * @li "fb"
1892     * @li "directfb"
1893     * @li "software_16_x11"
1894     * @li "software_8_x11"
1895     * @li "xrender_x11"
1896     * @li "opengl_x11"
1897     * @li "software_gdi"
1898     * @li "software_16_wince_gdi"
1899     * @li "sdl"
1900     * @li "software_16_sdl"
1901     * @li "opengl_sdl"
1902     * @li "buffer"
1903     * @li "ews"
1904     *
1905     * @{
1906     */
1907
1908    /**
1909     * @brief Get Elementary's rendering engine in use.
1910     *
1911     * @return The rendering engine's name
1912     * @note there's no need to free the returned string, here.
1913     *
1914     * This gets the global rendering engine that is applied to all Elementary
1915     * applications.
1916     *
1917     * @see elm_engine_set()
1918     */
1919    EAPI const char  *elm_engine_current_get(void);
1920
1921    /**
1922     * @brief Set Elementary's rendering engine for use.
1923     *
1924     * @param engine The rendering engine's name
1925     *
1926     * This sets global rendering engine that is applied to all Elementary
1927     * applications. Note that it will take effect only to Elementary windows
1928     * created after this is called.
1929     *
1930     * @see elm_win_add()
1931     */
1932    EAPI void         elm_engine_set(const char *engine);
1933
1934    /**
1935     * @}
1936     */
1937
1938    /**
1939     * @defgroup Fonts Elementary Fonts
1940     *
1941     * These are functions dealing with font rendering, selection and the
1942     * like for Elementary applications. One might fetch which system
1943     * fonts are there to use and set custom fonts for individual classes
1944     * of UI items containing text (text classes).
1945     *
1946     * @{
1947     */
1948
1949   typedef struct _Elm_Text_Class
1950     {
1951        const char *name;
1952        const char *desc;
1953     } Elm_Text_Class;
1954
1955   typedef struct _Elm_Font_Overlay
1956     {
1957        const char     *text_class;
1958        const char     *font;
1959        Evas_Font_Size  size;
1960     } Elm_Font_Overlay;
1961
1962   typedef struct _Elm_Font_Properties
1963     {
1964        const char *name;
1965        Eina_List  *styles;
1966     } Elm_Font_Properties;
1967
1968    /**
1969     * Get Elementary's list of supported text classes.
1970     *
1971     * @return The text classes list, with @c Elm_Text_Class blobs as data.
1972     * @ingroup Fonts
1973     *
1974     * Release the list with elm_text_classes_list_free().
1975     */
1976    EAPI const Eina_List     *elm_text_classes_list_get(void);
1977
1978    /**
1979     * Free Elementary's list of supported text classes.
1980     *
1981     * @ingroup Fonts
1982     *
1983     * @see elm_text_classes_list_get().
1984     */
1985    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
1986
1987    /**
1988     * Get Elementary's list of font overlays, set with
1989     * elm_font_overlay_set().
1990     *
1991     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1992     * data.
1993     *
1994     * @ingroup Fonts
1995     *
1996     * For each text class, one can set a <b>font overlay</b> for it,
1997     * overriding the default font properties for that class coming from
1998     * the theme in use. There is no need to free this list.
1999     *
2000     * @see elm_font_overlay_set() and elm_font_overlay_unset().
2001     */
2002    EAPI const Eina_List     *elm_font_overlay_list_get(void);
2003
2004    /**
2005     * Set a font overlay for a given Elementary text class.
2006     *
2007     * @param text_class Text class name
2008     * @param font Font name and style string
2009     * @param size Font size
2010     *
2011     * @ingroup Fonts
2012     *
2013     * @p font has to be in the format returned by
2014     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2015     * and elm_font_overlay_unset().
2016     */
2017    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2018
2019    /**
2020     * Unset a font overlay for a given Elementary text class.
2021     *
2022     * @param text_class Text class name
2023     *
2024     * @ingroup Fonts
2025     *
2026     * This will bring back text elements belonging to text class
2027     * @p text_class back to their default font settings.
2028     */
2029    EAPI void                 elm_font_overlay_unset(const char *text_class);
2030
2031    /**
2032     * Apply the changes made with elm_font_overlay_set() and
2033     * elm_font_overlay_unset() on the current Elementary window.
2034     *
2035     * @ingroup Fonts
2036     *
2037     * This applies all font overlays set to all objects in the UI.
2038     */
2039    EAPI void                 elm_font_overlay_apply(void);
2040
2041    /**
2042     * Apply the changes made with elm_font_overlay_set() and
2043     * elm_font_overlay_unset() on all Elementary application windows.
2044     *
2045     * @ingroup Fonts
2046     *
2047     * This applies all font overlays set to all objects in the UI.
2048     */
2049    EAPI void                 elm_font_overlay_all_apply(void);
2050
2051    /**
2052     * Translate a font (family) name string in fontconfig's font names
2053     * syntax into an @c Elm_Font_Properties struct.
2054     *
2055     * @param font The font name and styles string
2056     * @return the font properties struct
2057     *
2058     * @ingroup Fonts
2059     *
2060     * @note The reverse translation can be achived with
2061     * elm_font_fontconfig_name_get(), for one style only (single font
2062     * instance, not family).
2063     */
2064    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2065
2066    /**
2067     * Free font properties return by elm_font_properties_get().
2068     *
2069     * @param efp the font properties struct
2070     *
2071     * @ingroup Fonts
2072     */
2073    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2074
2075    /**
2076     * Translate a font name, bound to a style, into fontconfig's font names
2077     * syntax.
2078     *
2079     * @param name The font (family) name
2080     * @param style The given style (may be @c NULL)
2081     *
2082     * @return the font name and style string
2083     *
2084     * @ingroup Fonts
2085     *
2086     * @note The reverse translation can be achived with
2087     * elm_font_properties_get(), for one style only (single font
2088     * instance, not family).
2089     */
2090    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2091
2092    /**
2093     * Free the font string return by elm_font_fontconfig_name_get().
2094     *
2095     * @param efp the font properties struct
2096     *
2097     * @ingroup Fonts
2098     */
2099    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2100
2101    /**
2102     * Create a font hash table of available system fonts.
2103     *
2104     * One must call it with @p list being the return value of
2105     * evas_font_available_list(). The hash will be indexed by font
2106     * (family) names, being its values @c Elm_Font_Properties blobs.
2107     *
2108     * @param list The list of available system fonts, as returned by
2109     * evas_font_available_list().
2110     * @return the font hash.
2111     *
2112     * @ingroup Fonts
2113     *
2114     * @note The user is supposed to get it populated at least with 3
2115     * default font families (Sans, Serif, Monospace), which should be
2116     * present on most systems.
2117     */
2118    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2119
2120    /**
2121     * Free the hash return by elm_font_available_hash_add().
2122     *
2123     * @param hash the hash to be freed.
2124     *
2125     * @ingroup Fonts
2126     */
2127    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2128
2129    /**
2130     * @}
2131     */
2132
2133    /**
2134     * @defgroup Fingers Fingers
2135     *
2136     * Elementary is designed to be finger-friendly for touchscreens,
2137     * and so in addition to scaling for display resolution, it can
2138     * also scale based on finger "resolution" (or size). You can then
2139     * customize the granularity of the areas meant to receive clicks
2140     * on touchscreens.
2141     *
2142     * Different profiles may have pre-set values for finger sizes.
2143     *
2144     * @ref general_functions_example_page "This" example contemplates
2145     * some of these functions.
2146     *
2147     * @{
2148     */
2149
2150    /**
2151     * Get the configured "finger size"
2152     *
2153     * @return The finger size
2154     *
2155     * This gets the globally configured finger size, <b>in pixels</b>
2156     *
2157     * @ingroup Fingers
2158     */
2159    EAPI Evas_Coord       elm_finger_size_get(void);
2160
2161    /**
2162     * Set the configured finger size
2163     *
2164     * This sets the globally configured finger size in pixels
2165     *
2166     * @param size The finger size
2167     * @ingroup Fingers
2168     */
2169    EAPI void             elm_finger_size_set(Evas_Coord size);
2170
2171    /**
2172     * Set the configured finger size for all applications on the display
2173     *
2174     * This sets the globally configured finger size in pixels for all
2175     * applications on the display
2176     *
2177     * @param size The finger size
2178     * @ingroup Fingers
2179     */
2180    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2181
2182    /**
2183     * @}
2184     */
2185
2186    /**
2187     * @defgroup Focus Focus
2188     *
2189     * An Elementary application has, at all times, one (and only one)
2190     * @b focused object. This is what determines where the input
2191     * events go to within the application's window. Also, focused
2192     * objects can be decorated differently, in order to signal to the
2193     * user where the input is, at a given moment.
2194     *
2195     * Elementary applications also have the concept of <b>focus
2196     * chain</b>: one can cycle through all the windows' focusable
2197     * objects by input (tab key) or programmatically. The default
2198     * focus chain for an application is the one define by the order in
2199     * which the widgets where added in code. One will cycle through
2200     * top level widgets, and, for each one containg sub-objects, cycle
2201     * through them all, before returning to the level
2202     * above. Elementary also allows one to set @b custom focus chains
2203     * for their applications.
2204     *
2205     * Besides the focused decoration a widget may exhibit, when it
2206     * gets focus, Elementary has a @b global focus highlight object
2207     * that can be enabled for a window. If one chooses to do so, this
2208     * extra highlight effect will surround the current focused object,
2209     * too.
2210     *
2211     * @note Some Elementary widgets are @b unfocusable, after
2212     * creation, by their very nature: they are not meant to be
2213     * interacted with input events, but are there just for visual
2214     * purposes.
2215     *
2216     * @ref general_functions_example_page "This" example contemplates
2217     * some of these functions.
2218     */
2219
2220    /**
2221     * Get the enable status of the focus highlight
2222     *
2223     * This gets whether the highlight on focused objects is enabled or not
2224     * @ingroup Focus
2225     */
2226    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2227
2228    /**
2229     * Set the enable status of the focus highlight
2230     *
2231     * Set whether to show or not the highlight on focused objects
2232     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2233     * @ingroup Focus
2234     */
2235    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2236
2237    /**
2238     * Get the enable status of the highlight animation
2239     *
2240     * Get whether the focus highlight, if enabled, will animate its switch from
2241     * one object to the next
2242     * @ingroup Focus
2243     */
2244    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2245
2246    /**
2247     * Set the enable status of the highlight animation
2248     *
2249     * Set whether the focus highlight, if enabled, will animate its switch from
2250     * one object to the next
2251     * @param animate Enable animation if EINA_TRUE, disable otherwise
2252     * @ingroup Focus
2253     */
2254    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2255
2256    /**
2257     * Get the whether an Elementary object has the focus or not.
2258     *
2259     * @param obj The Elementary object to get the information from
2260     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2261     *            not (and on errors).
2262     *
2263     * @see elm_object_focus_set()
2264     *
2265     * @ingroup Focus
2266     */
2267    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2268
2269    /**
2270     * Set/unset focus to a given Elementary object.
2271     *
2272     * @param obj The Elementary object to operate on.
2273     * @param enable @c EINA_TRUE Set focus to a given object,
2274     *               @c EINA_FALSE Unset focus to a given object.
2275     *
2276     * @note When you set focus to this object, if it can handle focus, will
2277     * take the focus away from the one who had it previously and will, for
2278     * now on, be the one receiving input events. Unsetting focus will remove
2279     * the focus from @p obj, passing it back to the previous element in the
2280     * focus chain list.
2281     *
2282     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2283     *
2284     * @ingroup Focus
2285     */
2286    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2287
2288    /**
2289     * Make a given Elementary object the focused one.
2290     *
2291     * @param obj The Elementary object to make focused.
2292     *
2293     * @note This object, if it can handle focus, will take the focus
2294     * away from the one who had it previously and will, for now on, be
2295     * the one receiving input events.
2296     *
2297     * @see elm_object_focus_get()
2298     * @deprecated use elm_object_focus_set() instead.
2299     *
2300     * @ingroup Focus
2301     */
2302    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2303
2304    /**
2305     * Remove the focus from an Elementary object
2306     *
2307     * @param obj The Elementary to take focus from
2308     *
2309     * This removes the focus from @p obj, passing it back to the
2310     * previous element in the focus chain list.
2311     *
2312     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2313     * @deprecated use elm_object_focus_set() instead.
2314     *
2315     * @ingroup Focus
2316     */
2317    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2318
2319    /**
2320     * Set the ability for an Element object to be focused
2321     *
2322     * @param obj The Elementary object to operate on
2323     * @param enable @c EINA_TRUE if the object can be focused, @c
2324     *        EINA_FALSE if not (and on errors)
2325     *
2326     * This sets whether the object @p obj is able to take focus or
2327     * not. Unfocusable objects do nothing when programmatically
2328     * focused, being the nearest focusable parent object the one
2329     * really getting focus. Also, when they receive mouse input, they
2330     * will get the event, but not take away the focus from where it
2331     * was previously.
2332     *
2333     * @ingroup Focus
2334     */
2335    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2336
2337    /**
2338     * Get whether an Elementary object is focusable or not
2339     *
2340     * @param obj The Elementary object to operate on
2341     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2342     *             EINA_FALSE if not (and on errors)
2343     *
2344     * @note Objects which are meant to be interacted with by input
2345     * events are created able to be focused, by default. All the
2346     * others are not.
2347     *
2348     * @ingroup Focus
2349     */
2350    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2351
2352    /**
2353     * Set custom focus chain.
2354     *
2355     * This function overwrites any previous custom focus chain within
2356     * the list of objects. The previous list will be deleted and this list
2357     * will be managed by elementary. After it is set, don't modify it.
2358     *
2359     * @note On focus cycle, only will be evaluated children of this container.
2360     *
2361     * @param obj The container object
2362     * @param objs Chain of objects to pass focus
2363     * @ingroup Focus
2364     */
2365    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2366
2367    /**
2368     * Unset a custom focus chain on a given Elementary widget
2369     *
2370     * @param obj The container object to remove focus chain from
2371     *
2372     * Any focus chain previously set on @p obj (for its child objects)
2373     * is removed entirely after this call.
2374     *
2375     * @ingroup Focus
2376     */
2377    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2378
2379    /**
2380     * Get custom focus chain
2381     *
2382     * @param obj The container object
2383     * @ingroup Focus
2384     */
2385    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2386
2387    /**
2388     * Append object to custom focus chain.
2389     *
2390     * @note If relative_child equal to NULL or not in custom chain, the object
2391     * will be added in end.
2392     *
2393     * @note On focus cycle, only will be evaluated children of this container.
2394     *
2395     * @param obj The container object
2396     * @param child The child to be added in custom chain
2397     * @param relative_child The relative object to position the child
2398     * @ingroup Focus
2399     */
2400    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2401
2402    /**
2403     * Prepend object to custom focus chain.
2404     *
2405     * @note If relative_child equal to NULL or not in custom chain, the object
2406     * will be added in begin.
2407     *
2408     * @note On focus cycle, only will be evaluated children of this container.
2409     *
2410     * @param obj The container object
2411     * @param child The child to be added in custom chain
2412     * @param relative_child The relative object to position the child
2413     * @ingroup Focus
2414     */
2415    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2416
2417    /**
2418     * Give focus to next object in object tree.
2419     *
2420     * Give focus to next object in focus chain of one object sub-tree.
2421     * If the last object of chain already have focus, the focus will go to the
2422     * first object of chain.
2423     *
2424     * @param obj The object root of sub-tree
2425     * @param dir Direction to cycle the focus
2426     *
2427     * @ingroup Focus
2428     */
2429    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2430
2431    /**
2432     * Give focus to near object in one direction.
2433     *
2434     * Give focus to near object in direction of one object.
2435     * If none focusable object in given direction, the focus will not change.
2436     *
2437     * @param obj The reference object
2438     * @param x Horizontal component of direction to focus
2439     * @param y Vertical component of direction to focus
2440     *
2441     * @ingroup Focus
2442     */
2443    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2444
2445    /**
2446     * Make the elementary object and its children to be unfocusable
2447     * (or focusable).
2448     *
2449     * @param obj The Elementary object to operate on
2450     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2451     *        @c EINA_FALSE for focusable.
2452     *
2453     * This sets whether the object @p obj and its children objects
2454     * are able to take focus or not. If the tree is set as unfocusable,
2455     * newest focused object which is not in this tree will get focus.
2456     * This API can be helpful for an object to be deleted.
2457     * When an object will be deleted soon, it and its children may not
2458     * want to get focus (by focus reverting or by other focus controls).
2459     * Then, just use this API before deleting.
2460     *
2461     * @see elm_object_tree_unfocusable_get()
2462     *
2463     * @ingroup Focus
2464     */
2465    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2466
2467    /**
2468     * Get whether an Elementary object and its children are unfocusable or not.
2469     *
2470     * @param obj The Elementary object to get the information from
2471     * @return @c EINA_TRUE, if the tree is unfocussable,
2472     *         @c EINA_FALSE if not (and on errors).
2473     *
2474     * @see elm_object_tree_unfocusable_set()
2475     *
2476     * @ingroup Focus
2477     */
2478    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2479
2480    /**
2481     * @defgroup Scrolling Scrolling
2482     *
2483     * These are functions setting how scrollable views in Elementary
2484     * widgets should behave on user interaction.
2485     *
2486     * @{
2487     */
2488
2489    /**
2490     * Get whether scrollers should bounce when they reach their
2491     * viewport's edge during a scroll.
2492     *
2493     * @return the thumb scroll bouncing state
2494     *
2495     * This is the default behavior for touch screens, in general.
2496     * @ingroup Scrolling
2497     */
2498    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2499
2500    /**
2501     * Set whether scrollers should bounce when they reach their
2502     * viewport's edge during a scroll.
2503     *
2504     * @param enabled the thumb scroll bouncing state
2505     *
2506     * @see elm_thumbscroll_bounce_enabled_get()
2507     * @ingroup Scrolling
2508     */
2509    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2510
2511    /**
2512     * Set whether scrollers should bounce when they reach their
2513     * viewport's edge during a scroll, for all Elementary application
2514     * windows.
2515     *
2516     * @param enabled the thumb scroll bouncing state
2517     *
2518     * @see elm_thumbscroll_bounce_enabled_get()
2519     * @ingroup Scrolling
2520     */
2521    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2522
2523    /**
2524     * Get the amount of inertia a scroller will impose at bounce
2525     * animations.
2526     *
2527     * @return the thumb scroll bounce friction
2528     *
2529     * @ingroup Scrolling
2530     */
2531    EAPI double           elm_scroll_bounce_friction_get(void);
2532
2533    /**
2534     * Set the amount of inertia a scroller will impose at bounce
2535     * animations.
2536     *
2537     * @param friction the thumb scroll bounce friction
2538     *
2539     * @see elm_thumbscroll_bounce_friction_get()
2540     * @ingroup Scrolling
2541     */
2542    EAPI void             elm_scroll_bounce_friction_set(double friction);
2543
2544    /**
2545     * Set the amount of inertia a scroller will impose at bounce
2546     * animations, for all Elementary application windows.
2547     *
2548     * @param friction the thumb scroll bounce friction
2549     *
2550     * @see elm_thumbscroll_bounce_friction_get()
2551     * @ingroup Scrolling
2552     */
2553    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2554
2555    /**
2556     * Get the amount of inertia a <b>paged</b> scroller will impose at
2557     * page fitting animations.
2558     *
2559     * @return the page scroll friction
2560     *
2561     * @ingroup Scrolling
2562     */
2563    EAPI double           elm_scroll_page_scroll_friction_get(void);
2564
2565    /**
2566     * Set the amount of inertia a <b>paged</b> scroller will impose at
2567     * page fitting animations.
2568     *
2569     * @param friction the page scroll friction
2570     *
2571     * @see elm_thumbscroll_page_scroll_friction_get()
2572     * @ingroup Scrolling
2573     */
2574    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2575
2576    /**
2577     * Set the amount of inertia a <b>paged</b> scroller will impose at
2578     * page fitting animations, for all Elementary application windows.
2579     *
2580     * @param friction the page scroll friction
2581     *
2582     * @see elm_thumbscroll_page_scroll_friction_get()
2583     * @ingroup Scrolling
2584     */
2585    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2586
2587    /**
2588     * Get the amount of inertia a scroller will impose at region bring
2589     * animations.
2590     *
2591     * @return the bring in scroll friction
2592     *
2593     * @ingroup Scrolling
2594     */
2595    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2596
2597    /**
2598     * Set the amount of inertia a scroller will impose at region bring
2599     * animations.
2600     *
2601     * @param friction the bring in scroll friction
2602     *
2603     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2604     * @ingroup Scrolling
2605     */
2606    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2607
2608    /**
2609     * Set the amount of inertia a scroller will impose at region bring
2610     * animations, for all Elementary application windows.
2611     *
2612     * @param friction the bring in scroll friction
2613     *
2614     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2615     * @ingroup Scrolling
2616     */
2617    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2618
2619    /**
2620     * Get the amount of inertia scrollers will impose at animations
2621     * triggered by Elementary widgets' zooming API.
2622     *
2623     * @return the zoom friction
2624     *
2625     * @ingroup Scrolling
2626     */
2627    EAPI double           elm_scroll_zoom_friction_get(void);
2628
2629    /**
2630     * Set the amount of inertia scrollers will impose at animations
2631     * triggered by Elementary widgets' zooming API.
2632     *
2633     * @param friction the zoom friction
2634     *
2635     * @see elm_thumbscroll_zoom_friction_get()
2636     * @ingroup Scrolling
2637     */
2638    EAPI void             elm_scroll_zoom_friction_set(double friction);
2639
2640    /**
2641     * Set the amount of inertia scrollers will impose at animations
2642     * triggered by Elementary widgets' zooming API, for all Elementary
2643     * application windows.
2644     *
2645     * @param friction the zoom friction
2646     *
2647     * @see elm_thumbscroll_zoom_friction_get()
2648     * @ingroup Scrolling
2649     */
2650    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2651
2652    /**
2653     * Get whether scrollers should be draggable from any point in their
2654     * views.
2655     *
2656     * @return the thumb scroll state
2657     *
2658     * @note This is the default behavior for touch screens, in general.
2659     * @note All other functions namespaced with "thumbscroll" will only
2660     *       have effect if this mode is enabled.
2661     *
2662     * @ingroup Scrolling
2663     */
2664    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2665
2666    /**
2667     * Set whether scrollers should be draggable from any point in their
2668     * views.
2669     *
2670     * @param enabled the thumb scroll state
2671     *
2672     * @see elm_thumbscroll_enabled_get()
2673     * @ingroup Scrolling
2674     */
2675    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2676
2677    /**
2678     * Set whether scrollers should be draggable from any point in their
2679     * views, for all Elementary application windows.
2680     *
2681     * @param enabled the thumb scroll state
2682     *
2683     * @see elm_thumbscroll_enabled_get()
2684     * @ingroup Scrolling
2685     */
2686    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2687
2688    /**
2689     * Get the number of pixels one should travel while dragging a
2690     * scroller's view to actually trigger scrolling.
2691     *
2692     * @return the thumb scroll threshould
2693     *
2694     * One would use higher values for touch screens, in general, because
2695     * of their inherent imprecision.
2696     * @ingroup Scrolling
2697     */
2698    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2699
2700    /**
2701     * Set the number of pixels one should travel while dragging a
2702     * scroller's view to actually trigger scrolling.
2703     *
2704     * @param threshold the thumb scroll threshould
2705     *
2706     * @see elm_thumbscroll_threshould_get()
2707     * @ingroup Scrolling
2708     */
2709    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2710
2711    /**
2712     * Set the number of pixels one should travel while dragging a
2713     * scroller's view to actually trigger scrolling, for all Elementary
2714     * application windows.
2715     *
2716     * @param threshold the thumb scroll threshould
2717     *
2718     * @see elm_thumbscroll_threshould_get()
2719     * @ingroup Scrolling
2720     */
2721    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2722
2723    /**
2724     * Get the minimum speed of mouse cursor movement which will trigger
2725     * list self scrolling animation after a mouse up event
2726     * (pixels/second).
2727     *
2728     * @return the thumb scroll momentum threshould
2729     *
2730     * @ingroup Scrolling
2731     */
2732    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2733
2734    /**
2735     * Set the minimum speed of mouse cursor movement which will trigger
2736     * list self scrolling animation after a mouse up event
2737     * (pixels/second).
2738     *
2739     * @param threshold the thumb scroll momentum threshould
2740     *
2741     * @see elm_thumbscroll_momentum_threshould_get()
2742     * @ingroup Scrolling
2743     */
2744    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2745
2746    /**
2747     * Set the minimum speed of mouse cursor movement which will trigger
2748     * list self scrolling animation after a mouse up event
2749     * (pixels/second), for all Elementary application windows.
2750     *
2751     * @param threshold the thumb scroll momentum threshould
2752     *
2753     * @see elm_thumbscroll_momentum_threshould_get()
2754     * @ingroup Scrolling
2755     */
2756    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2757
2758    /**
2759     * Get the amount of inertia a scroller will impose at self scrolling
2760     * animations.
2761     *
2762     * @return the thumb scroll friction
2763     *
2764     * @ingroup Scrolling
2765     */
2766    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2767
2768    /**
2769     * Set the amount of inertia a scroller will impose at self scrolling
2770     * animations.
2771     *
2772     * @param friction the thumb scroll friction
2773     *
2774     * @see elm_thumbscroll_friction_get()
2775     * @ingroup Scrolling
2776     */
2777    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2778
2779    /**
2780     * Set the amount of inertia a scroller will impose at self scrolling
2781     * animations, for all Elementary application windows.
2782     *
2783     * @param friction the thumb scroll friction
2784     *
2785     * @see elm_thumbscroll_friction_get()
2786     * @ingroup Scrolling
2787     */
2788    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2789
2790    /**
2791     * Get the amount of lag between your actual mouse cursor dragging
2792     * movement and a scroller's view movement itself, while pushing it
2793     * into bounce state manually.
2794     *
2795     * @return the thumb scroll border friction
2796     *
2797     * @ingroup Scrolling
2798     */
2799    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2800
2801    /**
2802     * Set the amount of lag between your actual mouse cursor dragging
2803     * movement and a scroller's view movement itself, while pushing it
2804     * into bounce state manually.
2805     *
2806     * @param friction the thumb scroll border friction. @c 0.0 for
2807     *        perfect synchrony between two movements, @c 1.0 for maximum
2808     *        lag.
2809     *
2810     * @see elm_thumbscroll_border_friction_get()
2811     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2812     *
2813     * @ingroup Scrolling
2814     */
2815    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2816
2817    /**
2818     * Set the amount of lag between your actual mouse cursor dragging
2819     * movement and a scroller's view movement itself, while pushing it
2820     * into bounce state manually, for all Elementary application windows.
2821     *
2822     * @param friction the thumb scroll border friction. @c 0.0 for
2823     *        perfect synchrony between two movements, @c 1.0 for maximum
2824     *        lag.
2825     *
2826     * @see elm_thumbscroll_border_friction_get()
2827     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2828     *
2829     * @ingroup Scrolling
2830     */
2831    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2832
2833    /**
2834     * Get the sensitivity amount which is be multiplied by the length of
2835     * mouse dragging.
2836     *
2837     * @return the thumb scroll sensitivity friction
2838     *
2839     * @ingroup Scrolling
2840     */
2841    EAPI double           elm_scroll_thumbscroll_sensitivity_friction_get(void);
2842
2843    /**
2844     * Set the sensitivity amount which is be multiplied by the length of
2845     * mouse dragging.
2846     *
2847     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2848     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2849     *        is proper.
2850     *
2851     * @see elm_thumbscroll_sensitivity_friction_get()
2852     * @note parameter value will get bound to 0.1 - 1.0 interval, always
2853     *
2854     * @ingroup Scrolling
2855     */
2856    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2857
2858    /**
2859     * Set the sensitivity amount which is be multiplied by the length of
2860     * mouse dragging, for all Elementary application windows.
2861     *
2862     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2863     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2864     *        is proper.
2865     *
2866     * @see elm_thumbscroll_sensitivity_friction_get()
2867     * @note parameter value will get bound to 0.1 - 1.0 interval, always
2868     *
2869     * @ingroup Scrolling
2870     */
2871    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2872
2873    /**
2874     * @}
2875     */
2876
2877    /**
2878     * @defgroup Scrollhints Scrollhints
2879     *
2880     * Objects when inside a scroller can scroll, but this may not always be
2881     * desirable in certain situations. This allows an object to hint to itself
2882     * and parents to "not scroll" in one of 2 ways. If any child object of a
2883     * scroller has pushed a scroll freeze or hold then it affects all parent
2884     * scrollers until all children have released them.
2885     *
2886     * 1. To hold on scrolling. This means just flicking and dragging may no
2887     * longer scroll, but pressing/dragging near an edge of the scroller will
2888     * still scroll. This is automatically used by the entry object when
2889     * selecting text.
2890     *
2891     * 2. To totally freeze scrolling. This means it stops. until
2892     * popped/released.
2893     *
2894     * @{
2895     */
2896
2897    /**
2898     * Push the scroll hold by 1
2899     *
2900     * This increments the scroll hold count by one. If it is more than 0 it will
2901     * take effect on the parents of the indicated object.
2902     *
2903     * @param obj The object
2904     * @ingroup Scrollhints
2905     */
2906    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2907
2908    /**
2909     * Pop the scroll hold by 1
2910     *
2911     * This decrements the scroll hold count by one. If it is more than 0 it will
2912     * take effect on the parents of the indicated object.
2913     *
2914     * @param obj The object
2915     * @ingroup Scrollhints
2916     */
2917    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2918
2919    /**
2920     * Push the scroll freeze by 1
2921     *
2922     * This increments the scroll freeze count by one. If it is more
2923     * than 0 it will take effect on the parents of the indicated
2924     * object.
2925     *
2926     * @param obj The object
2927     * @ingroup Scrollhints
2928     */
2929    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2930
2931    /**
2932     * Pop the scroll freeze by 1
2933     *
2934     * This decrements the scroll freeze count by one. If it is more
2935     * than 0 it will take effect on the parents of the indicated
2936     * object.
2937     *
2938     * @param obj The object
2939     * @ingroup Scrollhints
2940     */
2941    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2942
2943    /**
2944     * Lock the scrolling of the given widget (and thus all parents)
2945     *
2946     * This locks the given object from scrolling in the X axis (and implicitly
2947     * also locks all parent scrollers too from doing the same).
2948     *
2949     * @param obj The object
2950     * @param lock The lock state (1 == locked, 0 == unlocked)
2951     * @ingroup Scrollhints
2952     */
2953    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2954
2955    /**
2956     * Lock the scrolling of the given widget (and thus all parents)
2957     *
2958     * This locks the given object from scrolling in the Y axis (and implicitly
2959     * also locks all parent scrollers too from doing the same).
2960     *
2961     * @param obj The object
2962     * @param lock The lock state (1 == locked, 0 == unlocked)
2963     * @ingroup Scrollhints
2964     */
2965    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2966
2967    /**
2968     * Get the scrolling lock of the given widget
2969     *
2970     * This gets the lock for X axis scrolling.
2971     *
2972     * @param obj The object
2973     * @ingroup Scrollhints
2974     */
2975    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2976
2977    /**
2978     * Get the scrolling lock of the given widget
2979     *
2980     * This gets the lock for X axis scrolling.
2981     *
2982     * @param obj The object
2983     * @ingroup Scrollhints
2984     */
2985    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2986
2987    /**
2988     * @}
2989     */
2990
2991    /**
2992     * Send a signal to the widget edje object.
2993     *
2994     * This function sends a signal to the edje object of the obj. An
2995     * edje program can respond to a signal by specifying matching
2996     * 'signal' and 'source' fields.
2997     *
2998     * @param obj The object
2999     * @param emission The signal's name.
3000     * @param source The signal's source.
3001     * @ingroup General
3002     */
3003    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3004
3005    /**
3006     * Add a callback for a signal emitted by widget edje object.
3007     *
3008     * This function connects a callback function to a signal emitted by the
3009     * edje object of the obj.
3010     * Globs can occur in either the emission or source name.
3011     *
3012     * @param obj The object
3013     * @param emission The signal's name.
3014     * @param source The signal's source.
3015     * @param func The callback function to be executed when the signal is
3016     * emitted.
3017     * @param data A pointer to data to pass in to the callback function.
3018     * @ingroup General
3019     */
3020    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);
3021
3022    /**
3023     * Remove a signal-triggered callback from a widget edje object.
3024     *
3025     * This function removes a callback, previoulsy attached to a
3026     * signal emitted by the edje object of the obj.  The parameters
3027     * emission, source and func must match exactly those passed to a
3028     * previous call to elm_object_signal_callback_add(). The data
3029     * pointer that was passed to this call will be returned.
3030     *
3031     * @param obj The object
3032     * @param emission The signal's name.
3033     * @param source The signal's source.
3034     * @param func The callback function to be executed when the signal is
3035     * emitted.
3036     * @return The data pointer
3037     * @ingroup General
3038     */
3039    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);
3040
3041    /**
3042     * Add a callback for input events (key up, key down, mouse wheel)
3043     * on a given Elementary widget
3044     *
3045     * @param obj The widget to add an event callback on
3046     * @param func The callback function to be executed when the event
3047     * happens
3048     * @param data Data to pass in to @p func
3049     *
3050     * Every widget in an Elementary interface set to receive focus,
3051     * with elm_object_focus_allow_set(), will propagate @b all of its
3052     * key up, key down and mouse wheel input events up to its parent
3053     * object, and so on. All of the focusable ones in this chain which
3054     * had an event callback set, with this call, will be able to treat
3055     * those events. There are two ways of making the propagation of
3056     * these event upwards in the tree of widgets to @b cease:
3057     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3058     *   the event was @b not processed, so the propagation will go on.
3059     * - The @c event_info pointer passed to @p func will contain the
3060     *   event's structure and, if you OR its @c event_flags inner
3061     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3062     *   one has already handled it, thus killing the event's
3063     *   propagation, too.
3064     *
3065     * @note Your event callback will be issued on those events taking
3066     * place only if no other child widget of @obj has consumed the
3067     * event already.
3068     *
3069     * @note Not to be confused with @c
3070     * evas_object_event_callback_add(), which will add event callbacks
3071     * per type on general Evas objects (no event propagation
3072     * infrastructure taken in account).
3073     *
3074     * @note Not to be confused with @c
3075     * elm_object_signal_callback_add(), which will add callbacks to @b
3076     * signals coming from a widget's theme, not input events.
3077     *
3078     * @note Not to be confused with @c
3079     * edje_object_signal_callback_add(), which does the same as
3080     * elm_object_signal_callback_add(), but directly on an Edje
3081     * object.
3082     *
3083     * @note Not to be confused with @c
3084     * evas_object_smart_callback_add(), which adds callbacks to smart
3085     * objects' <b>smart events</b>, and not input events.
3086     *
3087     * @see elm_object_event_callback_del()
3088     *
3089     * @ingroup General
3090     */
3091    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3092
3093    /**
3094     * Remove an event callback from a widget.
3095     *
3096     * This function removes a callback, previoulsy attached to event emission
3097     * by the @p obj.
3098     * The parameters func and data must match exactly those passed to
3099     * a previous call to elm_object_event_callback_add(). The data pointer that
3100     * was passed to this call will be returned.
3101     *
3102     * @param obj The object
3103     * @param func The callback function to be executed when the event is
3104     * emitted.
3105     * @param data Data to pass in to the callback function.
3106     * @return The data pointer
3107     * @ingroup General
3108     */
3109    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3110
3111    /**
3112     * Adjust size of an element for finger usage.
3113     *
3114     * @param times_w How many fingers should fit horizontally
3115     * @param w Pointer to the width size to adjust
3116     * @param times_h How many fingers should fit vertically
3117     * @param h Pointer to the height size to adjust
3118     *
3119     * This takes width and height sizes (in pixels) as input and a
3120     * size multiple (which is how many fingers you want to place
3121     * within the area, being "finger" the size set by
3122     * elm_finger_size_set()), and adjusts the size to be large enough
3123     * to accommodate the resulting size -- if it doesn't already
3124     * accommodate it. On return the @p w and @p h sizes pointed to by
3125     * these parameters will be modified, on those conditions.
3126     *
3127     * @note This is kind of a low level Elementary call, most useful
3128     * on size evaluation times for widgets. An external user wouldn't
3129     * be calling, most of the time.
3130     *
3131     * @ingroup Fingers
3132     */
3133    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3134
3135    /**
3136     * Get the duration for occuring long press event.
3137     *
3138     * @return Timeout for long press event
3139     * @ingroup Longpress
3140     */
3141    EAPI double           elm_longpress_timeout_get(void);
3142
3143    /**
3144     * Set the duration for occuring long press event.
3145     *
3146     * @param lonpress_timeout Timeout for long press event
3147     * @ingroup Longpress
3148     */
3149    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3150
3151    /**
3152     * @defgroup Debug Debug
3153     * don't use it unless you are sure
3154     *
3155     * @{
3156     */
3157
3158    /**
3159     * Print Tree object hierarchy in stdout
3160     *
3161     * @param obj The root object
3162     * @ingroup Debug
3163     */
3164    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3165
3166    /**
3167     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3168     *
3169     * @param obj The root object
3170     * @param file The path of output file
3171     * @ingroup Debug
3172     */
3173    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3174
3175    /**
3176     * @}
3177     */
3178
3179    /**
3180     * @defgroup Theme Theme
3181     *
3182     * Elementary uses Edje to theme its widgets, naturally. But for the most
3183     * part this is hidden behind a simpler interface that lets the user set
3184     * extensions and choose the style of widgets in a much easier way.
3185     *
3186     * Instead of thinking in terms of paths to Edje files and their groups
3187     * each time you want to change the appearance of a widget, Elementary
3188     * works so you can add any theme file with extensions or replace the
3189     * main theme at one point in the application, and then just set the style
3190     * of widgets with elm_object_style_set() and related functions. Elementary
3191     * will then look in its list of themes for a matching group and apply it,
3192     * and when the theme changes midway through the application, all widgets
3193     * will be updated accordingly.
3194     *
3195     * There are three concepts you need to know to understand how Elementary
3196     * theming works: default theme, extensions and overlays.
3197     *
3198     * Default theme, obviously enough, is the one that provides the default
3199     * look of all widgets. End users can change the theme used by Elementary
3200     * by setting the @c ELM_THEME environment variable before running an
3201     * application, or globally for all programs using the @c elementary_config
3202     * utility. Applications can change the default theme using elm_theme_set(),
3203     * but this can go against the user wishes, so it's not an adviced practice.
3204     *
3205     * Ideally, applications should find everything they need in the already
3206     * provided theme, but there may be occasions when that's not enough and
3207     * custom styles are required to correctly express the idea. For this
3208     * cases, Elementary has extensions.
3209     *
3210     * Extensions allow the application developer to write styles of its own
3211     * to apply to some widgets. This requires knowledge of how each widget
3212     * is themed, as extensions will always replace the entire group used by
3213     * the widget, so important signals and parts need to be there for the
3214     * object to behave properly (see documentation of Edje for details).
3215     * Once the theme for the extension is done, the application needs to add
3216     * it to the list of themes Elementary will look into, using
3217     * elm_theme_extension_add(), and set the style of the desired widgets as
3218     * he would normally with elm_object_style_set().
3219     *
3220     * Overlays, on the other hand, can replace the look of all widgets by
3221     * overriding the default style. Like extensions, it's up to the application
3222     * developer to write the theme for the widgets it wants, the difference
3223     * being that when looking for the theme, Elementary will check first the
3224     * list of overlays, then the set theme and lastly the list of extensions,
3225     * so with overlays it's possible to replace the default view and every
3226     * widget will be affected. This is very much alike to setting the whole
3227     * theme for the application and will probably clash with the end user
3228     * options, not to mention the risk of ending up with not matching styles
3229     * across the program. Unless there's a very special reason to use them,
3230     * overlays should be avoided for the resons exposed before.
3231     *
3232     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3233     * keeps one default internally and every function that receives one of
3234     * these can be called with NULL to refer to this default (except for
3235     * elm_theme_free()). It's possible to create a new instance of a
3236     * ::Elm_Theme to set other theme for a specific widget (and all of its
3237     * children), but this is as discouraged, if not even more so, than using
3238     * overlays. Don't use this unless you really know what you are doing.
3239     *
3240     * But to be less negative about things, you can look at the following
3241     * examples:
3242     * @li @ref theme_example_01 "Using extensions"
3243     * @li @ref theme_example_02 "Using overlays"
3244     *
3245     * @{
3246     */
3247    /**
3248     * @typedef Elm_Theme
3249     *
3250     * Opaque handler for the list of themes Elementary looks for when
3251     * rendering widgets.
3252     *
3253     * Stay out of this unless you really know what you are doing. For most
3254     * cases, sticking to the default is all a developer needs.
3255     */
3256    typedef struct _Elm_Theme Elm_Theme;
3257
3258    /**
3259     * Create a new specific theme
3260     *
3261     * This creates an empty specific theme that only uses the default theme. A
3262     * specific theme has its own private set of extensions and overlays too
3263     * (which are empty by default). Specific themes do not fall back to themes
3264     * of parent objects. They are not intended for this use. Use styles, overlays
3265     * and extensions when needed, but avoid specific themes unless there is no
3266     * other way (example: you want to have a preview of a new theme you are
3267     * selecting in a "theme selector" window. The preview is inside a scroller
3268     * and should display what the theme you selected will look like, but not
3269     * actually apply it yet. The child of the scroller will have a specific
3270     * theme set to show this preview before the user decides to apply it to all
3271     * applications).
3272     */
3273    EAPI Elm_Theme       *elm_theme_new(void);
3274    /**
3275     * Free a specific theme
3276     *
3277     * @param th The theme to free
3278     *
3279     * This frees a theme created with elm_theme_new().
3280     */
3281    EAPI void             elm_theme_free(Elm_Theme *th);
3282    /**
3283     * Copy the theme fom the source to the destination theme
3284     *
3285     * @param th The source theme to copy from
3286     * @param thdst The destination theme to copy data to
3287     *
3288     * This makes a one-time static copy of all the theme config, extensions
3289     * and overlays from @p th to @p thdst. If @p th references a theme, then
3290     * @p thdst is also set to reference it, with all the theme settings,
3291     * overlays and extensions that @p th had.
3292     */
3293    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3294    /**
3295     * Tell the source theme to reference the ref theme
3296     *
3297     * @param th The theme that will do the referencing
3298     * @param thref The theme that is the reference source
3299     *
3300     * This clears @p th to be empty and then sets it to refer to @p thref
3301     * so @p th acts as an override to @p thref, but where its overrides
3302     * don't apply, it will fall through to @p thref for configuration.
3303     */
3304    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3305    /**
3306     * Return the theme referred to
3307     *
3308     * @param th The theme to get the reference from
3309     * @return The referenced theme handle
3310     *
3311     * This gets the theme set as the reference theme by elm_theme_ref_set().
3312     * If no theme is set as a reference, NULL is returned.
3313     */
3314    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3315    /**
3316     * Return the default theme
3317     *
3318     * @return The default theme handle
3319     *
3320     * This returns the internal default theme setup handle that all widgets
3321     * use implicitly unless a specific theme is set. This is also often use
3322     * as a shorthand of NULL.
3323     */
3324    EAPI Elm_Theme       *elm_theme_default_get(void);
3325    /**
3326     * Prepends a theme overlay to the list of overlays
3327     *
3328     * @param th The theme to add to, or if NULL, the default theme
3329     * @param item The Edje file path to be used
3330     *
3331     * Use this if your application needs to provide some custom overlay theme
3332     * (An Edje file that replaces some default styles of widgets) where adding
3333     * new styles, or changing system theme configuration is not possible. Do
3334     * NOT use this instead of a proper system theme configuration. Use proper
3335     * configuration files, profiles, environment variables etc. to set a theme
3336     * so that the theme can be altered by simple confiugration by a user. Using
3337     * this call to achieve that effect is abusing the API and will create lots
3338     * of trouble.
3339     *
3340     * @see elm_theme_extension_add()
3341     */
3342    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3343    /**
3344     * Delete a theme overlay from the list of overlays
3345     *
3346     * @param th The theme to delete from, or if NULL, the default theme
3347     * @param item The name of the theme overlay
3348     *
3349     * @see elm_theme_overlay_add()
3350     */
3351    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3352    /**
3353     * Appends a theme extension to the list of extensions.
3354     *
3355     * @param th The theme to add to, or if NULL, the default theme
3356     * @param item The Edje file path to be used
3357     *
3358     * This is intended when an application needs more styles of widgets or new
3359     * widget themes that the default does not provide (or may not provide). The
3360     * application has "extended" usage by coming up with new custom style names
3361     * for widgets for specific uses, but as these are not "standard", they are
3362     * not guaranteed to be provided by a default theme. This means the
3363     * application is required to provide these extra elements itself in specific
3364     * Edje files. This call adds one of those Edje files to the theme search
3365     * path to be search after the default theme. The use of this call is
3366     * encouraged when default styles do not meet the needs of the application.
3367     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3368     *
3369     * @see elm_object_style_set()
3370     */
3371    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3372    /**
3373     * Deletes a theme extension from the list of extensions.
3374     *
3375     * @param th The theme to delete from, or if NULL, the default theme
3376     * @param item The name of the theme extension
3377     *
3378     * @see elm_theme_extension_add()
3379     */
3380    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3381    /**
3382     * Set the theme search order for the given theme
3383     *
3384     * @param th The theme to set the search order, or if NULL, the default theme
3385     * @param theme Theme search string
3386     *
3387     * This sets the search string for the theme in path-notation from first
3388     * theme to search, to last, delimited by the : character. Example:
3389     *
3390     * "shiny:/path/to/file.edj:default"
3391     *
3392     * See the ELM_THEME environment variable for more information.
3393     *
3394     * @see elm_theme_get()
3395     * @see elm_theme_list_get()
3396     */
3397    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3398    /**
3399     * Return the theme search order
3400     *
3401     * @param th The theme to get the search order, or if NULL, the default theme
3402     * @return The internal search order path
3403     *
3404     * This function returns a colon separated string of theme elements as
3405     * returned by elm_theme_list_get().
3406     *
3407     * @see elm_theme_set()
3408     * @see elm_theme_list_get()
3409     */
3410    EAPI const char      *elm_theme_get(Elm_Theme *th);
3411    /**
3412     * Return a list of theme elements to be used in a theme.
3413     *
3414     * @param th Theme to get the list of theme elements from.
3415     * @return The internal list of theme elements
3416     *
3417     * This returns the internal list of theme elements (will only be valid as
3418     * long as the theme is not modified by elm_theme_set() or theme is not
3419     * freed by elm_theme_free(). This is a list of strings which must not be
3420     * altered as they are also internal. If @p th is NULL, then the default
3421     * theme element list is returned.
3422     *
3423     * A theme element can consist of a full or relative path to a .edj file,
3424     * or a name, without extension, for a theme to be searched in the known
3425     * theme paths for Elemementary.
3426     *
3427     * @see elm_theme_set()
3428     * @see elm_theme_get()
3429     */
3430    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3431    /**
3432     * Return the full patrh for a theme element
3433     *
3434     * @param f The theme element name
3435     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3436     * @return The full path to the file found.
3437     *
3438     * This returns a string you should free with free() on success, NULL on
3439     * failure. This will search for the given theme element, and if it is a
3440     * full or relative path element or a simple searchable name. The returned
3441     * path is the full path to the file, if searched, and the file exists, or it
3442     * is simply the full path given in the element or a resolved path if
3443     * relative to home. The @p in_search_path boolean pointed to is set to
3444     * EINA_TRUE if the file was a searchable file andis in the search path,
3445     * and EINA_FALSE otherwise.
3446     */
3447    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3448    /**
3449     * Flush the current theme.
3450     *
3451     * @param th Theme to flush
3452     *
3453     * This flushes caches that let elementary know where to find theme elements
3454     * in the given theme. If @p th is NULL, then the default theme is flushed.
3455     * Call this function if source theme data has changed in such a way as to
3456     * make any caches Elementary kept invalid.
3457     */
3458    EAPI void             elm_theme_flush(Elm_Theme *th);
3459    /**
3460     * This flushes all themes (default and specific ones).
3461     *
3462     * This will flush all themes in the current application context, by calling
3463     * elm_theme_flush() on each of them.
3464     */
3465    EAPI void             elm_theme_full_flush(void);
3466    /**
3467     * Set the theme for all elementary using applications on the current display
3468     *
3469     * @param theme The name of the theme to use. Format same as the ELM_THEME
3470     * environment variable.
3471     */
3472    EAPI void             elm_theme_all_set(const char *theme);
3473    /**
3474     * Return a list of theme elements in the theme search path
3475     *
3476     * @return A list of strings that are the theme element names.
3477     *
3478     * This lists all available theme files in the standard Elementary search path
3479     * for theme elements, and returns them in alphabetical order as theme
3480     * element names in a list of strings. Free this with
3481     * elm_theme_name_available_list_free() when you are done with the list.
3482     */
3483    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3484    /**
3485     * Free the list returned by elm_theme_name_available_list_new()
3486     *
3487     * This frees the list of themes returned by
3488     * elm_theme_name_available_list_new(). Once freed the list should no longer
3489     * be used. a new list mys be created.
3490     */
3491    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3492    /**
3493     * Set a specific theme to be used for this object and its children
3494     *
3495     * @param obj The object to set the theme on
3496     * @param th The theme to set
3497     *
3498     * This sets a specific theme that will be used for the given object and any
3499     * child objects it has. If @p th is NULL then the theme to be used is
3500     * cleared and the object will inherit its theme from its parent (which
3501     * ultimately will use the default theme if no specific themes are set).
3502     *
3503     * Use special themes with great care as this will annoy users and make
3504     * configuration difficult. Avoid any custom themes at all if it can be
3505     * helped.
3506     */
3507    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3508    /**
3509     * Get the specific theme to be used
3510     *
3511     * @param obj The object to get the specific theme from
3512     * @return The specifc theme set.
3513     *
3514     * This will return a specific theme set, or NULL if no specific theme is
3515     * set on that object. It will not return inherited themes from parents, only
3516     * the specific theme set for that specific object. See elm_object_theme_set()
3517     * for more information.
3518     */
3519    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3520
3521    /**
3522     * Get a data item from a theme
3523     *
3524     * @param th The theme, or NULL for default theme
3525     * @param key The data key to search with
3526     * @return The data value, or NULL on failure
3527     *
3528     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3529     * It works the same way as edje_file_data_get() except that the return is stringshared.
3530     */
3531    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3532    /**
3533     * @}
3534     */
3535
3536    /* win */
3537    /** @defgroup Win Win
3538     *
3539     * @image html img/widget/win/preview-00.png
3540     * @image latex img/widget/win/preview-00.eps
3541     *
3542     * The window class of Elementary.  Contains functions to manipulate
3543     * windows. The Evas engine used to render the window contents is specified
3544     * in the system or user elementary config files (whichever is found last),
3545     * and can be overridden with the ELM_ENGINE environment variable for
3546     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3547     * compilation setup and modules actually installed at runtime) are (listed
3548     * in order of best supported and most likely to be complete and work to
3549     * lowest quality).
3550     *
3551     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3552     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3553     * rendering in X11)
3554     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3555     * exits)
3556     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3557     * rendering)
3558     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3559     * buffer)
3560     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3561     * rendering using SDL as the buffer)
3562     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3563     * GDI with software)
3564     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3565     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3566     * grayscale using dedicated 8bit software engine in X11)
3567     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3568     * X11 using 16bit software engine)
3569     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3570     * (Windows CE rendering via GDI with 16bit software renderer)
3571     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3572     * buffer with 16bit software renderer)
3573     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3574     *
3575     * All engines use a simple string to select the engine to render, EXCEPT
3576     * the "shot" engine. This actually encodes the output of the virtual
3577     * screenshot and how long to delay in the engine string. The engine string
3578     * is encoded in the following way:
3579     *
3580     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3581     *
3582     * Where options are separated by a ":" char if more than one option is
3583     * given, with delay, if provided being the first option and file the last
3584     * (order is important). The delay specifies how long to wait after the
3585     * window is shown before doing the virtual "in memory" rendering and then
3586     * save the output to the file specified by the file option (and then exit).
3587     * If no delay is given, the default is 0.5 seconds. If no file is given the
3588     * default output file is "out.png". Repeat option is for continous
3589     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3590     * fixed to "out001.png" Some examples of using the shot engine:
3591     *
3592     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3593     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3594     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3595     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3596     *   ELM_ENGINE="shot:" elementary_test
3597     *
3598     * Signals that you can add callbacks for are:
3599     *
3600     * @li "delete,request": the user requested to close the window. See
3601     * elm_win_autodel_set().
3602     * @li "focus,in": window got focus
3603     * @li "focus,out": window lost focus
3604     * @li "moved": window that holds the canvas was moved
3605     *
3606     * Examples:
3607     * @li @ref win_example_01
3608     *
3609     * @{
3610     */
3611    /**
3612     * Defines the types of window that can be created
3613     *
3614     * These are hints set on the window so that a running Window Manager knows
3615     * how the window should be handled and/or what kind of decorations it
3616     * should have.
3617     *
3618     * Currently, only the X11 backed engines use them.
3619     */
3620    typedef enum _Elm_Win_Type
3621      {
3622         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3623                          window. Almost every window will be created with this
3624                          type. */
3625         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3626         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3627                            window holding desktop icons. */
3628         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3629                         be kept on top of any other window by the Window
3630                         Manager. */
3631         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3632                            similar. */
3633         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3634         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3635                            pallete. */
3636         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3637         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3638                                  entry in a menubar is clicked. Typically used
3639                                  with elm_win_override_set(). This hint exists
3640                                  for completion only, as the EFL way of
3641                                  implementing a menu would not normally use a
3642                                  separate window for its contents. */
3643         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3644                               triggered by right-clicking an object. */
3645         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3646                            explanatory text that typically appear after the
3647                            mouse cursor hovers over an object for a while.
3648                            Typically used with elm_win_override_set() and also
3649                            not very commonly used in the EFL. */
3650         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3651                                 battery life or a new E-Mail received. */
3652         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3653                          usually used in the EFL. */
3654         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3655                        object being dragged across different windows, or even
3656                        applications. Typically used with
3657                        elm_win_override_set(). */
3658         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3659                                  buffer. No actual window is created for this
3660                                  type, instead the window and all of its
3661                                  contents will be rendered to an image buffer.
3662                                  This allows to have children window inside a
3663                                  parent one just like any other object would
3664                                  be, and do other things like applying @c
3665                                  Evas_Map effects to it. This is the only type
3666                                  of window that requires the @c parent
3667                                  parameter of elm_win_add() to be a valid @c
3668                                  Evas_Object. */
3669      } Elm_Win_Type;
3670
3671    /**
3672     * The differents layouts that can be requested for the virtual keyboard.
3673     *
3674     * When the application window is being managed by Illume, it may request
3675     * any of the following layouts for the virtual keyboard.
3676     */
3677    typedef enum _Elm_Win_Keyboard_Mode
3678      {
3679         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3680         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3681         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3682         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3683         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3684         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3685         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3686         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3687         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3688         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3689         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3690         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3691         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3692         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3693         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3694         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3695      } Elm_Win_Keyboard_Mode;
3696
3697    /**
3698     * Available commands that can be sent to the Illume manager.
3699     *
3700     * When running under an Illume session, a window may send commands to the
3701     * Illume manager to perform different actions.
3702     */
3703    typedef enum _Elm_Illume_Command
3704      {
3705         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3706                                          window */
3707         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3708                                             in the list */
3709         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3710                                          screen */
3711         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3712      } Elm_Illume_Command;
3713
3714    /**
3715     * Adds a window object. If this is the first window created, pass NULL as
3716     * @p parent.
3717     *
3718     * @param parent Parent object to add the window to, or NULL
3719     * @param name The name of the window
3720     * @param type The window type, one of #Elm_Win_Type.
3721     *
3722     * The @p parent paramter can be @c NULL for every window @p type except
3723     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3724     * which the image object will be created.
3725     *
3726     * @return The created object, or NULL on failure
3727     */
3728    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3729    /**
3730     * Add @p subobj as a resize object of window @p obj.
3731     *
3732     *
3733     * Setting an object as a resize object of the window means that the
3734     * @p subobj child's size and position will be controlled by the window
3735     * directly. That is, the object will be resized to match the window size
3736     * and should never be moved or resized manually by the developer.
3737     *
3738     * In addition, resize objects of the window control what the minimum size
3739     * of it will be, as well as whether it can or not be resized by the user.
3740     *
3741     * For the end user to be able to resize a window by dragging the handles
3742     * or borders provided by the Window Manager, or using any other similar
3743     * mechanism, all of the resize objects in the window should have their
3744     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3745     *
3746     * @param obj The window object
3747     * @param subobj The resize object to add
3748     */
3749    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3750    /**
3751     * Delete @p subobj as a resize object of window @p obj.
3752     *
3753     * This function removes the object @p subobj from the resize objects of
3754     * the window @p obj. It will not delete the object itself, which will be
3755     * left unmanaged and should be deleted by the developer, manually handled
3756     * or set as child of some other container.
3757     *
3758     * @param obj The window object
3759     * @param subobj The resize object to add
3760     */
3761    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3762    /**
3763     * Set the title of the window
3764     *
3765     * @param obj The window object
3766     * @param title The title to set
3767     */
3768    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3769    /**
3770     * Get the title of the window
3771     *
3772     * The returned string is an internal one and should not be freed or
3773     * modified. It will also be rendered invalid if a new title is set or if
3774     * the window is destroyed.
3775     *
3776     * @param obj The window object
3777     * @return The title
3778     */
3779    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3780    /**
3781     * Set the window's autodel state.
3782     *
3783     * When closing the window in any way outside of the program control, like
3784     * pressing the X button in the titlebar or using a command from the
3785     * Window Manager, a "delete,request" signal is emitted to indicate that
3786     * this event occurred and the developer can take any action, which may
3787     * include, or not, destroying the window object.
3788     *
3789     * When the @p autodel parameter is set, the window will be automatically
3790     * destroyed when this event occurs, after the signal is emitted.
3791     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3792     * and is up to the program to do so when it's required.
3793     *
3794     * @param obj The window object
3795     * @param autodel If true, the window will automatically delete itself when
3796     * closed
3797     */
3798    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3799    /**
3800     * Get the window's autodel state.
3801     *
3802     * @param obj The window object
3803     * @return If the window will automatically delete itself when closed
3804     *
3805     * @see elm_win_autodel_set()
3806     */
3807    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3808    /**
3809     * Activate a window object.
3810     *
3811     * This function sends a request to the Window Manager to activate the
3812     * window pointed by @p obj. If honored by the WM, the window will receive
3813     * the keyboard focus.
3814     *
3815     * @note This is just a request that a Window Manager may ignore, so calling
3816     * this function does not ensure in any way that the window will be the
3817     * active one after it.
3818     *
3819     * @param obj The window object
3820     */
3821    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3822    /**
3823     * Lower a window object.
3824     *
3825     * Places the window pointed by @p obj at the bottom of the stack, so that
3826     * no other window is covered by it.
3827     *
3828     * If elm_win_override_set() is not set, the Window Manager may ignore this
3829     * request.
3830     *
3831     * @param obj The window object
3832     */
3833    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3834    /**
3835     * Raise a window object.
3836     *
3837     * Places the window pointed by @p obj at the top of the stack, so that it's
3838     * not covered by any other window.
3839     *
3840     * If elm_win_override_set() is not set, the Window Manager may ignore this
3841     * request.
3842     *
3843     * @param obj The window object
3844     */
3845    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3846    /**
3847     * Set the borderless state of a window.
3848     *
3849     * This function requests the Window Manager to not draw any decoration
3850     * around the window.
3851     *
3852     * @param obj The window object
3853     * @param borderless If true, the window is borderless
3854     */
3855    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3856    /**
3857     * Get the borderless state of a window.
3858     *
3859     * @param obj The window object
3860     * @return If true, the window is borderless
3861     */
3862    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3863    /**
3864     * Set the shaped state of a window.
3865     *
3866     * Shaped windows, when supported, will render the parts of the window that
3867     * has no content, transparent.
3868     *
3869     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3870     * background object or cover the entire window in any other way, or the
3871     * parts of the canvas that have no data will show framebuffer artifacts.
3872     *
3873     * @param obj The window object
3874     * @param shaped If true, the window is shaped
3875     *
3876     * @see elm_win_alpha_set()
3877     */
3878    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3879    /**
3880     * Get the shaped state of a window.
3881     *
3882     * @param obj The window object
3883     * @return If true, the window is shaped
3884     *
3885     * @see elm_win_shaped_set()
3886     */
3887    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3888    /**
3889     * Set the alpha channel state of a window.
3890     *
3891     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3892     * possibly making parts of the window completely or partially transparent.
3893     * This is also subject to the underlying system supporting it, like for
3894     * example, running under a compositing manager. If no compositing is
3895     * available, enabling this option will instead fallback to using shaped
3896     * windows, with elm_win_shaped_set().
3897     *
3898     * @param obj The window object
3899     * @param alpha If true, the window has an alpha channel
3900     *
3901     * @see elm_win_alpha_set()
3902     */
3903    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3904    /**
3905     * Get the transparency state of a window.
3906     *
3907     * @param obj The window object
3908     * @return If true, the window is transparent
3909     *
3910     * @see elm_win_transparent_set()
3911     */
3912    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3913    /**
3914     * Set the transparency state of a window.
3915     *
3916     * Use elm_win_alpha_set() instead.
3917     *
3918     * @param obj The window object
3919     * @param transparent If true, the window is transparent
3920     *
3921     * @see elm_win_alpha_set()
3922     */
3923    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3924    /**
3925     * Get the alpha channel state of a window.
3926     *
3927     * @param obj The window object
3928     * @return If true, the window has an alpha channel
3929     */
3930    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3931    /**
3932     * Set the override state of a window.
3933     *
3934     * A window with @p override set to EINA_TRUE will not be managed by the
3935     * Window Manager. This means that no decorations of any kind will be shown
3936     * for it, moving and resizing must be handled by the application, as well
3937     * as the window visibility.
3938     *
3939     * This should not be used for normal windows, and even for not so normal
3940     * ones, it should only be used when there's a good reason and with a lot
3941     * of care. Mishandling override windows may result situations that
3942     * disrupt the normal workflow of the end user.
3943     *
3944     * @param obj The window object
3945     * @param override If true, the window is overridden
3946     */
3947    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3948    /**
3949     * Get the override state of a window.
3950     *
3951     * @param obj The window object
3952     * @return If true, the window is overridden
3953     *
3954     * @see elm_win_override_set()
3955     */
3956    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3957    /**
3958     * Set the fullscreen state of a window.
3959     *
3960     * @param obj The window object
3961     * @param fullscreen If true, the window is fullscreen
3962     */
3963    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3964    /**
3965     * Get the fullscreen state of a window.
3966     *
3967     * @param obj The window object
3968     * @return If true, the window is fullscreen
3969     */
3970    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3971    /**
3972     * Set the maximized state of a window.
3973     *
3974     * @param obj The window object
3975     * @param maximized If true, the window is maximized
3976     */
3977    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3978    /**
3979     * Get the maximized state of a window.
3980     *
3981     * @param obj The window object
3982     * @return If true, the window is maximized
3983     */
3984    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3985    /**
3986     * Set the iconified state of a window.
3987     *
3988     * @param obj The window object
3989     * @param iconified If true, the window is iconified
3990     */
3991    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3992    /**
3993     * Get the iconified state of a window.
3994     *
3995     * @param obj The window object
3996     * @return If true, the window is iconified
3997     */
3998    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3999    /**
4000     * Set the layer of the window.
4001     *
4002     * What this means exactly will depend on the underlying engine used.
4003     *
4004     * In the case of X11 backed engines, the value in @p layer has the
4005     * following meanings:
4006     * @li < 3: The window will be placed below all others.
4007     * @li > 5: The window will be placed above all others.
4008     * @li other: The window will be placed in the default layer.
4009     *
4010     * @param obj The window object
4011     * @param layer The layer of the window
4012     */
4013    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4014    /**
4015     * Get the layer of the window.
4016     *
4017     * @param obj The window object
4018     * @return The layer of the window
4019     *
4020     * @see elm_win_layer_set()
4021     */
4022    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4023    /**
4024     * Set the rotation of the window.
4025     *
4026     * Most engines only work with multiples of 90.
4027     *
4028     * This function is used to set the orientation of the window @p obj to
4029     * match that of the screen. The window itself will be resized to adjust
4030     * to the new geometry of its contents. If you want to keep the window size,
4031     * see elm_win_rotation_with_resize_set().
4032     *
4033     * @param obj The window object
4034     * @param rotation The rotation of the window, in degrees (0-360),
4035     * counter-clockwise.
4036     */
4037    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4038    /**
4039     * Rotates the window and resizes it.
4040     *
4041     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4042     * that they fit inside the current window geometry.
4043     *
4044     * @param obj The window object
4045     * @param layer The rotation of the window in degrees (0-360),
4046     * counter-clockwise.
4047     */
4048    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4049    /**
4050     * Get the rotation of the window.
4051     *
4052     * @param obj The window object
4053     * @return The rotation of the window in degrees (0-360)
4054     *
4055     * @see elm_win_rotation_set()
4056     * @see elm_win_rotation_with_resize_set()
4057     */
4058    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4059    /**
4060     * Set the sticky state of the window.
4061     *
4062     * Hints the Window Manager that the window in @p obj should be left fixed
4063     * at its position even when the virtual desktop it's on moves or changes.
4064     *
4065     * @param obj The window object
4066     * @param sticky If true, the window's sticky state is enabled
4067     */
4068    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4069    /**
4070     * Get the sticky state of the window.
4071     *
4072     * @param obj The window object
4073     * @return If true, the window's sticky state is enabled
4074     *
4075     * @see elm_win_sticky_set()
4076     */
4077    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4078    /**
4079     * Set if this window is an illume conformant window
4080     *
4081     * @param obj The window object
4082     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4083     */
4084    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4085    /**
4086     * Get if this window is an illume conformant window
4087     *
4088     * @param obj The window object
4089     * @return A boolean if this window is illume conformant or not
4090     */
4091    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4092    /**
4093     * Set a window to be an illume quickpanel window
4094     *
4095     * By default window objects are not quickpanel windows.
4096     *
4097     * @param obj The window object
4098     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4099     */
4100    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4101    /**
4102     * Get if this window is a quickpanel or not
4103     *
4104     * @param obj The window object
4105     * @return A boolean if this window is a quickpanel or not
4106     */
4107    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4108    /**
4109     * Set the major priority of a quickpanel window
4110     *
4111     * @param obj The window object
4112     * @param priority The major priority for this quickpanel
4113     */
4114    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4115    /**
4116     * Get the major priority of a quickpanel window
4117     *
4118     * @param obj The window object
4119     * @return The major priority of this quickpanel
4120     */
4121    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4122    /**
4123     * Set the minor priority of a quickpanel window
4124     *
4125     * @param obj The window object
4126     * @param priority The minor priority for this quickpanel
4127     */
4128    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4129    /**
4130     * Get the minor priority of a quickpanel window
4131     *
4132     * @param obj The window object
4133     * @return The minor priority of this quickpanel
4134     */
4135    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4136    /**
4137     * Set which zone this quickpanel should appear in
4138     *
4139     * @param obj The window object
4140     * @param zone The requested zone for this quickpanel
4141     */
4142    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4143    /**
4144     * Get which zone this quickpanel should appear in
4145     *
4146     * @param obj The window object
4147     * @return The requested zone for this quickpanel
4148     */
4149    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4150    /**
4151     * Set the window to be skipped by keyboard focus
4152     *
4153     * This sets the window to be skipped by normal keyboard input. This means
4154     * a window manager will be asked to not focus this window as well as omit
4155     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4156     *
4157     * Call this and enable it on a window BEFORE you show it for the first time,
4158     * otherwise it may have no effect.
4159     *
4160     * Use this for windows that have only output information or might only be
4161     * interacted with by the mouse or fingers, and never for typing input.
4162     * Be careful that this may have side-effects like making the window
4163     * non-accessible in some cases unless the window is specially handled. Use
4164     * this with care.
4165     *
4166     * @param obj The window object
4167     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4168     */
4169    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4170    /**
4171     * Send a command to the windowing environment
4172     *
4173     * This is intended to work in touchscreen or small screen device
4174     * environments where there is a more simplistic window management policy in
4175     * place. This uses the window object indicated to select which part of the
4176     * environment to control (the part that this window lives in), and provides
4177     * a command and an optional parameter structure (use NULL for this if not
4178     * needed).
4179     *
4180     * @param obj The window object that lives in the environment to control
4181     * @param command The command to send
4182     * @param params Optional parameters for the command
4183     */
4184    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4185    /**
4186     * Get the inlined image object handle
4187     *
4188     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4189     * then the window is in fact an evas image object inlined in the parent
4190     * canvas. You can get this object (be careful to not manipulate it as it
4191     * is under control of elementary), and use it to do things like get pixel
4192     * data, save the image to a file, etc.
4193     *
4194     * @param obj The window object to get the inlined image from
4195     * @return The inlined image object, or NULL if none exists
4196     */
4197    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4198    /**
4199     * Set the enabled status for the focus highlight in a window
4200     *
4201     * This function will enable or disable the focus highlight only for the
4202     * given window, regardless of the global setting for it
4203     *
4204     * @param obj The window where to enable the highlight
4205     * @param enabled The enabled value for the highlight
4206     */
4207    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4208    /**
4209     * Get the enabled value of the focus highlight for this window
4210     *
4211     * @param obj The window in which to check if the focus highlight is enabled
4212     *
4213     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4214     */
4215    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4216    /**
4217     * Set the style for the focus highlight on this window
4218     *
4219     * Sets the style to use for theming the highlight of focused objects on
4220     * the given window. If @p style is NULL, the default will be used.
4221     *
4222     * @param obj The window where to set the style
4223     * @param style The style to set
4224     */
4225    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4226    /**
4227     * Get the style set for the focus highlight object
4228     *
4229     * Gets the style set for this windows highilght object, or NULL if none
4230     * is set.
4231     *
4232     * @param obj The window to retrieve the highlights style from
4233     *
4234     * @return The style set or NULL if none was. Default is used in that case.
4235     */
4236    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4237    /*...
4238     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4239     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4240     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4241     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4242     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4243     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4244     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4245     *
4246     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4247     * (blank mouse, private mouse obj, defaultmouse)
4248     *
4249     */
4250    /**
4251     * Sets the keyboard mode of the window.
4252     *
4253     * @param obj The window object
4254     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4255     */
4256    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4257    /**
4258     * Gets the keyboard mode of the window.
4259     *
4260     * @param obj The window object
4261     * @return The mode, one of #Elm_Win_Keyboard_Mode
4262     */
4263    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4264    /**
4265     * Sets whether the window is a keyboard.
4266     *
4267     * @param obj The window object
4268     * @param is_keyboard If true, the window is a virtual keyboard
4269     */
4270    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4271    /**
4272     * Gets whether the window is a keyboard.
4273     *
4274     * @param obj The window object
4275     * @return If the window is a virtual keyboard
4276     */
4277    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4278
4279    /**
4280     * Get the screen position of a window.
4281     *
4282     * @param obj The window object
4283     * @param x The int to store the x coordinate to
4284     * @param y The int to store the y coordinate to
4285     */
4286    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4287    /**
4288     * @}
4289     */
4290
4291    /**
4292     * @defgroup Inwin Inwin
4293     *
4294     * @image html img/widget/inwin/preview-00.png
4295     * @image latex img/widget/inwin/preview-00.eps
4296     * @image html img/widget/inwin/preview-01.png
4297     * @image latex img/widget/inwin/preview-01.eps
4298     * @image html img/widget/inwin/preview-02.png
4299     * @image latex img/widget/inwin/preview-02.eps
4300     *
4301     * An inwin is a window inside a window that is useful for a quick popup.
4302     * It does not hover.
4303     *
4304     * It works by creating an object that will occupy the entire window, so it
4305     * must be created using an @ref Win "elm_win" as parent only. The inwin
4306     * object can be hidden or restacked below every other object if it's
4307     * needed to show what's behind it without destroying it. If this is done,
4308     * the elm_win_inwin_activate() function can be used to bring it back to
4309     * full visibility again.
4310     *
4311     * There are three styles available in the default theme. These are:
4312     * @li default: The inwin is sized to take over most of the window it's
4313     * placed in.
4314     * @li minimal: The size of the inwin will be the minimum necessary to show
4315     * its contents.
4316     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4317     * possible, but it's sized vertically the most it needs to fit its\
4318     * contents.
4319     *
4320     * Some examples of Inwin can be found in the following:
4321     * @li @ref inwin_example_01
4322     *
4323     * @{
4324     */
4325    /**
4326     * Adds an inwin to the current window
4327     *
4328     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4329     * Never call this function with anything other than the top-most window
4330     * as its parameter, unless you are fond of undefined behavior.
4331     *
4332     * After creating the object, the widget will set itself as resize object
4333     * for the window with elm_win_resize_object_add(), so when shown it will
4334     * appear to cover almost the entire window (how much of it depends on its
4335     * content and the style used). It must not be added into other container
4336     * objects and it needs not be moved or resized manually.
4337     *
4338     * @param parent The parent object
4339     * @return The new object or NULL if it cannot be created
4340     */
4341    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4342    /**
4343     * Activates an inwin object, ensuring its visibility
4344     *
4345     * This function will make sure that the inwin @p obj is completely visible
4346     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4347     * to the front. It also sets the keyboard focus to it, which will be passed
4348     * onto its content.
4349     *
4350     * The object's theme will also receive the signal "elm,action,show" with
4351     * source "elm".
4352     *
4353     * @param obj The inwin to activate
4354     */
4355    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4356    /**
4357     * Set the content of an inwin object.
4358     *
4359     * Once the content object is set, a previously set one will be deleted.
4360     * If you want to keep that old content object, use the
4361     * elm_win_inwin_content_unset() function.
4362     *
4363     * @param obj The inwin object
4364     * @param content The object to set as content
4365     */
4366    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4367    /**
4368     * Get the content of an inwin object.
4369     *
4370     * Return the content object which is set for this widget.
4371     *
4372     * The returned object is valid as long as the inwin is still alive and no
4373     * other content is set on it. Deleting the object will notify the inwin
4374     * about it and this one will be left empty.
4375     *
4376     * If you need to remove an inwin's content to be reused somewhere else,
4377     * see elm_win_inwin_content_unset().
4378     *
4379     * @param obj The inwin object
4380     * @return The content that is being used
4381     */
4382    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4383    /**
4384     * Unset the content of an inwin object.
4385     *
4386     * Unparent and return the content object which was set for this widget.
4387     *
4388     * @param obj The inwin object
4389     * @return The content that was being used
4390     */
4391    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4392    /**
4393     * @}
4394     */
4395    /* X specific calls - won't work on non-x engines (return 0) */
4396
4397    /**
4398     * Get the Ecore_X_Window of an Evas_Object
4399     *
4400     * @param obj The object
4401     *
4402     * @return The Ecore_X_Window of @p obj
4403     *
4404     * @ingroup Win
4405     */
4406    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4407
4408    /* smart callbacks called:
4409     * "delete,request" - the user requested to delete the window
4410     * "focus,in" - window got focus
4411     * "focus,out" - window lost focus
4412     * "moved" - window that holds the canvas was moved
4413     */
4414
4415    /**
4416     * @defgroup Bg Bg
4417     *
4418     * @image html img/widget/bg/preview-00.png
4419     * @image latex img/widget/bg/preview-00.eps
4420     *
4421     * @brief Background object, used for setting a solid color, image or Edje
4422     * group as background to a window or any container object.
4423     *
4424     * The bg object is used for setting a solid background to a window or
4425     * packing into any container object. It works just like an image, but has
4426     * some properties useful to a background, like setting it to tiled,
4427     * centered, scaled or stretched.
4428     *
4429     * Here is some sample code using it:
4430     * @li @ref bg_01_example_page
4431     * @li @ref bg_02_example_page
4432     * @li @ref bg_03_example_page
4433     */
4434
4435    /* bg */
4436    typedef enum _Elm_Bg_Option
4437      {
4438         ELM_BG_OPTION_CENTER,  /**< center the background */
4439         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4440         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4441         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4442      } Elm_Bg_Option;
4443
4444    /**
4445     * Add a new background to the parent
4446     *
4447     * @param parent The parent object
4448     * @return The new object or NULL if it cannot be created
4449     *
4450     * @ingroup Bg
4451     */
4452    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4453
4454    /**
4455     * Set the file (image or edje) used for the background
4456     *
4457     * @param obj The bg object
4458     * @param file The file path
4459     * @param group Optional key (group in Edje) within the file
4460     *
4461     * This sets the image file used in the background object. The image (or edje)
4462     * will be stretched (retaining aspect if its an image file) to completely fill
4463     * the bg object. This may mean some parts are not visible.
4464     *
4465     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4466     * even if @p file is NULL.
4467     *
4468     * @ingroup Bg
4469     */
4470    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4471
4472    /**
4473     * Get the file (image or edje) used for the background
4474     *
4475     * @param obj The bg object
4476     * @param file The file path
4477     * @param group Optional key (group in Edje) within the file
4478     *
4479     * @ingroup Bg
4480     */
4481    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4482
4483    /**
4484     * Set the option used for the background image
4485     *
4486     * @param obj The bg object
4487     * @param option The desired background option (TILE, SCALE)
4488     *
4489     * This sets the option used for manipulating the display of the background
4490     * image. The image can be tiled or scaled.
4491     *
4492     * @ingroup Bg
4493     */
4494    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4495
4496    /**
4497     * Get the option used for the background image
4498     *
4499     * @param obj The bg object
4500     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4501     *
4502     * @ingroup Bg
4503     */
4504    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4505    /**
4506     * Set the option used for the background color
4507     *
4508     * @param obj The bg object
4509     * @param r
4510     * @param g
4511     * @param b
4512     *
4513     * This sets the color used for the background rectangle. Its range goes
4514     * from 0 to 255.
4515     *
4516     * @ingroup Bg
4517     */
4518    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4519    /**
4520     * Get the option used for the background color
4521     *
4522     * @param obj The bg object
4523     * @param r
4524     * @param g
4525     * @param b
4526     *
4527     * @ingroup Bg
4528     */
4529    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4530
4531    /**
4532     * Set the overlay object used for the background object.
4533     *
4534     * @param obj The bg object
4535     * @param overlay The overlay object
4536     *
4537     * This provides a way for elm_bg to have an 'overlay' that will be on top
4538     * of the bg. Once the over object is set, a previously set one will be
4539     * deleted, even if you set the new one to NULL. If you want to keep that
4540     * old content object, use the elm_bg_overlay_unset() function.
4541     *
4542     * @ingroup Bg
4543     */
4544
4545    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4546
4547    /**
4548     * Get the overlay object used for the background object.
4549     *
4550     * @param obj The bg object
4551     * @return The content that is being used
4552     *
4553     * Return the content object which is set for this widget
4554     *
4555     * @ingroup Bg
4556     */
4557    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4558
4559    /**
4560     * Get the overlay object used for the background object.
4561     *
4562     * @param obj The bg object
4563     * @return The content that was being used
4564     *
4565     * Unparent and return the overlay object which was set for this widget
4566     *
4567     * @ingroup Bg
4568     */
4569    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4570
4571    /**
4572     * Set the size of the pixmap representation of the image.
4573     *
4574     * This option just makes sense if an image is going to be set in the bg.
4575     *
4576     * @param obj The bg object
4577     * @param w The new width of the image pixmap representation.
4578     * @param h The new height of the image pixmap representation.
4579     *
4580     * This function sets a new size for pixmap representation of the given bg
4581     * image. It allows the image to be loaded already in the specified size,
4582     * reducing the memory usage and load time when loading a big image with load
4583     * size set to a smaller size.
4584     *
4585     * NOTE: this is just a hint, the real size of the pixmap may differ
4586     * depending on the type of image being loaded, being bigger than requested.
4587     *
4588     * @ingroup Bg
4589     */
4590    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4591    /* smart callbacks called:
4592     */
4593
4594    /**
4595     * @defgroup Icon Icon
4596     *
4597     * @image html img/widget/icon/preview-00.png
4598     * @image latex img/widget/icon/preview-00.eps
4599     *
4600     * An object that provides standard icon images (delete, edit, arrows, etc.)
4601     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4602     *
4603     * The icon image requested can be in the elementary theme, or in the
4604     * freedesktop.org paths. It's possible to set the order of preference from
4605     * where the image will be used.
4606     *
4607     * This API is very similar to @ref Image, but with ready to use images.
4608     *
4609     * Default images provided by the theme are described below.
4610     *
4611     * The first list contains icons that were first intended to be used in
4612     * toolbars, but can be used in many other places too:
4613     * @li home
4614     * @li close
4615     * @li apps
4616     * @li arrow_up
4617     * @li arrow_down
4618     * @li arrow_left
4619     * @li arrow_right
4620     * @li chat
4621     * @li clock
4622     * @li delete
4623     * @li edit
4624     * @li refresh
4625     * @li folder
4626     * @li file
4627     *
4628     * Now some icons that were designed to be used in menus (but again, you can
4629     * use them anywhere else):
4630     * @li menu/home
4631     * @li menu/close
4632     * @li menu/apps
4633     * @li menu/arrow_up
4634     * @li menu/arrow_down
4635     * @li menu/arrow_left
4636     * @li menu/arrow_right
4637     * @li menu/chat
4638     * @li menu/clock
4639     * @li menu/delete
4640     * @li menu/edit
4641     * @li menu/refresh
4642     * @li menu/folder
4643     * @li menu/file
4644     *
4645     * And here we have some media player specific icons:
4646     * @li media_player/forward
4647     * @li media_player/info
4648     * @li media_player/next
4649     * @li media_player/pause
4650     * @li media_player/play
4651     * @li media_player/prev
4652     * @li media_player/rewind
4653     * @li media_player/stop
4654     *
4655     * Signals that you can add callbacks for are:
4656     *
4657     * "clicked" - This is called when a user has clicked the icon
4658     *
4659     * An example of usage for this API follows:
4660     * @li @ref tutorial_icon
4661     */
4662
4663    /**
4664     * @addtogroup Icon
4665     * @{
4666     */
4667
4668    typedef enum _Elm_Icon_Type
4669      {
4670         ELM_ICON_NONE,
4671         ELM_ICON_FILE,
4672         ELM_ICON_STANDARD
4673      } Elm_Icon_Type;
4674    /**
4675     * @enum _Elm_Icon_Lookup_Order
4676     * @typedef Elm_Icon_Lookup_Order
4677     *
4678     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4679     * theme, FDO paths, or both?
4680     *
4681     * @ingroup Icon
4682     */
4683    typedef enum _Elm_Icon_Lookup_Order
4684      {
4685         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4686         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4687         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4688         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4689      } Elm_Icon_Lookup_Order;
4690
4691    /**
4692     * Add a new icon object to the parent.
4693     *
4694     * @param parent The parent object
4695     * @return The new object or NULL if it cannot be created
4696     *
4697     * @see elm_icon_file_set()
4698     *
4699     * @ingroup Icon
4700     */
4701    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4702    /**
4703     * Set the file that will be used as icon.
4704     *
4705     * @param obj The icon object
4706     * @param file The path to file that will be used as icon image
4707     * @param group The group that the icon belongs to in edje file
4708     *
4709     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4710     *
4711     * @note The icon image set by this function can be changed by
4712     * elm_icon_standard_set().
4713     *
4714     * @see elm_icon_file_get()
4715     *
4716     * @ingroup Icon
4717     */
4718    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4719    /**
4720     * Set a location in memory to be used as an icon
4721     *
4722     * @param obj The icon object
4723     * @param img The binary data that will be used as an image
4724     * @param size The size of binary data @p img
4725     * @param format Optional format of @p img to pass to the image loader
4726     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4727     *
4728     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4729     *
4730     * @note The icon image set by this function can be changed by
4731     * elm_icon_standard_set().
4732     *
4733     * @ingroup Icon
4734     */
4735    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);
4736    /**
4737     * Get the file that will be used as icon.
4738     *
4739     * @param obj The icon object
4740     * @param file The path to file that will be used as icon icon image
4741     * @param group The group that the icon belongs to in edje file
4742     *
4743     * @see elm_icon_file_set()
4744     *
4745     * @ingroup Icon
4746     */
4747    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4748    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4749    /**
4750     * Set the icon by icon standards names.
4751     *
4752     * @param obj The icon object
4753     * @param name The icon name
4754     *
4755     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4756     *
4757     * For example, freedesktop.org defines standard icon names such as "home",
4758     * "network", etc. There can be different icon sets to match those icon
4759     * keys. The @p name given as parameter is one of these "keys", and will be
4760     * used to look in the freedesktop.org paths and elementary theme. One can
4761     * change the lookup order with elm_icon_order_lookup_set().
4762     *
4763     * If name is not found in any of the expected locations and it is the
4764     * absolute path of an image file, this image will be used.
4765     *
4766     * @note The icon image set by this function can be changed by
4767     * elm_icon_file_set().
4768     *
4769     * @see elm_icon_standard_get()
4770     * @see elm_icon_file_set()
4771     *
4772     * @ingroup Icon
4773     */
4774    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4775    /**
4776     * Get the icon name set by icon standard names.
4777     *
4778     * @param obj The icon object
4779     * @return The icon name
4780     *
4781     * If the icon image was set using elm_icon_file_set() instead of
4782     * elm_icon_standard_set(), then this function will return @c NULL.
4783     *
4784     * @see elm_icon_standard_set()
4785     *
4786     * @ingroup Icon
4787     */
4788    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4789    /**
4790     * Set the smooth effect for an icon object.
4791     *
4792     * @param obj The icon object
4793     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4794     * otherwise. Default is @c EINA_TRUE.
4795     *
4796     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4797     * scaling provides a better resulting image, but is slower.
4798     *
4799     * The smooth scaling should be disabled when making animations that change
4800     * the icon size, since they will be faster. Animations that don't require
4801     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4802     * is already scaled, since the scaled icon image will be cached).
4803     *
4804     * @see elm_icon_smooth_get()
4805     *
4806     * @ingroup Icon
4807     */
4808    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4809    /**
4810     * Get the smooth effect for an icon object.
4811     *
4812     * @param obj The icon object
4813     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4814     *
4815     * @see elm_icon_smooth_set()
4816     *
4817     * @ingroup Icon
4818     */
4819    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4820    /**
4821     * Disable scaling of this object.
4822     *
4823     * @param obj The icon object.
4824     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4825     * otherwise. Default is @c EINA_FALSE.
4826     *
4827     * This function disables scaling of the icon object through the function
4828     * elm_object_scale_set(). However, this does not affect the object
4829     * size/resize in any way. For that effect, take a look at
4830     * elm_icon_scale_set().
4831     *
4832     * @see elm_icon_no_scale_get()
4833     * @see elm_icon_scale_set()
4834     * @see elm_object_scale_set()
4835     *
4836     * @ingroup Icon
4837     */
4838    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4839    /**
4840     * Get whether scaling is disabled on the object.
4841     *
4842     * @param obj The icon object
4843     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4844     *
4845     * @see elm_icon_no_scale_set()
4846     *
4847     * @ingroup Icon
4848     */
4849    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4850    /**
4851     * Set if the object is (up/down) resizable.
4852     *
4853     * @param obj The icon object
4854     * @param scale_up A bool to set if the object is resizable up. Default is
4855     * @c EINA_TRUE.
4856     * @param scale_down A bool to set if the object is resizable down. Default
4857     * is @c EINA_TRUE.
4858     *
4859     * This function limits the icon object resize ability. If @p scale_up is set to
4860     * @c EINA_FALSE, the object can't have its height or width resized to a value
4861     * higher than the original icon size. Same is valid for @p scale_down.
4862     *
4863     * @see elm_icon_scale_get()
4864     *
4865     * @ingroup Icon
4866     */
4867    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4868    /**
4869     * Get if the object is (up/down) resizable.
4870     *
4871     * @param obj The icon object
4872     * @param scale_up A bool to set if the object is resizable up
4873     * @param scale_down A bool to set if the object is resizable down
4874     *
4875     * @see elm_icon_scale_set()
4876     *
4877     * @ingroup Icon
4878     */
4879    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4880    /**
4881     * Get the object's image size
4882     *
4883     * @param obj The icon object
4884     * @param w A pointer to store the width in
4885     * @param h A pointer to store the height in
4886     *
4887     * @ingroup Icon
4888     */
4889    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4890    /**
4891     * Set if the icon fill the entire object area.
4892     *
4893     * @param obj The icon object
4894     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4895     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4896     *
4897     * When the icon object is resized to a different aspect ratio from the
4898     * original icon image, the icon image will still keep its aspect. This flag
4899     * tells how the image should fill the object's area. They are: keep the
4900     * entire icon inside the limits of height and width of the object (@p
4901     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4902     * of the object, and the icon will fill the entire object (@p fill_outside
4903     * is @c EINA_TRUE).
4904     *
4905     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4906     * retain property to false. Thus, the icon image will always keep its
4907     * original aspect ratio.
4908     *
4909     * @see elm_icon_fill_outside_get()
4910     * @see elm_image_fill_outside_set()
4911     *
4912     * @ingroup Icon
4913     */
4914    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4915    /**
4916     * Get if the object is filled outside.
4917     *
4918     * @param obj The icon object
4919     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4920     *
4921     * @see elm_icon_fill_outside_set()
4922     *
4923     * @ingroup Icon
4924     */
4925    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4926    /**
4927     * Set the prescale size for the icon.
4928     *
4929     * @param obj The icon object
4930     * @param size The prescale size. This value is used for both width and
4931     * height.
4932     *
4933     * This function sets a new size for pixmap representation of the given
4934     * icon. It allows the icon to be loaded already in the specified size,
4935     * reducing the memory usage and load time when loading a big icon with load
4936     * size set to a smaller size.
4937     *
4938     * It's equivalent to the elm_bg_load_size_set() function for bg.
4939     *
4940     * @note this is just a hint, the real size of the pixmap may differ
4941     * depending on the type of icon being loaded, being bigger than requested.
4942     *
4943     * @see elm_icon_prescale_get()
4944     * @see elm_bg_load_size_set()
4945     *
4946     * @ingroup Icon
4947     */
4948    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4949    /**
4950     * Get the prescale size for the icon.
4951     *
4952     * @param obj The icon object
4953     * @return The prescale size
4954     *
4955     * @see elm_icon_prescale_set()
4956     *
4957     * @ingroup Icon
4958     */
4959    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4960    /**
4961     * Sets the icon lookup order used by elm_icon_standard_set().
4962     *
4963     * @param obj The icon object
4964     * @param order The icon lookup order (can be one of
4965     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4966     * or ELM_ICON_LOOKUP_THEME)
4967     *
4968     * @see elm_icon_order_lookup_get()
4969     * @see Elm_Icon_Lookup_Order
4970     *
4971     * @ingroup Icon
4972     */
4973    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4974    /**
4975     * Gets the icon lookup order.
4976     *
4977     * @param obj The icon object
4978     * @return The icon lookup order
4979     *
4980     * @see elm_icon_order_lookup_set()
4981     * @see Elm_Icon_Lookup_Order
4982     *
4983     * @ingroup Icon
4984     */
4985    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4986    /**
4987     * Get if the icon supports animation or not.
4988     *
4989     * @param obj The icon object
4990     * @return @c EINA_TRUE if the icon supports animation,
4991     *         @c EINA_FALSE otherwise.
4992     *
4993     * Return if this elm icon's image can be animated. Currently Evas only
4994     * supports gif animation. If the return value is EINA_FALSE, other
4995     * elm_icon_animated_XXX APIs won't work.
4996     * @ingroup Icon
4997     */
4998    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4999    /**
5000     * Set animation mode of the icon.
5001     *
5002     * @param obj The icon object
5003     * @param anim @c EINA_TRUE if the object do animation job,
5004     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5005     *
5006     * Even though elm icon's file can be animated,
5007     * sometimes appication developer want to just first page of image.
5008     * In that time, don't call this function, because default value is EINA_FALSE
5009     * Only when you want icon support anition,
5010     * use this function and set animated to EINA_TURE
5011     * @ingroup Icon
5012     */
5013    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5014    /**
5015     * Get animation mode of the icon.
5016     *
5017     * @param obj The icon object
5018     * @return The animation mode of the icon object
5019     * @see elm_icon_animated_set
5020     * @ingroup Icon
5021     */
5022    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5023    /**
5024     * Set animation play mode of the icon.
5025     *
5026     * @param obj The icon object
5027     * @param play @c EINA_TRUE the object play animation images,
5028     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5029     *
5030     * If you want to play elm icon's animation, you set play to EINA_TURE.
5031     * For example, you make gif player using this set/get API and click event.
5032     *
5033     * 1. Click event occurs
5034     * 2. Check play flag using elm_icon_animaged_play_get
5035     * 3. If elm icon was playing, set play to EINA_FALSE.
5036     *    Then animation will be stopped and vice versa
5037     * @ingroup Icon
5038     */
5039    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5040    /**
5041     * Get animation play mode of the icon.
5042     *
5043     * @param obj The icon object
5044     * @return The play mode of the icon object
5045     *
5046     * @see elm_icon_animated_lay_get
5047     * @ingroup Icon
5048     */
5049    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5050
5051    /**
5052     * @}
5053     */
5054
5055    /**
5056     * @defgroup Image Image
5057     *
5058     * @image html img/widget/image/preview-00.png
5059     * @image latex img/widget/image/preview-00.eps
5060
5061     *
5062     * An object that allows one to load an image file to it. It can be used
5063     * anywhere like any other elementary widget.
5064     *
5065     * This widget provides most of the functionality provided from @ref Bg or @ref
5066     * Icon, but with a slightly different API (use the one that fits better your
5067     * needs).
5068     *
5069     * The features not provided by those two other image widgets are:
5070     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5071     * @li change the object orientation with elm_image_orient_set();
5072     * @li and turning the image editable with elm_image_editable_set().
5073     *
5074     * Signals that you can add callbacks for are:
5075     *
5076     * @li @c "clicked" - This is called when a user has clicked the image
5077     *
5078     * An example of usage for this API follows:
5079     * @li @ref tutorial_image
5080     */
5081
5082    /**
5083     * @addtogroup Image
5084     * @{
5085     */
5086
5087    /**
5088     * @enum _Elm_Image_Orient
5089     * @typedef Elm_Image_Orient
5090     *
5091     * Possible orientation options for elm_image_orient_set().
5092     *
5093     * @image html elm_image_orient_set.png
5094     * @image latex elm_image_orient_set.eps width=\textwidth
5095     *
5096     * @ingroup Image
5097     */
5098    typedef enum _Elm_Image_Orient
5099      {
5100         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5101         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5102         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5103         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5104         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5105         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5106         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5107         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5108      } Elm_Image_Orient;
5109
5110    /**
5111     * Add a new image to the parent.
5112     *
5113     * @param parent The parent object
5114     * @return The new object or NULL if it cannot be created
5115     *
5116     * @see elm_image_file_set()
5117     *
5118     * @ingroup Image
5119     */
5120    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5121    /**
5122     * Set the file that will be used as image.
5123     *
5124     * @param obj The image object
5125     * @param file The path to file that will be used as image
5126     * @param group The group that the image belongs in edje file (if it's an
5127     * edje image)
5128     *
5129     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5130     *
5131     * @see elm_image_file_get()
5132     *
5133     * @ingroup Image
5134     */
5135    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5136    /**
5137     * Get the file that will be used as image.
5138     *
5139     * @param obj The image object
5140     * @param file The path to file
5141     * @param group The group that the image belongs in edje file
5142     *
5143     * @see elm_image_file_set()
5144     *
5145     * @ingroup Image
5146     */
5147    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5148    /**
5149     * Set the smooth effect for an image.
5150     *
5151     * @param obj The image object
5152     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5153     * otherwise. Default is @c EINA_TRUE.
5154     *
5155     * Set the scaling algorithm to be used when scaling the image. Smooth
5156     * scaling provides a better resulting image, but is slower.
5157     *
5158     * The smooth scaling should be disabled when making animations that change
5159     * the image size, since it will be faster. Animations that don't require
5160     * resizing of the image can keep the smooth scaling enabled (even if the
5161     * image is already scaled, since the scaled image will be cached).
5162     *
5163     * @see elm_image_smooth_get()
5164     *
5165     * @ingroup Image
5166     */
5167    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5168    /**
5169     * Get the smooth effect for an image.
5170     *
5171     * @param obj The image object
5172     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5173     *
5174     * @see elm_image_smooth_get()
5175     *
5176     * @ingroup Image
5177     */
5178    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5179    /**
5180     * Gets the current size of the image.
5181     *
5182     * @param obj The image object.
5183     * @param w Pointer to store width, or NULL.
5184     * @param h Pointer to store height, or NULL.
5185     *
5186     * This is the real size of the image, not the size of the object.
5187     *
5188     * On error, neither w or h will be written.
5189     *
5190     * @ingroup Image
5191     */
5192    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5193    /**
5194     * Disable scaling of this object.
5195     *
5196     * @param obj The image object.
5197     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5198     * otherwise. Default is @c EINA_FALSE.
5199     *
5200     * This function disables scaling of the elm_image widget through the
5201     * function elm_object_scale_set(). However, this does not affect the widget
5202     * size/resize in any way. For that effect, take a look at
5203     * elm_image_scale_set().
5204     *
5205     * @see elm_image_no_scale_get()
5206     * @see elm_image_scale_set()
5207     * @see elm_object_scale_set()
5208     *
5209     * @ingroup Image
5210     */
5211    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5212    /**
5213     * Get whether scaling is disabled on the object.
5214     *
5215     * @param obj The image object
5216     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5217     *
5218     * @see elm_image_no_scale_set()
5219     *
5220     * @ingroup Image
5221     */
5222    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5223    /**
5224     * Set if the object is (up/down) resizable.
5225     *
5226     * @param obj The image object
5227     * @param scale_up A bool to set if the object is resizable up. Default is
5228     * @c EINA_TRUE.
5229     * @param scale_down A bool to set if the object is resizable down. Default
5230     * is @c EINA_TRUE.
5231     *
5232     * This function limits the image resize ability. If @p scale_up is set to
5233     * @c EINA_FALSE, the object can't have its height or width resized to a value
5234     * higher than the original image size. Same is valid for @p scale_down.
5235     *
5236     * @see elm_image_scale_get()
5237     *
5238     * @ingroup Image
5239     */
5240    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5241    /**
5242     * Get if the object is (up/down) resizable.
5243     *
5244     * @param obj The image object
5245     * @param scale_up A bool to set if the object is resizable up
5246     * @param scale_down A bool to set if the object is resizable down
5247     *
5248     * @see elm_image_scale_set()
5249     *
5250     * @ingroup Image
5251     */
5252    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5253    /**
5254     * Set if the image fill the entire object area when keeping the aspect ratio.
5255     *
5256     * @param obj The image object
5257     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5258     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5259     *
5260     * When the image should keep its aspect ratio even if resized to another
5261     * aspect ratio, there are two possibilities to resize it: keep the entire
5262     * image inside the limits of height and width of the object (@p fill_outside
5263     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5264     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5265     *
5266     * @note This option will have no effect if
5267     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5268     *
5269     * @see elm_image_fill_outside_get()
5270     * @see elm_image_aspect_ratio_retained_set()
5271     *
5272     * @ingroup Image
5273     */
5274    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5275    /**
5276     * Get if the object is filled outside
5277     *
5278     * @param obj The image object
5279     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5280     *
5281     * @see elm_image_fill_outside_set()
5282     *
5283     * @ingroup Image
5284     */
5285    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5286    /**
5287     * Set the prescale size for the image
5288     *
5289     * @param obj The image object
5290     * @param size The prescale size. This value is used for both width and
5291     * height.
5292     *
5293     * This function sets a new size for pixmap representation of the given
5294     * image. It allows the image to be loaded already in the specified size,
5295     * reducing the memory usage and load time when loading a big image with load
5296     * size set to a smaller size.
5297     *
5298     * It's equivalent to the elm_bg_load_size_set() function for bg.
5299     *
5300     * @note this is just a hint, the real size of the pixmap may differ
5301     * depending on the type of image being loaded, being bigger than requested.
5302     *
5303     * @see elm_image_prescale_get()
5304     * @see elm_bg_load_size_set()
5305     *
5306     * @ingroup Image
5307     */
5308    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5309    /**
5310     * Get the prescale size for the image
5311     *
5312     * @param obj The image object
5313     * @return The prescale size
5314     *
5315     * @see elm_image_prescale_set()
5316     *
5317     * @ingroup Image
5318     */
5319    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5320    /**
5321     * Set the image orientation.
5322     *
5323     * @param obj The image object
5324     * @param orient The image orientation
5325     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5326     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5327     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5328     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5329     *  Default is #ELM_IMAGE_ORIENT_NONE.
5330     *
5331     * This function allows to rotate or flip the given image.
5332     *
5333     * @see elm_image_orient_get()
5334     * @see @ref Elm_Image_Orient
5335     *
5336     * @ingroup Image
5337     */
5338    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5339    /**
5340     * Get the image orientation.
5341     *
5342     * @param obj The image object
5343     * @return The image orientation
5344     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5345     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5346     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5347     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5348     *
5349     * @see elm_image_orient_set()
5350     * @see @ref Elm_Image_Orient
5351     *
5352     * @ingroup Image
5353     */
5354    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5355    /**
5356     * Make the image 'editable'.
5357     *
5358     * @param obj Image object.
5359     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5360     *
5361     * This means the image is a valid drag target for drag and drop, and can be
5362     * cut or pasted too.
5363     *
5364     * @ingroup Image
5365     */
5366    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5367    /**
5368     * Make the image 'editable'.
5369     *
5370     * @param obj Image object.
5371     * @return Editability.
5372     *
5373     * This means the image is a valid drag target for drag and drop, and can be
5374     * cut or pasted too.
5375     *
5376     * @ingroup Image
5377     */
5378    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5379    /**
5380     * Get the basic Evas_Image object from this object (widget).
5381     *
5382     * @param obj The image object to get the inlined image from
5383     * @return The inlined image object, or NULL if none exists
5384     *
5385     * This function allows one to get the underlying @c Evas_Object of type
5386     * Image from this elementary widget. It can be useful to do things like get
5387     * the pixel data, save the image to a file, etc.
5388     *
5389     * @note Be careful to not manipulate it, as it is under control of
5390     * elementary.
5391     *
5392     * @ingroup Image
5393     */
5394    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5395    /**
5396     * Set whether the original aspect ratio of the image should be kept on resize.
5397     *
5398     * @param obj The image object.
5399     * @param retained @c EINA_TRUE if the image should retain the aspect,
5400     * @c EINA_FALSE otherwise.
5401     *
5402     * The original aspect ratio (width / height) of the image is usually
5403     * distorted to match the object's size. Enabling this option will retain
5404     * this original aspect, and the way that the image is fit into the object's
5405     * area depends on the option set by elm_image_fill_outside_set().
5406     *
5407     * @see elm_image_aspect_ratio_retained_get()
5408     * @see elm_image_fill_outside_set()
5409     *
5410     * @ingroup Image
5411     */
5412    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5413    /**
5414     * Get if the object retains the original aspect ratio.
5415     *
5416     * @param obj The image object.
5417     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5418     * otherwise.
5419     *
5420     * @ingroup Image
5421     */
5422    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5423
5424    /**
5425     * @}
5426     */
5427
5428    /* glview */
5429    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5430
5431    typedef enum _Elm_GLView_Mode
5432      {
5433         ELM_GLVIEW_ALPHA   = 1,
5434         ELM_GLVIEW_DEPTH   = 2,
5435         ELM_GLVIEW_STENCIL = 4
5436      } Elm_GLView_Mode;
5437
5438    /**
5439     * Defines a policy for the glview resizing.
5440     *
5441     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5442     */
5443    typedef enum _Elm_GLView_Resize_Policy
5444      {
5445         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5446         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5447      } Elm_GLView_Resize_Policy;
5448
5449    typedef enum _Elm_GLView_Render_Policy
5450      {
5451         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5452         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5453      } Elm_GLView_Render_Policy;
5454
5455    /**
5456     * @defgroup GLView
5457     *
5458     * A simple GLView widget that allows GL rendering.
5459     *
5460     * Signals that you can add callbacks for are:
5461     *
5462     * @{
5463     */
5464
5465    /**
5466     * Add a new glview to the parent
5467     *
5468     * @param parent The parent object
5469     * @return The new object or NULL if it cannot be created
5470     *
5471     * @ingroup GLView
5472     */
5473    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5474
5475    /**
5476     * Sets the size of the glview
5477     *
5478     * @param obj The glview object
5479     * @param width width of the glview object
5480     * @param height height of the glview object
5481     *
5482     * @ingroup GLView
5483     */
5484    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5485
5486    /**
5487     * Gets the size of the glview.
5488     *
5489     * @param obj The glview object
5490     * @param width width of the glview object
5491     * @param height height of the glview object
5492     *
5493     * Note that this function returns the actual image size of the
5494     * glview.  This means that when the scale policy is set to
5495     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5496     * size.
5497     *
5498     * @ingroup GLView
5499     */
5500    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5501
5502    /**
5503     * Gets the gl api struct for gl rendering
5504     *
5505     * @param obj The glview object
5506     * @return The api object or NULL if it cannot be created
5507     *
5508     * @ingroup GLView
5509     */
5510    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5511
5512    /**
5513     * Set the mode of the GLView. Supports Three simple modes.
5514     *
5515     * @param obj The glview object
5516     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5517     * @return True if set properly.
5518     *
5519     * @ingroup GLView
5520     */
5521    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5522
5523    /**
5524     * Set the resize policy for the glview object.
5525     *
5526     * @param obj The glview object.
5527     * @param policy The scaling policy.
5528     *
5529     * By default, the resize policy is set to
5530     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5531     * destroys the previous surface and recreates the newly specified
5532     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5533     * however, glview only scales the image object and not the underlying
5534     * GL Surface.
5535     *
5536     * @ingroup GLView
5537     */
5538    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5539
5540    /**
5541     * Set the render policy for the glview object.
5542     *
5543     * @param obj The glview object.
5544     * @param policy The render policy.
5545     *
5546     * By default, the render policy is set to
5547     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5548     * that during the render loop, glview is only redrawn if it needs
5549     * to be redrawn. (i.e. When it is visible) If the policy is set to
5550     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5551     * whether it is visible/need redrawing or not.
5552     *
5553     * @ingroup GLView
5554     */
5555    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5556
5557    /**
5558     * Set the init function that runs once in the main loop.
5559     *
5560     * @param obj The glview object.
5561     * @param func The init function to be registered.
5562     *
5563     * The registered init function gets called once during the render loop.
5564     *
5565     * @ingroup GLView
5566     */
5567    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5568
5569    /**
5570     * Set the render function that runs in the main loop.
5571     *
5572     * @param obj The glview object.
5573     * @param func The delete function to be registered.
5574     *
5575     * The registered del function gets called when GLView object is deleted.
5576     *
5577     * @ingroup GLView
5578     */
5579    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5580
5581    /**
5582     * Set the resize function that gets called when resize happens.
5583     *
5584     * @param obj The glview object.
5585     * @param func The resize function to be registered.
5586     *
5587     * @ingroup GLView
5588     */
5589    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5590
5591    /**
5592     * Set the render function that runs in the main loop.
5593     *
5594     * @param obj The glview object.
5595     * @param func The render function to be registered.
5596     *
5597     * @ingroup GLView
5598     */
5599    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5600
5601    /**
5602     * Notifies that there has been changes in the GLView.
5603     *
5604     * @param obj The glview object.
5605     *
5606     * @ingroup GLView
5607     */
5608    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5609
5610    /**
5611     * @}
5612     */
5613
5614    /* box */
5615    /**
5616     * @defgroup Box Box
5617     *
5618     * @image html img/widget/box/preview-00.png
5619     * @image latex img/widget/box/preview-00.eps width=\textwidth
5620     *
5621     * @image html img/box.png
5622     * @image latex img/box.eps width=\textwidth
5623     *
5624     * A box arranges objects in a linear fashion, governed by a layout function
5625     * that defines the details of this arrangement.
5626     *
5627     * By default, the box will use an internal function to set the layout to
5628     * a single row, either vertical or horizontal. This layout is affected
5629     * by a number of parameters, such as the homogeneous flag set by
5630     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5631     * elm_box_align_set() and the hints set to each object in the box.
5632     *
5633     * For this default layout, it's possible to change the orientation with
5634     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5635     * placing its elements ordered from top to bottom. When horizontal is set,
5636     * the order will go from left to right. If the box is set to be
5637     * homogeneous, every object in it will be assigned the same space, that
5638     * of the largest object. Padding can be used to set some spacing between
5639     * the cell given to each object. The alignment of the box, set with
5640     * elm_box_align_set(), determines how the bounding box of all the elements
5641     * will be placed within the space given to the box widget itself.
5642     *
5643     * The size hints of each object also affect how they are placed and sized
5644     * within the box. evas_object_size_hint_min_set() will give the minimum
5645     * size the object can have, and the box will use it as the basis for all
5646     * latter calculations. Elementary widgets set their own minimum size as
5647     * needed, so there's rarely any need to use it manually.
5648     *
5649     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5650     * used to tell whether the object will be allocated the minimum size it
5651     * needs or if the space given to it should be expanded. It's important
5652     * to realize that expanding the size given to the object is not the same
5653     * thing as resizing the object. It could very well end being a small
5654     * widget floating in a much larger empty space. If not set, the weight
5655     * for objects will normally be 0.0 for both axis, meaning the widget will
5656     * not be expanded. To take as much space possible, set the weight to
5657     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5658     *
5659     * Besides how much space each object is allocated, it's possible to control
5660     * how the widget will be placed within that space using
5661     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5662     * for both axis, meaning the object will be centered, but any value from
5663     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5664     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5665     * is -1.0, means the object will be resized to fill the entire space it
5666     * was allocated.
5667     *
5668     * In addition, customized functions to define the layout can be set, which
5669     * allow the application developer to organize the objects within the box
5670     * in any number of ways.
5671     *
5672     * The special elm_box_layout_transition() function can be used
5673     * to switch from one layout to another, animating the motion of the
5674     * children of the box.
5675     *
5676     * @note Objects should not be added to box objects using _add() calls.
5677     *
5678     * Some examples on how to use boxes follow:
5679     * @li @ref box_example_01
5680     * @li @ref box_example_02
5681     *
5682     * @{
5683     */
5684    /**
5685     * @typedef Elm_Box_Transition
5686     *
5687     * Opaque handler containing the parameters to perform an animated
5688     * transition of the layout the box uses.
5689     *
5690     * @see elm_box_transition_new()
5691     * @see elm_box_layout_set()
5692     * @see elm_box_layout_transition()
5693     */
5694    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5695
5696    /**
5697     * Add a new box to the parent
5698     *
5699     * By default, the box will be in vertical mode and non-homogeneous.
5700     *
5701     * @param parent The parent object
5702     * @return The new object or NULL if it cannot be created
5703     */
5704    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5705    /**
5706     * Set the horizontal orientation
5707     *
5708     * By default, box object arranges their contents vertically from top to
5709     * bottom.
5710     * By calling this function with @p horizontal as EINA_TRUE, the box will
5711     * become horizontal, arranging contents from left to right.
5712     *
5713     * @note This flag is ignored if a custom layout function is set.
5714     *
5715     * @param obj The box object
5716     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5717     * EINA_FALSE = vertical)
5718     */
5719    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5720    /**
5721     * Get the horizontal orientation
5722     *
5723     * @param obj The box object
5724     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5725     */
5726    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5727    /**
5728     * Set the box to arrange its children homogeneously
5729     *
5730     * If enabled, homogeneous layout makes all items the same size, according
5731     * to the size of the largest of its children.
5732     *
5733     * @note This flag is ignored if a custom layout function is set.
5734     *
5735     * @param obj The box object
5736     * @param homogeneous The homogeneous flag
5737     */
5738    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5739    /**
5740     * Get whether the box is using homogeneous mode or not
5741     *
5742     * @param obj The box object
5743     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5744     */
5745    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5746    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5747    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5748    /**
5749     * Add an object to the beginning of the pack list
5750     *
5751     * Pack @p subobj into the box @p obj, placing it first in the list of
5752     * children objects. The actual position the object will get on screen
5753     * depends on the layout used. If no custom layout is set, it will be at
5754     * the top or left, depending if the box is vertical or horizontal,
5755     * respectively.
5756     *
5757     * @param obj The box object
5758     * @param subobj The object to add to the box
5759     *
5760     * @see elm_box_pack_end()
5761     * @see elm_box_pack_before()
5762     * @see elm_box_pack_after()
5763     * @see elm_box_unpack()
5764     * @see elm_box_unpack_all()
5765     * @see elm_box_clear()
5766     */
5767    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5768    /**
5769     * Add an object at the end of the pack list
5770     *
5771     * Pack @p subobj into the box @p obj, placing it last in the list of
5772     * children objects. The actual position the object will get on screen
5773     * depends on the layout used. If no custom layout is set, it will be at
5774     * the bottom or right, depending if the box is vertical or horizontal,
5775     * respectively.
5776     *
5777     * @param obj The box object
5778     * @param subobj The object to add to the box
5779     *
5780     * @see elm_box_pack_start()
5781     * @see elm_box_pack_before()
5782     * @see elm_box_pack_after()
5783     * @see elm_box_unpack()
5784     * @see elm_box_unpack_all()
5785     * @see elm_box_clear()
5786     */
5787    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5788    /**
5789     * Adds an object to the box before the indicated object
5790     *
5791     * This will add the @p subobj to the box indicated before the object
5792     * indicated with @p before. If @p before is not already in the box, results
5793     * are undefined. Before means either to the left of the indicated object or
5794     * above it depending on orientation.
5795     *
5796     * @param obj The box object
5797     * @param subobj The object to add to the box
5798     * @param before The object before which to add it
5799     *
5800     * @see elm_box_pack_start()
5801     * @see elm_box_pack_end()
5802     * @see elm_box_pack_after()
5803     * @see elm_box_unpack()
5804     * @see elm_box_unpack_all()
5805     * @see elm_box_clear()
5806     */
5807    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5808    /**
5809     * Adds an object to the box after the indicated object
5810     *
5811     * This will add the @p subobj to the box indicated after the object
5812     * indicated with @p after. If @p after is not already in the box, results
5813     * are undefined. After means either to the right of the indicated object or
5814     * below it depending on orientation.
5815     *
5816     * @param obj The box object
5817     * @param subobj The object to add to the box
5818     * @param after The object after which to add it
5819     *
5820     * @see elm_box_pack_start()
5821     * @see elm_box_pack_end()
5822     * @see elm_box_pack_before()
5823     * @see elm_box_unpack()
5824     * @see elm_box_unpack_all()
5825     * @see elm_box_clear()
5826     */
5827    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5828    /**
5829     * Clear the box of all children
5830     *
5831     * Remove all the elements contained by the box, deleting the respective
5832     * objects.
5833     *
5834     * @param obj The box object
5835     *
5836     * @see elm_box_unpack()
5837     * @see elm_box_unpack_all()
5838     */
5839    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5840    /**
5841     * Unpack a box item
5842     *
5843     * Remove the object given by @p subobj from the box @p obj without
5844     * deleting it.
5845     *
5846     * @param obj The box object
5847     *
5848     * @see elm_box_unpack_all()
5849     * @see elm_box_clear()
5850     */
5851    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5852    /**
5853     * Remove all items from the box, without deleting them
5854     *
5855     * Clear the box from all children, but don't delete the respective objects.
5856     * If no other references of the box children exist, the objects will never
5857     * be deleted, and thus the application will leak the memory. Make sure
5858     * when using this function that you hold a reference to all the objects
5859     * in the box @p obj.
5860     *
5861     * @param obj The box object
5862     *
5863     * @see elm_box_clear()
5864     * @see elm_box_unpack()
5865     */
5866    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5867    /**
5868     * Retrieve a list of the objects packed into the box
5869     *
5870     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5871     * The order of the list corresponds to the packing order the box uses.
5872     *
5873     * You must free this list with eina_list_free() once you are done with it.
5874     *
5875     * @param obj The box object
5876     */
5877    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5878    /**
5879     * Set the space (padding) between the box's elements.
5880     *
5881     * Extra space in pixels that will be added between a box child and its
5882     * neighbors after its containing cell has been calculated. This padding
5883     * is set for all elements in the box, besides any possible padding that
5884     * individual elements may have through their size hints.
5885     *
5886     * @param obj The box object
5887     * @param horizontal The horizontal space between elements
5888     * @param vertical The vertical space between elements
5889     */
5890    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5891    /**
5892     * Get the space (padding) between the box's elements.
5893     *
5894     * @param obj The box object
5895     * @param horizontal The horizontal space between elements
5896     * @param vertical The vertical space between elements
5897     *
5898     * @see elm_box_padding_set()
5899     */
5900    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5901    /**
5902     * Set the alignment of the whole bouding box of contents.
5903     *
5904     * Sets how the bounding box containing all the elements of the box, after
5905     * their sizes and position has been calculated, will be aligned within
5906     * the space given for the whole box widget.
5907     *
5908     * @param obj The box object
5909     * @param horizontal The horizontal alignment of elements
5910     * @param vertical The vertical alignment of elements
5911     */
5912    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5913    /**
5914     * Get the alignment of the whole bouding box of contents.
5915     *
5916     * @param obj The box object
5917     * @param horizontal The horizontal alignment of elements
5918     * @param vertical The vertical alignment of elements
5919     *
5920     * @see elm_box_align_set()
5921     */
5922    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5923
5924    /**
5925     * Force the box to recalculate its children packing.
5926     *
5927     * If any children was added or removed, box will not calculate the
5928     * values immediately rather leaving it to the next main loop
5929     * iteration. While this is great as it would save lots of
5930     * recalculation, whenever you need to get the position of a just
5931     * added item you must force recalculate before doing so.
5932     *
5933     * @param obj The box object.
5934     */
5935    EAPI void                 elm_box_recalculate(Evas_Object *obj);
5936
5937    /**
5938     * Set the layout defining function to be used by the box
5939     *
5940     * Whenever anything changes that requires the box in @p obj to recalculate
5941     * the size and position of its elements, the function @p cb will be called
5942     * to determine what the layout of the children will be.
5943     *
5944     * Once a custom function is set, everything about the children layout
5945     * is defined by it. The flags set by elm_box_horizontal_set() and
5946     * elm_box_homogeneous_set() no longer have any meaning, and the values
5947     * given by elm_box_padding_set() and elm_box_align_set() are up to this
5948     * layout function to decide if they are used and how. These last two
5949     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5950     * passed to @p cb. The @c Evas_Object the function receives is not the
5951     * Elementary widget, but the internal Evas Box it uses, so none of the
5952     * functions described here can be used on it.
5953     *
5954     * Any of the layout functions in @c Evas can be used here, as well as the
5955     * special elm_box_layout_transition().
5956     *
5957     * The final @p data argument received by @p cb is the same @p data passed
5958     * here, and the @p free_data function will be called to free it
5959     * whenever the box is destroyed or another layout function is set.
5960     *
5961     * Setting @p cb to NULL will revert back to the default layout function.
5962     *
5963     * @param obj The box object
5964     * @param cb The callback function used for layout
5965     * @param data Data that will be passed to layout function
5966     * @param free_data Function called to free @p data
5967     *
5968     * @see elm_box_layout_transition()
5969     */
5970    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);
5971    /**
5972     * Special layout function that animates the transition from one layout to another
5973     *
5974     * Normally, when switching the layout function for a box, this will be
5975     * reflected immediately on screen on the next render, but it's also
5976     * possible to do this through an animated transition.
5977     *
5978     * This is done by creating an ::Elm_Box_Transition and setting the box
5979     * layout to this function.
5980     *
5981     * For example:
5982     * @code
5983     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5984     *                            evas_object_box_layout_vertical, // start
5985     *                            NULL, // data for initial layout
5986     *                            NULL, // free function for initial data
5987     *                            evas_object_box_layout_horizontal, // end
5988     *                            NULL, // data for final layout
5989     *                            NULL, // free function for final data
5990     *                            anim_end, // will be called when animation ends
5991     *                            NULL); // data for anim_end function\
5992     * elm_box_layout_set(box, elm_box_layout_transition, t,
5993     *                    elm_box_transition_free);
5994     * @endcode
5995     *
5996     * @note This function can only be used with elm_box_layout_set(). Calling
5997     * it directly will not have the expected results.
5998     *
5999     * @see elm_box_transition_new
6000     * @see elm_box_transition_free
6001     * @see elm_box_layout_set
6002     */
6003    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6004    /**
6005     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6006     *
6007     * If you want to animate the change from one layout to another, you need
6008     * to set the layout function of the box to elm_box_layout_transition(),
6009     * passing as user data to it an instance of ::Elm_Box_Transition with the
6010     * necessary information to perform this animation. The free function to
6011     * set for the layout is elm_box_transition_free().
6012     *
6013     * The parameters to create an ::Elm_Box_Transition sum up to how long
6014     * will it be, in seconds, a layout function to describe the initial point,
6015     * another for the final position of the children and one function to be
6016     * called when the whole animation ends. This last function is useful to
6017     * set the definitive layout for the box, usually the same as the end
6018     * layout for the animation, but could be used to start another transition.
6019     *
6020     * @param start_layout The layout function that will be used to start the animation
6021     * @param start_layout_data The data to be passed the @p start_layout function
6022     * @param start_layout_free_data Function to free @p start_layout_data
6023     * @param end_layout The layout function that will be used to end the animation
6024     * @param end_layout_free_data The data to be passed the @p end_layout function
6025     * @param end_layout_free_data Function to free @p end_layout_data
6026     * @param transition_end_cb Callback function called when animation ends
6027     * @param transition_end_data Data to be passed to @p transition_end_cb
6028     * @return An instance of ::Elm_Box_Transition
6029     *
6030     * @see elm_box_transition_new
6031     * @see elm_box_layout_transition
6032     */
6033    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);
6034    /**
6035     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6036     *
6037     * This function is mostly useful as the @c free_data parameter in
6038     * elm_box_layout_set() when elm_box_layout_transition().
6039     *
6040     * @param data The Elm_Box_Transition instance to be freed.
6041     *
6042     * @see elm_box_transition_new
6043     * @see elm_box_layout_transition
6044     */
6045    EAPI void                elm_box_transition_free(void *data);
6046    /**
6047     * @}
6048     */
6049
6050    /* button */
6051    /**
6052     * @defgroup Button Button
6053     *
6054     * @image html img/widget/button/preview-00.png
6055     * @image latex img/widget/button/preview-00.eps
6056     * @image html img/widget/button/preview-01.png
6057     * @image latex img/widget/button/preview-01.eps
6058     * @image html img/widget/button/preview-02.png
6059     * @image latex img/widget/button/preview-02.eps
6060     *
6061     * This is a push-button. Press it and run some function. It can contain
6062     * a simple label and icon object and it also has an autorepeat feature.
6063     *
6064     * This widgets emits the following signals:
6065     * @li "clicked": the user clicked the button (press/release).
6066     * @li "repeated": the user pressed the button without releasing it.
6067     * @li "pressed": button was pressed.
6068     * @li "unpressed": button was released after being pressed.
6069     * In all three cases, the @c event parameter of the callback will be
6070     * @c NULL.
6071     *
6072     * Also, defined in the default theme, the button has the following styles
6073     * available:
6074     * @li default: a normal button.
6075     * @li anchor: Like default, but the button fades away when the mouse is not
6076     * over it, leaving only the text or icon.
6077     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6078     * continuous look across its options.
6079     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6080     *
6081     * Follow through a complete example @ref button_example_01 "here".
6082     * @{
6083     */
6084    /**
6085     * Add a new button to the parent's canvas
6086     *
6087     * @param parent The parent object
6088     * @return The new object or NULL if it cannot be created
6089     */
6090    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6091    /**
6092     * Set the label used in the button
6093     *
6094     * The passed @p label can be NULL to clean any existing text in it and
6095     * leave the button as an icon only object.
6096     *
6097     * @param obj The button object
6098     * @param label The text will be written on the button
6099     * @deprecated use elm_object_text_set() instead.
6100     */
6101    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6102    /**
6103     * Get the label set for the button
6104     *
6105     * The string returned is an internal pointer and should not be freed or
6106     * altered. It will also become invalid when the button is destroyed.
6107     * The string returned, if not NULL, is a stringshare, so if you need to
6108     * keep it around even after the button is destroyed, you can use
6109     * eina_stringshare_ref().
6110     *
6111     * @param obj The button object
6112     * @return The text set to the label, or NULL if nothing is set
6113     * @deprecated use elm_object_text_set() instead.
6114     */
6115    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6116    /**
6117     * Set the icon used for the button
6118     *
6119     * Setting a new icon will delete any other that was previously set, making
6120     * any reference to them invalid. If you need to maintain the previous
6121     * object alive, unset it first with elm_button_icon_unset().
6122     *
6123     * @param obj The button object
6124     * @param icon The icon object for the button
6125     */
6126    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6127    /**
6128     * Get the icon used for the button
6129     *
6130     * Return the icon object which is set for this widget. If the button is
6131     * destroyed or another icon is set, the returned object will be deleted
6132     * and any reference to it will be invalid.
6133     *
6134     * @param obj The button object
6135     * @return The icon object that is being used
6136     *
6137     * @see elm_button_icon_unset()
6138     */
6139    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6140    /**
6141     * Remove the icon set without deleting it and return the object
6142     *
6143     * This function drops the reference the button holds of the icon object
6144     * and returns this last object. It is used in case you want to remove any
6145     * icon, or set another one, without deleting the actual object. The button
6146     * will be left without an icon set.
6147     *
6148     * @param obj The button object
6149     * @return The icon object that was being used
6150     */
6151    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6152    /**
6153     * Turn on/off the autorepeat event generated when the button is kept pressed
6154     *
6155     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6156     * signal when they are clicked.
6157     *
6158     * When on, keeping a button pressed will continuously emit a @c repeated
6159     * signal until the button is released. The time it takes until it starts
6160     * emitting the signal is given by
6161     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6162     * new emission by elm_button_autorepeat_gap_timeout_set().
6163     *
6164     * @param obj The button object
6165     * @param on  A bool to turn on/off the event
6166     */
6167    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6168    /**
6169     * Get whether the autorepeat feature is enabled
6170     *
6171     * @param obj The button object
6172     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6173     *
6174     * @see elm_button_autorepeat_set()
6175     */
6176    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6177    /**
6178     * Set the initial timeout before the autorepeat event is generated
6179     *
6180     * Sets the timeout, in seconds, since the button is pressed until the
6181     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6182     * won't be any delay and the even will be fired the moment the button is
6183     * pressed.
6184     *
6185     * @param obj The button object
6186     * @param t   Timeout in seconds
6187     *
6188     * @see elm_button_autorepeat_set()
6189     * @see elm_button_autorepeat_gap_timeout_set()
6190     */
6191    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6192    /**
6193     * Get the initial timeout before the autorepeat event is generated
6194     *
6195     * @param obj The button object
6196     * @return Timeout in seconds
6197     *
6198     * @see elm_button_autorepeat_initial_timeout_set()
6199     */
6200    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6201    /**
6202     * Set the interval between each generated autorepeat event
6203     *
6204     * After the first @c repeated event is fired, all subsequent ones will
6205     * follow after a delay of @p t seconds for each.
6206     *
6207     * @param obj The button object
6208     * @param t   Interval in seconds
6209     *
6210     * @see elm_button_autorepeat_initial_timeout_set()
6211     */
6212    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6213    /**
6214     * Get the interval between each generated autorepeat event
6215     *
6216     * @param obj The button object
6217     * @return Interval in seconds
6218     */
6219    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6220    /**
6221     * @}
6222     */
6223
6224    /**
6225     * @defgroup File_Selector_Button File Selector Button
6226     *
6227     * @image html img/widget/fileselector_button/preview-00.png
6228     * @image latex img/widget/fileselector_button/preview-00.eps
6229     * @image html img/widget/fileselector_button/preview-01.png
6230     * @image latex img/widget/fileselector_button/preview-01.eps
6231     * @image html img/widget/fileselector_button/preview-02.png
6232     * @image latex img/widget/fileselector_button/preview-02.eps
6233     *
6234     * This is a button that, when clicked, creates an Elementary
6235     * window (or inner window) <b> with a @ref Fileselector "file
6236     * selector widget" within</b>. When a file is chosen, the (inner)
6237     * window is closed and the button emits a signal having the
6238     * selected file as it's @c event_info.
6239     *
6240     * This widget encapsulates operations on its internal file
6241     * selector on its own API. There is less control over its file
6242     * selector than that one would have instatiating one directly.
6243     *
6244     * The following styles are available for this button:
6245     * @li @c "default"
6246     * @li @c "anchor"
6247     * @li @c "hoversel_vertical"
6248     * @li @c "hoversel_vertical_entry"
6249     *
6250     * Smart callbacks one can register to:
6251     * - @c "file,chosen" - the user has selected a path, whose string
6252     *   pointer comes as the @c event_info data (a stringshared
6253     *   string)
6254     *
6255     * Here is an example on its usage:
6256     * @li @ref fileselector_button_example
6257     *
6258     * @see @ref File_Selector_Entry for a similar widget.
6259     * @{
6260     */
6261
6262    /**
6263     * Add a new file selector button widget to the given parent
6264     * Elementary (container) object
6265     *
6266     * @param parent The parent object
6267     * @return a new file selector button widget handle or @c NULL, on
6268     * errors
6269     */
6270    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6271
6272    /**
6273     * Set the label for a given file selector button widget
6274     *
6275     * @param obj The file selector button widget
6276     * @param label The text label to be displayed on @p obj
6277     *
6278     * @deprecated use elm_object_text_set() instead.
6279     */
6280    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6281
6282    /**
6283     * Get the label set for a given file selector button widget
6284     *
6285     * @param obj The file selector button widget
6286     * @return The button label
6287     *
6288     * @deprecated use elm_object_text_set() instead.
6289     */
6290    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6291
6292    /**
6293     * Set the icon on a given file selector button widget
6294     *
6295     * @param obj The file selector button widget
6296     * @param icon The icon object for the button
6297     *
6298     * Once the icon object is set, a previously set one will be
6299     * deleted. If you want to keep the latter, use the
6300     * elm_fileselector_button_icon_unset() function.
6301     *
6302     * @see elm_fileselector_button_icon_get()
6303     */
6304    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6305
6306    /**
6307     * Get the icon set for a given file selector button widget
6308     *
6309     * @param obj The file selector button widget
6310     * @return The icon object currently set on @p obj or @c NULL, if
6311     * none is
6312     *
6313     * @see elm_fileselector_button_icon_set()
6314     */
6315    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6316
6317    /**
6318     * Unset the icon used in a given file selector button widget
6319     *
6320     * @param obj The file selector button widget
6321     * @return The icon object that was being used on @p obj or @c
6322     * NULL, on errors
6323     *
6324     * Unparent and return the icon object which was set for this
6325     * widget.
6326     *
6327     * @see elm_fileselector_button_icon_set()
6328     */
6329    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6330
6331    /**
6332     * Set the title for a given file selector button widget's window
6333     *
6334     * @param obj The file selector button widget
6335     * @param title The title string
6336     *
6337     * This will change the window's title, when the file selector pops
6338     * out after a click on the button. Those windows have the default
6339     * (unlocalized) value of @c "Select a file" as titles.
6340     *
6341     * @note It will only take any effect if the file selector
6342     * button widget is @b not under "inwin mode".
6343     *
6344     * @see elm_fileselector_button_window_title_get()
6345     */
6346    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6347
6348    /**
6349     * Get the title set for a given file selector button widget's
6350     * window
6351     *
6352     * @param obj The file selector button widget
6353     * @return Title of the file selector button's window
6354     *
6355     * @see elm_fileselector_button_window_title_get() for more details
6356     */
6357    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6358
6359    /**
6360     * Set the size of a given file selector button widget's window,
6361     * holding the file selector itself.
6362     *
6363     * @param obj The file selector button widget
6364     * @param width The window's width
6365     * @param height The window's height
6366     *
6367     * @note it will only take any effect if the file selector button
6368     * widget is @b not under "inwin mode". The default size for the
6369     * window (when applicable) is 400x400 pixels.
6370     *
6371     * @see elm_fileselector_button_window_size_get()
6372     */
6373    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6374
6375    /**
6376     * Get the size of a given file selector button widget's window,
6377     * holding the file selector itself.
6378     *
6379     * @param obj The file selector button widget
6380     * @param width Pointer into which to store the width value
6381     * @param height Pointer into which to store the height value
6382     *
6383     * @note Use @c NULL pointers on the size values you're not
6384     * interested in: they'll be ignored by the function.
6385     *
6386     * @see elm_fileselector_button_window_size_set(), for more details
6387     */
6388    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6389
6390    /**
6391     * Set the initial file system path for a given file selector
6392     * button widget
6393     *
6394     * @param obj The file selector button widget
6395     * @param path The path string
6396     *
6397     * It must be a <b>directory</b> path, which will have the contents
6398     * displayed initially in the file selector's view, when invoked
6399     * from @p obj. The default initial path is the @c "HOME"
6400     * environment variable's value.
6401     *
6402     * @see elm_fileselector_button_path_get()
6403     */
6404    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6405
6406    /**
6407     * Get the initial file system path set for a given file selector
6408     * button widget
6409     *
6410     * @param obj The file selector button widget
6411     * @return path The path string
6412     *
6413     * @see elm_fileselector_button_path_set() for more details
6414     */
6415    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6416
6417    /**
6418     * Enable/disable a tree view in the given file selector button
6419     * widget's internal file selector
6420     *
6421     * @param obj The file selector button widget
6422     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6423     * disable
6424     *
6425     * This has the same effect as elm_fileselector_expandable_set(),
6426     * but now applied to a file selector button's internal file
6427     * selector.
6428     *
6429     * @note There's no way to put a file selector button's internal
6430     * file selector in "grid mode", as one may do with "pure" file
6431     * selectors.
6432     *
6433     * @see elm_fileselector_expandable_get()
6434     */
6435    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6436
6437    /**
6438     * Get whether tree view is enabled for the given file selector
6439     * button widget's internal file selector
6440     *
6441     * @param obj The file selector button widget
6442     * @return @c EINA_TRUE if @p obj widget's internal file selector
6443     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6444     *
6445     * @see elm_fileselector_expandable_set() for more details
6446     */
6447    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6448
6449    /**
6450     * Set whether a given file selector button widget's internal file
6451     * selector is to display folders only or the directory contents,
6452     * as well.
6453     *
6454     * @param obj The file selector button widget
6455     * @param only @c EINA_TRUE to make @p obj widget's internal file
6456     * selector only display directories, @c EINA_FALSE to make files
6457     * to be displayed in it too
6458     *
6459     * This has the same effect as elm_fileselector_folder_only_set(),
6460     * but now applied to a file selector button's internal file
6461     * selector.
6462     *
6463     * @see elm_fileselector_folder_only_get()
6464     */
6465    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6466
6467    /**
6468     * Get whether a given file selector button widget's internal file
6469     * selector is displaying folders only or the directory contents,
6470     * as well.
6471     *
6472     * @param obj The file selector button widget
6473     * @return @c EINA_TRUE if @p obj widget's internal file
6474     * selector is only displaying directories, @c EINA_FALSE if files
6475     * are being displayed in it too (and on errors)
6476     *
6477     * @see elm_fileselector_button_folder_only_set() for more details
6478     */
6479    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6480
6481    /**
6482     * Enable/disable the file name entry box where the user can type
6483     * in a name for a file, in a given file selector button widget's
6484     * internal file selector.
6485     *
6486     * @param obj The file selector button widget
6487     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6488     * file selector a "saving dialog", @c EINA_FALSE otherwise
6489     *
6490     * This has the same effect as elm_fileselector_is_save_set(),
6491     * but now applied to a file selector button's internal file
6492     * selector.
6493     *
6494     * @see elm_fileselector_is_save_get()
6495     */
6496    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6497
6498    /**
6499     * Get whether the given file selector button widget's internal
6500     * file selector is in "saving dialog" mode
6501     *
6502     * @param obj The file selector button widget
6503     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6504     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6505     * errors)
6506     *
6507     * @see elm_fileselector_button_is_save_set() for more details
6508     */
6509    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6510
6511    /**
6512     * Set whether a given file selector button widget's internal file
6513     * selector will raise an Elementary "inner window", instead of a
6514     * dedicated Elementary window. By default, it won't.
6515     *
6516     * @param obj The file selector button widget
6517     * @param value @c EINA_TRUE to make it use an inner window, @c
6518     * EINA_TRUE to make it use a dedicated window
6519     *
6520     * @see elm_win_inwin_add() for more information on inner windows
6521     * @see elm_fileselector_button_inwin_mode_get()
6522     */
6523    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6524
6525    /**
6526     * Get whether a given file selector button widget's internal file
6527     * selector will raise an Elementary "inner window", instead of a
6528     * dedicated Elementary window.
6529     *
6530     * @param obj The file selector button widget
6531     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6532     * if it will use a dedicated window
6533     *
6534     * @see elm_fileselector_button_inwin_mode_set() for more details
6535     */
6536    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6537
6538    /**
6539     * @}
6540     */
6541
6542     /**
6543     * @defgroup File_Selector_Entry File Selector Entry
6544     *
6545     * @image html img/widget/fileselector_entry/preview-00.png
6546     * @image latex img/widget/fileselector_entry/preview-00.eps
6547     *
6548     * This is an entry made to be filled with or display a <b>file
6549     * system path string</b>. Besides the entry itself, the widget has
6550     * a @ref File_Selector_Button "file selector button" on its side,
6551     * which will raise an internal @ref Fileselector "file selector widget",
6552     * when clicked, for path selection aided by file system
6553     * navigation.
6554     *
6555     * This file selector may appear in an Elementary window or in an
6556     * inner window. When a file is chosen from it, the (inner) window
6557     * is closed and the selected file's path string is exposed both as
6558     * an smart event and as the new text on the entry.
6559     *
6560     * This widget encapsulates operations on its internal file
6561     * selector on its own API. There is less control over its file
6562     * selector than that one would have instatiating one directly.
6563     *
6564     * Smart callbacks one can register to:
6565     * - @c "changed" - The text within the entry was changed
6566     * - @c "activated" - The entry has had editing finished and
6567     *   changes are to be "committed"
6568     * - @c "press" - The entry has been clicked
6569     * - @c "longpressed" - The entry has been clicked (and held) for a
6570     *   couple seconds
6571     * - @c "clicked" - The entry has been clicked
6572     * - @c "clicked,double" - The entry has been double clicked
6573     * - @c "focused" - The entry has received focus
6574     * - @c "unfocused" - The entry has lost focus
6575     * - @c "selection,paste" - A paste action has occurred on the
6576     *   entry
6577     * - @c "selection,copy" - A copy action has occurred on the entry
6578     * - @c "selection,cut" - A cut action has occurred on the entry
6579     * - @c "unpressed" - The file selector entry's button was released
6580     *   after being pressed.
6581     * - @c "file,chosen" - The user has selected a path via the file
6582     *   selector entry's internal file selector, whose string pointer
6583     *   comes as the @c event_info data (a stringshared string)
6584     *
6585     * Here is an example on its usage:
6586     * @li @ref fileselector_entry_example
6587     *
6588     * @see @ref File_Selector_Button for a similar widget.
6589     * @{
6590     */
6591
6592    /**
6593     * Add a new file selector entry widget to the given parent
6594     * Elementary (container) object
6595     *
6596     * @param parent The parent object
6597     * @return a new file selector entry widget handle or @c NULL, on
6598     * errors
6599     */
6600    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6601
6602    /**
6603     * Set the label for a given file selector entry widget's button
6604     *
6605     * @param obj The file selector entry widget
6606     * @param label The text label to be displayed on @p obj widget's
6607     * button
6608     *
6609     * @deprecated use elm_object_text_set() instead.
6610     */
6611    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6612
6613    /**
6614     * Get the label set for a given file selector entry widget's button
6615     *
6616     * @param obj The file selector entry widget
6617     * @return The widget button's label
6618     *
6619     * @deprecated use elm_object_text_set() instead.
6620     */
6621    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6622
6623    /**
6624     * Set the icon on a given file selector entry widget's button
6625     *
6626     * @param obj The file selector entry widget
6627     * @param icon The icon object for the entry's button
6628     *
6629     * Once the icon object is set, a previously set one will be
6630     * deleted. If you want to keep the latter, use the
6631     * elm_fileselector_entry_button_icon_unset() function.
6632     *
6633     * @see elm_fileselector_entry_button_icon_get()
6634     */
6635    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6636
6637    /**
6638     * Get the icon set for a given file selector entry widget's button
6639     *
6640     * @param obj The file selector entry widget
6641     * @return The icon object currently set on @p obj widget's button
6642     * or @c NULL, if none is
6643     *
6644     * @see elm_fileselector_entry_button_icon_set()
6645     */
6646    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6647
6648    /**
6649     * Unset the icon used in a given file selector entry widget's
6650     * button
6651     *
6652     * @param obj The file selector entry widget
6653     * @return The icon object that was being used on @p obj widget's
6654     * button or @c NULL, on errors
6655     *
6656     * Unparent and return the icon object which was set for this
6657     * widget's button.
6658     *
6659     * @see elm_fileselector_entry_button_icon_set()
6660     */
6661    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6662
6663    /**
6664     * Set the title for a given file selector entry widget's window
6665     *
6666     * @param obj The file selector entry widget
6667     * @param title The title string
6668     *
6669     * This will change the window's title, when the file selector pops
6670     * out after a click on the entry's button. Those windows have the
6671     * default (unlocalized) value of @c "Select a file" as titles.
6672     *
6673     * @note It will only take any effect if the file selector
6674     * entry widget is @b not under "inwin mode".
6675     *
6676     * @see elm_fileselector_entry_window_title_get()
6677     */
6678    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6679
6680    /**
6681     * Get the title set for a given file selector entry widget's
6682     * window
6683     *
6684     * @param obj The file selector entry widget
6685     * @return Title of the file selector entry's window
6686     *
6687     * @see elm_fileselector_entry_window_title_get() for more details
6688     */
6689    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6690
6691    /**
6692     * Set the size of a given file selector entry widget's window,
6693     * holding the file selector itself.
6694     *
6695     * @param obj The file selector entry widget
6696     * @param width The window's width
6697     * @param height The window's height
6698     *
6699     * @note it will only take any effect if the file selector entry
6700     * widget is @b not under "inwin mode". The default size for the
6701     * window (when applicable) is 400x400 pixels.
6702     *
6703     * @see elm_fileselector_entry_window_size_get()
6704     */
6705    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6706
6707    /**
6708     * Get the size of a given file selector entry widget's window,
6709     * holding the file selector itself.
6710     *
6711     * @param obj The file selector entry widget
6712     * @param width Pointer into which to store the width value
6713     * @param height Pointer into which to store the height value
6714     *
6715     * @note Use @c NULL pointers on the size values you're not
6716     * interested in: they'll be ignored by the function.
6717     *
6718     * @see elm_fileselector_entry_window_size_set(), for more details
6719     */
6720    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6721
6722    /**
6723     * Set the initial file system path and the entry's path string for
6724     * a given file selector entry widget
6725     *
6726     * @param obj The file selector entry widget
6727     * @param path The path string
6728     *
6729     * It must be a <b>directory</b> path, which will have the contents
6730     * displayed initially in the file selector's view, when invoked
6731     * from @p obj. The default initial path is the @c "HOME"
6732     * environment variable's value.
6733     *
6734     * @see elm_fileselector_entry_path_get()
6735     */
6736    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6737
6738    /**
6739     * Get the entry's path string for a given file selector entry
6740     * widget
6741     *
6742     * @param obj The file selector entry widget
6743     * @return path The path string
6744     *
6745     * @see elm_fileselector_entry_path_set() for more details
6746     */
6747    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6748
6749    /**
6750     * Enable/disable a tree view in the given file selector entry
6751     * widget's internal file selector
6752     *
6753     * @param obj The file selector entry widget
6754     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6755     * disable
6756     *
6757     * This has the same effect as elm_fileselector_expandable_set(),
6758     * but now applied to a file selector entry's internal file
6759     * selector.
6760     *
6761     * @note There's no way to put a file selector entry's internal
6762     * file selector in "grid mode", as one may do with "pure" file
6763     * selectors.
6764     *
6765     * @see elm_fileselector_expandable_get()
6766     */
6767    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6768
6769    /**
6770     * Get whether tree view is enabled for the given file selector
6771     * entry widget's internal file selector
6772     *
6773     * @param obj The file selector entry widget
6774     * @return @c EINA_TRUE if @p obj widget's internal file selector
6775     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6776     *
6777     * @see elm_fileselector_expandable_set() for more details
6778     */
6779    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6780
6781    /**
6782     * Set whether a given file selector entry widget's internal file
6783     * selector is to display folders only or the directory contents,
6784     * as well.
6785     *
6786     * @param obj The file selector entry widget
6787     * @param only @c EINA_TRUE to make @p obj widget's internal file
6788     * selector only display directories, @c EINA_FALSE to make files
6789     * to be displayed in it too
6790     *
6791     * This has the same effect as elm_fileselector_folder_only_set(),
6792     * but now applied to a file selector entry's internal file
6793     * selector.
6794     *
6795     * @see elm_fileselector_folder_only_get()
6796     */
6797    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6798
6799    /**
6800     * Get whether a given file selector entry widget's internal file
6801     * selector is displaying folders only or the directory contents,
6802     * as well.
6803     *
6804     * @param obj The file selector entry widget
6805     * @return @c EINA_TRUE if @p obj widget's internal file
6806     * selector is only displaying directories, @c EINA_FALSE if files
6807     * are being displayed in it too (and on errors)
6808     *
6809     * @see elm_fileselector_entry_folder_only_set() for more details
6810     */
6811    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6812
6813    /**
6814     * Enable/disable the file name entry box where the user can type
6815     * in a name for a file, in a given file selector entry widget's
6816     * internal file selector.
6817     *
6818     * @param obj The file selector entry widget
6819     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6820     * file selector a "saving dialog", @c EINA_FALSE otherwise
6821     *
6822     * This has the same effect as elm_fileselector_is_save_set(),
6823     * but now applied to a file selector entry's internal file
6824     * selector.
6825     *
6826     * @see elm_fileselector_is_save_get()
6827     */
6828    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6829
6830    /**
6831     * Get whether the given file selector entry widget's internal
6832     * file selector is in "saving dialog" mode
6833     *
6834     * @param obj The file selector entry widget
6835     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6836     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6837     * errors)
6838     *
6839     * @see elm_fileselector_entry_is_save_set() for more details
6840     */
6841    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6842
6843    /**
6844     * Set whether a given file selector entry widget's internal file
6845     * selector will raise an Elementary "inner window", instead of a
6846     * dedicated Elementary window. By default, it won't.
6847     *
6848     * @param obj The file selector entry widget
6849     * @param value @c EINA_TRUE to make it use an inner window, @c
6850     * EINA_TRUE to make it use a dedicated window
6851     *
6852     * @see elm_win_inwin_add() for more information on inner windows
6853     * @see elm_fileselector_entry_inwin_mode_get()
6854     */
6855    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6856
6857    /**
6858     * Get whether a given file selector entry widget's internal file
6859     * selector will raise an Elementary "inner window", instead of a
6860     * dedicated Elementary window.
6861     *
6862     * @param obj The file selector entry widget
6863     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6864     * if it will use a dedicated window
6865     *
6866     * @see elm_fileselector_entry_inwin_mode_set() for more details
6867     */
6868    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6869
6870    /**
6871     * Set the initial file system path for a given file selector entry
6872     * widget
6873     *
6874     * @param obj The file selector entry widget
6875     * @param path The path string
6876     *
6877     * It must be a <b>directory</b> path, which will have the contents
6878     * displayed initially in the file selector's view, when invoked
6879     * from @p obj. The default initial path is the @c "HOME"
6880     * environment variable's value.
6881     *
6882     * @see elm_fileselector_entry_path_get()
6883     */
6884    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6885
6886    /**
6887     * Get the parent directory's path to the latest file selection on
6888     * a given filer selector entry widget
6889     *
6890     * @param obj The file selector object
6891     * @return The (full) path of the directory of the last selection
6892     * on @p obj widget, a @b stringshared string
6893     *
6894     * @see elm_fileselector_entry_path_set()
6895     */
6896    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6897
6898    /**
6899     * @}
6900     */
6901
6902    /**
6903     * @defgroup Scroller Scroller
6904     *
6905     * A scroller holds a single object and "scrolls it around". This means that
6906     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6907     * region around, allowing to move through a much larger object that is
6908     * contained in the scroller. The scroiller will always have a small minimum
6909     * size by default as it won't be limited by the contents of the scroller.
6910     *
6911     * Signals that you can add callbacks for are:
6912     * @li "edge,left" - the left edge of the content has been reached
6913     * @li "edge,right" - the right edge of the content has been reached
6914     * @li "edge,top" - the top edge of the content has been reached
6915     * @li "edge,bottom" - the bottom edge of the content has been reached
6916     * @li "scroll" - the content has been scrolled (moved)
6917     * @li "scroll,anim,start" - scrolling animation has started
6918     * @li "scroll,anim,stop" - scrolling animation has stopped
6919     * @li "scroll,drag,start" - dragging the contents around has started
6920     * @li "scroll,drag,stop" - dragging the contents around has stopped
6921     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6922     * user intervetion.
6923     *
6924     * @note When Elemementary is in embedded mode the scrollbars will not be
6925     * dragable, they appear merely as indicators of how much has been scrolled.
6926     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6927     * fingerscroll) won't work.
6928     *
6929     * In @ref tutorial_scroller you'll find an example of how to use most of
6930     * this API.
6931     * @{
6932     */
6933    /**
6934     * @brief Type that controls when scrollbars should appear.
6935     *
6936     * @see elm_scroller_policy_set()
6937     */
6938    typedef enum _Elm_Scroller_Policy
6939      {
6940         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6941         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6942         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6943         ELM_SCROLLER_POLICY_LAST
6944      } Elm_Scroller_Policy;
6945    /**
6946     * @brief Add a new scroller to the parent
6947     *
6948     * @param parent The parent object
6949     * @return The new object or NULL if it cannot be created
6950     */
6951    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6952    /**
6953     * @brief Set the content of the scroller widget (the object to be scrolled around).
6954     *
6955     * @param obj The scroller object
6956     * @param content The new content object
6957     *
6958     * Once the content object is set, a previously set one will be deleted.
6959     * If you want to keep that old content object, use the
6960     * elm_scroller_content_unset() function.
6961     */
6962    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6963    /**
6964     * @brief Get the content of the scroller widget
6965     *
6966     * @param obj The slider object
6967     * @return The content that is being used
6968     *
6969     * Return the content object which is set for this widget
6970     *
6971     * @see elm_scroller_content_set()
6972     */
6973    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6974    /**
6975     * @brief Unset the content of the scroller widget
6976     *
6977     * @param obj The slider object
6978     * @return The content that was being used
6979     *
6980     * Unparent and return the content object which was set for this widget
6981     *
6982     * @see elm_scroller_content_set()
6983     */
6984    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6985    /**
6986     * @brief Set custom theme elements for the scroller
6987     *
6988     * @param obj The scroller object
6989     * @param widget The widget name to use (default is "scroller")
6990     * @param base The base name to use (default is "base")
6991     */
6992    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6993    /**
6994     * @brief Make the scroller minimum size limited to the minimum size of the content
6995     *
6996     * @param obj The scroller object
6997     * @param w Enable limiting minimum size horizontally
6998     * @param h Enable limiting minimum size vertically
6999     *
7000     * By default the scroller will be as small as its design allows,
7001     * irrespective of its content. This will make the scroller minimum size the
7002     * right size horizontally and/or vertically to perfectly fit its content in
7003     * that direction.
7004     */
7005    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7006    /**
7007     * @brief Show a specific virtual region within the scroller content object
7008     *
7009     * @param obj The scroller object
7010     * @param x X coordinate of the region
7011     * @param y Y coordinate of the region
7012     * @param w Width of the region
7013     * @param h Height of the region
7014     *
7015     * This will ensure all (or part if it does not fit) of the designated
7016     * region in the virtual content object (0, 0 starting at the top-left of the
7017     * virtual content object) is shown within the scroller.
7018     */
7019    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);
7020    /**
7021     * @brief Set the scrollbar visibility policy
7022     *
7023     * @param obj The scroller object
7024     * @param policy_h Horizontal scrollbar policy
7025     * @param policy_v Vertical scrollbar policy
7026     *
7027     * This sets the scrollbar visibility policy for the given scroller.
7028     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7029     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7030     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7031     * respectively for the horizontal and vertical scrollbars.
7032     */
7033    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7034    /**
7035     * @brief Gets scrollbar visibility policy
7036     *
7037     * @param obj The scroller object
7038     * @param policy_h Horizontal scrollbar policy
7039     * @param policy_v Vertical scrollbar policy
7040     *
7041     * @see elm_scroller_policy_set()
7042     */
7043    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7044    /**
7045     * @brief Get the currently visible content region
7046     *
7047     * @param obj The scroller object
7048     * @param x X coordinate of the region
7049     * @param y Y coordinate of the region
7050     * @param w Width of the region
7051     * @param h Height of the region
7052     *
7053     * This gets the current region in the content object that is visible through
7054     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7055     * w, @p h values pointed to.
7056     *
7057     * @note All coordinates are relative to the content.
7058     *
7059     * @see elm_scroller_region_show()
7060     */
7061    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);
7062    /**
7063     * @brief Get the size of the content object
7064     *
7065     * @param obj The scroller object
7066     * @param w Width return
7067     * @param h Height return
7068     *
7069     * This gets the size of the content object of the scroller.
7070     */
7071    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7072    /**
7073     * @brief Set bouncing behavior
7074     *
7075     * @param obj The scroller object
7076     * @param h_bounce Will the scroller bounce horizontally or not
7077     * @param v_bounce Will the scroller bounce vertically or not
7078     *
7079     * When scrolling, the scroller may "bounce" when reaching an edge of the
7080     * content object. This is a visual way to indicate the end has been reached.
7081     * This is enabled by default for both axis. This will set if it is enabled
7082     * for that axis with the boolean parameters for each axis.
7083     */
7084    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7085    /**
7086     * @brief Get the bounce mode
7087     *
7088     * @param obj The Scroller object
7089     * @param h_bounce Allow bounce horizontally
7090     * @param v_bounce Allow bounce vertically
7091     *
7092     * @see elm_scroller_bounce_set()
7093     */
7094    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7095    /**
7096     * @brief Set scroll page size relative to viewport size.
7097     *
7098     * @param obj The scroller object
7099     * @param h_pagerel The horizontal page relative size
7100     * @param v_pagerel The vertical page relative size
7101     *
7102     * The scroller is capable of limiting scrolling by the user to "pages". That
7103     * is to jump by and only show a "whole page" at a time as if the continuous
7104     * area of the scroller content is split into page sized pieces. This sets
7105     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7106     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7107     * axis. This is mutually exclusive with page size
7108     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7109     * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
7110     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7111     * the other axis.
7112     */
7113    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7114    /**
7115     * @brief Set scroll page size.
7116     *
7117     * @param obj The scroller object
7118     * @param h_pagesize The horizontal page size
7119     * @param v_pagesize The vertical page size
7120     *
7121     * This sets the page size to an absolute fixed value, with 0 turning it off
7122     * for that axis.
7123     *
7124     * @see elm_scroller_page_relative_set()
7125     */
7126    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7127    /**
7128     * @brief Get scroll current page number.
7129     *
7130     * @param obj The scroller object
7131     * @param h_pagenumber The horizontal page number
7132     * @param v_pagenumber The vertical page number
7133     *
7134     * The page number starts from 0. 0 is the first page.
7135     * Current page means the page which meet the top-left of the viewport.
7136     * If there are two or more pages in the viewport, it returns the number of page
7137     * which meet the top-left of the viewport.
7138     *
7139     * @see elm_scroller_last_page_get()
7140     * @see elm_scroller_page_show()
7141     * @see elm_scroller_page_brint_in()
7142     */
7143    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7144    /**
7145     * @brief Get scroll last page number.
7146     *
7147     * @param obj The scroller object
7148     * @param h_pagenumber The horizontal page number
7149     * @param v_pagenumber The vertical page number
7150     *
7151     * The page number starts from 0. 0 is the first page.
7152     * This returns the last page number among the pages.
7153     *
7154     * @see elm_scroller_current_page_get()
7155     * @see elm_scroller_page_show()
7156     * @see elm_scroller_page_brint_in()
7157     */
7158    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7159    /**
7160     * Show a specific virtual region within the scroller content object by page number.
7161     *
7162     * @param obj The scroller object
7163     * @param h_pagenumber The horizontal page number
7164     * @param v_pagenumber The vertical page number
7165     *
7166     * 0, 0 of the indicated page is located at the top-left of the viewport.
7167     * This will jump to the page directly without animation.
7168     *
7169     * Example of usage:
7170     *
7171     * @code
7172     * sc = elm_scroller_add(win);
7173     * elm_scroller_content_set(sc, content);
7174     * elm_scroller_page_relative_set(sc, 1, 0);
7175     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7176     * elm_scroller_page_show(sc, h_page + 1, v_page);
7177     * @endcode
7178     *
7179     * @see elm_scroller_page_bring_in()
7180     */
7181    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7182    /**
7183     * Show a specific virtual region within the scroller content object by page number.
7184     *
7185     * @param obj The scroller object
7186     * @param h_pagenumber The horizontal page number
7187     * @param v_pagenumber The vertical page number
7188     *
7189     * 0, 0 of the indicated page is located at the top-left of the viewport.
7190     * This will slide to the page with animation.
7191     *
7192     * Example of usage:
7193     *
7194     * @code
7195     * sc = elm_scroller_add(win);
7196     * elm_scroller_content_set(sc, content);
7197     * elm_scroller_page_relative_set(sc, 1, 0);
7198     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7199     * elm_scroller_page_bring_in(sc, h_page, v_page);
7200     * @endcode
7201     *
7202     * @see elm_scroller_page_show()
7203     */
7204    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7205    /**
7206     * @brief Show a specific virtual region within the scroller content object.
7207     *
7208     * @param obj The scroller object
7209     * @param x X coordinate of the region
7210     * @param y Y coordinate of the region
7211     * @param w Width of the region
7212     * @param h Height of the region
7213     *
7214     * This will ensure all (or part if it does not fit) of the designated
7215     * region in the virtual content object (0, 0 starting at the top-left of the
7216     * virtual content object) is shown within the scroller. Unlike
7217     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7218     * to this location (if configuration in general calls for transitions). It
7219     * may not jump immediately to the new location and make take a while and
7220     * show other content along the way.
7221     *
7222     * @see elm_scroller_region_show()
7223     */
7224    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);
7225    /**
7226     * @brief Set event propagation on a scroller
7227     *
7228     * @param obj The scroller object
7229     * @param propagation If propagation is enabled or not
7230     *
7231     * This enables or disabled event propagation from the scroller content to
7232     * the scroller and its parent. By default event propagation is disabled.
7233     */
7234    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7235    /**
7236     * @brief Get event propagation for a scroller
7237     *
7238     * @param obj The scroller object
7239     * @return The propagation state
7240     *
7241     * This gets the event propagation for a scroller.
7242     *
7243     * @see elm_scroller_propagate_events_set()
7244     */
7245    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
7246    /**
7247     * @brief Set scrolling gravity on a scroller
7248     *
7249     * @param obj The scroller object
7250     * @param x The scrolling horizontal gravity
7251     * @param y The scrolling vertical gravity
7252     *
7253     * It set scrolling gravity. It adds scrolling weight values
7254     * to the scroller. Usually it uses for stopping the scroller.
7255     * To set y as 0.0 for lower growing child objects,
7256     * even though child objects are added to bottom, the scroller doesn't move.
7257     * To set y as 1.0 for upper growing child objects. And x is horizontal gravity.
7258     * By default 0.0 for x and y.
7259     */
7260    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y);
7261    /**
7262     * @brief Get scrolling gravity values for a scroller
7263     *
7264     * @param obj The scroller object
7265     * @param x The scrolling horizontal gravity
7266     * @param y The scrolling vertical gravity
7267     *
7268     * This gets gravity values for a scroller.
7269     *
7270     * @see elm_scroller_gravity_set()
7271     *
7272     */
7273    EAPI void         elm_scroller_gravity_get(Evas_Object *obj, double *x, double *y);
7274    /**
7275     * @}
7276     */
7277
7278    /**
7279     * @defgroup Label Label
7280     *
7281     * @image html img/widget/label/preview-00.png
7282     * @image latex img/widget/label/preview-00.eps
7283     *
7284     * @brief Widget to display text, with simple html-like markup.
7285     *
7286     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7287     * text doesn't fit the geometry of the label it will be ellipsized or be
7288     * cut. Elementary provides several themes for this widget:
7289     * @li default - No animation
7290     * @li marker - Centers the text in the label and make it bold by default
7291     * @li slide_long - The entire text appears from the right of the screen and
7292     * slides until it disappears in the left of the screen(reappering on the
7293     * right again).
7294     * @li slide_short - The text appears in the left of the label and slides to
7295     * the right to show the overflow. When all of the text has been shown the
7296     * position is reset.
7297     * @li slide_bounce - The text appears in the left of the label and slides to
7298     * the right to show the overflow. When all of the text has been shown the
7299     * animation reverses, moving the text to the left.
7300     *
7301     * Custom themes can of course invent new markup tags and style them any way
7302     * they like.
7303     *
7304     * See @ref tutorial_label for a demonstration of how to use a label widget.
7305     * @{
7306     */
7307    /**
7308     * @brief Add a new label to the parent
7309     *
7310     * @param parent The parent object
7311     * @return The new object or NULL if it cannot be created
7312     */
7313    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7314    /**
7315     * @brief Set the label on the label object
7316     *
7317     * @param obj The label object
7318     * @param label The label will be used on the label object
7319     * @deprecated See elm_object_text_set()
7320     */
7321    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 */
7322    /**
7323     * @brief Get the label used on the label object
7324     *
7325     * @param obj The label object
7326     * @return The string inside the label
7327     * @deprecated See elm_object_text_get()
7328     */
7329    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7330    /**
7331     * @brief Set the wrapping behavior of the label
7332     *
7333     * @param obj The label object
7334     * @param wrap To wrap text or not
7335     *
7336     * By default no wrapping is done. Possible values for @p wrap are:
7337     * @li ELM_WRAP_NONE - No wrapping
7338     * @li ELM_WRAP_CHAR - wrap between characters
7339     * @li ELM_WRAP_WORD - wrap between words
7340     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7341     */
7342    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7343    /**
7344     * @brief Get the wrapping behavior of the label
7345     *
7346     * @param obj The label object
7347     * @return Wrap type
7348     *
7349     * @see elm_label_line_wrap_set()
7350     */
7351    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7352    /**
7353     * @brief Set wrap width of the label
7354     *
7355     * @param obj The label object
7356     * @param w The wrap width in pixels at a minimum where words need to wrap
7357     *
7358     * This function sets the maximum width size hint of the label.
7359     *
7360     * @warning This is only relevant if the label is inside a container.
7361     */
7362    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7363    /**
7364     * @brief Get wrap width of the label
7365     *
7366     * @param obj The label object
7367     * @return The wrap width in pixels at a minimum where words need to wrap
7368     *
7369     * @see elm_label_wrap_width_set()
7370     */
7371    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7372    /**
7373     * @brief Set wrap height of the label
7374     *
7375     * @param obj The label object
7376     * @param h The wrap height in pixels at a minimum where words need to wrap
7377     *
7378     * This function sets the maximum height size hint of the label.
7379     *
7380     * @warning This is only relevant if the label is inside a container.
7381     */
7382    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7383    /**
7384     * @brief get wrap width of the label
7385     *
7386     * @param obj The label object
7387     * @return The wrap height in pixels at a minimum where words need to wrap
7388     */
7389    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7390    /**
7391     * @brief Set the font size on the label object.
7392     *
7393     * @param obj The label object
7394     * @param size font size
7395     *
7396     * @warning NEVER use this. It is for hyper-special cases only. use styles
7397     * instead. e.g. "big", "medium", "small" - or better name them by use:
7398     * "title", "footnote", "quote" etc.
7399     */
7400    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7401    /**
7402     * @brief Set the text color on the label object
7403     *
7404     * @param obj The label object
7405     * @param r Red property background color of The label object
7406     * @param g Green property background color of The label object
7407     * @param b Blue property background color of The label object
7408     * @param a Alpha property background color of The label object
7409     *
7410     * @warning NEVER use this. It is for hyper-special cases only. use styles
7411     * instead. e.g. "big", "medium", "small" - or better name them by use:
7412     * "title", "footnote", "quote" etc.
7413     */
7414    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);
7415    /**
7416     * @brief Set the text align on the label object
7417     *
7418     * @param obj The label object
7419     * @param align align mode ("left", "center", "right")
7420     *
7421     * @warning NEVER use this. It is for hyper-special cases only. use styles
7422     * instead. e.g. "big", "medium", "small" - or better name them by use:
7423     * "title", "footnote", "quote" etc.
7424     */
7425    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7426    /**
7427     * @brief Set background color of the label
7428     *
7429     * @param obj The label object
7430     * @param r Red property background color of The label object
7431     * @param g Green property background color of The label object
7432     * @param b Blue property background color of The label object
7433     * @param a Alpha property background alpha of The label object
7434     *
7435     * @warning NEVER use this. It is for hyper-special cases only. use styles
7436     * instead. e.g. "big", "medium", "small" - or better name them by use:
7437     * "title", "footnote", "quote" etc.
7438     */
7439    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);
7440    /**
7441     * @brief Set the ellipsis behavior of the label
7442     *
7443     * @param obj The label object
7444     * @param ellipsis To ellipsis text or not
7445     *
7446     * If set to true and the text doesn't fit in the label an ellipsis("...")
7447     * will be shown at the end of the widget.
7448     *
7449     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7450     * choosen wrap method was ELM_WRAP_WORD.
7451     */
7452    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7453    /**
7454     * @brief Set the text slide of the label
7455     *
7456     * @param obj The label object
7457     * @param slide To start slide or stop
7458     *
7459     * If set to true the text of the label will slide throught the length of
7460     * label.
7461     *
7462     * @warning This only work with the themes "slide_short", "slide_long" and
7463     * "slide_bounce".
7464     */
7465    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7466    /**
7467     * @brief Get the text slide mode of the label
7468     *
7469     * @param obj The label object
7470     * @return slide slide mode value
7471     *
7472     * @see elm_label_slide_set()
7473     */
7474    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7475    /**
7476     * @brief Set the slide duration(speed) of the label
7477     *
7478     * @param obj The label object
7479     * @return The duration in seconds in moving text from slide begin position
7480     * to slide end position
7481     */
7482    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7483    /**
7484     * @brief Get the slide duration(speed) of the label
7485     *
7486     * @param obj The label object
7487     * @return The duration time in moving text from slide begin position to slide end position
7488     *
7489     * @see elm_label_slide_duration_set()
7490     */
7491    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7492    /**
7493     * @}
7494     */
7495
7496    /**
7497     * @defgroup Toggle Toggle
7498     *
7499     * @image html img/widget/toggle/preview-00.png
7500     * @image latex img/widget/toggle/preview-00.eps
7501     *
7502     * @brief A toggle is a slider which can be used to toggle between
7503     * two values.  It has two states: on and off.
7504     *
7505     * Signals that you can add callbacks for are:
7506     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7507     *                 until the toggle is released by the cursor (assuming it
7508     *                 has been triggered by the cursor in the first place).
7509     *
7510     * @ref tutorial_toggle show how to use a toggle.
7511     * @{
7512     */
7513    /**
7514     * @brief Add a toggle to @p parent.
7515     *
7516     * @param parent The parent object
7517     *
7518     * @return The toggle object
7519     */
7520    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7521    /**
7522     * @brief Sets the label to be displayed with the toggle.
7523     *
7524     * @param obj The toggle object
7525     * @param label The label to be displayed
7526     *
7527     * @deprecated use elm_object_text_set() instead.
7528     */
7529    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7530    /**
7531     * @brief Gets the label of the toggle
7532     *
7533     * @param obj  toggle object
7534     * @return The label of the toggle
7535     *
7536     * @deprecated use elm_object_text_get() instead.
7537     */
7538    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7539    /**
7540     * @brief Set the icon used for the toggle
7541     *
7542     * @param obj The toggle object
7543     * @param icon The icon object for the button
7544     *
7545     * Once the icon object is set, a previously set one will be deleted
7546     * If you want to keep that old content object, use the
7547     * elm_toggle_icon_unset() function.
7548     */
7549    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7550    /**
7551     * @brief Get the icon used for the toggle
7552     *
7553     * @param obj The toggle object
7554     * @return The icon object that is being used
7555     *
7556     * Return the icon object which is set for this widget.
7557     *
7558     * @see elm_toggle_icon_set()
7559     */
7560    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7561    /**
7562     * @brief Unset the icon used for the toggle
7563     *
7564     * @param obj The toggle object
7565     * @return The icon object that was being used
7566     *
7567     * Unparent and return the icon object which was set for this widget.
7568     *
7569     * @see elm_toggle_icon_set()
7570     */
7571    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7572    /**
7573     * @brief Sets the labels to be associated with the on and off states of the toggle.
7574     *
7575     * @param obj The toggle object
7576     * @param onlabel The label displayed when the toggle is in the "on" state
7577     * @param offlabel The label displayed when the toggle is in the "off" state
7578     */
7579    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7580    /**
7581     * @brief Gets the labels associated with the on and off states of the toggle.
7582     *
7583     * @param obj The toggle object
7584     * @param onlabel A char** to place the onlabel of @p obj into
7585     * @param offlabel A char** to place the offlabel of @p obj into
7586     */
7587    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7588    /**
7589     * @brief Sets the state of the toggle to @p state.
7590     *
7591     * @param obj The toggle object
7592     * @param state The state of @p obj
7593     */
7594    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7595    /**
7596     * @brief Gets the state of the toggle to @p state.
7597     *
7598     * @param obj The toggle object
7599     * @return The state of @p obj
7600     */
7601    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7602    /**
7603     * @brief Sets the state pointer of the toggle to @p statep.
7604     *
7605     * @param obj The toggle object
7606     * @param statep The state pointer of @p obj
7607     */
7608    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7609    /**
7610     * @}
7611     */
7612
7613    /**
7614     * @defgroup Frame Frame
7615     *
7616     * @image html img/widget/frame/preview-00.png
7617     * @image latex img/widget/frame/preview-00.eps
7618     *
7619     * @brief Frame is a widget that holds some content and has a title.
7620     *
7621     * The default look is a frame with a title, but Frame supports multple
7622     * styles:
7623     * @li default
7624     * @li pad_small
7625     * @li pad_medium
7626     * @li pad_large
7627     * @li pad_huge
7628     * @li outdent_top
7629     * @li outdent_bottom
7630     *
7631     * Of all this styles only default shows the title. Frame emits no signals.
7632     *
7633     * For a detailed example see the @ref tutorial_frame.
7634     *
7635     * @{
7636     */
7637    /**
7638     * @brief Add a new frame to the parent
7639     *
7640     * @param parent The parent object
7641     * @return The new object or NULL if it cannot be created
7642     */
7643    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7644    /**
7645     * @brief Set the frame label
7646     *
7647     * @param obj The frame object
7648     * @param label The label of this frame object
7649     *
7650     * @deprecated use elm_object_text_set() instead.
7651     */
7652    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7653    /**
7654     * @brief Get the frame label
7655     *
7656     * @param obj The frame object
7657     *
7658     * @return The label of this frame objet or NULL if unable to get frame
7659     *
7660     * @deprecated use elm_object_text_get() instead.
7661     */
7662    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7663    /**
7664     * @brief Set the content of the frame widget
7665     *
7666     * Once the content object is set, a previously set one will be deleted.
7667     * If you want to keep that old content object, use the
7668     * elm_frame_content_unset() function.
7669     *
7670     * @param obj The frame object
7671     * @param content The content will be filled in this frame object
7672     */
7673    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7674    /**
7675     * @brief Get the content of the frame widget
7676     *
7677     * Return the content object which is set for this widget
7678     *
7679     * @param obj The frame object
7680     * @return The content that is being used
7681     */
7682    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7683    /**
7684     * @brief Unset the content of the frame widget
7685     *
7686     * Unparent and return the content object which was set for this widget
7687     *
7688     * @param obj The frame object
7689     * @return The content that was being used
7690     */
7691    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7692    /**
7693     * @}
7694     */
7695
7696    /**
7697     * @defgroup Table Table
7698     *
7699     * A container widget to arrange other widgets in a table where items can
7700     * also span multiple columns or rows - even overlap (and then be raised or
7701     * lowered accordingly to adjust stacking if they do overlap).
7702     *
7703     * The followin are examples of how to use a table:
7704     * @li @ref tutorial_table_01
7705     * @li @ref tutorial_table_02
7706     *
7707     * @{
7708     */
7709    /**
7710     * @brief Add a new table to the parent
7711     *
7712     * @param parent The parent object
7713     * @return The new object or NULL if it cannot be created
7714     */
7715    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7716    /**
7717     * @brief Set the homogeneous layout in the table
7718     *
7719     * @param obj The layout object
7720     * @param homogeneous A boolean to set if the layout is homogeneous in the
7721     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7722     */
7723    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7724    /**
7725     * @brief Get the current table homogeneous mode.
7726     *
7727     * @param obj The table object
7728     * @return A boolean to indicating if the layout is homogeneous in the table
7729     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7730     */
7731    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7732    /**
7733     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7734     */
7735    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7736    /**
7737     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7738     */
7739    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7740    /**
7741     * @brief Set padding between cells.
7742     *
7743     * @param obj The layout object.
7744     * @param horizontal set the horizontal padding.
7745     * @param vertical set the vertical padding.
7746     *
7747     * Default value is 0.
7748     */
7749    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7750    /**
7751     * @brief Get padding between cells.
7752     *
7753     * @param obj The layout object.
7754     * @param horizontal set the horizontal padding.
7755     * @param vertical set the vertical padding.
7756     */
7757    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7758    /**
7759     * @brief Add a subobject on the table with the coordinates passed
7760     *
7761     * @param obj The table object
7762     * @param subobj The subobject to be added to the table
7763     * @param x Row number
7764     * @param y Column number
7765     * @param w rowspan
7766     * @param h colspan
7767     *
7768     * @note All positioning inside the table is relative to rows and columns, so
7769     * a value of 0 for x and y, means the top left cell of the table, and a
7770     * value of 1 for w and h means @p subobj only takes that 1 cell.
7771     */
7772    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7773    /**
7774     * @brief Remove child from table.
7775     *
7776     * @param obj The table object
7777     * @param subobj The subobject
7778     */
7779    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7780    /**
7781     * @brief Faster way to remove all child objects from a table object.
7782     *
7783     * @param obj The table object
7784     * @param clear If true, will delete children, else just remove from table.
7785     */
7786    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7787    /**
7788     * @brief Set the packing location of an existing child of the table
7789     *
7790     * @param subobj The subobject to be modified in the table
7791     * @param x Row number
7792     * @param y Column number
7793     * @param w rowspan
7794     * @param h colspan
7795     *
7796     * Modifies the position of an object already in the table.
7797     *
7798     * @note All positioning inside the table is relative to rows and columns, so
7799     * a value of 0 for x and y, means the top left cell of the table, and a
7800     * value of 1 for w and h means @p subobj only takes that 1 cell.
7801     */
7802    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7803    /**
7804     * @brief Get the packing location of an existing child of the table
7805     *
7806     * @param subobj The subobject to be modified in the table
7807     * @param x Row number
7808     * @param y Column number
7809     * @param w rowspan
7810     * @param h colspan
7811     *
7812     * @see elm_table_pack_set()
7813     */
7814    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7815    /**
7816     * @}
7817     */
7818
7819    /**
7820     * @defgroup Gengrid Gengrid (Generic grid)
7821     *
7822     * This widget aims to position objects in a grid layout while
7823     * actually creating and rendering only the visible ones, using the
7824     * same idea as the @ref Genlist "genlist": the user defines a @b
7825     * class for each item, specifying functions that will be called at
7826     * object creation, deletion, etc. When those items are selected by
7827     * the user, a callback function is issued. Users may interact with
7828     * a gengrid via the mouse (by clicking on items to select them and
7829     * clicking on the grid's viewport and swiping to pan the whole
7830     * view) or via the keyboard, navigating through item with the
7831     * arrow keys.
7832     *
7833     * @section Gengrid_Layouts Gengrid layouts
7834     *
7835     * Gengrids may layout its items in one of two possible layouts:
7836     * - horizontal or
7837     * - vertical.
7838     *
7839     * When in "horizontal mode", items will be placed in @b columns,
7840     * from top to bottom and, when the space for a column is filled,
7841     * another one is started on the right, thus expanding the grid
7842     * horizontally, making for horizontal scrolling. When in "vertical
7843     * mode" , though, items will be placed in @b rows, from left to
7844     * right and, when the space for a row is filled, another one is
7845     * started below, thus expanding the grid vertically (and making
7846     * for vertical scrolling).
7847     *
7848     * @section Gengrid_Items Gengrid items
7849     *
7850     * An item in a gengrid can have 0 or more text labels (they can be
7851     * regular text or textblock Evas objects - that's up to the style
7852     * to determine), 0 or more icons (which are simply objects
7853     * swallowed into the gengrid item's theming Edje object) and 0 or
7854     * more <b>boolean states</b>, which have the behavior left to the
7855     * user to define. The Edje part names for each of these properties
7856     * will be looked up, in the theme file for the gengrid, under the
7857     * Edje (string) data items named @c "labels", @c "icons" and @c
7858     * "states", respectively. For each of those properties, if more
7859     * than one part is provided, they must have names listed separated
7860     * by spaces in the data fields. For the default gengrid item
7861     * theme, we have @b one label part (@c "elm.text"), @b two icon
7862     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7863     * no state parts.
7864     *
7865     * A gengrid item may be at one of several styles. Elementary
7866     * provides one by default - "default", but this can be extended by
7867     * system or application custom themes/overlays/extensions (see
7868     * @ref Theme "themes" for more details).
7869     *
7870     * @section Gengrid_Item_Class Gengrid item classes
7871     *
7872     * In order to have the ability to add and delete items on the fly,
7873     * gengrid implements a class (callback) system where the
7874     * application provides a structure with information about that
7875     * type of item (gengrid may contain multiple different items with
7876     * different classes, states and styles). Gengrid will call the
7877     * functions in this struct (methods) when an item is "realized"
7878     * (i.e., created dynamically, while the user is scrolling the
7879     * grid). All objects will simply be deleted when no longer needed
7880     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7881     * contains the following members:
7882     * - @c item_style - This is a constant string and simply defines
7883     * the name of the item style. It @b must be specified and the
7884     * default should be @c "default".
7885     * - @c func.label_get - This function is called when an item
7886     * object is actually created. The @c data parameter will point to
7887     * the same data passed to elm_gengrid_item_append() and related
7888     * item creation functions. The @c obj parameter is the gengrid
7889     * object itself, while the @c part one is the name string of one
7890     * of the existing text parts in the Edje group implementing the
7891     * item's theme. This function @b must return a strdup'()ed string,
7892     * as the caller will free() it when done. See
7893     * #Elm_Gengrid_Item_Label_Get_Cb.
7894     * - @c func.icon_get - This function is called when an item object
7895     * is actually created. The @c data parameter will point to the
7896     * same data passed to elm_gengrid_item_append() and related item
7897     * creation functions. The @c obj parameter is the gengrid object
7898     * itself, while the @c part one is the name string of one of the
7899     * existing (icon) swallow parts in the Edje group implementing the
7900     * item's theme. It must return @c NULL, when no icon is desired,
7901     * or a valid object handle, otherwise. The object will be deleted
7902     * by the gengrid on its deletion or when the item is "unrealized".
7903     * See #Elm_Gengrid_Item_Icon_Get_Cb.
7904     * - @c func.state_get - This function is called when an item
7905     * object is actually created. The @c data parameter will point to
7906     * the same data passed to elm_gengrid_item_append() and related
7907     * item creation functions. The @c obj parameter is the gengrid
7908     * object itself, while the @c part one is the name string of one
7909     * of the state parts in the Edje group implementing the item's
7910     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7911     * true/on. Gengrids will emit a signal to its theming Edje object
7912     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7913     * "source" arguments, respectively, when the state is true (the
7914     * default is false), where @c XXX is the name of the (state) part.
7915     * See #Elm_Gengrid_Item_State_Get_Cb.
7916     * - @c func.del - This is called when elm_gengrid_item_del() is
7917     * called on an item or elm_gengrid_clear() is called on the
7918     * gengrid. This is intended for use when gengrid items are
7919     * deleted, so any data attached to the item (e.g. its data
7920     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7921     *
7922     * @section Gengrid_Usage_Hints Usage hints
7923     *
7924     * If the user wants to have multiple items selected at the same
7925     * time, elm_gengrid_multi_select_set() will permit it. If the
7926     * gengrid is single-selection only (the default), then
7927     * elm_gengrid_select_item_get() will return the selected item or
7928     * @c NULL, if none is selected. If the gengrid is under
7929     * multi-selection, then elm_gengrid_selected_items_get() will
7930     * return a list (that is only valid as long as no items are
7931     * modified (added, deleted, selected or unselected) of child items
7932     * on a gengrid.
7933     *
7934     * If an item changes (internal (boolean) state, label or icon
7935     * changes), then use elm_gengrid_item_update() to have gengrid
7936     * update the item with the new state. A gengrid will re-"realize"
7937     * the item, thus calling the functions in the
7938     * #Elm_Gengrid_Item_Class set for that item.
7939     *
7940     * To programmatically (un)select an item, use
7941     * elm_gengrid_item_selected_set(). To get its selected state use
7942     * elm_gengrid_item_selected_get(). To make an item disabled
7943     * (unable to be selected and appear differently) use
7944     * elm_gengrid_item_disabled_set() to set this and
7945     * elm_gengrid_item_disabled_get() to get the disabled state.
7946     *
7947     * Grid cells will only have their selection smart callbacks called
7948     * when firstly getting selected. Any further clicks will do
7949     * nothing, unless you enable the "always select mode", with
7950     * elm_gengrid_always_select_mode_set(), thus making every click to
7951     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7952     * turn off the ability to select items entirely in the widget and
7953     * they will neither appear selected nor call the selection smart
7954     * callbacks.
7955     *
7956     * Remember that you can create new styles and add your own theme
7957     * augmentation per application with elm_theme_extension_add(). If
7958     * you absolutely must have a specific style that overrides any
7959     * theme the user or system sets up you can use
7960     * elm_theme_overlay_add() to add such a file.
7961     *
7962     * @section Gengrid_Smart_Events Gengrid smart events
7963     *
7964     * Smart events that you can add callbacks for are:
7965     * - @c "activated" - The user has double-clicked or pressed
7966     *   (enter|return|spacebar) on an item. The @c event_info parameter
7967     *   is the gengrid item that was activated.
7968     * - @c "clicked,double" - The user has double-clicked an item.
7969     *   The @c event_info parameter is the gengrid item that was double-clicked.
7970     * - @c "longpressed" - This is called when the item is pressed for a certain
7971     *   amount of time. By default it's 1 second.
7972     * - @c "selected" - The user has made an item selected. The
7973     *   @c event_info parameter is the gengrid item that was selected.
7974     * - @c "unselected" - The user has made an item unselected. The
7975     *   @c event_info parameter is the gengrid item that was unselected.
7976     * - @c "realized" - This is called when the item in the gengrid
7977     *   has its implementing Evas object instantiated, de facto. @c
7978     *   event_info is the gengrid item that was created. The object
7979     *   may be deleted at any time, so it is highly advised to the
7980     *   caller @b not to use the object pointer returned from
7981     *   elm_gengrid_item_object_get(), because it may point to freed
7982     *   objects.
7983     * - @c "unrealized" - This is called when the implementing Evas
7984     *   object for this item is deleted. @c event_info is the gengrid
7985     *   item that was deleted.
7986     * - @c "changed" - Called when an item is added, removed, resized
7987     *   or moved and when the gengrid is resized or gets "horizontal"
7988     *   property changes.
7989     * - @c "scroll,anim,start" - This is called when scrolling animation has
7990     *   started.
7991     * - @c "scroll,anim,stop" - This is called when scrolling animation has
7992     *   stopped.
7993     * - @c "drag,start,up" - Called when the item in the gengrid has
7994     *   been dragged (not scrolled) up.
7995     * - @c "drag,start,down" - Called when the item in the gengrid has
7996     *   been dragged (not scrolled) down.
7997     * - @c "drag,start,left" - Called when the item in the gengrid has
7998     *   been dragged (not scrolled) left.
7999     * - @c "drag,start,right" - Called when the item in the gengrid has
8000     *   been dragged (not scrolled) right.
8001     * - @c "drag,stop" - Called when the item in the gengrid has
8002     *   stopped being dragged.
8003     * - @c "drag" - Called when the item in the gengrid is being
8004     *   dragged.
8005     * - @c "scroll" - called when the content has been scrolled
8006     *   (moved).
8007     * - @c "scroll,drag,start" - called when dragging the content has
8008     *   started.
8009     * - @c "scroll,drag,stop" - called when dragging the content has
8010     *   stopped.
8011     * - @c "scroll,edge,top" - This is called when the gengrid is scrolled until
8012     *   the top edge.
8013     * - @c "scroll,edge,bottom" - This is called when the gengrid is scrolled
8014     *   until the bottom edge.
8015     * - @c "scroll,edge,left" - This is called when the gengrid is scrolled
8016     *   until the left edge.
8017     * - @c "scroll,edge,right" - This is called when the gengrid is scrolled
8018     *   until the right edge.
8019     *
8020     * List of gengrid examples:
8021     * @li @ref gengrid_example
8022     */
8023
8024    /**
8025     * @addtogroup Gengrid
8026     * @{
8027     */
8028
8029    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8030    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8031    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8032    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8033    typedef Evas_Object *(*Elm_Gengrid_Item_Icon_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
8034    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. */
8035    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8036
8037    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
8038    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
8039    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
8040    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
8041
8042    /**
8043     * @struct _Elm_Gengrid_Item_Class
8044     *
8045     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8046     * field details.
8047     */
8048    struct _Elm_Gengrid_Item_Class
8049      {
8050         const char             *item_style;
8051         struct _Elm_Gengrid_Item_Class_Func
8052           {
8053              Elm_Gengrid_Item_Label_Get_Cb label_get;
8054              Elm_Gengrid_Item_Icon_Get_Cb  icon_get;
8055              Elm_Gengrid_Item_State_Get_Cb state_get;
8056              Elm_Gengrid_Item_Del_Cb       del;
8057           } func;
8058      }; /**< #Elm_Gengrid_Item_Class member definitions */
8059
8060    /**
8061     * Add a new gengrid widget to the given parent Elementary
8062     * (container) object
8063     *
8064     * @param parent The parent object
8065     * @return a new gengrid widget handle or @c NULL, on errors
8066     *
8067     * This function inserts a new gengrid widget on the canvas.
8068     *
8069     * @see elm_gengrid_item_size_set()
8070     * @see elm_gengrid_group_item_size_set()
8071     * @see elm_gengrid_horizontal_set()
8072     * @see elm_gengrid_item_append()
8073     * @see elm_gengrid_item_del()
8074     * @see elm_gengrid_clear()
8075     *
8076     * @ingroup Gengrid
8077     */
8078    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8079
8080    /**
8081     * Set the size for the items of a given gengrid widget
8082     *
8083     * @param obj The gengrid object.
8084     * @param w The items' width.
8085     * @param h The items' height;
8086     *
8087     * A gengrid, after creation, has still no information on the size
8088     * to give to each of its cells. So, you most probably will end up
8089     * with squares one @ref Fingers "finger" wide, the default
8090     * size. Use this function to force a custom size for you items,
8091     * making them as big as you wish.
8092     *
8093     * @see elm_gengrid_item_size_get()
8094     *
8095     * @ingroup Gengrid
8096     */
8097    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8098
8099    /**
8100     * Get the size set for the items of a given gengrid widget
8101     *
8102     * @param obj The gengrid object.
8103     * @param w Pointer to a variable where to store the items' width.
8104     * @param h Pointer to a variable where to store the items' height.
8105     *
8106     * @note Use @c NULL pointers on the size values you're not
8107     * interested in: they'll be ignored by the function.
8108     *
8109     * @see elm_gengrid_item_size_get() for more details
8110     *
8111     * @ingroup Gengrid
8112     */
8113    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8114
8115    /**
8116     * Set the size for the group items of a given gengrid widget
8117     *
8118     * @param obj The gengrid object.
8119     * @param w The group items' width.
8120     * @param h The group items' height;
8121     *
8122     * A gengrid, after creation, has still no information on the size
8123     * to give to each of its cells. So, you most probably will end up
8124     * with squares one @ref Fingers "finger" wide, the default
8125     * size. Use this function to force a custom size for you group items,
8126     * making them as big as you wish.
8127     *
8128     * @see elm_gengrid_group_item_size_get()
8129     *
8130     * @ingroup Gengrid
8131     */
8132    EAPI void               elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8133
8134    /**
8135     * Get the size set for the group items of a given gengrid widget
8136     *
8137     * @param obj The gengrid object.
8138     * @param w Pointer to a variable where to store the group items' width.
8139     * @param h Pointer to a variable where to store the group items' height.
8140     *
8141     * @note Use @c NULL pointers on the size values you're not
8142     * interested in: they'll be ignored by the function.
8143     *
8144     * @see elm_gengrid_group_item_size_get() for more details
8145     *
8146     * @ingroup Gengrid
8147     */
8148    EAPI void               elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8149
8150    /**
8151     * Set the items grid's alignment within a given gengrid widget
8152     *
8153     * @param obj The gengrid object.
8154     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8155     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8156     *
8157     * This sets the alignment of the whole grid of items of a gengrid
8158     * within its given viewport. By default, those values are both
8159     * 0.5, meaning that the gengrid will have its items grid placed
8160     * exactly in the middle of its viewport.
8161     *
8162     * @note If given alignment values are out of the cited ranges,
8163     * they'll be changed to the nearest boundary values on the valid
8164     * ranges.
8165     *
8166     * @see elm_gengrid_align_get()
8167     *
8168     * @ingroup Gengrid
8169     */
8170    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8171
8172    /**
8173     * Get the items grid's alignment values within a given gengrid
8174     * widget
8175     *
8176     * @param obj The gengrid object.
8177     * @param align_x Pointer to a variable where to store the
8178     * horizontal alignment.
8179     * @param align_y Pointer to a variable where to store the vertical
8180     * alignment.
8181     *
8182     * @note Use @c NULL pointers on the alignment values you're not
8183     * interested in: they'll be ignored by the function.
8184     *
8185     * @see elm_gengrid_align_set() for more details
8186     *
8187     * @ingroup Gengrid
8188     */
8189    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8190
8191    /**
8192     * Set whether a given gengrid widget is or not able have items
8193     * @b reordered
8194     *
8195     * @param obj The gengrid object
8196     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8197     * @c EINA_FALSE to turn it off
8198     *
8199     * If a gengrid is set to allow reordering, a click held for more
8200     * than 0.5 over a given item will highlight it specially,
8201     * signalling the gengrid has entered the reordering state. From
8202     * that time on, the user will be able to, while still holding the
8203     * mouse button down, move the item freely in the gengrid's
8204     * viewport, replacing to said item to the locations it goes to.
8205     * The replacements will be animated and, whenever the user
8206     * releases the mouse button, the item being replaced gets a new
8207     * definitive place in the grid.
8208     *
8209     * @see elm_gengrid_reorder_mode_get()
8210     *
8211     * @ingroup Gengrid
8212     */
8213    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8214
8215    /**
8216     * Get whether a given gengrid widget is or not able have items
8217     * @b reordered
8218     *
8219     * @param obj The gengrid object
8220     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8221     * off
8222     *
8223     * @see elm_gengrid_reorder_mode_set() for more details
8224     *
8225     * @ingroup Gengrid
8226     */
8227    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8228
8229    /**
8230     * Append a new item in a given gengrid widget.
8231     *
8232     * @param obj The gengrid object.
8233     * @param gic The item class for the item.
8234     * @param data The item data.
8235     * @param func Convenience function called when the item is
8236     * selected.
8237     * @param func_data Data to be passed to @p func.
8238     * @return A handle to the item added or @c NULL, on errors.
8239     *
8240     * This adds an item to the beginning of the gengrid.
8241     *
8242     * @see elm_gengrid_item_prepend()
8243     * @see elm_gengrid_item_insert_before()
8244     * @see elm_gengrid_item_insert_after()
8245     * @see elm_gengrid_item_del()
8246     *
8247     * @ingroup Gengrid
8248     */
8249    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);
8250
8251    /**
8252     * Prepend a new item in a given gengrid widget.
8253     *
8254     * @param obj The gengrid object.
8255     * @param gic The item class for the item.
8256     * @param data The item data.
8257     * @param func Convenience function called when the item is
8258     * selected.
8259     * @param func_data Data to be passed to @p func.
8260     * @return A handle to the item added or @c NULL, on errors.
8261     *
8262     * This adds an item to the end of the gengrid.
8263     *
8264     * @see elm_gengrid_item_append()
8265     * @see elm_gengrid_item_insert_before()
8266     * @see elm_gengrid_item_insert_after()
8267     * @see elm_gengrid_item_del()
8268     *
8269     * @ingroup Gengrid
8270     */
8271    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);
8272
8273    /**
8274     * Insert an item before another in a gengrid widget
8275     *
8276     * @param obj The gengrid object.
8277     * @param gic The item class for the item.
8278     * @param data The item data.
8279     * @param relative The item to place this new one before.
8280     * @param func Convenience function called when the item is
8281     * selected.
8282     * @param func_data Data to be passed to @p func.
8283     * @return A handle to the item added or @c NULL, on errors.
8284     *
8285     * This inserts an item before another in the gengrid.
8286     *
8287     * @see elm_gengrid_item_append()
8288     * @see elm_gengrid_item_prepend()
8289     * @see elm_gengrid_item_insert_after()
8290     * @see elm_gengrid_item_del()
8291     *
8292     * @ingroup Gengrid
8293     */
8294    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);
8295
8296    /**
8297     * Insert an item after another in a gengrid widget
8298     *
8299     * @param obj The gengrid object.
8300     * @param gic The item class for the item.
8301     * @param data The item data.
8302     * @param relative The item to place this new one after.
8303     * @param func Convenience function called when the item is
8304     * selected.
8305     * @param func_data Data to be passed to @p func.
8306     * @return A handle to the item added or @c NULL, on errors.
8307     *
8308     * This inserts an item after another in the gengrid.
8309     *
8310     * @see elm_gengrid_item_append()
8311     * @see elm_gengrid_item_prepend()
8312     * @see elm_gengrid_item_insert_after()
8313     * @see elm_gengrid_item_del()
8314     *
8315     * @ingroup Gengrid
8316     */
8317    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);
8318
8319    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);
8320
8321    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);
8322
8323    /**
8324     * Set whether items on a given gengrid widget are to get their
8325     * selection callbacks issued for @b every subsequent selection
8326     * click on them or just for the first click.
8327     *
8328     * @param obj The gengrid object
8329     * @param always_select @c EINA_TRUE to make items "always
8330     * selected", @c EINA_FALSE, otherwise
8331     *
8332     * By default, grid items will only call their selection callback
8333     * function when firstly getting selected, any subsequent further
8334     * clicks will do nothing. With this call, you make those
8335     * subsequent clicks also to issue the selection callbacks.
8336     *
8337     * @note <b>Double clicks</b> will @b always be reported on items.
8338     *
8339     * @see elm_gengrid_always_select_mode_get()
8340     *
8341     * @ingroup Gengrid
8342     */
8343    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8344
8345    /**
8346     * Get whether items on a given gengrid widget have their selection
8347     * callbacks issued for @b every subsequent selection click on them
8348     * or just for the first click.
8349     *
8350     * @param obj The gengrid object.
8351     * @return @c EINA_TRUE if the gengrid items are "always selected",
8352     * @c EINA_FALSE, otherwise
8353     *
8354     * @see elm_gengrid_always_select_mode_set() for more details
8355     *
8356     * @ingroup Gengrid
8357     */
8358    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8359
8360    /**
8361     * Set whether items on a given gengrid widget can be selected or not.
8362     *
8363     * @param obj The gengrid object
8364     * @param no_select @c EINA_TRUE to make items selectable,
8365     * @c EINA_FALSE otherwise
8366     *
8367     * This will make items in @p obj selectable or not. In the latter
8368     * case, any user interaction on the gengrid items will neither make
8369     * them appear selected nor them call their selection callback
8370     * functions.
8371     *
8372     * @see elm_gengrid_no_select_mode_get()
8373     *
8374     * @ingroup Gengrid
8375     */
8376    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8377
8378    /**
8379     * Get whether items on a given gengrid widget can be selected or
8380     * not.
8381     *
8382     * @param obj The gengrid object
8383     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8384     * otherwise
8385     *
8386     * @see elm_gengrid_no_select_mode_set() for more details
8387     *
8388     * @ingroup Gengrid
8389     */
8390    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8391
8392    /**
8393     * Enable or disable multi-selection in a given gengrid widget
8394     *
8395     * @param obj The gengrid object.
8396     * @param multi @c EINA_TRUE, to enable multi-selection,
8397     * @c EINA_FALSE to disable it.
8398     *
8399     * Multi-selection is the ability for one to have @b more than one
8400     * item selected, on a given gengrid, simultaneously. When it is
8401     * enabled, a sequence of clicks on different items will make them
8402     * all selected, progressively. A click on an already selected item
8403     * will unselect it. If interecting via the keyboard,
8404     * multi-selection is enabled while holding the "Shift" key.
8405     *
8406     * @note By default, multi-selection is @b disabled on gengrids
8407     *
8408     * @see elm_gengrid_multi_select_get()
8409     *
8410     * @ingroup Gengrid
8411     */
8412    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8413
8414    /**
8415     * Get whether multi-selection is enabled or disabled for a given
8416     * gengrid widget
8417     *
8418     * @param obj The gengrid object.
8419     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8420     * EINA_FALSE otherwise
8421     *
8422     * @see elm_gengrid_multi_select_set() for more details
8423     *
8424     * @ingroup Gengrid
8425     */
8426    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8427
8428    /**
8429     * Enable or disable bouncing effect for a given gengrid widget
8430     *
8431     * @param obj The gengrid object
8432     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8433     * @c EINA_FALSE to disable it
8434     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8435     * @c EINA_FALSE to disable it
8436     *
8437     * The bouncing effect occurs whenever one reaches the gengrid's
8438     * edge's while panning it -- it will scroll past its limits a
8439     * little bit and return to the edge again, in a animated for,
8440     * automatically.
8441     *
8442     * @note By default, gengrids have bouncing enabled on both axis
8443     *
8444     * @see elm_gengrid_bounce_get()
8445     *
8446     * @ingroup Gengrid
8447     */
8448    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8449
8450    /**
8451     * Get whether bouncing effects are enabled or disabled, for a
8452     * given gengrid widget, on each axis
8453     *
8454     * @param obj The gengrid object
8455     * @param h_bounce Pointer to a variable where to store the
8456     * horizontal bouncing flag.
8457     * @param v_bounce Pointer to a variable where to store the
8458     * vertical bouncing flag.
8459     *
8460     * @see elm_gengrid_bounce_set() for more details
8461     *
8462     * @ingroup Gengrid
8463     */
8464    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8465
8466    /**
8467     * Set a given gengrid widget's scrolling page size, relative to
8468     * its viewport size.
8469     *
8470     * @param obj The gengrid object
8471     * @param h_pagerel The horizontal page (relative) size
8472     * @param v_pagerel The vertical page (relative) size
8473     *
8474     * The gengrid's scroller is capable of binding scrolling by the
8475     * user to "pages". It means that, while scrolling and, specially
8476     * after releasing the mouse button, the grid will @b snap to the
8477     * nearest displaying page's area. When page sizes are set, the
8478     * grid's continuous content area is split into (equal) page sized
8479     * pieces.
8480     *
8481     * This function sets the size of a page <b>relatively to the
8482     * viewport dimensions</b> of the gengrid, for each axis. A value
8483     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8484     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8485     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8486     * 1.0. Values beyond those will make it behave behave
8487     * inconsistently. If you only want one axis to snap to pages, use
8488     * the value @c 0.0 for the other one.
8489     *
8490     * There is a function setting page size values in @b absolute
8491     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8492     * is mutually exclusive to this one.
8493     *
8494     * @see elm_gengrid_page_relative_get()
8495     *
8496     * @ingroup Gengrid
8497     */
8498    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8499
8500    /**
8501     * Get a given gengrid widget's scrolling page size, relative to
8502     * its viewport size.
8503     *
8504     * @param obj The gengrid object
8505     * @param h_pagerel Pointer to a variable where to store the
8506     * horizontal page (relative) size
8507     * @param v_pagerel Pointer to a variable where to store the
8508     * vertical page (relative) size
8509     *
8510     * @see elm_gengrid_page_relative_set() for more details
8511     *
8512     * @ingroup Gengrid
8513     */
8514    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8515
8516    /**
8517     * Set a given gengrid widget's scrolling page size
8518     *
8519     * @param obj The gengrid object
8520     * @param h_pagerel The horizontal page size, in pixels
8521     * @param v_pagerel The vertical page size, in pixels
8522     *
8523     * The gengrid's scroller is capable of binding scrolling by the
8524     * user to "pages". It means that, while scrolling and, specially
8525     * after releasing the mouse button, the grid will @b snap to the
8526     * nearest displaying page's area. When page sizes are set, the
8527     * grid's continuous content area is split into (equal) page sized
8528     * pieces.
8529     *
8530     * This function sets the size of a page of the gengrid, in pixels,
8531     * for each axis. Sane usable values are, between @c 0 and the
8532     * dimensions of @p obj, for each axis. Values beyond those will
8533     * make it behave behave inconsistently. If you only want one axis
8534     * to snap to pages, use the value @c 0 for the other one.
8535     *
8536     * There is a function setting page size values in @b relative
8537     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8538     * use is mutually exclusive to this one.
8539     *
8540     * @ingroup Gengrid
8541     */
8542    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8543
8544    /**
8545     * @brief Get gengrid current page number.
8546     *
8547     * @param obj The gengrid object
8548     * @param h_pagenumber The horizontal page number
8549     * @param v_pagenumber The vertical page number
8550     *
8551     * The page number starts from 0. 0 is the first page.
8552     * Current page means the page which meet the top-left of the viewport.
8553     * If there are two or more pages in the viewport, it returns the number of page
8554     * which meet the top-left of the viewport.
8555     *
8556     * @see elm_gengrid_last_page_get()
8557     * @see elm_gengrid_page_show()
8558     * @see elm_gengrid_page_brint_in()
8559     */
8560    EAPI void         elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8561
8562    /**
8563     * @brief Get scroll last page number.
8564     *
8565     * @param obj The gengrid object
8566     * @param h_pagenumber The horizontal page number
8567     * @param v_pagenumber The vertical page number
8568     *
8569     * The page number starts from 0. 0 is the first page.
8570     * This returns the last page number among the pages.
8571     *
8572     * @see elm_gengrid_current_page_get()
8573     * @see elm_gengrid_page_show()
8574     * @see elm_gengrid_page_brint_in()
8575     */
8576    EAPI void         elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8577
8578    /**
8579     * Show a specific virtual region within the gengrid content object by page number.
8580     *
8581     * @param obj The gengrid object
8582     * @param h_pagenumber The horizontal page number
8583     * @param v_pagenumber The vertical page number
8584     *
8585     * 0, 0 of the indicated page is located at the top-left of the viewport.
8586     * This will jump to the page directly without animation.
8587     *
8588     * Example of usage:
8589     *
8590     * @code
8591     * sc = elm_gengrid_add(win);
8592     * elm_gengrid_content_set(sc, content);
8593     * elm_gengrid_page_relative_set(sc, 1, 0);
8594     * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8595     * elm_gengrid_page_show(sc, h_page + 1, v_page);
8596     * @endcode
8597     *
8598     * @see elm_gengrid_page_bring_in()
8599     */
8600    EAPI void         elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8601
8602    /**
8603     * Show a specific virtual region within the gengrid content object by page number.
8604     *
8605     * @param obj The gengrid object
8606     * @param h_pagenumber The horizontal page number
8607     * @param v_pagenumber The vertical page number
8608     *
8609     * 0, 0 of the indicated page is located at the top-left of the viewport.
8610     * This will slide to the page with animation.
8611     *
8612     * Example of usage:
8613     *
8614     * @code
8615     * sc = elm_gengrid_add(win);
8616     * elm_gengrid_content_set(sc, content);
8617     * elm_gengrid_page_relative_set(sc, 1, 0);
8618     * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8619     * elm_gengrid_page_bring_in(sc, h_page, v_page);
8620     * @endcode
8621     *
8622     * @see elm_gengrid_page_show()
8623     */
8624     EAPI void         elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8625
8626    /**
8627     * Set for what direction a given gengrid widget will expand while
8628     * placing its items.
8629     *
8630     * @param obj The gengrid object.
8631     * @param setting @c EINA_TRUE to make the gengrid expand
8632     * horizontally, @c EINA_FALSE to expand vertically.
8633     *
8634     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8635     * in @b columns, from top to bottom and, when the space for a
8636     * column is filled, another one is started on the right, thus
8637     * expanding the grid horizontally. When in "vertical mode"
8638     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8639     * to right and, when the space for a row is filled, another one is
8640     * started below, thus expanding the grid vertically.
8641     *
8642     * @see elm_gengrid_horizontal_get()
8643     *
8644     * @ingroup Gengrid
8645     */
8646    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8647
8648    /**
8649     * Get for what direction a given gengrid widget will expand while
8650     * placing its items.
8651     *
8652     * @param obj The gengrid object.
8653     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8654     * @c EINA_FALSE if it's set to expand vertically.
8655     *
8656     * @see elm_gengrid_horizontal_set() for more detais
8657     *
8658     * @ingroup Gengrid
8659     */
8660    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8661
8662    /**
8663     * Get the first item in a given gengrid widget
8664     *
8665     * @param obj The gengrid object
8666     * @return The first item's handle or @c NULL, if there are no
8667     * items in @p obj (and on errors)
8668     *
8669     * This returns the first item in the @p obj's internal list of
8670     * items.
8671     *
8672     * @see elm_gengrid_last_item_get()
8673     *
8674     * @ingroup Gengrid
8675     */
8676    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8677
8678    /**
8679     * Get the last item in a given gengrid widget
8680     *
8681     * @param obj The gengrid object
8682     * @return The last item's handle or @c NULL, if there are no
8683     * items in @p obj (and on errors)
8684     *
8685     * This returns the last item in the @p obj's internal list of
8686     * items.
8687     *
8688     * @see elm_gengrid_first_item_get()
8689     *
8690     * @ingroup Gengrid
8691     */
8692    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8693
8694    /**
8695     * Get the @b next item in a gengrid widget's internal list of items,
8696     * given a handle to one of those items.
8697     *
8698     * @param item The gengrid item to fetch next from
8699     * @return The item after @p item, or @c NULL if there's none (and
8700     * on errors)
8701     *
8702     * This returns the item placed after the @p item, on the container
8703     * gengrid.
8704     *
8705     * @see elm_gengrid_item_prev_get()
8706     *
8707     * @ingroup Gengrid
8708     */
8709    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8710
8711    /**
8712     * Get the @b previous item in a gengrid widget's internal list of items,
8713     * given a handle to one of those items.
8714     *
8715     * @param item The gengrid item to fetch previous from
8716     * @return The item before @p item, or @c NULL if there's none (and
8717     * on errors)
8718     *
8719     * This returns the item placed before the @p item, on the container
8720     * gengrid.
8721     *
8722     * @see elm_gengrid_item_next_get()
8723     *
8724     * @ingroup Gengrid
8725     */
8726    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8727
8728    /**
8729     * Get the gengrid object's handle which contains a given gengrid
8730     * item
8731     *
8732     * @param item The item to fetch the container from
8733     * @return The gengrid (parent) object
8734     *
8735     * This returns the gengrid object itself that an item belongs to.
8736     *
8737     * @ingroup Gengrid
8738     */
8739    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8740
8741    /**
8742     * Remove a gengrid item from the its parent, deleting it.
8743     *
8744     * @param item The item to be removed.
8745     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8746     *
8747     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8748     * once.
8749     *
8750     * @ingroup Gengrid
8751     */
8752    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8753
8754    /**
8755     * Update the contents of a given gengrid item
8756     *
8757     * @param item The gengrid item
8758     *
8759     * This updates an item by calling all the item class functions
8760     * again to get the icons, labels and states. Use this when the
8761     * original item data has changed and you want thta changes to be
8762     * reflected.
8763     *
8764     * @ingroup Gengrid
8765     */
8766    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8767    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8768    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8769
8770    /**
8771     * Return the data associated to a given gengrid item
8772     *
8773     * @param item The gengrid item.
8774     * @return the data associated to this item.
8775     *
8776     * This returns the @c data value passed on the
8777     * elm_gengrid_item_append() and related item addition calls.
8778     *
8779     * @see elm_gengrid_item_append()
8780     * @see elm_gengrid_item_data_set()
8781     *
8782     * @ingroup Gengrid
8783     */
8784    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8785
8786    /**
8787     * Set the data associated to a given gengrid item
8788     *
8789     * @param item The gengrid item
8790     * @param data The new data pointer to set on it
8791     *
8792     * This @b overrides the @c data value passed on the
8793     * elm_gengrid_item_append() and related item addition calls. This
8794     * function @b won't call elm_gengrid_item_update() automatically,
8795     * so you'd issue it afterwards if you want to hove the item
8796     * updated to reflect the that new data.
8797     *
8798     * @see elm_gengrid_item_data_get()
8799     *
8800     * @ingroup Gengrid
8801     */
8802    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8803
8804    /**
8805     * Get a given gengrid item's position, relative to the whole
8806     * gengrid's grid area.
8807     *
8808     * @param item The Gengrid item.
8809     * @param x Pointer to variable where to store the item's <b>row
8810     * number</b>.
8811     * @param y Pointer to variable where to store the item's <b>column
8812     * number</b>.
8813     *
8814     * This returns the "logical" position of the item whithin the
8815     * gengrid. For example, @c (0, 1) would stand for first row,
8816     * second column.
8817     *
8818     * @ingroup Gengrid
8819     */
8820    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8821
8822    /**
8823     * Set whether a given gengrid item is selected or not
8824     *
8825     * @param item The gengrid item
8826     * @param selected Use @c EINA_TRUE, to make it selected, @c
8827     * EINA_FALSE to make it unselected
8828     *
8829     * This sets the selected state of an item. If multi selection is
8830     * not enabled on the containing gengrid and @p selected is @c
8831     * EINA_TRUE, any other previously selected items will get
8832     * unselected in favor of this new one.
8833     *
8834     * @see elm_gengrid_item_selected_get()
8835     *
8836     * @ingroup Gengrid
8837     */
8838    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8839
8840    /**
8841     * Get whether a given gengrid item is selected or not
8842     *
8843     * @param item The gengrid item
8844     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8845     *
8846     * @see elm_gengrid_item_selected_set() for more details
8847     *
8848     * @ingroup Gengrid
8849     */
8850    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8851
8852    /**
8853     * Get the real Evas object created to implement the view of a
8854     * given gengrid item
8855     *
8856     * @param item The gengrid item.
8857     * @return the Evas object implementing this item's view.
8858     *
8859     * This returns the actual Evas object used to implement the
8860     * specified gengrid item's view. This may be @c NULL, as it may
8861     * not have been created or may have been deleted, at any time, by
8862     * the gengrid. <b>Do not modify this object</b> (move, resize,
8863     * show, hide, etc.), as the gengrid is controlling it. This
8864     * function is for querying, emitting custom signals or hooking
8865     * lower level callbacks for events on that object. Do not delete
8866     * this object under any circumstances.
8867     *
8868     * @see elm_gengrid_item_data_get()
8869     *
8870     * @ingroup Gengrid
8871     */
8872    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8873
8874    /**
8875     * Show the portion of a gengrid's internal grid containing a given
8876     * item, @b immediately.
8877     *
8878     * @param item The item to display
8879     *
8880     * This causes gengrid to @b redraw its viewport's contents to the
8881     * region contining the given @p item item, if it is not fully
8882     * visible.
8883     *
8884     * @see elm_gengrid_item_bring_in()
8885     *
8886     * @ingroup Gengrid
8887     */
8888    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8889
8890    /**
8891     * Animatedly bring in, to the visible are of a gengrid, a given
8892     * item on it.
8893     *
8894     * @param item The gengrid item to display
8895     *
8896     * This causes gengrig to jump to the given @p item item and show
8897     * it (by scrolling), if it is not fully visible. This will use
8898     * animation to do so and take a period of time to complete.
8899     *
8900     * @see elm_gengrid_item_show()
8901     *
8902     * @ingroup Gengrid
8903     */
8904    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8905
8906    /**
8907     * Set whether a given gengrid item is disabled or not.
8908     *
8909     * @param item The gengrid item
8910     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8911     * to enable it back.
8912     *
8913     * A disabled item cannot be selected or unselected. It will also
8914     * change its appearance, to signal the user it's disabled.
8915     *
8916     * @see elm_gengrid_item_disabled_get()
8917     *
8918     * @ingroup Gengrid
8919     */
8920    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8921
8922    /**
8923     * Get whether a given gengrid item is disabled or not.
8924     *
8925     * @param item The gengrid item
8926     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8927     * (and on errors).
8928     *
8929     * @see elm_gengrid_item_disabled_set() for more details
8930     *
8931     * @ingroup Gengrid
8932     */
8933    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8934
8935    /**
8936     * Set the text to be shown in a given gengrid item's tooltips.
8937     *
8938     * @param item The gengrid item
8939     * @param text The text to set in the content
8940     *
8941     * This call will setup the text to be used as tooltip to that item
8942     * (analogous to elm_object_tooltip_text_set(), but being item
8943     * tooltips with higher precedence than object tooltips). It can
8944     * have only one tooltip at a time, so any previous tooltip data
8945     * will get removed.
8946     *
8947     * @ingroup Gengrid
8948     */
8949    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8950
8951    /**
8952     * Set the content to be shown in a given gengrid item's tooltips
8953     *
8954     * @param item The gengrid item.
8955     * @param func The function returning the tooltip contents.
8956     * @param data What to provide to @a func as callback data/context.
8957     * @param del_cb Called when data is not needed anymore, either when
8958     *        another callback replaces @p func, the tooltip is unset with
8959     *        elm_gengrid_item_tooltip_unset() or the owner @p item
8960     *        dies. This callback receives as its first parameter the
8961     *        given @p data, being @c event_info the item handle.
8962     *
8963     * This call will setup the tooltip's contents to @p item
8964     * (analogous to elm_object_tooltip_content_cb_set(), but being
8965     * item tooltips with higher precedence than object tooltips). It
8966     * can have only one tooltip at a time, so any previous tooltip
8967     * content will get removed. @p func (with @p data) will be called
8968     * every time Elementary needs to show the tooltip and it should
8969     * return a valid Evas object, which will be fully managed by the
8970     * tooltip system, getting deleted when the tooltip is gone.
8971     *
8972     * @ingroup Gengrid
8973     */
8974    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);
8975
8976    /**
8977     * Unset a tooltip from a given gengrid item
8978     *
8979     * @param item gengrid item to remove a previously set tooltip from.
8980     *
8981     * This call removes any tooltip set on @p item. The callback
8982     * provided as @c del_cb to
8983     * elm_gengrid_item_tooltip_content_cb_set() will be called to
8984     * notify it is not used anymore (and have resources cleaned, if
8985     * need be).
8986     *
8987     * @see elm_gengrid_item_tooltip_content_cb_set()
8988     *
8989     * @ingroup Gengrid
8990     */
8991    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8992
8993    /**
8994     * Set a different @b style for a given gengrid item's tooltip.
8995     *
8996     * @param item gengrid item with tooltip set
8997     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8998     * "default", @c "transparent", etc)
8999     *
9000     * Tooltips can have <b>alternate styles</b> to be displayed on,
9001     * which are defined by the theme set on Elementary. This function
9002     * works analogously as elm_object_tooltip_style_set(), but here
9003     * applied only to gengrid item objects. The default style for
9004     * tooltips is @c "default".
9005     *
9006     * @note before you set a style you should define a tooltip with
9007     *       elm_gengrid_item_tooltip_content_cb_set() or
9008     *       elm_gengrid_item_tooltip_text_set()
9009     *
9010     * @see elm_gengrid_item_tooltip_style_get()
9011     *
9012     * @ingroup Gengrid
9013     */
9014    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9015
9016    /**
9017     * Get the style set a given gengrid item's tooltip.
9018     *
9019     * @param item gengrid item with tooltip already set on.
9020     * @return style the theme style in use, which defaults to
9021     *         "default". If the object does not have a tooltip set,
9022     *         then @c NULL is returned.
9023     *
9024     * @see elm_gengrid_item_tooltip_style_set() for more details
9025     *
9026     * @ingroup Gengrid
9027     */
9028    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9029    /**
9030     * @brief Disable size restrictions on an object's tooltip
9031     * @param item The tooltip's anchor object
9032     * @param disable If EINA_TRUE, size restrictions are disabled
9033     * @return EINA_FALSE on failure, EINA_TRUE on success
9034     *
9035     * This function allows a tooltip to expand beyond its parant window's canvas.
9036     * It will instead be limited only by the size of the display.
9037     */
9038    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9039    /**
9040     * @brief Retrieve size restriction state of an object's tooltip
9041     * @param item The tooltip's anchor object
9042     * @return If EINA_TRUE, size restrictions are disabled
9043     *
9044     * This function returns whether a tooltip is allowed to expand beyond
9045     * its parant window's canvas.
9046     * It will instead be limited only by the size of the display.
9047     */
9048    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9049    /**
9050     * Set the type of mouse pointer/cursor decoration to be shown,
9051     * when the mouse pointer is over the given gengrid widget item
9052     *
9053     * @param item gengrid item to customize cursor on
9054     * @param cursor the cursor type's name
9055     *
9056     * This function works analogously as elm_object_cursor_set(), but
9057     * here the cursor's changing area is restricted to the item's
9058     * area, and not the whole widget's. Note that that item cursors
9059     * have precedence over widget cursors, so that a mouse over @p
9060     * item will always show cursor @p type.
9061     *
9062     * If this function is called twice for an object, a previously set
9063     * cursor will be unset on the second call.
9064     *
9065     * @see elm_object_cursor_set()
9066     * @see elm_gengrid_item_cursor_get()
9067     * @see elm_gengrid_item_cursor_unset()
9068     *
9069     * @ingroup Gengrid
9070     */
9071    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9072
9073    /**
9074     * Get the type of mouse pointer/cursor decoration set to be shown,
9075     * when the mouse pointer is over the given gengrid widget item
9076     *
9077     * @param item gengrid item with custom cursor set
9078     * @return the cursor type's name or @c NULL, if no custom cursors
9079     * were set to @p item (and on errors)
9080     *
9081     * @see elm_object_cursor_get()
9082     * @see elm_gengrid_item_cursor_set() for more details
9083     * @see elm_gengrid_item_cursor_unset()
9084     *
9085     * @ingroup Gengrid
9086     */
9087    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9088
9089    /**
9090     * Unset any custom mouse pointer/cursor decoration set to be
9091     * shown, when the mouse pointer is over the given gengrid widget
9092     * item, thus making it show the @b default cursor again.
9093     *
9094     * @param item a gengrid item
9095     *
9096     * Use this call to undo any custom settings on this item's cursor
9097     * decoration, bringing it back to defaults (no custom style set).
9098     *
9099     * @see elm_object_cursor_unset()
9100     * @see elm_gengrid_item_cursor_set() for more details
9101     *
9102     * @ingroup Gengrid
9103     */
9104    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9105
9106    /**
9107     * Set a different @b style for a given custom cursor set for a
9108     * gengrid item.
9109     *
9110     * @param item gengrid item with custom cursor set
9111     * @param style the <b>theme style</b> to use (e.g. @c "default",
9112     * @c "transparent", etc)
9113     *
9114     * This function only makes sense when one is using custom mouse
9115     * cursor decorations <b>defined in a theme file</b> , which can
9116     * have, given a cursor name/type, <b>alternate styles</b> on
9117     * it. It works analogously as elm_object_cursor_style_set(), but
9118     * here applied only to gengrid item objects.
9119     *
9120     * @warning Before you set a cursor style you should have defined a
9121     *       custom cursor previously on the item, with
9122     *       elm_gengrid_item_cursor_set()
9123     *
9124     * @see elm_gengrid_item_cursor_engine_only_set()
9125     * @see elm_gengrid_item_cursor_style_get()
9126     *
9127     * @ingroup Gengrid
9128     */
9129    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9130
9131    /**
9132     * Get the current @b style set for a given gengrid item's custom
9133     * cursor
9134     *
9135     * @param item gengrid item with custom cursor set.
9136     * @return style the cursor style in use. If the object does not
9137     *         have a cursor set, then @c NULL is returned.
9138     *
9139     * @see elm_gengrid_item_cursor_style_set() for more details
9140     *
9141     * @ingroup Gengrid
9142     */
9143    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9144
9145    /**
9146     * Set if the (custom) cursor for a given gengrid item should be
9147     * searched in its theme, also, or should only rely on the
9148     * rendering engine.
9149     *
9150     * @param item item with custom (custom) cursor already set on
9151     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9152     * only on those provided by the rendering engine, @c EINA_FALSE to
9153     * have them searched on the widget's theme, as well.
9154     *
9155     * @note This call is of use only if you've set a custom cursor
9156     * for gengrid items, with elm_gengrid_item_cursor_set().
9157     *
9158     * @note By default, cursors will only be looked for between those
9159     * provided by the rendering engine.
9160     *
9161     * @ingroup Gengrid
9162     */
9163    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9164
9165    /**
9166     * Get if the (custom) cursor for a given gengrid item is being
9167     * searched in its theme, also, or is only relying on the rendering
9168     * engine.
9169     *
9170     * @param item a gengrid item
9171     * @return @c EINA_TRUE, if cursors are being looked for only on
9172     * those provided by the rendering engine, @c EINA_FALSE if they
9173     * are being searched on the widget's theme, as well.
9174     *
9175     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9176     *
9177     * @ingroup Gengrid
9178     */
9179    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9180
9181    /**
9182     * Remove all items from a given gengrid widget
9183     *
9184     * @param obj The gengrid object.
9185     *
9186     * This removes (and deletes) all items in @p obj, leaving it
9187     * empty.
9188     *
9189     * @see elm_gengrid_item_del(), to remove just one item.
9190     *
9191     * @ingroup Gengrid
9192     */
9193    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9194
9195    /**
9196     * Get the selected item in a given gengrid widget
9197     *
9198     * @param obj The gengrid object.
9199     * @return The selected item's handleor @c NULL, if none is
9200     * selected at the moment (and on errors)
9201     *
9202     * This returns the selected item in @p obj. If multi selection is
9203     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9204     * the first item in the list is selected, which might not be very
9205     * useful. For that case, see elm_gengrid_selected_items_get().
9206     *
9207     * @ingroup Gengrid
9208     */
9209    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9210
9211    /**
9212     * Get <b>a list</b> of selected items in a given gengrid
9213     *
9214     * @param obj The gengrid object.
9215     * @return The list of selected items or @c NULL, if none is
9216     * selected at the moment (and on errors)
9217     *
9218     * This returns a list of the selected items, in the order that
9219     * they appear in the grid. This list is only valid as long as no
9220     * more items are selected or unselected (or unselected implictly
9221     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9222     * data, naturally.
9223     *
9224     * @see elm_gengrid_selected_item_get()
9225     *
9226     * @ingroup Gengrid
9227     */
9228    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9229
9230    /**
9231     * @}
9232     */
9233
9234    /**
9235     * @defgroup Clock Clock
9236     *
9237     * @image html img/widget/clock/preview-00.png
9238     * @image latex img/widget/clock/preview-00.eps
9239     *
9240     * This is a @b digital clock widget. In its default theme, it has a
9241     * vintage "flipping numbers clock" appearance, which will animate
9242     * sheets of individual algarisms individually as time goes by.
9243     *
9244     * A newly created clock will fetch system's time (already
9245     * considering local time adjustments) to start with, and will tick
9246     * accondingly. It may or may not show seconds.
9247     *
9248     * Clocks have an @b edition mode. When in it, the sheets will
9249     * display extra arrow indications on the top and bottom and the
9250     * user may click on them to raise or lower the time values. After
9251     * it's told to exit edition mode, it will keep ticking with that
9252     * new time set (it keeps the difference from local time).
9253     *
9254     * Also, when under edition mode, user clicks on the cited arrows
9255     * which are @b held for some time will make the clock to flip the
9256     * sheet, thus editing the time, continuosly and automatically for
9257     * the user. The interval between sheet flips will keep growing in
9258     * time, so that it helps the user to reach a time which is distant
9259     * from the one set.
9260     *
9261     * The time display is, by default, in military mode (24h), but an
9262     * am/pm indicator may be optionally shown, too, when it will
9263     * switch to 12h.
9264     *
9265     * Smart callbacks one can register to:
9266     * - "changed" - the clock's user changed the time
9267     *
9268     * Here is an example on its usage:
9269     * @li @ref clock_example
9270     */
9271
9272    /**
9273     * @addtogroup Clock
9274     * @{
9275     */
9276
9277    /**
9278     * Identifiers for which clock digits should be editable, when a
9279     * clock widget is in edition mode. Values may be ORed together to
9280     * make a mask, naturally.
9281     *
9282     * @see elm_clock_edit_set()
9283     * @see elm_clock_digit_edit_set()
9284     */
9285    typedef enum _Elm_Clock_Digedit
9286      {
9287         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9288         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9289         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9290         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9291         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9292         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9293         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9294         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9295      } Elm_Clock_Digedit;
9296
9297    /**
9298     * Add a new clock widget to the given parent Elementary
9299     * (container) object
9300     *
9301     * @param parent The parent object
9302     * @return a new clock widget handle or @c NULL, on errors
9303     *
9304     * This function inserts a new clock widget on the canvas.
9305     *
9306     * @ingroup Clock
9307     */
9308    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9309
9310    /**
9311     * Set a clock widget's time, programmatically
9312     *
9313     * @param obj The clock widget object
9314     * @param hrs The hours to set
9315     * @param min The minutes to set
9316     * @param sec The secondes to set
9317     *
9318     * This function updates the time that is showed by the clock
9319     * widget.
9320     *
9321     *  Values @b must be set within the following ranges:
9322     * - 0 - 23, for hours
9323     * - 0 - 59, for minutes
9324     * - 0 - 59, for seconds,
9325     *
9326     * even if the clock is not in "military" mode.
9327     *
9328     * @warning The behavior for values set out of those ranges is @b
9329     * indefined.
9330     *
9331     * @ingroup Clock
9332     */
9333    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9334
9335    /**
9336     * Get a clock widget's time values
9337     *
9338     * @param obj The clock object
9339     * @param[out] hrs Pointer to the variable to get the hours value
9340     * @param[out] min Pointer to the variable to get the minutes value
9341     * @param[out] sec Pointer to the variable to get the seconds value
9342     *
9343     * This function gets the time set for @p obj, returning
9344     * it on the variables passed as the arguments to function
9345     *
9346     * @note Use @c NULL pointers on the time values you're not
9347     * interested in: they'll be ignored by the function.
9348     *
9349     * @ingroup Clock
9350     */
9351    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9352
9353    /**
9354     * Set whether a given clock widget is under <b>edition mode</b> or
9355     * under (default) displaying-only mode.
9356     *
9357     * @param obj The clock object
9358     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9359     * put it back to "displaying only" mode
9360     *
9361     * This function makes a clock's time to be editable or not <b>by
9362     * user interaction</b>. When in edition mode, clocks @b stop
9363     * ticking, until one brings them back to canonical mode. The
9364     * elm_clock_digit_edit_set() function will influence which digits
9365     * of the clock will be editable. By default, all of them will be
9366     * (#ELM_CLOCK_NONE).
9367     *
9368     * @note am/pm sheets, if being shown, will @b always be editable
9369     * under edition mode.
9370     *
9371     * @see elm_clock_edit_get()
9372     *
9373     * @ingroup Clock
9374     */
9375    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9376
9377    /**
9378     * Retrieve whether a given clock widget is under <b>edition
9379     * mode</b> or under (default) displaying-only mode.
9380     *
9381     * @param obj The clock object
9382     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9383     * otherwise
9384     *
9385     * This function retrieves whether the clock's time can be edited
9386     * or not by user interaction.
9387     *
9388     * @see elm_clock_edit_set() for more details
9389     *
9390     * @ingroup Clock
9391     */
9392    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9393
9394    /**
9395     * Set what digits of the given clock widget should be editable
9396     * when in edition mode.
9397     *
9398     * @param obj The clock object
9399     * @param digedit Bit mask indicating the digits to be editable
9400     * (values in #Elm_Clock_Digedit).
9401     *
9402     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9403     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9404     * EINA_FALSE).
9405     *
9406     * @see elm_clock_digit_edit_get()
9407     *
9408     * @ingroup Clock
9409     */
9410    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9411
9412    /**
9413     * Retrieve what digits of the given clock widget should be
9414     * editable when in edition mode.
9415     *
9416     * @param obj The clock object
9417     * @return Bit mask indicating the digits to be editable
9418     * (values in #Elm_Clock_Digedit).
9419     *
9420     * @see elm_clock_digit_edit_set() for more details
9421     *
9422     * @ingroup Clock
9423     */
9424    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9425
9426    /**
9427     * Set if the given clock widget must show hours in military or
9428     * am/pm mode
9429     *
9430     * @param obj The clock object
9431     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9432     * to military mode
9433     *
9434     * This function sets if the clock must show hours in military or
9435     * am/pm mode. In some countries like Brazil the military mode
9436     * (00-24h-format) is used, in opposition to the USA, where the
9437     * am/pm mode is more commonly used.
9438     *
9439     * @see elm_clock_show_am_pm_get()
9440     *
9441     * @ingroup Clock
9442     */
9443    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9444
9445    /**
9446     * Get if the given clock widget shows hours in military or am/pm
9447     * mode
9448     *
9449     * @param obj The clock object
9450     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9451     * military
9452     *
9453     * This function gets if the clock shows hours in military or am/pm
9454     * mode.
9455     *
9456     * @see elm_clock_show_am_pm_set() for more details
9457     *
9458     * @ingroup Clock
9459     */
9460    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9461
9462    /**
9463     * Set if the given clock widget must show time with seconds or not
9464     *
9465     * @param obj The clock object
9466     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9467     *
9468     * This function sets if the given clock must show or not elapsed
9469     * seconds. By default, they are @b not shown.
9470     *
9471     * @see elm_clock_show_seconds_get()
9472     *
9473     * @ingroup Clock
9474     */
9475    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9476
9477    /**
9478     * Get whether the given clock widget is showing time with seconds
9479     * or not
9480     *
9481     * @param obj The clock object
9482     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9483     *
9484     * This function gets whether @p obj is showing or not the elapsed
9485     * seconds.
9486     *
9487     * @see elm_clock_show_seconds_set()
9488     *
9489     * @ingroup Clock
9490     */
9491    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9492
9493    /**
9494     * Set the interval on time updates for an user mouse button hold
9495     * on clock widgets' time edition.
9496     *
9497     * @param obj The clock object
9498     * @param interval The (first) interval value in seconds
9499     *
9500     * This interval value is @b decreased while the user holds the
9501     * mouse pointer either incrementing or decrementing a given the
9502     * clock digit's value.
9503     *
9504     * This helps the user to get to a given time distant from the
9505     * current one easier/faster, as it will start to flip quicker and
9506     * quicker on mouse button holds.
9507     *
9508     * The calculation for the next flip interval value, starting from
9509     * the one set with this call, is the previous interval divided by
9510     * 1.05, so it decreases a little bit.
9511     *
9512     * The default starting interval value for automatic flips is
9513     * @b 0.85 seconds.
9514     *
9515     * @see elm_clock_interval_get()
9516     *
9517     * @ingroup Clock
9518     */
9519    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9520
9521    /**
9522     * Get the interval on time updates for an user mouse button hold
9523     * on clock widgets' time edition.
9524     *
9525     * @param obj The clock object
9526     * @return The (first) interval value, in seconds, set on it
9527     *
9528     * @see elm_clock_interval_set() for more details
9529     *
9530     * @ingroup Clock
9531     */
9532    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9533
9534    /**
9535     * @}
9536     */
9537
9538    /**
9539     * @defgroup Layout Layout
9540     *
9541     * @image html img/widget/layout/preview-00.png
9542     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9543     *
9544     * @image html img/layout-predefined.png
9545     * @image latex img/layout-predefined.eps width=\textwidth
9546     *
9547     * This is a container widget that takes a standard Edje design file and
9548     * wraps it very thinly in a widget.
9549     *
9550     * An Edje design (theme) file has a very wide range of possibilities to
9551     * describe the behavior of elements added to the Layout. Check out the Edje
9552     * documentation and the EDC reference to get more information about what can
9553     * be done with Edje.
9554     *
9555     * Just like @ref List, @ref Box, and other container widgets, any
9556     * object added to the Layout will become its child, meaning that it will be
9557     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9558     *
9559     * The Layout widget can contain as many Contents, Boxes or Tables as
9560     * described in its theme file. For instance, objects can be added to
9561     * different Tables by specifying the respective Table part names. The same
9562     * is valid for Content and Box.
9563     *
9564     * The objects added as child of the Layout will behave as described in the
9565     * part description where they were added. There are 3 possible types of
9566     * parts where a child can be added:
9567     *
9568     * @section secContent Content (SWALLOW part)
9569     *
9570     * Only one object can be added to the @c SWALLOW part (but you still can
9571     * have many @c SWALLOW parts and one object on each of them). Use the @c
9572     * elm_layout_content_* set of functions to set, retrieve and unset objects
9573     * as content of the @c SWALLOW. After being set to this part, the object
9574     * size, position, visibility, clipping and other description properties
9575     * will be totally controled by the description of the given part (inside
9576     * the Edje theme file).
9577     *
9578     * One can use @c evas_object_size_hint_* functions on the child to have some
9579     * kind of control over its behavior, but the resulting behavior will still
9580     * depend heavily on the @c SWALLOW part description.
9581     *
9582     * The Edje theme also can change the part description, based on signals or
9583     * scripts running inside the theme. This change can also be animated. All of
9584     * this will affect the child object set as content accordingly. The object
9585     * size will be changed if the part size is changed, it will animate move if
9586     * the part is moving, and so on.
9587     *
9588     * The following picture demonstrates a Layout widget with a child object
9589     * added to its @c SWALLOW:
9590     *
9591     * @image html layout_swallow.png
9592     * @image latex layout_swallow.eps width=\textwidth
9593     *
9594     * @section secBox Box (BOX part)
9595     *
9596     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9597     * allows one to add objects to the box and have them distributed along its
9598     * area, accordingly to the specified @a layout property (now by @a layout we
9599     * mean the chosen layouting design of the Box, not the Layout widget
9600     * itself).
9601     *
9602     * A similar effect for having a box with its position, size and other things
9603     * controled by the Layout theme would be to create an Elementary @ref Box
9604     * widget and add it as a Content in the @c SWALLOW part.
9605     *
9606     * The main difference of using the Layout Box is that its behavior, the box
9607     * properties like layouting format, padding, align, etc. will be all
9608     * controled by the theme. This means, for example, that a signal could be
9609     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9610     * handled the signal by changing the box padding, or align, or both. Using
9611     * the Elementary @ref Box widget is not necessarily harder or easier, it
9612     * just depends on the circunstances and requirements.
9613     *
9614     * The Layout Box can be used through the @c elm_layout_box_* set of
9615     * functions.
9616     *
9617     * The following picture demonstrates a Layout widget with many child objects
9618     * added to its @c BOX part:
9619     *
9620     * @image html layout_box.png
9621     * @image latex layout_box.eps width=\textwidth
9622     *
9623     * @section secTable Table (TABLE part)
9624     *
9625     * Just like the @ref secBox, the Layout Table is very similar to the
9626     * Elementary @ref Table widget. It allows one to add objects to the Table
9627     * specifying the row and column where the object should be added, and any
9628     * column or row span if necessary.
9629     *
9630     * Again, we could have this design by adding a @ref Table widget to the @c
9631     * SWALLOW part using elm_layout_content_set(). The same difference happens
9632     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9633     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9634     *
9635     * The Layout Table can be used through the @c elm_layout_table_* set of
9636     * functions.
9637     *
9638     * The following picture demonstrates a Layout widget with many child objects
9639     * added to its @c TABLE part:
9640     *
9641     * @image html layout_table.png
9642     * @image latex layout_table.eps width=\textwidth
9643     *
9644     * @section secPredef Predefined Layouts
9645     *
9646     * Another interesting thing about the Layout widget is that it offers some
9647     * predefined themes that come with the default Elementary theme. These
9648     * themes can be set by the call elm_layout_theme_set(), and provide some
9649     * basic functionality depending on the theme used.
9650     *
9651     * Most of them already send some signals, some already provide a toolbar or
9652     * back and next buttons.
9653     *
9654     * These are available predefined theme layouts. All of them have class = @c
9655     * layout, group = @c application, and style = one of the following options:
9656     *
9657     * @li @c toolbar-content - application with toolbar and main content area
9658     * @li @c toolbar-content-back - application with toolbar and main content
9659     * area with a back button and title area
9660     * @li @c toolbar-content-back-next - application with toolbar and main
9661     * content area with a back and next buttons and title area
9662     * @li @c content-back - application with a main content area with a back
9663     * button and title area
9664     * @li @c content-back-next - application with a main content area with a
9665     * back and next buttons and title area
9666     * @li @c toolbar-vbox - application with toolbar and main content area as a
9667     * vertical box
9668     * @li @c toolbar-table - application with toolbar and main content area as a
9669     * table
9670     *
9671     * @section secExamples Examples
9672     *
9673     * Some examples of the Layout widget can be found here:
9674     * @li @ref layout_example_01
9675     * @li @ref layout_example_02
9676     * @li @ref layout_example_03
9677     * @li @ref layout_example_edc
9678     *
9679     */
9680
9681    /**
9682     * Add a new layout to the parent
9683     *
9684     * @param parent The parent object
9685     * @return The new object or NULL if it cannot be created
9686     *
9687     * @see elm_layout_file_set()
9688     * @see elm_layout_theme_set()
9689     *
9690     * @ingroup Layout
9691     */
9692    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9693    /**
9694     * Set the file that will be used as layout
9695     *
9696     * @param obj The layout object
9697     * @param file The path to file (edj) that will be used as layout
9698     * @param group The group that the layout belongs in edje file
9699     *
9700     * @return (1 = success, 0 = error)
9701     *
9702     * @ingroup Layout
9703     */
9704    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9705    /**
9706     * Set the edje group from the elementary theme that will be used as layout
9707     *
9708     * @param obj The layout object
9709     * @param clas the clas of the group
9710     * @param group the group
9711     * @param style the style to used
9712     *
9713     * @return (1 = success, 0 = error)
9714     *
9715     * @ingroup Layout
9716     */
9717    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9718    /**
9719     * Set the layout content.
9720     *
9721     * @param obj The layout object
9722     * @param swallow The swallow part name in the edje file
9723     * @param content The child that will be added in this layout object
9724     *
9725     * Once the content object is set, a previously set one will be deleted.
9726     * If you want to keep that old content object, use the
9727     * elm_layout_content_unset() function.
9728     *
9729     * @note In an Edje theme, the part used as a content container is called @c
9730     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9731     * expected to be a part name just like the second parameter of
9732     * elm_layout_box_append().
9733     *
9734     * @see elm_layout_box_append()
9735     * @see elm_layout_content_get()
9736     * @see elm_layout_content_unset()
9737     * @see @ref secBox
9738     *
9739     * @ingroup Layout
9740     */
9741    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9742    /**
9743     * Get the child object in the given content part.
9744     *
9745     * @param obj The layout object
9746     * @param swallow The SWALLOW part to get its content
9747     *
9748     * @return The swallowed object or NULL if none or an error occurred
9749     *
9750     * @see elm_layout_content_set()
9751     *
9752     * @ingroup Layout
9753     */
9754    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9755    /**
9756     * Unset the layout content.
9757     *
9758     * @param obj The layout object
9759     * @param swallow The swallow part name in the edje file
9760     * @return The content that was being used
9761     *
9762     * Unparent and return the content object which was set for this part.
9763     *
9764     * @see elm_layout_content_set()
9765     *
9766     * @ingroup Layout
9767     */
9768     EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9769    /**
9770     * Set the text of the given part
9771     *
9772     * @param obj The layout object
9773     * @param part The TEXT part where to set the text
9774     * @param text The text to set
9775     *
9776     * @ingroup Layout
9777     * @deprecated use elm_object_text_* instead.
9778     */
9779    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9780    /**
9781     * Get the text set in the given part
9782     *
9783     * @param obj The layout object
9784     * @param part The TEXT part to retrieve the text off
9785     *
9786     * @return The text set in @p part
9787     *
9788     * @ingroup Layout
9789     * @deprecated use elm_object_text_* instead.
9790     */
9791    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9792    /**
9793     * Append child to layout box part.
9794     *
9795     * @param obj the layout object
9796     * @param part the box part to which the object will be appended.
9797     * @param child the child object to append to box.
9798     *
9799     * Once the object is appended, it will become child of the layout. Its
9800     * lifetime will be bound to the layout, whenever the layout dies the child
9801     * will be deleted automatically. One should use elm_layout_box_remove() to
9802     * make this layout forget about the object.
9803     *
9804     * @see elm_layout_box_prepend()
9805     * @see elm_layout_box_insert_before()
9806     * @see elm_layout_box_insert_at()
9807     * @see elm_layout_box_remove()
9808     *
9809     * @ingroup Layout
9810     */
9811    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9812    /**
9813     * Prepend child to layout box part.
9814     *
9815     * @param obj the layout object
9816     * @param part the box part to prepend.
9817     * @param child the child object to prepend to box.
9818     *
9819     * Once the object is prepended, it will become child of the layout. Its
9820     * lifetime will be bound to the layout, whenever the layout dies the child
9821     * will be deleted automatically. One should use elm_layout_box_remove() to
9822     * make this layout forget about the object.
9823     *
9824     * @see elm_layout_box_append()
9825     * @see elm_layout_box_insert_before()
9826     * @see elm_layout_box_insert_at()
9827     * @see elm_layout_box_remove()
9828     *
9829     * @ingroup Layout
9830     */
9831    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9832    /**
9833     * Insert child to layout box part before a reference object.
9834     *
9835     * @param obj the layout object
9836     * @param part the box part to insert.
9837     * @param child the child object to insert into box.
9838     * @param reference another reference object to insert before in box.
9839     *
9840     * Once the object is inserted, it will become child of the layout. Its
9841     * lifetime will be bound to the layout, whenever the layout dies the child
9842     * will be deleted automatically. One should use elm_layout_box_remove() to
9843     * make this layout forget about the object.
9844     *
9845     * @see elm_layout_box_append()
9846     * @see elm_layout_box_prepend()
9847     * @see elm_layout_box_insert_before()
9848     * @see elm_layout_box_remove()
9849     *
9850     * @ingroup Layout
9851     */
9852    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9853    /**
9854     * Insert child to layout box part at a given position.
9855     *
9856     * @param obj the layout object
9857     * @param part the box part to insert.
9858     * @param child the child object to insert into box.
9859     * @param pos the numeric position >=0 to insert the child.
9860     *
9861     * Once the object is inserted, it will become child of the layout. Its
9862     * lifetime will be bound to the layout, whenever the layout dies the child
9863     * will be deleted automatically. One should use elm_layout_box_remove() to
9864     * make this layout forget about the object.
9865     *
9866     * @see elm_layout_box_append()
9867     * @see elm_layout_box_prepend()
9868     * @see elm_layout_box_insert_before()
9869     * @see elm_layout_box_remove()
9870     *
9871     * @ingroup Layout
9872     */
9873    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9874    /**
9875     * Remove a child of the given part box.
9876     *
9877     * @param obj The layout object
9878     * @param part The box part name to remove child.
9879     * @param child The object to remove from box.
9880     * @return The object that was being used, or NULL if not found.
9881     *
9882     * The object will be removed from the box part and its lifetime will
9883     * not be handled by the layout anymore. This is equivalent to
9884     * elm_layout_content_unset() for box.
9885     *
9886     * @see elm_layout_box_append()
9887     * @see elm_layout_box_remove_all()
9888     *
9889     * @ingroup Layout
9890     */
9891    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9892    /**
9893     * Remove all child of the given part box.
9894     *
9895     * @param obj The layout object
9896     * @param part The box part name to remove child.
9897     * @param clear If EINA_TRUE, then all objects will be deleted as
9898     *        well, otherwise they will just be removed and will be
9899     *        dangling on the canvas.
9900     *
9901     * The objects will be removed from the box part and their lifetime will
9902     * not be handled by the layout anymore. This is equivalent to
9903     * elm_layout_box_remove() for all box children.
9904     *
9905     * @see elm_layout_box_append()
9906     * @see elm_layout_box_remove()
9907     *
9908     * @ingroup Layout
9909     */
9910    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9911    /**
9912     * Insert child to layout table part.
9913     *
9914     * @param obj the layout object
9915     * @param part the box part to pack child.
9916     * @param child_obj the child object to pack into table.
9917     * @param col the column to which the child should be added. (>= 0)
9918     * @param row the row to which the child should be added. (>= 0)
9919     * @param colspan how many columns should be used to store this object. (>=
9920     *        1)
9921     * @param rowspan how many rows should be used to store this object. (>= 1)
9922     *
9923     * Once the object is inserted, it will become child of the table. Its
9924     * lifetime will be bound to the layout, and whenever the layout dies the
9925     * child will be deleted automatically. One should use
9926     * elm_layout_table_remove() to make this layout forget about the object.
9927     *
9928     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9929     * more space than a single cell. For instance, the following code:
9930     * @code
9931     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9932     * @endcode
9933     *
9934     * Would result in an object being added like the following picture:
9935     *
9936     * @image html layout_colspan.png
9937     * @image latex layout_colspan.eps width=\textwidth
9938     *
9939     * @see elm_layout_table_unpack()
9940     * @see elm_layout_table_clear()
9941     *
9942     * @ingroup Layout
9943     */
9944    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);
9945    /**
9946     * Unpack (remove) a child of the given part table.
9947     *
9948     * @param obj The layout object
9949     * @param part The table part name to remove child.
9950     * @param child_obj The object to remove from table.
9951     * @return The object that was being used, or NULL if not found.
9952     *
9953     * The object will be unpacked from the table part and its lifetime
9954     * will not be handled by the layout anymore. This is equivalent to
9955     * elm_layout_content_unset() for table.
9956     *
9957     * @see elm_layout_table_pack()
9958     * @see elm_layout_table_clear()
9959     *
9960     * @ingroup Layout
9961     */
9962    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9963    /**
9964     * Remove all child of the given part table.
9965     *
9966     * @param obj The layout object
9967     * @param part The table part name to remove child.
9968     * @param clear If EINA_TRUE, then all objects will be deleted as
9969     *        well, otherwise they will just be removed and will be
9970     *        dangling on the canvas.
9971     *
9972     * The objects will be removed from the table part and their lifetime will
9973     * not be handled by the layout anymore. This is equivalent to
9974     * elm_layout_table_unpack() for all table children.
9975     *
9976     * @see elm_layout_table_pack()
9977     * @see elm_layout_table_unpack()
9978     *
9979     * @ingroup Layout
9980     */
9981    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9982    /**
9983     * Get the edje layout
9984     *
9985     * @param obj The layout object
9986     *
9987     * @return A Evas_Object with the edje layout settings loaded
9988     * with function elm_layout_file_set
9989     *
9990     * This returns the edje object. It is not expected to be used to then
9991     * swallow objects via edje_object_part_swallow() for example. Use
9992     * elm_layout_content_set() instead so child object handling and sizing is
9993     * done properly.
9994     *
9995     * @note This function should only be used if you really need to call some
9996     * low level Edje function on this edje object. All the common stuff (setting
9997     * text, emitting signals, hooking callbacks to signals, etc.) can be done
9998     * with proper elementary functions.
9999     *
10000     * @see elm_object_signal_callback_add()
10001     * @see elm_object_signal_emit()
10002     * @see elm_object_text_part_set()
10003     * @see elm_layout_content_set()
10004     * @see elm_layout_box_append()
10005     * @see elm_layout_table_pack()
10006     * @see elm_layout_data_get()
10007     *
10008     * @ingroup Layout
10009     */
10010    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10011    /**
10012     * Get the edje data from the given layout
10013     *
10014     * @param obj The layout object
10015     * @param key The data key
10016     *
10017     * @return The edje data string
10018     *
10019     * This function fetches data specified inside the edje theme of this layout.
10020     * This function return NULL if data is not found.
10021     *
10022     * In EDC this comes from a data block within the group block that @p
10023     * obj was loaded from. E.g.
10024     *
10025     * @code
10026     * collections {
10027     *   group {
10028     *     name: "a_group";
10029     *     data {
10030     *       item: "key1" "value1";
10031     *       item: "key2" "value2";
10032     *     }
10033     *   }
10034     * }
10035     * @endcode
10036     *
10037     * @ingroup Layout
10038     */
10039    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10040    /**
10041     * Eval sizing
10042     *
10043     * @param obj The layout object
10044     *
10045     * Manually forces a sizing re-evaluation. This is useful when the minimum
10046     * size required by the edje theme of this layout has changed. The change on
10047     * the minimum size required by the edje theme is not immediately reported to
10048     * the elementary layout, so one needs to call this function in order to tell
10049     * the widget (layout) that it needs to reevaluate its own size.
10050     *
10051     * The minimum size of the theme is calculated based on minimum size of
10052     * parts, the size of elements inside containers like box and table, etc. All
10053     * of this can change due to state changes, and that's when this function
10054     * should be called.
10055     *
10056     * Also note that a standard signal of "size,eval" "elm" emitted from the
10057     * edje object will cause this to happen too.
10058     *
10059     * @ingroup Layout
10060     */
10061    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10062
10063    /**
10064     * Sets a specific cursor for an edje part.
10065     *
10066     * @param obj The layout object.
10067     * @param part_name a part from loaded edje group.
10068     * @param cursor cursor name to use, see Elementary_Cursor.h
10069     *
10070     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10071     *         part not exists or it has "mouse_events: 0".
10072     *
10073     * @ingroup Layout
10074     */
10075    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10076
10077    /**
10078     * Get the cursor to be shown when mouse is over an edje part
10079     *
10080     * @param obj The layout object.
10081     * @param part_name a part from loaded edje group.
10082     * @return the cursor name.
10083     *
10084     * @ingroup Layout
10085     */
10086    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10087
10088    /**
10089     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10090     *
10091     * @param obj The layout object.
10092     * @param part_name a part from loaded edje group, that had a cursor set
10093     *        with elm_layout_part_cursor_set().
10094     *
10095     * @ingroup Layout
10096     */
10097    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10098
10099    /**
10100     * Sets a specific cursor style for an edje part.
10101     *
10102     * @param obj The layout object.
10103     * @param part_name a part from loaded edje group.
10104     * @param style the theme style to use (default, transparent, ...)
10105     *
10106     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10107     *         part not exists or it did not had a cursor set.
10108     *
10109     * @ingroup Layout
10110     */
10111    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10112
10113    /**
10114     * Gets a specific cursor style for an edje part.
10115     *
10116     * @param obj The layout object.
10117     * @param part_name a part from loaded edje group.
10118     *
10119     * @return the theme style in use, defaults to "default". If the
10120     *         object does not have a cursor set, then NULL is returned.
10121     *
10122     * @ingroup Layout
10123     */
10124    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10125
10126    /**
10127     * Sets if the cursor set should be searched on the theme or should use
10128     * the provided by the engine, only.
10129     *
10130     * @note before you set if should look on theme you should define a
10131     * cursor with elm_layout_part_cursor_set(). By default it will only
10132     * look for cursors provided by the engine.
10133     *
10134     * @param obj The layout object.
10135     * @param part_name a part from loaded edje group.
10136     * @param engine_only if cursors should be just provided by the engine
10137     *        or should also search on widget's theme as well
10138     *
10139     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10140     *         part not exists or it did not had a cursor set.
10141     *
10142     * @ingroup Layout
10143     */
10144    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);
10145
10146    /**
10147     * Gets a specific cursor engine_only for an edje part.
10148     *
10149     * @param obj The layout object.
10150     * @param part_name a part from loaded edje group.
10151     *
10152     * @return whenever the cursor is just provided by engine or also from theme.
10153     *
10154     * @ingroup Layout
10155     */
10156    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10157
10158 /**
10159  * @def elm_layout_icon_set
10160  * Convienience macro to set the icon object in a layout that follows the
10161  * Elementary naming convention for its parts.
10162  *
10163  * @ingroup Layout
10164  */
10165 #define elm_layout_icon_set(_ly, _obj) \
10166   do { \
10167     const char *sig; \
10168     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10169     if ((_obj)) sig = "elm,state,icon,visible"; \
10170     else sig = "elm,state,icon,hidden"; \
10171     elm_object_signal_emit((_ly), sig, "elm"); \
10172   } while (0)
10173
10174 /**
10175  * @def elm_layout_icon_get
10176  * Convienience macro to get the icon object from a layout that follows the
10177  * Elementary naming convention for its parts.
10178  *
10179  * @ingroup Layout
10180  */
10181 #define elm_layout_icon_get(_ly) \
10182   elm_layout_content_get((_ly), "elm.swallow.icon")
10183
10184 /**
10185  * @def elm_layout_end_set
10186  * Convienience macro to set the end object in a layout that follows the
10187  * Elementary naming convention for its parts.
10188  *
10189  * @ingroup Layout
10190  */
10191 #define elm_layout_end_set(_ly, _obj) \
10192   do { \
10193     const char *sig; \
10194     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10195     if ((_obj)) sig = "elm,state,end,visible"; \
10196     else sig = "elm,state,end,hidden"; \
10197     elm_object_signal_emit((_ly), sig, "elm"); \
10198   } while (0)
10199
10200 /**
10201  * @def elm_layout_end_get
10202  * Convienience macro to get the end object in a layout that follows the
10203  * Elementary naming convention for its parts.
10204  *
10205  * @ingroup Layout
10206  */
10207 #define elm_layout_end_get(_ly) \
10208   elm_layout_content_get((_ly), "elm.swallow.end")
10209
10210 /**
10211  * @def elm_layout_label_set
10212  * Convienience macro to set the label in a layout that follows the
10213  * Elementary naming convention for its parts.
10214  *
10215  * @ingroup Layout
10216  * @deprecated use elm_object_text_* instead.
10217  */
10218 #define elm_layout_label_set(_ly, _txt) \
10219   elm_layout_text_set((_ly), "elm.text", (_txt))
10220
10221 /**
10222  * @def elm_layout_label_get
10223  * Convienience macro to get the label in a layout that follows the
10224  * Elementary naming convention for its parts.
10225  *
10226  * @ingroup Layout
10227  * @deprecated use elm_object_text_* instead.
10228  */
10229 #define elm_layout_label_get(_ly) \
10230   elm_layout_text_get((_ly), "elm.text")
10231
10232    /* smart callbacks called:
10233     * "theme,changed" - when elm theme is changed.
10234     */
10235
10236    /**
10237     * @defgroup Notify Notify
10238     *
10239     * @image html img/widget/notify/preview-00.png
10240     * @image latex img/widget/notify/preview-00.eps
10241     *
10242     * Display a container in a particular region of the parent(top, bottom,
10243     * etc.  A timeout can be set to automatically hide the notify. This is so
10244     * that, after an evas_object_show() on a notify object, if a timeout was set
10245     * on it, it will @b automatically get hidden after that time.
10246     *
10247     * Signals that you can add callbacks for are:
10248     * @li "timeout" - when timeout happens on notify and it's hidden
10249     * @li "block,clicked" - when a click outside of the notify happens
10250     *
10251     * @ref tutorial_notify show usage of the API.
10252     *
10253     * @{
10254     */
10255    /**
10256     * @brief Possible orient values for notify.
10257     *
10258     * This values should be used in conjunction to elm_notify_orient_set() to
10259     * set the position in which the notify should appear(relative to its parent)
10260     * and in conjunction with elm_notify_orient_get() to know where the notify
10261     * is appearing.
10262     */
10263    typedef enum _Elm_Notify_Orient
10264      {
10265         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10266         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10267         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10268         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10269         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10270         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10271         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10272         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10273         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10274         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10275      } Elm_Notify_Orient;
10276    /**
10277     * @brief Add a new notify to the parent
10278     *
10279     * @param parent The parent object
10280     * @return The new object or NULL if it cannot be created
10281     */
10282    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10283    /**
10284     * @brief Set the content of the notify widget
10285     *
10286     * @param obj The notify object
10287     * @param content The content will be filled in this notify object
10288     *
10289     * Once the content object is set, a previously set one will be deleted. If
10290     * you want to keep that old content object, use the
10291     * elm_notify_content_unset() function.
10292     */
10293    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10294    /**
10295     * @brief Unset the content of the notify widget
10296     *
10297     * @param obj The notify object
10298     * @return The content that was being used
10299     *
10300     * Unparent and return the content object which was set for this widget
10301     *
10302     * @see elm_notify_content_set()
10303     */
10304    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10305    /**
10306     * @brief Return the content of the notify widget
10307     *
10308     * @param obj The notify object
10309     * @return The content that is being used
10310     *
10311     * @see elm_notify_content_set()
10312     */
10313    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10314    /**
10315     * @brief Set the notify parent
10316     *
10317     * @param obj The notify object
10318     * @param content The new parent
10319     *
10320     * Once the parent object is set, a previously set one will be disconnected
10321     * and replaced.
10322     */
10323    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10324    /**
10325     * @brief Get the notify parent
10326     *
10327     * @param obj The notify object
10328     * @return The parent
10329     *
10330     * @see elm_notify_parent_set()
10331     */
10332    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10333    /**
10334     * @brief Set the orientation
10335     *
10336     * @param obj The notify object
10337     * @param orient The new orientation
10338     *
10339     * Sets the position in which the notify will appear in its parent.
10340     *
10341     * @see @ref Elm_Notify_Orient for possible values.
10342     */
10343    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10344    /**
10345     * @brief Return the orientation
10346     * @param obj The notify object
10347     * @return The orientation of the notification
10348     *
10349     * @see elm_notify_orient_set()
10350     * @see Elm_Notify_Orient
10351     */
10352    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10353    /**
10354     * @brief Set the time interval after which the notify window is going to be
10355     * hidden.
10356     *
10357     * @param obj The notify object
10358     * @param time The timeout in seconds
10359     *
10360     * This function sets a timeout and starts the timer controlling when the
10361     * notify is hidden. Since calling evas_object_show() on a notify restarts
10362     * the timer controlling when the notify is hidden, setting this before the
10363     * notify is shown will in effect mean starting the timer when the notify is
10364     * shown.
10365     *
10366     * @note Set a value <= 0.0 to disable a running timer.
10367     *
10368     * @note If the value > 0.0 and the notify is previously visible, the
10369     * timer will be started with this value, canceling any running timer.
10370     */
10371    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10372    /**
10373     * @brief Return the timeout value (in seconds)
10374     * @param obj the notify object
10375     *
10376     * @see elm_notify_timeout_set()
10377     */
10378    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10379    /**
10380     * @brief Sets whether events should be passed to by a click outside
10381     * its area.
10382     *
10383     * @param obj The notify object
10384     * @param repeats EINA_TRUE Events are repeats, else no
10385     *
10386     * When true if the user clicks outside the window the events will be caught
10387     * by the others widgets, else the events are blocked.
10388     *
10389     * @note The default value is EINA_TRUE.
10390     */
10391    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10392    /**
10393     * @brief Return true if events are repeat below the notify object
10394     * @param obj the notify object
10395     *
10396     * @see elm_notify_repeat_events_set()
10397     */
10398    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10399    /**
10400     * @}
10401     */
10402
10403    /**
10404     * @defgroup Hover Hover
10405     *
10406     * @image html img/widget/hover/preview-00.png
10407     * @image latex img/widget/hover/preview-00.eps
10408     *
10409     * A Hover object will hover over its @p parent object at the @p target
10410     * location. Anything in the background will be given a darker coloring to
10411     * indicate that the hover object is on top (at the default theme). When the
10412     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10413     * clicked that @b doesn't cause the hover to be dismissed.
10414     *
10415     * @note The hover object will take up the entire space of @p target
10416     * object.
10417     *
10418     * Elementary has the following styles for the hover widget:
10419     * @li default
10420     * @li popout
10421     * @li menu
10422     * @li hoversel_vertical
10423     *
10424     * The following are the available position for content:
10425     * @li left
10426     * @li top-left
10427     * @li top
10428     * @li top-right
10429     * @li right
10430     * @li bottom-right
10431     * @li bottom
10432     * @li bottom-left
10433     * @li middle
10434     * @li smart
10435     *
10436     * Signals that you can add callbacks for are:
10437     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10438     * @li "smart,changed" - a content object placed under the "smart"
10439     *                   policy was replaced to a new slot direction.
10440     *
10441     * See @ref tutorial_hover for more information.
10442     *
10443     * @{
10444     */
10445    typedef enum _Elm_Hover_Axis
10446      {
10447         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10448         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10449         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10450         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10451      } Elm_Hover_Axis;
10452    /**
10453     * @brief Adds a hover object to @p parent
10454     *
10455     * @param parent The parent object
10456     * @return The hover object or NULL if one could not be created
10457     */
10458    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10459    /**
10460     * @brief Sets the target object for the hover.
10461     *
10462     * @param obj The hover object
10463     * @param target The object to center the hover onto. The hover
10464     *
10465     * This function will cause the hover to be centered on the target object.
10466     */
10467    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10468    /**
10469     * @brief Gets the target object for the hover.
10470     *
10471     * @param obj The hover object
10472     * @param parent The object to locate the hover over.
10473     *
10474     * @see elm_hover_target_set()
10475     */
10476    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10477    /**
10478     * @brief Sets the parent object for the hover.
10479     *
10480     * @param obj The hover object
10481     * @param parent The object to locate the hover over.
10482     *
10483     * This function will cause the hover to take up the entire space that the
10484     * parent object fills.
10485     */
10486    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10487    /**
10488     * @brief Gets the parent object for the hover.
10489     *
10490     * @param obj The hover object
10491     * @return The parent object to locate the hover over.
10492     *
10493     * @see elm_hover_parent_set()
10494     */
10495    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10496    /**
10497     * @brief Sets the content of the hover object and the direction in which it
10498     * will pop out.
10499     *
10500     * @param obj The hover object
10501     * @param swallow The direction that the object will be displayed
10502     * at. Accepted values are "left", "top-left", "top", "top-right",
10503     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10504     * "smart".
10505     * @param content The content to place at @p swallow
10506     *
10507     * Once the content object is set for a given direction, a previously
10508     * set one (on the same direction) will be deleted. If you want to
10509     * keep that old content object, use the elm_hover_content_unset()
10510     * function.
10511     *
10512     * All directions may have contents at the same time, except for
10513     * "smart". This is a special placement hint and its use case
10514     * independs of the calculations coming from
10515     * elm_hover_best_content_location_get(). Its use is for cases when
10516     * one desires only one hover content, but with a dinamic special
10517     * placement within the hover area. The content's geometry, whenever
10518     * it changes, will be used to decide on a best location not
10519     * extrapolating the hover's parent object view to show it in (still
10520     * being the hover's target determinant of its medium part -- move and
10521     * resize it to simulate finger sizes, for example). If one of the
10522     * directions other than "smart" are used, a previously content set
10523     * using it will be deleted, and vice-versa.
10524     */
10525    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10526    /**
10527     * @brief Get the content of the hover object, in a given direction.
10528     *
10529     * Return the content object which was set for this widget in the
10530     * @p swallow direction.
10531     *
10532     * @param obj The hover object
10533     * @param swallow The direction that the object was display at.
10534     * @return The content that was being used
10535     *
10536     * @see elm_hover_content_set()
10537     */
10538    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10539    /**
10540     * @brief Unset the content of the hover object, in a given direction.
10541     *
10542     * Unparent and return the content object set at @p swallow direction.
10543     *
10544     * @param obj The hover object
10545     * @param swallow The direction that the object was display at.
10546     * @return The content that was being used.
10547     *
10548     * @see elm_hover_content_set()
10549     */
10550    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10551    /**
10552     * @brief Returns the best swallow location for content in the hover.
10553     *
10554     * @param obj The hover object
10555     * @param pref_axis The preferred orientation axis for the hover object to use
10556     * @return The edje location to place content into the hover or @c
10557     *         NULL, on errors.
10558     *
10559     * Best is defined here as the location at which there is the most available
10560     * space.
10561     *
10562     * @p pref_axis may be one of
10563     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10564     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10565     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10566     * - @c ELM_HOVER_AXIS_BOTH -- both
10567     *
10568     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10569     * nescessarily be along the horizontal axis("left" or "right"). If
10570     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10571     * be along the vertical axis("top" or "bottom"). Chossing
10572     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10573     * returned position may be in either axis.
10574     *
10575     * @see elm_hover_content_set()
10576     */
10577    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10578    /**
10579     * @}
10580     */
10581
10582    /* entry */
10583    /**
10584     * @defgroup Entry Entry
10585     *
10586     * @image html img/widget/entry/preview-00.png
10587     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10588     * @image html img/widget/entry/preview-01.png
10589     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10590     * @image html img/widget/entry/preview-02.png
10591     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10592     * @image html img/widget/entry/preview-03.png
10593     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10594     *
10595     * An entry is a convenience widget which shows a box that the user can
10596     * enter text into. Entries by default don't scroll, so they grow to
10597     * accomodate the entire text, resizing the parent window as needed. This
10598     * can be changed with the elm_entry_scrollable_set() function.
10599     *
10600     * They can also be single line or multi line (the default) and when set
10601     * to multi line mode they support text wrapping in any of the modes
10602     * indicated by #Elm_Wrap_Type.
10603     *
10604     * Other features include password mode, filtering of inserted text with
10605     * elm_entry_text_filter_append() and related functions, inline "items" and
10606     * formatted markup text.
10607     *
10608     * @section entry-markup Formatted text
10609     *
10610     * The markup tags supported by the Entry are defined by the theme, but
10611     * even when writing new themes or extensions it's a good idea to stick to
10612     * a sane default, to maintain coherency and avoid application breakages.
10613     * Currently defined by the default theme are the following tags:
10614     * @li \<br\>: Inserts a line break.
10615     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10616     * breaks.
10617     * @li \<tab\>: Inserts a tab.
10618     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10619     * enclosed text.
10620     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10621     * @li \<link\>...\</link\>: Underlines the enclosed text.
10622     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10623     *
10624     * @section entry-special Special markups
10625     *
10626     * Besides those used to format text, entries support two special markup
10627     * tags used to insert clickable portions of text or items inlined within
10628     * the text.
10629     *
10630     * @subsection entry-anchors Anchors
10631     *
10632     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10633     * \</a\> tags and an event will be generated when this text is clicked,
10634     * like this:
10635     *
10636     * @code
10637     * This text is outside <a href=anc-01>but this one is an anchor</a>
10638     * @endcode
10639     *
10640     * The @c href attribute in the opening tag gives the name that will be
10641     * used to identify the anchor and it can be any valid utf8 string.
10642     *
10643     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10644     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10645     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10646     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10647     * an anchor.
10648     *
10649     * @subsection entry-items Items
10650     *
10651     * Inlined in the text, any other @c Evas_Object can be inserted by using
10652     * \<item\> tags this way:
10653     *
10654     * @code
10655     * <item size=16x16 vsize=full href=emoticon/haha></item>
10656     * @endcode
10657     *
10658     * Just like with anchors, the @c href identifies each item, but these need,
10659     * in addition, to indicate their size, which is done using any one of
10660     * @c size, @c absize or @c relsize attributes. These attributes take their
10661     * value in the WxH format, where W is the width and H the height of the
10662     * item.
10663     *
10664     * @li absize: Absolute pixel size for the item. Whatever value is set will
10665     * be the item's size regardless of any scale value the object may have
10666     * been set to. The final line height will be adjusted to fit larger items.
10667     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10668     * for the object.
10669     * @li relsize: Size is adjusted for the item to fit within the current
10670     * line height.
10671     *
10672     * Besides their size, items are specificed a @c vsize value that affects
10673     * how their final size and position are calculated. The possible values
10674     * are:
10675     * @li ascent: Item will be placed within the line's baseline and its
10676     * ascent. That is, the height between the line where all characters are
10677     * positioned and the highest point in the line. For @c size and @c absize
10678     * items, the descent value will be added to the total line height to make
10679     * them fit. @c relsize items will be adjusted to fit within this space.
10680     * @li full: Items will be placed between the descent and ascent, or the
10681     * lowest point in the line and its highest.
10682     *
10683     * The next image shows different configurations of items and how they
10684     * are the previously mentioned options affect their sizes. In all cases,
10685     * the green line indicates the ascent, blue for the baseline and red for
10686     * the descent.
10687     *
10688     * @image html entry_item.png
10689     * @image latex entry_item.eps width=\textwidth
10690     *
10691     * And another one to show how size differs from absize. In the first one,
10692     * the scale value is set to 1.0, while the second one is using one of 2.0.
10693     *
10694     * @image html entry_item_scale.png
10695     * @image latex entry_item_scale.eps width=\textwidth
10696     *
10697     * After the size for an item is calculated, the entry will request an
10698     * object to place in its space. For this, the functions set with
10699     * elm_entry_item_provider_append() and related functions will be called
10700     * in order until one of them returns a @c non-NULL value. If no providers
10701     * are available, or all of them return @c NULL, then the entry falls back
10702     * to one of the internal defaults, provided the name matches with one of
10703     * them.
10704     *
10705     * All of the following are currently supported:
10706     *
10707     * - emoticon/angry
10708     * - emoticon/angry-shout
10709     * - emoticon/crazy-laugh
10710     * - emoticon/evil-laugh
10711     * - emoticon/evil
10712     * - emoticon/goggle-smile
10713     * - emoticon/grumpy
10714     * - emoticon/grumpy-smile
10715     * - emoticon/guilty
10716     * - emoticon/guilty-smile
10717     * - emoticon/haha
10718     * - emoticon/half-smile
10719     * - emoticon/happy-panting
10720     * - emoticon/happy
10721     * - emoticon/indifferent
10722     * - emoticon/kiss
10723     * - emoticon/knowing-grin
10724     * - emoticon/laugh
10725     * - emoticon/little-bit-sorry
10726     * - emoticon/love-lots
10727     * - emoticon/love
10728     * - emoticon/minimal-smile
10729     * - emoticon/not-happy
10730     * - emoticon/not-impressed
10731     * - emoticon/omg
10732     * - emoticon/opensmile
10733     * - emoticon/smile
10734     * - emoticon/sorry
10735     * - emoticon/squint-laugh
10736     * - emoticon/surprised
10737     * - emoticon/suspicious
10738     * - emoticon/tongue-dangling
10739     * - emoticon/tongue-poke
10740     * - emoticon/uh
10741     * - emoticon/unhappy
10742     * - emoticon/very-sorry
10743     * - emoticon/what
10744     * - emoticon/wink
10745     * - emoticon/worried
10746     * - emoticon/wtf
10747     *
10748     * Alternatively, an item may reference an image by its path, using
10749     * the URI form @c file:///path/to/an/image.png and the entry will then
10750     * use that image for the item.
10751     *
10752     * @section entry-files Loading and saving files
10753     *
10754     * Entries have convinience functions to load text from a file and save
10755     * changes back to it after a short delay. The automatic saving is enabled
10756     * by default, but can be disabled with elm_entry_autosave_set() and files
10757     * can be loaded directly as plain text or have any markup in them
10758     * recognized. See elm_entry_file_set() for more details.
10759     *
10760     * @section entry-signals Emitted signals
10761     *
10762     * This widget emits the following signals:
10763     *
10764     * @li "changed": The text within the entry was changed.
10765     * @li "changed,user": The text within the entry was changed because of user interaction.
10766     * @li "activated": The enter key was pressed on a single line entry.
10767     * @li "press": A mouse button has been pressed on the entry.
10768     * @li "longpressed": A mouse button has been pressed and held for a couple
10769     * seconds.
10770     * @li "clicked": The entry has been clicked (mouse press and release).
10771     * @li "clicked,double": The entry has been double clicked.
10772     * @li "clicked,triple": The entry has been triple clicked.
10773     * @li "focused": The entry has received focus.
10774     * @li "unfocused": The entry has lost focus.
10775     * @li "selection,paste": A paste of the clipboard contents was requested.
10776     * @li "selection,copy": A copy of the selected text into the clipboard was
10777     * requested.
10778     * @li "selection,cut": A cut of the selected text into the clipboard was
10779     * requested.
10780     * @li "selection,start": A selection has begun and no previous selection
10781     * existed.
10782     * @li "selection,changed": The current selection has changed.
10783     * @li "selection,cleared": The current selection has been cleared.
10784     * @li "cursor,changed": The cursor has changed position.
10785     * @li "anchor,clicked": An anchor has been clicked. The event_info
10786     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10787     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10788     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10789     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10790     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10791     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10792     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10793     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10794     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10795     * @li "preedit,changed": The preedit string has changed.
10796     *
10797     * @section entry-examples
10798     *
10799     * An overview of the Entry API can be seen in @ref entry_example_01
10800     *
10801     * @{
10802     */
10803    /**
10804     * @typedef Elm_Entry_Anchor_Info
10805     *
10806     * The info sent in the callback for the "anchor,clicked" signals emitted
10807     * by entries.
10808     */
10809    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10810    /**
10811     * @struct _Elm_Entry_Anchor_Info
10812     *
10813     * The info sent in the callback for the "anchor,clicked" signals emitted
10814     * by entries.
10815     */
10816    struct _Elm_Entry_Anchor_Info
10817      {
10818         const char *name; /**< The name of the anchor, as stated in its href */
10819         int         button; /**< The mouse button used to click on it */
10820         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
10821                     y, /**< Anchor geometry, relative to canvas */
10822                     w, /**< Anchor geometry, relative to canvas */
10823                     h; /**< Anchor geometry, relative to canvas */
10824      };
10825    /**
10826     * @typedef Elm_Entry_Filter_Cb
10827     * This callback type is used by entry filters to modify text.
10828     * @param data The data specified as the last param when adding the filter
10829     * @param entry The entry object
10830     * @param text A pointer to the location of the text being filtered. This data can be modified,
10831     * but any additional allocations must be managed by the user.
10832     * @see elm_entry_text_filter_append
10833     * @see elm_entry_text_filter_prepend
10834     */
10835    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10836
10837    /**
10838     * This adds an entry to @p parent object.
10839     *
10840     * By default, entries are:
10841     * @li not scrolled
10842     * @li multi-line
10843     * @li word wrapped
10844     * @li autosave is enabled
10845     *
10846     * @param parent The parent object
10847     * @return The new object or NULL if it cannot be created
10848     */
10849    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10850    /**
10851     * Sets the entry to single line mode.
10852     *
10853     * In single line mode, entries don't ever wrap when the text reaches the
10854     * edge, and instead they keep growing horizontally. Pressing the @c Enter
10855     * key will generate an @c "activate" event instead of adding a new line.
10856     *
10857     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10858     * and pressing enter will break the text into a different line
10859     * without generating any events.
10860     *
10861     * @param obj The entry object
10862     * @param single_line If true, the text in the entry
10863     * will be on a single line.
10864     */
10865    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10866    /**
10867     * Gets whether the entry is set to be single line.
10868     *
10869     * @param obj The entry object
10870     * @return single_line If true, the text in the entry is set to display
10871     * on a single line.
10872     *
10873     * @see elm_entry_single_line_set()
10874     */
10875    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10876    /**
10877     * Sets the entry to password mode.
10878     *
10879     * In password mode, entries are implicitly single line and the display of
10880     * any text in them is replaced with asterisks (*).
10881     *
10882     * @param obj The entry object
10883     * @param password If true, password mode is enabled.
10884     */
10885    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10886    /**
10887     * Gets whether the entry is set to password mode.
10888     *
10889     * @param obj The entry object
10890     * @return If true, the entry is set to display all characters
10891     * as asterisks (*).
10892     *
10893     * @see elm_entry_password_set()
10894     */
10895    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10896    /**
10897     * This sets the text displayed within the entry to @p entry.
10898     *
10899     * @param obj The entry object
10900     * @param entry The text to be displayed
10901     *
10902     * @deprecated Use elm_object_text_set() instead.
10903     */
10904    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10905    /**
10906     * This returns the text currently shown in object @p entry.
10907     * See also elm_entry_entry_set().
10908     *
10909     * @param obj The entry object
10910     * @return The currently displayed text or NULL on failure
10911     *
10912     * @deprecated Use elm_object_text_get() instead.
10913     */
10914    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10915    /**
10916     * Appends @p entry to the text of the entry.
10917     *
10918     * Adds the text in @p entry to the end of any text already present in the
10919     * widget.
10920     *
10921     * The appended text is subject to any filters set for the widget.
10922     *
10923     * @param obj The entry object
10924     * @param entry The text to be displayed
10925     *
10926     * @see elm_entry_text_filter_append()
10927     */
10928    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10929    /**
10930     * Gets whether the entry is empty.
10931     *
10932     * Empty means no text at all. If there are any markup tags, like an item
10933     * tag for which no provider finds anything, and no text is displayed, this
10934     * function still returns EINA_FALSE.
10935     *
10936     * @param obj The entry object
10937     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10938     */
10939    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10940    /**
10941     * Gets any selected text within the entry.
10942     *
10943     * If there's any selected text in the entry, this function returns it as
10944     * a string in markup format. NULL is returned if no selection exists or
10945     * if an error occurred.
10946     *
10947     * The returned value points to an internal string and should not be freed
10948     * or modified in any way. If the @p entry object is deleted or its
10949     * contents are changed, the returned pointer should be considered invalid.
10950     *
10951     * @param obj The entry object
10952     * @return The selected text within the entry or NULL on failure
10953     */
10954    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10955    /**
10956     * Inserts the given text into the entry at the current cursor position.
10957     *
10958     * This inserts text at the cursor position as if it was typed
10959     * by the user (note that this also allows markup which a user
10960     * can't just "type" as it would be converted to escaped text, so this
10961     * call can be used to insert things like emoticon items or bold push/pop
10962     * tags, other font and color change tags etc.)
10963     *
10964     * If any selection exists, it will be replaced by the inserted text.
10965     *
10966     * The inserted text is subject to any filters set for the widget.
10967     *
10968     * @param obj The entry object
10969     * @param entry The text to insert
10970     *
10971     * @see elm_entry_text_filter_append()
10972     */
10973    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10974    /**
10975     * Set the line wrap type to use on multi-line entries.
10976     *
10977     * Sets the wrap type used by the entry to any of the specified in
10978     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10979     * line (without inserting a line break or paragraph separator) when it
10980     * reaches the far edge of the widget.
10981     *
10982     * Note that this only makes sense for multi-line entries. A widget set
10983     * to be single line will never wrap.
10984     *
10985     * @param obj The entry object
10986     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10987     */
10988    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10989    /**
10990     * Gets the wrap mode the entry was set to use.
10991     *
10992     * @param obj The entry object
10993     * @return Wrap type
10994     *
10995     * @see also elm_entry_line_wrap_set()
10996     */
10997    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10998    /**
10999     * Sets if the entry is to be editable or not.
11000     *
11001     * By default, entries are editable and when focused, any text input by the
11002     * user will be inserted at the current cursor position. But calling this
11003     * function with @p editable as EINA_FALSE will prevent the user from
11004     * inputting text into the entry.
11005     *
11006     * The only way to change the text of a non-editable entry is to use
11007     * elm_object_text_set(), elm_entry_entry_insert() and other related
11008     * functions.
11009     *
11010     * @param obj The entry object
11011     * @param editable If EINA_TRUE, user input will be inserted in the entry,
11012     * if not, the entry is read-only and no user input is allowed.
11013     */
11014    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11015    /**
11016     * Gets whether the entry is editable or not.
11017     *
11018     * @param obj The entry object
11019     * @return If true, the entry is editable by the user.
11020     * If false, it is not editable by the user
11021     *
11022     * @see elm_entry_editable_set()
11023     */
11024    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11025    /**
11026     * This drops any existing text selection within the entry.
11027     *
11028     * @param obj The entry object
11029     */
11030    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11031    /**
11032     * This selects all text within the entry.
11033     *
11034     * @param obj The entry object
11035     */
11036    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11037    /**
11038     * This moves the cursor one place to the right within the entry.
11039     *
11040     * @param obj The entry object
11041     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11042     */
11043    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11044    /**
11045     * This moves the cursor one place to the left within the entry.
11046     *
11047     * @param obj The entry object
11048     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11049     */
11050    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11051    /**
11052     * This moves the cursor one line up within the entry.
11053     *
11054     * @param obj The entry object
11055     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11056     */
11057    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11058    /**
11059     * This moves the cursor one line down within the entry.
11060     *
11061     * @param obj The entry object
11062     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11063     */
11064    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11065    /**
11066     * This moves the cursor to the beginning of the entry.
11067     *
11068     * @param obj The entry object
11069     */
11070    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11071    /**
11072     * This moves the cursor to the end of the entry.
11073     *
11074     * @param obj The entry object
11075     */
11076    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11077    /**
11078     * This moves the cursor to the beginning of the current line.
11079     *
11080     * @param obj The entry object
11081     */
11082    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11083    /**
11084     * This moves the cursor to the end of the current line.
11085     *
11086     * @param obj The entry object
11087     */
11088    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11089    /**
11090     * This begins a selection within the entry as though
11091     * the user were holding down the mouse button to make a selection.
11092     *
11093     * @param obj The entry object
11094     */
11095    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11096    /**
11097     * This ends a selection within the entry as though
11098     * the user had just released the mouse button while making a selection.
11099     *
11100     * @param obj The entry object
11101     */
11102    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11103    /**
11104     * Gets whether a format node exists at the current cursor position.
11105     *
11106     * A format node is anything that defines how the text is rendered. It can
11107     * be a visible format node, such as a line break or a paragraph separator,
11108     * or an invisible one, such as bold begin or end tag.
11109     * This function returns whether any format node exists at the current
11110     * cursor position.
11111     *
11112     * @param obj The entry object
11113     * @return EINA_TRUE if the current cursor position contains a format node,
11114     * EINA_FALSE otherwise.
11115     *
11116     * @see elm_entry_cursor_is_visible_format_get()
11117     */
11118    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11119    /**
11120     * Gets if the current cursor position holds a visible format node.
11121     *
11122     * @param obj The entry object
11123     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11124     * if it's an invisible one or no format exists.
11125     *
11126     * @see elm_entry_cursor_is_format_get()
11127     */
11128    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11129    /**
11130     * Gets the character pointed by the cursor at its current position.
11131     *
11132     * This function returns a string with the utf8 character stored at the
11133     * current cursor position.
11134     * Only the text is returned, any format that may exist will not be part
11135     * of the return value.
11136     *
11137     * @param obj The entry object
11138     * @return The text pointed by the cursors.
11139     */
11140    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11141    /**
11142     * This function returns the geometry of the cursor.
11143     *
11144     * It's useful if you want to draw something on the cursor (or where it is),
11145     * or for example in the case of scrolled entry where you want to show the
11146     * cursor.
11147     *
11148     * @param obj The entry object
11149     * @param x returned geometry
11150     * @param y returned geometry
11151     * @param w returned geometry
11152     * @param h returned geometry
11153     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11154     */
11155    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);
11156    /**
11157     * Sets the cursor position in the entry to the given value
11158     *
11159     * The value in @p pos is the index of the character position within the
11160     * contents of the string as returned by elm_entry_cursor_pos_get().
11161     *
11162     * @param obj The entry object
11163     * @param pos The position of the cursor
11164     */
11165    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11166    /**
11167     * Retrieves the current position of the cursor in the entry
11168     *
11169     * @param obj The entry object
11170     * @return The cursor position
11171     */
11172    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11173    /**
11174     * This executes a "cut" action on the selected text in the entry.
11175     *
11176     * @param obj The entry object
11177     */
11178    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11179    /**
11180     * This executes a "copy" action on the selected text in the entry.
11181     *
11182     * @param obj The entry object
11183     */
11184    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11185    /**
11186     * This executes a "paste" action in the entry.
11187     *
11188     * @param obj The entry object
11189     */
11190    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11191    /**
11192     * This clears and frees the items in a entry's contextual (longpress)
11193     * menu.
11194     *
11195     * @param obj The entry object
11196     *
11197     * @see elm_entry_context_menu_item_add()
11198     */
11199    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11200    /**
11201     * This adds an item to the entry's contextual menu.
11202     *
11203     * A longpress on an entry will make the contextual menu show up, if this
11204     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11205     * By default, this menu provides a few options like enabling selection mode,
11206     * which is useful on embedded devices that need to be explicit about it,
11207     * and when a selection exists it also shows the copy and cut actions.
11208     *
11209     * With this function, developers can add other options to this menu to
11210     * perform any action they deem necessary.
11211     *
11212     * @param obj The entry object
11213     * @param label The item's text label
11214     * @param icon_file The item's icon file
11215     * @param icon_type The item's icon type
11216     * @param func The callback to execute when the item is clicked
11217     * @param data The data to associate with the item for related functions
11218     */
11219    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);
11220    /**
11221     * This disables the entry's contextual (longpress) menu.
11222     *
11223     * @param obj The entry object
11224     * @param disabled If true, the menu is disabled
11225     */
11226    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11227    /**
11228     * This returns whether the entry's contextual (longpress) menu is
11229     * disabled.
11230     *
11231     * @param obj The entry object
11232     * @return If true, the menu is disabled
11233     */
11234    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11235    /**
11236     * This appends a custom item provider to the list for that entry
11237     *
11238     * This appends the given callback. The list is walked from beginning to end
11239     * with each function called given the item href string in the text. If the
11240     * function returns an object handle other than NULL (it should create an
11241     * object to do this), then this object is used to replace that item. If
11242     * not the next provider is called until one provides an item object, or the
11243     * default provider in entry does.
11244     *
11245     * @param obj The entry object
11246     * @param func The function called to provide the item object
11247     * @param data The data passed to @p func
11248     *
11249     * @see @ref entry-items
11250     */
11251    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);
11252    /**
11253     * This prepends a custom item provider to the list for that entry
11254     *
11255     * This prepends the given callback. See elm_entry_item_provider_append() for
11256     * more information
11257     *
11258     * @param obj The entry object
11259     * @param func The function called to provide the item object
11260     * @param data The data passed to @p func
11261     */
11262    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);
11263    /**
11264     * This removes a custom item provider to the list for that entry
11265     *
11266     * This removes the given callback. See elm_entry_item_provider_append() for
11267     * more information
11268     *
11269     * @param obj The entry object
11270     * @param func The function called to provide the item object
11271     * @param data The data passed to @p func
11272     */
11273    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);
11274    /**
11275     * Append a filter function for text inserted in the entry
11276     *
11277     * Append the given callback to the list. This functions will be called
11278     * whenever any text is inserted into the entry, with the text to be inserted
11279     * as a parameter. The callback function is free to alter the text in any way
11280     * it wants, but it must remember to free the given pointer and update it.
11281     * If the new text is to be discarded, the function can free it and set its
11282     * text parameter to NULL. This will also prevent any following filters from
11283     * being called.
11284     *
11285     * @param obj The entry object
11286     * @param func The function to use as text filter
11287     * @param data User data to pass to @p func
11288     */
11289    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11290    /**
11291     * Prepend a filter function for text insdrted in the entry
11292     *
11293     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11294     * for more information
11295     *
11296     * @param obj The entry object
11297     * @param func The function to use as text filter
11298     * @param data User data to pass to @p func
11299     */
11300    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11301    /**
11302     * Remove a filter from the list
11303     *
11304     * Removes the given callback from the filter list. See
11305     * elm_entry_text_filter_append() for more information.
11306     *
11307     * @param obj The entry object
11308     * @param func The filter function to remove
11309     * @param data The user data passed when adding the function
11310     */
11311    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11312    /**
11313     * This converts a markup (HTML-like) string into UTF-8.
11314     *
11315     * The returned string is a malloc'ed buffer and it should be freed when
11316     * not needed anymore.
11317     *
11318     * @param s The string (in markup) to be converted
11319     * @return The converted string (in UTF-8). It should be freed.
11320     */
11321    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11322    /**
11323     * This converts a UTF-8 string into markup (HTML-like).
11324     *
11325     * The returned string is a malloc'ed buffer and it should be freed when
11326     * not needed anymore.
11327     *
11328     * @param s The string (in UTF-8) to be converted
11329     * @return The converted string (in markup). It should be freed.
11330     */
11331    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11332    /**
11333     * This sets the file (and implicitly loads it) for the text to display and
11334     * then edit. All changes are written back to the file after a short delay if
11335     * the entry object is set to autosave (which is the default).
11336     *
11337     * If the entry had any other file set previously, any changes made to it
11338     * will be saved if the autosave feature is enabled, otherwise, the file
11339     * will be silently discarded and any non-saved changes will be lost.
11340     *
11341     * @param obj The entry object
11342     * @param file The path to the file to load and save
11343     * @param format The file format
11344     */
11345    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11346    /**
11347     * Gets the file being edited by the entry.
11348     *
11349     * This function can be used to retrieve any file set on the entry for
11350     * edition, along with the format used to load and save it.
11351     *
11352     * @param obj The entry object
11353     * @param file The path to the file to load and save
11354     * @param format The file format
11355     */
11356    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11357    /**
11358     * This function writes any changes made to the file set with
11359     * elm_entry_file_set()
11360     *
11361     * @param obj The entry object
11362     */
11363    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11364    /**
11365     * This sets the entry object to 'autosave' the loaded text file or not.
11366     *
11367     * @param obj The entry object
11368     * @param autosave Autosave the loaded file or not
11369     *
11370     * @see elm_entry_file_set()
11371     */
11372    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11373    /**
11374     * This gets the entry object's 'autosave' status.
11375     *
11376     * @param obj The entry object
11377     * @return Autosave the loaded file or not
11378     *
11379     * @see elm_entry_file_set()
11380     */
11381    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11382    /**
11383     * Control pasting of text and images for the widget.
11384     *
11385     * Normally the entry allows both text and images to be pasted.  By setting
11386     * textonly to be true, this prevents images from being pasted.
11387     *
11388     * Note this only changes the behaviour of text.
11389     *
11390     * @param obj The entry object
11391     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11392     * text+image+other.
11393     */
11394    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11395    /**
11396     * Getting elm_entry text paste/drop mode.
11397     *
11398     * In textonly mode, only text may be pasted or dropped into the widget.
11399     *
11400     * @param obj The entry object
11401     * @return If the widget only accepts text from pastes.
11402     */
11403    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11404    /**
11405     * Enable or disable scrolling in entry
11406     *
11407     * Normally the entry is not scrollable unless you enable it with this call.
11408     *
11409     * @param obj The entry object
11410     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11411     */
11412    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11413    /**
11414     * Get the scrollable state of the entry
11415     *
11416     * Normally the entry is not scrollable. This gets the scrollable state
11417     * of the entry. See elm_entry_scrollable_set() for more information.
11418     *
11419     * @param obj The entry object
11420     * @return The scrollable state
11421     */
11422    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11423    /**
11424     * This sets a widget to be displayed to the left of a scrolled entry.
11425     *
11426     * @param obj The scrolled entry object
11427     * @param icon The widget to display on the left side of the scrolled
11428     * entry.
11429     *
11430     * @note A previously set widget will be destroyed.
11431     * @note If the object being set does not have minimum size hints set,
11432     * it won't get properly displayed.
11433     *
11434     * @see elm_entry_end_set()
11435     */
11436    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11437    /**
11438     * Gets the leftmost widget of the scrolled entry. This object is
11439     * owned by the scrolled entry and should not be modified.
11440     *
11441     * @param obj The scrolled entry object
11442     * @return the left widget inside the scroller
11443     */
11444    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11445    /**
11446     * Unset the leftmost widget of the scrolled entry, unparenting and
11447     * returning it.
11448     *
11449     * @param obj The scrolled entry object
11450     * @return the previously set icon sub-object of this entry, on
11451     * success.
11452     *
11453     * @see elm_entry_icon_set()
11454     */
11455    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11456    /**
11457     * Sets the visibility of the left-side widget of the scrolled entry,
11458     * set by elm_entry_icon_set().
11459     *
11460     * @param obj The scrolled entry object
11461     * @param setting EINA_TRUE if the object should be displayed,
11462     * EINA_FALSE if not.
11463     */
11464    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11465    /**
11466     * This sets a widget to be displayed to the end of a scrolled entry.
11467     *
11468     * @param obj The scrolled entry object
11469     * @param end The widget to display on the right side of the scrolled
11470     * entry.
11471     *
11472     * @note A previously set widget will be destroyed.
11473     * @note If the object being set does not have minimum size hints set,
11474     * it won't get properly displayed.
11475     *
11476     * @see elm_entry_icon_set
11477     */
11478    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11479    /**
11480     * Gets the endmost widget of the scrolled entry. This object is owned
11481     * by the scrolled entry and should not be modified.
11482     *
11483     * @param obj The scrolled entry object
11484     * @return the right widget inside the scroller
11485     */
11486    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11487    /**
11488     * Unset the endmost widget of the scrolled entry, unparenting and
11489     * returning it.
11490     *
11491     * @param obj The scrolled entry object
11492     * @return the previously set icon sub-object of this entry, on
11493     * success.
11494     *
11495     * @see elm_entry_icon_set()
11496     */
11497    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11498    /**
11499     * Sets the visibility of the end widget of the scrolled entry, set by
11500     * elm_entry_end_set().
11501     *
11502     * @param obj The scrolled entry object
11503     * @param setting EINA_TRUE if the object should be displayed,
11504     * EINA_FALSE if not.
11505     */
11506    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11507    /**
11508     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11509     * them).
11510     *
11511     * Setting an entry to single-line mode with elm_entry_single_line_set()
11512     * will automatically disable the display of scrollbars when the entry
11513     * moves inside its scroller.
11514     *
11515     * @param obj The scrolled entry object
11516     * @param h The horizontal scrollbar policy to apply
11517     * @param v The vertical scrollbar policy to apply
11518     */
11519    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11520    /**
11521     * This enables/disables bouncing within the entry.
11522     *
11523     * This function sets whether the entry will bounce when scrolling reaches
11524     * the end of the contained entry.
11525     *
11526     * @param obj The scrolled entry object
11527     * @param h The horizontal bounce state
11528     * @param v The vertical bounce state
11529     */
11530    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11531    /**
11532     * Get the bounce mode
11533     *
11534     * @param obj The Entry object
11535     * @param h_bounce Allow bounce horizontally
11536     * @param v_bounce Allow bounce vertically
11537     */
11538    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11539
11540    /* pre-made filters for entries */
11541    /**
11542     * @typedef Elm_Entry_Filter_Limit_Size
11543     *
11544     * Data for the elm_entry_filter_limit_size() entry filter.
11545     */
11546    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11547    /**
11548     * @struct _Elm_Entry_Filter_Limit_Size
11549     *
11550     * Data for the elm_entry_filter_limit_size() entry filter.
11551     */
11552    struct _Elm_Entry_Filter_Limit_Size
11553      {
11554         int max_char_count; /**< The maximum number of characters allowed. */
11555         int max_byte_count; /**< The maximum number of bytes allowed*/
11556      };
11557    /**
11558     * Filter inserted text based on user defined character and byte limits
11559     *
11560     * Add this filter to an entry to limit the characters that it will accept
11561     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11562     * The funtion works on the UTF-8 representation of the string, converting
11563     * it from the set markup, thus not accounting for any format in it.
11564     *
11565     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11566     * it as data when setting the filter. In it, it's possible to set limits
11567     * by character count or bytes (any of them is disabled if 0), and both can
11568     * be set at the same time. In that case, it first checks for characters,
11569     * then bytes.
11570     *
11571     * The function will cut the inserted text in order to allow only the first
11572     * number of characters that are still allowed. The cut is made in
11573     * characters, even when limiting by bytes, in order to always contain
11574     * valid ones and avoid half unicode characters making it in.
11575     *
11576     * This filter, like any others, does not apply when setting the entry text
11577     * directly with elm_object_text_set() (or the deprecated
11578     * elm_entry_entry_set()).
11579     */
11580    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11581    /**
11582     * @typedef Elm_Entry_Filter_Accept_Set
11583     *
11584     * Data for the elm_entry_filter_accept_set() entry filter.
11585     */
11586    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11587    /**
11588     * @struct _Elm_Entry_Filter_Accept_Set
11589     *
11590     * Data for the elm_entry_filter_accept_set() entry filter.
11591     */
11592    struct _Elm_Entry_Filter_Accept_Set
11593      {
11594         const char *accepted; /**< Set of characters accepted in the entry. */
11595         const char *rejected; /**< Set of characters rejected from the entry. */
11596      };
11597    /**
11598     * Filter inserted text based on accepted or rejected sets of characters
11599     *
11600     * Add this filter to an entry to restrict the set of accepted characters
11601     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11602     * This structure contains both accepted and rejected sets, but they are
11603     * mutually exclusive.
11604     *
11605     * The @c accepted set takes preference, so if it is set, the filter will
11606     * only work based on the accepted characters, ignoring anything in the
11607     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11608     *
11609     * In both cases, the function filters by matching utf8 characters to the
11610     * raw markup text, so it can be used to remove formatting tags.
11611     *
11612     * This filter, like any others, does not apply when setting the entry text
11613     * directly with elm_object_text_set() (or the deprecated
11614     * elm_entry_entry_set()).
11615     */
11616    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11617    /**
11618     * Set the input panel layout of the entry
11619     *
11620     * @param obj The entry object
11621     * @param layout layout type
11622     */
11623    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11624    /**
11625     * Get the input panel layout of the entry
11626     *
11627     * @param obj The entry object
11628     * @return layout type
11629     *
11630     * @see elm_entry_input_panel_layout_set
11631     */
11632    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11633    /**
11634     * @}
11635     */
11636
11637    /* composite widgets - these basically put together basic widgets above
11638     * in convenient packages that do more than basic stuff */
11639
11640    /* anchorview */
11641    /**
11642     * @defgroup Anchorview Anchorview
11643     *
11644     * @image html img/widget/anchorview/preview-00.png
11645     * @image latex img/widget/anchorview/preview-00.eps
11646     *
11647     * Anchorview is for displaying text that contains markup with anchors
11648     * like <c>\<a href=1234\>something\</\></c> in it.
11649     *
11650     * Besides being styled differently, the anchorview widget provides the
11651     * necessary functionality so that clicking on these anchors brings up a
11652     * popup with user defined content such as "call", "add to contacts" or
11653     * "open web page". This popup is provided using the @ref Hover widget.
11654     *
11655     * This widget is very similar to @ref Anchorblock, so refer to that
11656     * widget for an example. The only difference Anchorview has is that the
11657     * widget is already provided with scrolling functionality, so if the
11658     * text set to it is too large to fit in the given space, it will scroll,
11659     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11660     * text can be displayed.
11661     *
11662     * This widget emits the following signals:
11663     * @li "anchor,clicked": will be called when an anchor is clicked. The
11664     * @p event_info parameter on the callback will be a pointer of type
11665     * ::Elm_Entry_Anchorview_Info.
11666     *
11667     * See @ref Anchorblock for an example on how to use both of them.
11668     *
11669     * @see Anchorblock
11670     * @see Entry
11671     * @see Hover
11672     *
11673     * @{
11674     */
11675    /**
11676     * @typedef Elm_Entry_Anchorview_Info
11677     *
11678     * The info sent in the callback for "anchor,clicked" signals emitted by
11679     * the Anchorview widget.
11680     */
11681    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11682    /**
11683     * @struct _Elm_Entry_Anchorview_Info
11684     *
11685     * The info sent in the callback for "anchor,clicked" signals emitted by
11686     * the Anchorview widget.
11687     */
11688    struct _Elm_Entry_Anchorview_Info
11689      {
11690         const char     *name; /**< Name of the anchor, as indicated in its href
11691                                    attribute */
11692         int             button; /**< The mouse button used to click on it */
11693         Evas_Object    *hover; /**< The hover object to use for the popup */
11694         struct {
11695              Evas_Coord    x, y, w, h;
11696         } anchor, /**< Geometry selection of text used as anchor */
11697           hover_parent; /**< Geometry of the object used as parent by the
11698                              hover */
11699         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11700                                              for content on the left side of
11701                                              the hover. Before calling the
11702                                              callback, the widget will make the
11703                                              necessary calculations to check
11704                                              which sides are fit to be set with
11705                                              content, based on the position the
11706                                              hover is activated and its distance
11707                                              to the edges of its parent object
11708                                              */
11709         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11710                                               the right side of the hover.
11711                                               See @ref hover_left */
11712         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11713                                             of the hover. See @ref hover_left */
11714         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11715                                                below the hover. See @ref
11716                                                hover_left */
11717      };
11718    /**
11719     * Add a new Anchorview object
11720     *
11721     * @param parent The parent object
11722     * @return The new object or NULL if it cannot be created
11723     */
11724    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11725    /**
11726     * Set the text to show in the anchorview
11727     *
11728     * Sets the text of the anchorview to @p text. This text can include markup
11729     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11730     * text that will be specially styled and react to click events, ended with
11731     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11732     * "anchor,clicked" signal that you can attach a callback to with
11733     * evas_object_smart_callback_add(). The name of the anchor given in the
11734     * event info struct will be the one set in the href attribute, in this
11735     * case, anchorname.
11736     *
11737     * Other markup can be used to style the text in different ways, but it's
11738     * up to the style defined in the theme which tags do what.
11739     * @deprecated use elm_object_text_set() instead.
11740     */
11741    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11742    /**
11743     * Get the markup text set for the anchorview
11744     *
11745     * Retrieves the text set on the anchorview, with markup tags included.
11746     *
11747     * @param obj The anchorview object
11748     * @return The markup text set or @c NULL if nothing was set or an error
11749     * occurred
11750     * @deprecated use elm_object_text_set() instead.
11751     */
11752    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11753    /**
11754     * Set the parent of the hover popup
11755     *
11756     * Sets the parent object to use by the hover created by the anchorview
11757     * when an anchor is clicked. See @ref Hover for more details on this.
11758     * If no parent is set, the same anchorview object will be used.
11759     *
11760     * @param obj The anchorview object
11761     * @param parent The object to use as parent for the hover
11762     */
11763    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11764    /**
11765     * Get the parent of the hover popup
11766     *
11767     * Get the object used as parent for the hover created by the anchorview
11768     * widget. See @ref Hover for more details on this.
11769     *
11770     * @param obj The anchorview object
11771     * @return The object used as parent for the hover, NULL if none is set.
11772     */
11773    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11774    /**
11775     * Set the style that the hover should use
11776     *
11777     * When creating the popup hover, anchorview will request that it's
11778     * themed according to @p style.
11779     *
11780     * @param obj The anchorview object
11781     * @param style The style to use for the underlying hover
11782     *
11783     * @see elm_object_style_set()
11784     */
11785    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11786    /**
11787     * Get the style that the hover should use
11788     *
11789     * Get the style the hover created by anchorview will use.
11790     *
11791     * @param obj The anchorview object
11792     * @return The style to use by the hover. NULL means the default is used.
11793     *
11794     * @see elm_object_style_set()
11795     */
11796    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11797    /**
11798     * Ends the hover popup in the anchorview
11799     *
11800     * When an anchor is clicked, the anchorview widget will create a hover
11801     * object to use as a popup with user provided content. This function
11802     * terminates this popup, returning the anchorview to its normal state.
11803     *
11804     * @param obj The anchorview object
11805     */
11806    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11807    /**
11808     * Set bouncing behaviour when the scrolled content reaches an edge
11809     *
11810     * Tell the internal scroller object whether it should bounce or not
11811     * when it reaches the respective edges for each axis.
11812     *
11813     * @param obj The anchorview object
11814     * @param h_bounce Whether to bounce or not in the horizontal axis
11815     * @param v_bounce Whether to bounce or not in the vertical axis
11816     *
11817     * @see elm_scroller_bounce_set()
11818     */
11819    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11820    /**
11821     * Get the set bouncing behaviour of the internal scroller
11822     *
11823     * Get whether the internal scroller should bounce when the edge of each
11824     * axis is reached scrolling.
11825     *
11826     * @param obj The anchorview object
11827     * @param h_bounce Pointer where to store the bounce state of the horizontal
11828     *                 axis
11829     * @param v_bounce Pointer where to store the bounce state of the vertical
11830     *                 axis
11831     *
11832     * @see elm_scroller_bounce_get()
11833     */
11834    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11835    /**
11836     * Appends a custom item provider to the given anchorview
11837     *
11838     * Appends the given function to the list of items providers. This list is
11839     * called, one function at a time, with the given @p data pointer, the
11840     * anchorview object and, in the @p item parameter, the item name as
11841     * referenced in its href string. Following functions in the list will be
11842     * called in order until one of them returns something different to NULL,
11843     * which should be an Evas_Object which will be used in place of the item
11844     * element.
11845     *
11846     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11847     * href=item/name\>\</item\>
11848     *
11849     * @param obj The anchorview object
11850     * @param func The function to add to the list of providers
11851     * @param data User data that will be passed to the callback function
11852     *
11853     * @see elm_entry_item_provider_append()
11854     */
11855    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);
11856    /**
11857     * Prepend a custom item provider to the given anchorview
11858     *
11859     * Like elm_anchorview_item_provider_append(), but it adds the function
11860     * @p func to the beginning of the list, instead of the end.
11861     *
11862     * @param obj The anchorview object
11863     * @param func The function to add to the list of providers
11864     * @param data User data that will be passed to the callback function
11865     */
11866    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);
11867    /**
11868     * Remove a custom item provider from the list of the given anchorview
11869     *
11870     * Removes the function and data pairing that matches @p func and @p data.
11871     * That is, unless the same function and same user data are given, the
11872     * function will not be removed from the list. This allows us to add the
11873     * same callback several times, with different @p data pointers and be
11874     * able to remove them later without conflicts.
11875     *
11876     * @param obj The anchorview object
11877     * @param func The function to remove from the list
11878     * @param data The data matching the function to remove from the list
11879     */
11880    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);
11881    /**
11882     * @}
11883     */
11884
11885    /* anchorblock */
11886    /**
11887     * @defgroup Anchorblock Anchorblock
11888     *
11889     * @image html img/widget/anchorblock/preview-00.png
11890     * @image latex img/widget/anchorblock/preview-00.eps
11891     *
11892     * Anchorblock is for displaying text that contains markup with anchors
11893     * like <c>\<a href=1234\>something\</\></c> in it.
11894     *
11895     * Besides being styled differently, the anchorblock widget provides the
11896     * necessary functionality so that clicking on these anchors brings up a
11897     * popup with user defined content such as "call", "add to contacts" or
11898     * "open web page". This popup is provided using the @ref Hover widget.
11899     *
11900     * This widget emits the following signals:
11901     * @li "anchor,clicked": will be called when an anchor is clicked. The
11902     * @p event_info parameter on the callback will be a pointer of type
11903     * ::Elm_Entry_Anchorblock_Info.
11904     *
11905     * @see Anchorview
11906     * @see Entry
11907     * @see Hover
11908     *
11909     * Since examples are usually better than plain words, we might as well
11910     * try @ref tutorial_anchorblock_example "one".
11911     */
11912    /**
11913     * @addtogroup Anchorblock
11914     * @{
11915     */
11916    /**
11917     * @typedef Elm_Entry_Anchorblock_Info
11918     *
11919     * The info sent in the callback for "anchor,clicked" signals emitted by
11920     * the Anchorblock widget.
11921     */
11922    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11923    /**
11924     * @struct _Elm_Entry_Anchorblock_Info
11925     *
11926     * The info sent in the callback for "anchor,clicked" signals emitted by
11927     * the Anchorblock widget.
11928     */
11929    struct _Elm_Entry_Anchorblock_Info
11930      {
11931         const char     *name; /**< Name of the anchor, as indicated in its href
11932                                    attribute */
11933         int             button; /**< The mouse button used to click on it */
11934         Evas_Object    *hover; /**< The hover object to use for the popup */
11935         struct {
11936              Evas_Coord    x, y, w, h;
11937         } anchor, /**< Geometry selection of text used as anchor */
11938           hover_parent; /**< Geometry of the object used as parent by the
11939                              hover */
11940         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11941                                              for content on the left side of
11942                                              the hover. Before calling the
11943                                              callback, the widget will make the
11944                                              necessary calculations to check
11945                                              which sides are fit to be set with
11946                                              content, based on the position the
11947                                              hover is activated and its distance
11948                                              to the edges of its parent object
11949                                              */
11950         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11951                                               the right side of the hover.
11952                                               See @ref hover_left */
11953         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11954                                             of the hover. See @ref hover_left */
11955         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11956                                                below the hover. See @ref
11957                                                hover_left */
11958      };
11959    /**
11960     * Add a new Anchorblock object
11961     *
11962     * @param parent The parent object
11963     * @return The new object or NULL if it cannot be created
11964     */
11965    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11966    /**
11967     * Set the text to show in the anchorblock
11968     *
11969     * Sets the text of the anchorblock to @p text. This text can include markup
11970     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11971     * of text that will be specially styled and react to click events, ended
11972     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11973     * "anchor,clicked" signal that you can attach a callback to with
11974     * evas_object_smart_callback_add(). The name of the anchor given in the
11975     * event info struct will be the one set in the href attribute, in this
11976     * case, anchorname.
11977     *
11978     * Other markup can be used to style the text in different ways, but it's
11979     * up to the style defined in the theme which tags do what.
11980     * @deprecated use elm_object_text_set() instead.
11981     */
11982    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11983    /**
11984     * Get the markup text set for the anchorblock
11985     *
11986     * Retrieves the text set on the anchorblock, with markup tags included.
11987     *
11988     * @param obj The anchorblock object
11989     * @return The markup text set or @c NULL if nothing was set or an error
11990     * occurred
11991     * @deprecated use elm_object_text_set() instead.
11992     */
11993    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11994    /**
11995     * Set the parent of the hover popup
11996     *
11997     * Sets the parent object to use by the hover created by the anchorblock
11998     * when an anchor is clicked. See @ref Hover for more details on this.
11999     *
12000     * @param obj The anchorblock object
12001     * @param parent The object to use as parent for the hover
12002     */
12003    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12004    /**
12005     * Get the parent of the hover popup
12006     *
12007     * Get the object used as parent for the hover created by the anchorblock
12008     * widget. See @ref Hover for more details on this.
12009     * If no parent is set, the same anchorblock object will be used.
12010     *
12011     * @param obj The anchorblock object
12012     * @return The object used as parent for the hover, NULL if none is set.
12013     */
12014    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12015    /**
12016     * Set the style that the hover should use
12017     *
12018     * When creating the popup hover, anchorblock will request that it's
12019     * themed according to @p style.
12020     *
12021     * @param obj The anchorblock object
12022     * @param style The style to use for the underlying hover
12023     *
12024     * @see elm_object_style_set()
12025     */
12026    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12027    /**
12028     * Get the style that the hover should use
12029     *
12030     * Get the style the hover created by anchorblock will use.
12031     *
12032     * @param obj The anchorblock object
12033     * @return The style to use by the hover. NULL means the default is used.
12034     *
12035     * @see elm_object_style_set()
12036     */
12037    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12038    /**
12039     * Ends the hover popup in the anchorblock
12040     *
12041     * When an anchor is clicked, the anchorblock widget will create a hover
12042     * object to use as a popup with user provided content. This function
12043     * terminates this popup, returning the anchorblock to its normal state.
12044     *
12045     * @param obj The anchorblock object
12046     */
12047    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12048    /**
12049     * Appends a custom item provider to the given anchorblock
12050     *
12051     * Appends the given function to the list of items providers. This list is
12052     * called, one function at a time, with the given @p data pointer, the
12053     * anchorblock object and, in the @p item parameter, the item name as
12054     * referenced in its href string. Following functions in the list will be
12055     * called in order until one of them returns something different to NULL,
12056     * which should be an Evas_Object which will be used in place of the item
12057     * element.
12058     *
12059     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12060     * href=item/name\>\</item\>
12061     *
12062     * @param obj The anchorblock object
12063     * @param func The function to add to the list of providers
12064     * @param data User data that will be passed to the callback function
12065     *
12066     * @see elm_entry_item_provider_append()
12067     */
12068    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);
12069    /**
12070     * Prepend a custom item provider to the given anchorblock
12071     *
12072     * Like elm_anchorblock_item_provider_append(), but it adds the function
12073     * @p func to the beginning of the list, instead of the end.
12074     *
12075     * @param obj The anchorblock object
12076     * @param func The function to add to the list of providers
12077     * @param data User data that will be passed to the callback function
12078     */
12079    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);
12080    /**
12081     * Remove a custom item provider from the list of the given anchorblock
12082     *
12083     * Removes the function and data pairing that matches @p func and @p data.
12084     * That is, unless the same function and same user data are given, the
12085     * function will not be removed from the list. This allows us to add the
12086     * same callback several times, with different @p data pointers and be
12087     * able to remove them later without conflicts.
12088     *
12089     * @param obj The anchorblock object
12090     * @param func The function to remove from the list
12091     * @param data The data matching the function to remove from the list
12092     */
12093    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);
12094    /**
12095     * @}
12096     */
12097
12098    /**
12099     * @defgroup Bubble Bubble
12100     *
12101     * @image html img/widget/bubble/preview-00.png
12102     * @image latex img/widget/bubble/preview-00.eps
12103     * @image html img/widget/bubble/preview-01.png
12104     * @image latex img/widget/bubble/preview-01.eps
12105     * @image html img/widget/bubble/preview-02.png
12106     * @image latex img/widget/bubble/preview-02.eps
12107     *
12108     * @brief The Bubble is a widget to show text similarly to how speech is
12109     * represented in comics.
12110     *
12111     * The bubble widget contains 5 important visual elements:
12112     * @li The frame is a rectangle with rounded rectangles and an "arrow".
12113     * @li The @p icon is an image to which the frame's arrow points to.
12114     * @li The @p label is a text which appears to the right of the icon if the
12115     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12116     * otherwise.
12117     * @li The @p info is a text which appears to the right of the label. Info's
12118     * font is of a ligther color than label.
12119     * @li The @p content is an evas object that is shown inside the frame.
12120     *
12121     * The position of the arrow, icon, label and info depends on which corner is
12122     * selected. The four available corners are:
12123     * @li "top_left" - Default
12124     * @li "top_right"
12125     * @li "bottom_left"
12126     * @li "bottom_right"
12127     *
12128     * Signals that you can add callbacks for are:
12129     * @li "clicked" - This is called when a user has clicked the bubble.
12130     *
12131     * For an example of using a buble see @ref bubble_01_example_page "this".
12132     *
12133     * @{
12134     */
12135    /**
12136     * Add a new bubble to the parent
12137     *
12138     * @param parent The parent object
12139     * @return The new object or NULL if it cannot be created
12140     *
12141     * This function adds a text bubble to the given parent evas object.
12142     */
12143    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12144    /**
12145     * Set the label of the bubble
12146     *
12147     * @param obj The bubble object
12148     * @param label The string to set in the label
12149     *
12150     * This function sets the title of the bubble. Where this appears depends on
12151     * the selected corner.
12152     * @deprecated use elm_object_text_set() instead.
12153     */
12154    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12155    /**
12156     * Get the label of the bubble
12157     *
12158     * @param obj The bubble object
12159     * @return The string of set in the label
12160     *
12161     * This function gets the title of the bubble.
12162     * @deprecated use elm_object_text_get() instead.
12163     */
12164    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12165    /**
12166     * Set the info of the bubble
12167     *
12168     * @param obj The bubble object
12169     * @param info The given info about the bubble
12170     *
12171     * This function sets the info of the bubble. Where this appears depends on
12172     * the selected corner.
12173     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12174     */
12175    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12176    /**
12177     * Get the info of the bubble
12178     *
12179     * @param obj The bubble object
12180     *
12181     * @return The "info" string of the bubble
12182     *
12183     * This function gets the info text.
12184     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12185     */
12186    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12187    /**
12188     * Set the content to be shown in the bubble
12189     *
12190     * Once the content object is set, a previously set one will be deleted.
12191     * If you want to keep the old content object, use the
12192     * elm_bubble_content_unset() function.
12193     *
12194     * @param obj The bubble object
12195     * @param content The given content of the bubble
12196     *
12197     * This function sets the content shown on the middle of the bubble.
12198     */
12199    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12200    /**
12201     * Get the content shown in the bubble
12202     *
12203     * Return the content object which is set for this widget.
12204     *
12205     * @param obj The bubble object
12206     * @return The content that is being used
12207     */
12208    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12209    /**
12210     * Unset the content shown in the bubble
12211     *
12212     * Unparent and return the content object which was set for this widget.
12213     *
12214     * @param obj The bubble object
12215     * @return The content that was being used
12216     */
12217    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12218    /**
12219     * Set the icon of the bubble
12220     *
12221     * Once the icon object is set, a previously set one will be deleted.
12222     * If you want to keep the old content object, use the
12223     * elm_icon_content_unset() function.
12224     *
12225     * @param obj The bubble object
12226     * @param icon The given icon for the bubble
12227     */
12228    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12229    /**
12230     * Get the icon of the bubble
12231     *
12232     * @param obj The bubble object
12233     * @return The icon for the bubble
12234     *
12235     * This function gets the icon shown on the top left of bubble.
12236     */
12237    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12238    /**
12239     * Unset the icon of the bubble
12240     *
12241     * Unparent and return the icon object which was set for this widget.
12242     *
12243     * @param obj The bubble object
12244     * @return The icon that was being used
12245     */
12246    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12247    /**
12248     * Set the corner of the bubble
12249     *
12250     * @param obj The bubble object.
12251     * @param corner The given corner for the bubble.
12252     *
12253     * This function sets the corner of the bubble. The corner will be used to
12254     * determine where the arrow in the frame points to and where label, icon and
12255     * info arre shown.
12256     *
12257     * Possible values for corner are:
12258     * @li "top_left" - Default
12259     * @li "top_right"
12260     * @li "bottom_left"
12261     * @li "bottom_right"
12262     */
12263    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12264    /**
12265     * Get the corner of the bubble
12266     *
12267     * @param obj The bubble object.
12268     * @return The given corner for the bubble.
12269     *
12270     * This function gets the selected corner of the bubble.
12271     */
12272    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12273    /**
12274     * @}
12275     */
12276
12277    /**
12278     * @defgroup Photo Photo
12279     *
12280     * For displaying the photo of a person (contact). Simple yet
12281     * with a very specific purpose.
12282     *
12283     * Signals that you can add callbacks for are:
12284     *
12285     * "clicked" - This is called when a user has clicked the photo
12286     * "drag,start" - Someone started dragging the image out of the object
12287     * "drag,end" - Dragged item was dropped (somewhere)
12288     *
12289     * @{
12290     */
12291
12292    /**
12293     * Add a new photo to the parent
12294     *
12295     * @param parent The parent object
12296     * @return The new object or NULL if it cannot be created
12297     *
12298     * @ingroup Photo
12299     */
12300    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12301
12302    /**
12303     * Set the file that will be used as photo
12304     *
12305     * @param obj The photo object
12306     * @param file The path to file that will be used as photo
12307     *
12308     * @return (1 = success, 0 = error)
12309     *
12310     * @ingroup Photo
12311     */
12312    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12313
12314     /**
12315     * Set the file that will be used as thumbnail in the photo.
12316     *
12317     * @param obj The photo object.
12318     * @param file The path to file that will be used as thumb.
12319     * @param group The key used in case of an EET file.
12320     *
12321     * @ingroup Photo
12322     */
12323    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12324
12325    /**
12326     * Set the size that will be used on the photo
12327     *
12328     * @param obj The photo object
12329     * @param size The size that the photo will be
12330     *
12331     * @ingroup Photo
12332     */
12333    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12334
12335    /**
12336     * Set if the photo should be completely visible or not.
12337     *
12338     * @param obj The photo object
12339     * @param fill if true the photo will be completely visible
12340     *
12341     * @ingroup Photo
12342     */
12343    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12344
12345    /**
12346     * Set editability of the photo.
12347     *
12348     * An editable photo can be dragged to or from, and can be cut or
12349     * pasted too.  Note that pasting an image or dropping an item on
12350     * the image will delete the existing content.
12351     *
12352     * @param obj The photo object.
12353     * @param set To set of clear editablity.
12354     */
12355    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12356
12357    /**
12358     * @}
12359     */
12360
12361    /* gesture layer */
12362    /**
12363     * @defgroup Elm_Gesture_Layer Gesture Layer
12364     * Gesture Layer Usage:
12365     *
12366     * Use Gesture Layer to detect gestures.
12367     * The advantage is that you don't have to implement
12368     * gesture detection, just set callbacks of gesture state.
12369     * By using gesture layer we make standard interface.
12370     *
12371     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12372     * with a parent object parameter.
12373     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12374     * call. Usually with same object as target (2nd parameter).
12375     *
12376     * Now you need to tell gesture layer what gestures you follow.
12377     * This is done with @ref elm_gesture_layer_cb_set call.
12378     * By setting the callback you actually saying to gesture layer:
12379     * I would like to know when the gesture @ref Elm_Gesture_Types
12380     * switches to state @ref Elm_Gesture_State.
12381     *
12382     * Next, you need to implement the actual action that follows the input
12383     * in your callback.
12384     *
12385     * Note that if you like to stop being reported about a gesture, just set
12386     * all callbacks referring this gesture to NULL.
12387     * (again with @ref elm_gesture_layer_cb_set)
12388     *
12389     * The information reported by gesture layer to your callback is depending
12390     * on @ref Elm_Gesture_Types:
12391     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12392     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12393     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12394     *
12395     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12396     * @ref ELM_GESTURE_MOMENTUM.
12397     *
12398     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12399     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12400     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12401     * Note that we consider a flick as a line-gesture that should be completed
12402     * in flick-time-limit as defined in @ref Config.
12403     *
12404     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12405     *
12406     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12407     *
12408     *
12409     * Gesture Layer Tweaks:
12410     *
12411     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12412     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12413     *
12414     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12415     * so gesture starts when user touches (a *DOWN event) touch-surface
12416     * and ends when no fingers touches surface (a *UP event).
12417     */
12418
12419    /**
12420     * @enum _Elm_Gesture_Types
12421     * Enum of supported gesture types.
12422     * @ingroup Elm_Gesture_Layer
12423     */
12424    enum _Elm_Gesture_Types
12425      {
12426         ELM_GESTURE_FIRST = 0,
12427
12428         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12429         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12430         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12431         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12432
12433         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12434
12435         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12436         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12437
12438         ELM_GESTURE_ZOOM, /**< Zoom */
12439         ELM_GESTURE_ROTATE, /**< Rotate */
12440
12441         ELM_GESTURE_LAST
12442      };
12443
12444    /**
12445     * @typedef Elm_Gesture_Types
12446     * gesture types enum
12447     * @ingroup Elm_Gesture_Layer
12448     */
12449    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12450
12451    /**
12452     * @enum _Elm_Gesture_State
12453     * Enum of gesture states.
12454     * @ingroup Elm_Gesture_Layer
12455     */
12456    enum _Elm_Gesture_State
12457      {
12458         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12459         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12460         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12461         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12462         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12463      };
12464
12465    /**
12466     * @typedef Elm_Gesture_State
12467     * gesture states enum
12468     * @ingroup Elm_Gesture_Layer
12469     */
12470    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12471
12472    /**
12473     * @struct _Elm_Gesture_Taps_Info
12474     * Struct holds taps info for user
12475     * @ingroup Elm_Gesture_Layer
12476     */
12477    struct _Elm_Gesture_Taps_Info
12478      {
12479         Evas_Coord x, y;         /**< Holds center point between fingers */
12480         unsigned int n;          /**< Number of fingers tapped           */
12481         unsigned int timestamp;  /**< event timestamp       */
12482      };
12483
12484    /**
12485     * @typedef Elm_Gesture_Taps_Info
12486     * holds taps info for user
12487     * @ingroup Elm_Gesture_Layer
12488     */
12489    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12490
12491    /**
12492     * @struct _Elm_Gesture_Momentum_Info
12493     * Struct holds momentum info for user
12494     * x1 and y1 are not necessarily in sync
12495     * x1 holds x value of x direction starting point
12496     * and same holds for y1.
12497     * This is noticeable when doing V-shape movement
12498     * @ingroup Elm_Gesture_Layer
12499     */
12500    struct _Elm_Gesture_Momentum_Info
12501      {  /* Report line ends, timestamps, and momentum computed        */
12502         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12503         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12504         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12505         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12506
12507         unsigned int tx; /**< Timestamp of start of final x-swipe */
12508         unsigned int ty; /**< Timestamp of start of final y-swipe */
12509
12510         Evas_Coord mx; /**< Momentum on X */
12511         Evas_Coord my; /**< Momentum on Y */
12512      };
12513
12514    /**
12515     * @typedef Elm_Gesture_Momentum_Info
12516     * holds momentum info for user
12517     * @ingroup Elm_Gesture_Layer
12518     */
12519     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12520
12521    /**
12522     * @struct _Elm_Gesture_Line_Info
12523     * Struct holds line info for user
12524     * @ingroup Elm_Gesture_Layer
12525     */
12526    struct _Elm_Gesture_Line_Info
12527      {  /* Report line ends, timestamps, and momentum computed      */
12528         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12529         unsigned int n;            /**< Number of fingers (lines)   */
12530         /* FIXME should be radians, bot degrees */
12531         double angle;              /**< Angle (direction) of lines  */
12532      };
12533
12534    /**
12535     * @typedef Elm_Gesture_Line_Info
12536     * Holds line info for user
12537     * @ingroup Elm_Gesture_Layer
12538     */
12539     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12540
12541    /**
12542     * @struct _Elm_Gesture_Zoom_Info
12543     * Struct holds zoom info for user
12544     * @ingroup Elm_Gesture_Layer
12545     */
12546    struct _Elm_Gesture_Zoom_Info
12547      {
12548         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12549         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12550         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12551         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12552      };
12553
12554    /**
12555     * @typedef Elm_Gesture_Zoom_Info
12556     * Holds zoom info for user
12557     * @ingroup Elm_Gesture_Layer
12558     */
12559    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12560
12561    /**
12562     * @struct _Elm_Gesture_Rotate_Info
12563     * Struct holds rotation info for user
12564     * @ingroup Elm_Gesture_Layer
12565     */
12566    struct _Elm_Gesture_Rotate_Info
12567      {
12568         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12569         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12570         double base_angle; /**< Holds start-angle */
12571         double angle;      /**< Rotation value: 0.0 means no rotation         */
12572         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12573      };
12574
12575    /**
12576     * @typedef Elm_Gesture_Rotate_Info
12577     * Holds rotation info for user
12578     * @ingroup Elm_Gesture_Layer
12579     */
12580    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12581
12582    /**
12583     * @typedef Elm_Gesture_Event_Cb
12584     * User callback used to stream gesture info from gesture layer
12585     * @param data user data
12586     * @param event_info gesture report info
12587     * Returns a flag field to be applied on the causing event.
12588     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12589     * upon the event, in an irreversible way.
12590     *
12591     * @ingroup Elm_Gesture_Layer
12592     */
12593    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12594
12595    /**
12596     * Use function to set callbacks to be notified about
12597     * change of state of gesture.
12598     * When a user registers a callback with this function
12599     * this means this gesture has to be tested.
12600     *
12601     * When ALL callbacks for a gesture are set to NULL
12602     * it means user isn't interested in gesture-state
12603     * and it will not be tested.
12604     *
12605     * @param obj Pointer to gesture-layer.
12606     * @param idx The gesture you would like to track its state.
12607     * @param cb callback function pointer.
12608     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12609     * @param data user info to be sent to callback (usually, Smart Data)
12610     *
12611     * @ingroup Elm_Gesture_Layer
12612     */
12613    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);
12614
12615    /**
12616     * Call this function to get repeat-events settings.
12617     *
12618     * @param obj Pointer to gesture-layer.
12619     *
12620     * @return repeat events settings.
12621     * @see elm_gesture_layer_hold_events_set()
12622     * @ingroup Elm_Gesture_Layer
12623     */
12624    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12625
12626    /**
12627     * This function called in order to make gesture-layer repeat events.
12628     * Set this of you like to get the raw events only if gestures were not detected.
12629     * Clear this if you like gesture layer to fwd events as testing gestures.
12630     *
12631     * @param obj Pointer to gesture-layer.
12632     * @param r Repeat: TRUE/FALSE
12633     *
12634     * @ingroup Elm_Gesture_Layer
12635     */
12636    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12637
12638    /**
12639     * This function sets step-value for zoom action.
12640     * Set step to any positive value.
12641     * Cancel step setting by setting to 0.0
12642     *
12643     * @param obj Pointer to gesture-layer.
12644     * @param s new zoom step value.
12645     *
12646     * @ingroup Elm_Gesture_Layer
12647     */
12648    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12649
12650    /**
12651     * This function sets step-value for rotate action.
12652     * Set step to any positive value.
12653     * Cancel step setting by setting to 0.0
12654     *
12655     * @param obj Pointer to gesture-layer.
12656     * @param s new roatate step value.
12657     *
12658     * @ingroup Elm_Gesture_Layer
12659     */
12660    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12661
12662    /**
12663     * This function called to attach gesture-layer to an Evas_Object.
12664     * @param obj Pointer to gesture-layer.
12665     * @param t Pointer to underlying object (AKA Target)
12666     *
12667     * @return TRUE, FALSE on success, failure.
12668     *
12669     * @ingroup Elm_Gesture_Layer
12670     */
12671    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12672
12673    /**
12674     * Call this function to construct a new gesture-layer object.
12675     * This does not activate the gesture layer. You have to
12676     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12677     *
12678     * @param parent the parent object.
12679     *
12680     * @return Pointer to new gesture-layer object.
12681     *
12682     * @ingroup Elm_Gesture_Layer
12683     */
12684    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12685
12686    /**
12687     * @defgroup Thumb Thumb
12688     *
12689     * @image html img/widget/thumb/preview-00.png
12690     * @image latex img/widget/thumb/preview-00.eps
12691     *
12692     * A thumb object is used for displaying the thumbnail of an image or video.
12693     * You must have compiled Elementary with Ethumb_Client support and the DBus
12694     * service must be present and auto-activated in order to have thumbnails to
12695     * be generated.
12696     *
12697     * Once the thumbnail object becomes visible, it will check if there is a
12698     * previously generated thumbnail image for the file set on it. If not, it
12699     * will start generating this thumbnail.
12700     *
12701     * Different config settings will cause different thumbnails to be generated
12702     * even on the same file.
12703     *
12704     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12705     * Ethumb documentation to change this path, and to see other configuration
12706     * options.
12707     *
12708     * Signals that you can add callbacks for are:
12709     *
12710     * - "clicked" - This is called when a user has clicked the thumb without dragging
12711     *             around.
12712     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12713     * - "press" - This is called when a user has pressed down the thumb.
12714     * - "generate,start" - The thumbnail generation started.
12715     * - "generate,stop" - The generation process stopped.
12716     * - "generate,error" - The generation failed.
12717     * - "load,error" - The thumbnail image loading failed.
12718     *
12719     * available styles:
12720     * - default
12721     * - noframe
12722     *
12723     * An example of use of thumbnail:
12724     *
12725     * - @ref thumb_example_01
12726     */
12727
12728    /**
12729     * @addtogroup Thumb
12730     * @{
12731     */
12732
12733    /**
12734     * @enum _Elm_Thumb_Animation_Setting
12735     * @typedef Elm_Thumb_Animation_Setting
12736     *
12737     * Used to set if a video thumbnail is animating or not.
12738     *
12739     * @ingroup Thumb
12740     */
12741    typedef enum _Elm_Thumb_Animation_Setting
12742      {
12743         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12744         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12745         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12746         ELM_THUMB_ANIMATION_LAST
12747      } Elm_Thumb_Animation_Setting;
12748
12749    /**
12750     * Add a new thumb object to the parent.
12751     *
12752     * @param parent The parent object.
12753     * @return The new object or NULL if it cannot be created.
12754     *
12755     * @see elm_thumb_file_set()
12756     * @see elm_thumb_ethumb_client_get()
12757     *
12758     * @ingroup Thumb
12759     */
12760    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12761    /**
12762     * Reload thumbnail if it was generated before.
12763     *
12764     * @param obj The thumb object to reload
12765     *
12766     * This is useful if the ethumb client configuration changed, like its
12767     * size, aspect or any other property one set in the handle returned
12768     * by elm_thumb_ethumb_client_get().
12769     *
12770     * If the options didn't change, the thumbnail won't be generated again, but
12771     * the old one will still be used.
12772     *
12773     * @see elm_thumb_file_set()
12774     *
12775     * @ingroup Thumb
12776     */
12777    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12778    /**
12779     * Set the file that will be used as thumbnail.
12780     *
12781     * @param obj The thumb object.
12782     * @param file The path to file that will be used as thumb.
12783     * @param key The key used in case of an EET file.
12784     *
12785     * The file can be an image or a video (in that case, acceptable extensions are:
12786     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12787     * function elm_thumb_animate().
12788     *
12789     * @see elm_thumb_file_get()
12790     * @see elm_thumb_reload()
12791     * @see elm_thumb_animate()
12792     *
12793     * @ingroup Thumb
12794     */
12795    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12796    /**
12797     * Get the image or video path and key used to generate the thumbnail.
12798     *
12799     * @param obj The thumb object.
12800     * @param file Pointer to filename.
12801     * @param key Pointer to key.
12802     *
12803     * @see elm_thumb_file_set()
12804     * @see elm_thumb_path_get()
12805     *
12806     * @ingroup Thumb
12807     */
12808    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12809    /**
12810     * Get the path and key to the image or video generated by ethumb.
12811     *
12812     * One just need to make sure that the thumbnail was generated before getting
12813     * its path; otherwise, the path will be NULL. One way to do that is by asking
12814     * for the path when/after the "generate,stop" smart callback is called.
12815     *
12816     * @param obj The thumb object.
12817     * @param file Pointer to thumb path.
12818     * @param key Pointer to thumb key.
12819     *
12820     * @see elm_thumb_file_get()
12821     *
12822     * @ingroup Thumb
12823     */
12824    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12825    /**
12826     * Set the animation state for the thumb object. If its content is an animated
12827     * video, you may start/stop the animation or tell it to play continuously and
12828     * looping.
12829     *
12830     * @param obj The thumb object.
12831     * @param setting The animation setting.
12832     *
12833     * @see elm_thumb_file_set()
12834     *
12835     * @ingroup Thumb
12836     */
12837    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12838    /**
12839     * Get the animation state for the thumb object.
12840     *
12841     * @param obj The thumb object.
12842     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12843     * on errors.
12844     *
12845     * @see elm_thumb_animate_set()
12846     *
12847     * @ingroup Thumb
12848     */
12849    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12850    /**
12851     * Get the ethumb_client handle so custom configuration can be made.
12852     *
12853     * @return Ethumb_Client instance or NULL.
12854     *
12855     * This must be called before the objects are created to be sure no object is
12856     * visible and no generation started.
12857     *
12858     * Example of usage:
12859     *
12860     * @code
12861     * #include <Elementary.h>
12862     * #ifndef ELM_LIB_QUICKLAUNCH
12863     * EAPI_MAIN int
12864     * elm_main(int argc, char **argv)
12865     * {
12866     *    Ethumb_Client *client;
12867     *
12868     *    elm_need_ethumb();
12869     *
12870     *    // ... your code
12871     *
12872     *    client = elm_thumb_ethumb_client_get();
12873     *    if (!client)
12874     *      {
12875     *         ERR("could not get ethumb_client");
12876     *         return 1;
12877     *      }
12878     *    ethumb_client_size_set(client, 100, 100);
12879     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
12880     *    // ... your code
12881     *
12882     *    // Create elm_thumb objects here
12883     *
12884     *    elm_run();
12885     *    elm_shutdown();
12886     *    return 0;
12887     * }
12888     * #endif
12889     * ELM_MAIN()
12890     * @endcode
12891     *
12892     * @note There's only one client handle for Ethumb, so once a configuration
12893     * change is done to it, any other request for thumbnails (for any thumbnail
12894     * object) will use that configuration. Thus, this configuration is global.
12895     *
12896     * @ingroup Thumb
12897     */
12898    EAPI void                        *elm_thumb_ethumb_client_get(void);
12899    /**
12900     * Get the ethumb_client connection state.
12901     *
12902     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12903     * otherwise.
12904     */
12905    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
12906    /**
12907     * Make the thumbnail 'editable'.
12908     *
12909     * @param obj Thumb object.
12910     * @param set Turn on or off editability. Default is @c EINA_FALSE.
12911     *
12912     * This means the thumbnail is a valid drag target for drag and drop, and can be
12913     * cut or pasted too.
12914     *
12915     * @see elm_thumb_editable_get()
12916     *
12917     * @ingroup Thumb
12918     */
12919    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12920    /**
12921     * Make the thumbnail 'editable'.
12922     *
12923     * @param obj Thumb object.
12924     * @return Editability.
12925     *
12926     * This means the thumbnail is a valid drag target for drag and drop, and can be
12927     * cut or pasted too.
12928     *
12929     * @see elm_thumb_editable_set()
12930     *
12931     * @ingroup Thumb
12932     */
12933    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12934
12935    /**
12936     * @}
12937     */
12938
12939    /**
12940     * @defgroup Web Web
12941     *
12942     * @image html img/widget/web/preview-00.png
12943     * @image latex img/widget/web/preview-00.eps
12944     *
12945     * A web object is used for displaying web pages (HTML/CSS/JS)
12946     * using WebKit-EFL. You must have compiled Elementary with
12947     * ewebkit support.
12948     *
12949     * Signals that you can add callbacks for are:
12950     * @li "download,request": A file download has been requested. Event info is
12951     * a pointer to a Elm_Web_Download
12952     * @li "editorclient,contents,changed": Editor client's contents changed
12953     * @li "editorclient,selection,changed": Editor client's selection changed
12954     * @li "frame,created": A new frame was created. Event info is an
12955     * Evas_Object which can be handled with WebKit's ewk_frame API
12956     * @li "icon,received": An icon was received by the main frame
12957     * @li "inputmethod,changed": Input method changed. Event info is an
12958     * Eina_Bool indicating whether it's enabled or not
12959     * @li "js,windowobject,clear": JS window object has been cleared
12960     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
12961     * is a char *link[2], where the first string contains the URL the link
12962     * points to, and the second one the title of the link
12963     * @li "link,hover,out": Mouse cursor left the link
12964     * @li "load,document,finished": Loading of a document finished. Event info
12965     * is the frame that finished loading
12966     * @li "load,error": Load failed. Event info is a pointer to
12967     * Elm_Web_Frame_Load_Error
12968     * @li "load,finished": Load finished. Event info is NULL on success, on
12969     * error it's a pointer to Elm_Web_Frame_Load_Error
12970     * @li "load,newwindow,show": A new window was created and is ready to be
12971     * shown
12972     * @li "load,progress": Overall load progress. Event info is a pointer to
12973     * a double containing a value between 0.0 and 1.0
12974     * @li "load,provisional": Started provisional load
12975     * @li "load,started": Loading of a document started
12976     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
12977     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
12978     * the menubar is visible, or EINA_FALSE in case it's not
12979     * @li "menubar,visible,set": Informs menubar visibility. Event info is
12980     * an Eina_Bool indicating the visibility
12981     * @li "popup,created": A dropdown widget was activated, requesting its
12982     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
12983     * @li "popup,willdelete": The web object is ready to destroy the popup
12984     * object created. Event info is a pointer to Elm_Web_Menu
12985     * @li "ready": Page is fully loaded
12986     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
12987     * info is a pointer to Eina_Bool where the visibility state should be set
12988     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
12989     * is an Eina_Bool with the visibility state set
12990     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
12991     * a string with the new text
12992     * @li "statusbar,visible,get": Queries visibility of the status bar.
12993     * Event info is a pointer to Eina_Bool where the visibility state should be
12994     * set.
12995     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
12996     * an Eina_Bool with the visibility value
12997     * @li "title,changed": Title of the main frame changed. Event info is a
12998     * string with the new title
12999     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13000     * is a pointer to Eina_Bool where the visibility state should be set
13001     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13002     * info is an Eina_Bool with the visibility state
13003     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13004     * a string with the text to show
13005     * @li "uri,changed": URI of the main frame changed. Event info is a string
13006     * with the new URI
13007     * @li "view,resized": The web object internal's view changed sized
13008     * @li "windows,close,request": A JavaScript request to close the current
13009     * window was requested
13010     * @li "zoom,animated,end": Animated zoom finished
13011     *
13012     * available styles:
13013     * - default
13014     *
13015     * An example of use of web:
13016     *
13017     * - @ref web_example_01 TBD
13018     */
13019
13020    /**
13021     * @addtogroup Web
13022     * @{
13023     */
13024
13025    /**
13026     * Structure used to report load errors.
13027     *
13028     * Load errors are reported as signal by elm_web. All the strings are
13029     * temporary references and should @b not be used after the signal
13030     * callback returns. If it's required, make copies with strdup() or
13031     * eina_stringshare_add() (they are not even guaranteed to be
13032     * stringshared, so must use eina_stringshare_add() and not
13033     * eina_stringshare_ref()).
13034     */
13035    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13036    /**
13037     * Structure used to report load errors.
13038     *
13039     * Load errors are reported as signal by elm_web. All the strings are
13040     * temporary references and should @b not be used after the signal
13041     * callback returns. If it's required, make copies with strdup() or
13042     * eina_stringshare_add() (they are not even guaranteed to be
13043     * stringshared, so must use eina_stringshare_add() and not
13044     * eina_stringshare_ref()).
13045     */
13046    struct _Elm_Web_Frame_Load_Error
13047      {
13048         int code; /**< Numeric error code */
13049         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13050         const char *domain; /**< Error domain name */
13051         const char *description; /**< Error description (already localized) */
13052         const char *failing_url; /**< The URL that failed to load */
13053         Evas_Object *frame; /**< Frame object that produced the error */
13054      };
13055
13056    /**
13057     * The possibles types that the items in a menu can be
13058     */
13059    typedef enum _Elm_Web_Menu_Item_Type
13060      {
13061         ELM_WEB_MENU_SEPARATOR,
13062         ELM_WEB_MENU_GROUP,
13063         ELM_WEB_MENU_OPTION
13064      } Elm_Web_Menu_Item_Type;
13065
13066    /**
13067     * Structure describing the items in a menu
13068     */
13069    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13070    /**
13071     * Structure describing the items in a menu
13072     */
13073    struct _Elm_Web_Menu_Item
13074      {
13075         const char *text; /**< The text for the item */
13076         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13077      };
13078
13079    /**
13080     * Structure describing the menu of a popup
13081     *
13082     * This structure will be passed as the @c event_info for the "popup,create"
13083     * signal, which is emitted when a dropdown menu is opened. Users wanting
13084     * to handle these popups by themselves should listen to this signal and
13085     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13086     * property as @c EINA_FALSE means that the user will not handle the popup
13087     * and the default implementation will be used.
13088     *
13089     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13090     * will be emitted to notify the user that it can destroy any objects and
13091     * free all data related to it.
13092     *
13093     * @see elm_web_popup_selected_set()
13094     * @see elm_web_popup_destroy()
13095     */
13096    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13097    /**
13098     * Structure describing the menu of a popup
13099     *
13100     * This structure will be passed as the @c event_info for the "popup,create"
13101     * signal, which is emitted when a dropdown menu is opened. Users wanting
13102     * to handle these popups by themselves should listen to this signal and
13103     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13104     * property as @c EINA_FALSE means that the user will not handle the popup
13105     * and the default implementation will be used.
13106     *
13107     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13108     * will be emitted to notify the user that it can destroy any objects and
13109     * free all data related to it.
13110     *
13111     * @see elm_web_popup_selected_set()
13112     * @see elm_web_popup_destroy()
13113     */
13114    struct _Elm_Web_Menu
13115      {
13116         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13117         int x; /**< The X position of the popup, relative to the elm_web object */
13118         int y; /**< The Y position of the popup, relative to the elm_web object */
13119         int width; /**< Width of the popup menu */
13120         int height; /**< Height of the popup menu */
13121
13122         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. */
13123      };
13124
13125    typedef struct _Elm_Web_Download Elm_Web_Download;
13126    struct _Elm_Web_Download
13127      {
13128         const char *url;
13129      };
13130
13131    /**
13132     * Types of zoom available.
13133     */
13134    typedef enum _Elm_Web_Zoom_Mode
13135      {
13136         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13137         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13138         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13139         ELM_WEB_ZOOM_MODE_LAST
13140      } Elm_Web_Zoom_Mode;
13141    /**
13142     * Opaque handler containing the features (such as statusbar, menubar, etc)
13143     * that are to be set on a newly requested window.
13144     */
13145    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13146    /**
13147     * Callback type for the create_window hook.
13148     *
13149     * The function parameters are:
13150     * @li @p data User data pointer set when setting the hook function
13151     * @li @p obj The elm_web object requesting the new window
13152     * @li @p js Set to @c EINA_TRUE if the request was originated from
13153     * JavaScript. @c EINA_FALSE otherwise.
13154     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13155     * the features requested for the new window.
13156     *
13157     * The returned value of the function should be the @c elm_web widget where
13158     * the request will be loaded. That is, if a new window or tab is created,
13159     * the elm_web widget in it should be returned, and @b NOT the window
13160     * object.
13161     * Returning @c NULL should cancel the request.
13162     *
13163     * @see elm_web_window_create_hook_set()
13164     */
13165    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13166    /**
13167     * Callback type for the JS alert hook.
13168     *
13169     * The function parameters are:
13170     * @li @p data User data pointer set when setting the hook function
13171     * @li @p obj The elm_web object requesting the new window
13172     * @li @p message The message to show in the alert dialog
13173     *
13174     * The function should return the object representing the alert dialog.
13175     * Elm_Web will run a second main loop to handle the dialog and normal
13176     * flow of the application will be restored when the object is deleted, so
13177     * the user should handle the popup properly in order to delete the object
13178     * when the action is finished.
13179     * If the function returns @c NULL the popup will be ignored.
13180     *
13181     * @see elm_web_dialog_alert_hook_set()
13182     */
13183    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13184    /**
13185     * Callback type for the JS confirm hook.
13186     *
13187     * The function parameters are:
13188     * @li @p data User data pointer set when setting the hook function
13189     * @li @p obj The elm_web object requesting the new window
13190     * @li @p message The message to show in the confirm dialog
13191     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13192     * the user selected @c Ok, @c EINA_FALSE otherwise.
13193     *
13194     * The function should return the object representing the confirm dialog.
13195     * Elm_Web will run a second main loop to handle the dialog and normal
13196     * flow of the application will be restored when the object is deleted, so
13197     * the user should handle the popup properly in order to delete the object
13198     * when the action is finished.
13199     * If the function returns @c NULL the popup will be ignored.
13200     *
13201     * @see elm_web_dialog_confirm_hook_set()
13202     */
13203    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13204    /**
13205     * Callback type for the JS prompt hook.
13206     *
13207     * The function parameters are:
13208     * @li @p data User data pointer set when setting the hook function
13209     * @li @p obj The elm_web object requesting the new window
13210     * @li @p message The message to show in the prompt dialog
13211     * @li @p def_value The default value to present the user in the entry
13212     * @li @p value Pointer where to store the value given by the user. Must
13213     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13214     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13215     * the user selected @c Ok, @c EINA_FALSE otherwise.
13216     *
13217     * The function should return the object representing the prompt dialog.
13218     * Elm_Web will run a second main loop to handle the dialog and normal
13219     * flow of the application will be restored when the object is deleted, so
13220     * the user should handle the popup properly in order to delete the object
13221     * when the action is finished.
13222     * If the function returns @c NULL the popup will be ignored.
13223     *
13224     * @see elm_web_dialog_prompt_hook_set()
13225     */
13226    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13227    /**
13228     * Callback type for the JS file selector hook.
13229     *
13230     * The function parameters are:
13231     * @li @p data User data pointer set when setting the hook function
13232     * @li @p obj The elm_web object requesting the new window
13233     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13234     * @li @p accept_types Mime types accepted
13235     * @li @p selected Pointer where to store the list of malloc'ed strings
13236     * containing the path to each file selected. Must be @c NULL if the file
13237     * dialog is cancelled
13238     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13239     * the user selected @c Ok, @c EINA_FALSE otherwise.
13240     *
13241     * The function should return the object representing the file selector
13242     * dialog.
13243     * Elm_Web will run a second main loop to handle the dialog and normal
13244     * flow of the application will be restored when the object is deleted, so
13245     * the user should handle the popup properly in order to delete the object
13246     * when the action is finished.
13247     * If the function returns @c NULL the popup will be ignored.
13248     *
13249     * @see elm_web_dialog_file selector_hook_set()
13250     */
13251    typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, const char *accept_types, Eina_List **selected, Eina_Bool *ret);
13252    /**
13253     * Callback type for the JS console message hook.
13254     *
13255     * When a console message is added from JavaScript, any set function to the
13256     * console message hook will be called for the user to handle. There is no
13257     * default implementation of this hook.
13258     *
13259     * The function parameters are:
13260     * @li @p data User data pointer set when setting the hook function
13261     * @li @p obj The elm_web object that originated the message
13262     * @li @p message The message sent
13263     * @li @p line_number The line number
13264     * @li @p source_id Source id
13265     *
13266     * @see elm_web_console_message_hook_set()
13267     */
13268    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13269    /**
13270     * Add a new web object to the parent.
13271     *
13272     * @param parent The parent object.
13273     * @return The new object or NULL if it cannot be created.
13274     *
13275     * @see elm_web_uri_set()
13276     * @see elm_web_webkit_view_get()
13277     */
13278    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13279
13280    /**
13281     * Get internal ewk_view object from web object.
13282     *
13283     * Elementary may not provide some low level features of EWebKit,
13284     * instead of cluttering the API with proxy methods we opted to
13285     * return the internal reference. Be careful using it as it may
13286     * interfere with elm_web behavior.
13287     *
13288     * @param obj The web object.
13289     * @return The internal ewk_view object or NULL if it does not
13290     *         exist. (Failure to create or Elementary compiled without
13291     *         ewebkit)
13292     *
13293     * @see elm_web_add()
13294     */
13295    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13296
13297    /**
13298     * Sets the function to call when a new window is requested
13299     *
13300     * This hook will be called when a request to create a new window is
13301     * issued from the web page loaded.
13302     * There is no default implementation for this feature, so leaving this
13303     * unset or passing @c NULL in @p func will prevent new windows from
13304     * opening.
13305     *
13306     * @param obj The web object where to set the hook function
13307     * @param func The hook function to be called when a window is requested
13308     * @param data User data
13309     */
13310    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13311    /**
13312     * Sets the function to call when an alert dialog
13313     *
13314     * This hook will be called when a JavaScript alert dialog is requested.
13315     * If no function is set or @c NULL is passed in @p func, the default
13316     * implementation will take place.
13317     *
13318     * @param obj The web object where to set the hook function
13319     * @param func The callback function to be used
13320     * @param data User data
13321     *
13322     * @see elm_web_inwin_mode_set()
13323     */
13324    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13325    /**
13326     * Sets the function to call when an confirm dialog
13327     *
13328     * This hook will be called when a JavaScript confirm dialog is requested.
13329     * If no function is set or @c NULL is passed in @p func, the default
13330     * implementation will take place.
13331     *
13332     * @param obj The web object where to set the hook function
13333     * @param func The callback function to be used
13334     * @param data User data
13335     *
13336     * @see elm_web_inwin_mode_set()
13337     */
13338    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13339    /**
13340     * Sets the function to call when an prompt dialog
13341     *
13342     * This hook will be called when a JavaScript prompt dialog is requested.
13343     * If no function is set or @c NULL is passed in @p func, the default
13344     * implementation will take place.
13345     *
13346     * @param obj The web object where to set the hook function
13347     * @param func The callback function to be used
13348     * @param data User data
13349     *
13350     * @see elm_web_inwin_mode_set()
13351     */
13352    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13353    /**
13354     * Sets the function to call when an file selector dialog
13355     *
13356     * This hook will be called when a JavaScript file selector dialog is
13357     * requested.
13358     * If no function is set or @c NULL is passed in @p func, the default
13359     * implementation will take place.
13360     *
13361     * @param obj The web object where to set the hook function
13362     * @param func The callback function to be used
13363     * @param data User data
13364     *
13365     * @see elm_web_inwin_mode_set()
13366     */
13367    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13368    /**
13369     * Sets the function to call when a console message is emitted from JS
13370     *
13371     * This hook will be called when a console message is emitted from
13372     * JavaScript. There is no default implementation for this feature.
13373     *
13374     * @param obj The web object where to set the hook function
13375     * @param func The callback function to be used
13376     * @param data User data
13377     */
13378    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13379    /**
13380     * Gets the status of the tab propagation
13381     *
13382     * @param obj The web object to query
13383     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13384     *
13385     * @see elm_web_tab_propagate_set()
13386     */
13387    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
13388    /**
13389     * Sets whether to use tab propagation
13390     *
13391     * If tab propagation is enabled, whenever the user presses the Tab key,
13392     * Elementary will handle it and switch focus to the next widget.
13393     * The default value is disabled, where WebKit will handle the Tab key to
13394     * cycle focus though its internal objects, jumping to the next widget
13395     * only when that cycle ends.
13396     *
13397     * @param obj The web object
13398     * @param propagate Whether to propagate Tab keys to Elementary or not
13399     */
13400    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13401    /**
13402     * Sets the URI for the web object
13403     *
13404     * It must be a full URI, with resource included, in the form
13405     * http://www.enlightenment.org or file:///tmp/something.html
13406     *
13407     * @param obj The web object
13408     * @param uri The URI to set
13409     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13410     */
13411    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
13412    /**
13413     * Gets the current URI for the object
13414     *
13415     * The returned string must not be freed and is guaranteed to be
13416     * stringshared.
13417     *
13418     * @param obj The web object
13419     * @return A stringshared internal string with the current URI, or NULL on
13420     * failure
13421     */
13422    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
13423    /**
13424     * Gets the current title
13425     *
13426     * The returned string must not be freed and is guaranteed to be
13427     * stringshared.
13428     *
13429     * @param obj The web object
13430     * @return A stringshared internal string with the current title, or NULL on
13431     * failure
13432     */
13433    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
13434    /**
13435     * Sets the background color to be used by the web object
13436     *
13437     * This is the color that will be used by default when the loaded page
13438     * does not set it's own. Color values are pre-multiplied.
13439     *
13440     * @param obj The web object
13441     * @param r Red component
13442     * @param g Green component
13443     * @param b Blue component
13444     * @param a Alpha component
13445     */
13446    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13447    /**
13448     * Gets the background color to be used by the web object
13449     *
13450     * This is the color that will be used by default when the loaded page
13451     * does not set it's own. Color values are pre-multiplied.
13452     *
13453     * @param obj The web object
13454     * @param r Red component
13455     * @param g Green component
13456     * @param b Blue component
13457     * @param a Alpha component
13458     */
13459    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13460    /**
13461     * Gets a copy of the currently selected text
13462     *
13463     * The string returned must be freed by the user when it's done with it.
13464     *
13465     * @param obj The web object
13466     * @return A newly allocated string, or NULL if nothing is selected or an
13467     * error occurred
13468     */
13469    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
13470    /**
13471     * Tells the web object which index in the currently open popup was selected
13472     *
13473     * When the user handles the popup creation from the "popup,created" signal,
13474     * it needs to tell the web object which item was selected by calling this
13475     * function with the index corresponding to the item.
13476     *
13477     * @param obj The web object
13478     * @param index The index selected
13479     *
13480     * @see elm_web_popup_destroy()
13481     */
13482    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
13483    /**
13484     * Dismisses an open dropdown popup
13485     *
13486     * When the popup from a dropdown widget is to be dismissed, either after
13487     * selecting an option or to cancel it, this function must be called, which
13488     * will later emit an "popup,willdelete" signal to notify the user that
13489     * any memory and objects related to this popup can be freed.
13490     *
13491     * @param obj The web object
13492     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13493     * if there was no menu to destroy
13494     */
13495    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
13496    /**
13497     * Searches the given string in a document.
13498     *
13499     * @param obj The web object where to search the text
13500     * @param string String to search
13501     * @param case_sensitive If search should be case sensitive or not
13502     * @param forward If search is from cursor and on or backwards
13503     * @param wrap If search should wrap at the end
13504     *
13505     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13506     * or failure
13507     */
13508    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13509    /**
13510     * Marks matches of the given string in a document.
13511     *
13512     * @param obj The web object where to search text
13513     * @param string String to match
13514     * @param case_sensitive If match should be case sensitive or not
13515     * @param highlight If matches should be highlighted
13516     * @param limit Maximum amount of matches, or zero to unlimited
13517     *
13518     * @return number of matched @a string
13519     */
13520    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13521    /**
13522     * Clears all marked matches in the document
13523     *
13524     * @param obj The web object
13525     *
13526     * @return EINA_TRUE on success, EINA_FALSE otherwise
13527     */
13528    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
13529    /**
13530     * Sets whether to highlight the matched marks
13531     *
13532     * If enabled, marks set with elm_web_text_matches_mark() will be
13533     * highlighted.
13534     *
13535     * @param obj The web object
13536     * @param highlight Whether to highlight the marks or not
13537     *
13538     * @return EINA_TRUE on success, EINA_FALSE otherwise
13539     */
13540    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13541    /**
13542     * Gets whether highlighting marks is enabled
13543     *
13544     * @param The web object
13545     *
13546     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13547     * otherwise
13548     */
13549    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
13550    /**
13551     * Gets the overall loading progress of the page
13552     *
13553     * Returns the estimated loading progress of the page, with a value between
13554     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13555     * included in the page.
13556     *
13557     * @param The web object
13558     *
13559     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13560     * failure
13561     */
13562    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
13563    /**
13564     * Stops loading the current page
13565     *
13566     * Cancels the loading of the current page in the web object. This will
13567     * cause a "load,error" signal to be emitted, with the is_cancellation
13568     * flag set to EINA_TRUE.
13569     *
13570     * @param obj The web object
13571     *
13572     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13573     */
13574    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
13575    /**
13576     * Requests a reload of the current document in the object
13577     *
13578     * @param obj The web object
13579     *
13580     * @return EINA_TRUE on success, EINA_FALSE otherwise
13581     */
13582    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
13583    /**
13584     * Requests a reload of the current document, avoiding any existing caches
13585     *
13586     * @param obj The web object
13587     *
13588     * @return EINA_TRUE on success, EINA_FALSE otherwise
13589     */
13590    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
13591    /**
13592     * Goes back one step in the browsing history
13593     *
13594     * This is equivalent to calling elm_web_object_navigate(obj, -1);
13595     *
13596     * @param obj The web object
13597     *
13598     * @return EINA_TRUE on success, EINA_FALSE otherwise
13599     *
13600     * @see elm_web_history_enable_set()
13601     * @see elm_web_back_possible()
13602     * @see elm_web_forward()
13603     * @see elm_web_navigate()
13604     */
13605    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
13606    /**
13607     * Goes forward one step in the browsing history
13608     *
13609     * This is equivalent to calling elm_web_object_navigate(obj, 1);
13610     *
13611     * @param obj The web object
13612     *
13613     * @return EINA_TRUE on success, EINA_FALSE otherwise
13614     *
13615     * @see elm_web_history_enable_set()
13616     * @see elm_web_forward_possible()
13617     * @see elm_web_back()
13618     * @see elm_web_navigate()
13619     */
13620    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
13621    /**
13622     * Jumps the given number of steps in the browsing history
13623     *
13624     * The @p steps value can be a negative integer to back in history, or a
13625     * positive to move forward.
13626     *
13627     * @param obj The web object
13628     * @param steps The number of steps to jump
13629     *
13630     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13631     * history exists to jump the given number of steps
13632     *
13633     * @see elm_web_history_enable_set()
13634     * @see elm_web_navigate_possible()
13635     * @see elm_web_back()
13636     * @see elm_web_forward()
13637     */
13638    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
13639    /**
13640     * Queries whether it's possible to go back in history
13641     *
13642     * @param obj The web object
13643     *
13644     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13645     * otherwise
13646     */
13647    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
13648    /**
13649     * Queries whether it's possible to go forward in history
13650     *
13651     * @param obj The web object
13652     *
13653     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13654     * otherwise
13655     */
13656    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
13657    /**
13658     * Queries whether it's possible to jump the given number of steps
13659     *
13660     * The @p steps value can be a negative integer to back in history, or a
13661     * positive to move forward.
13662     *
13663     * @param obj The web object
13664     * @param steps The number of steps to check for
13665     *
13666     * @return EINA_TRUE if enough history exists to perform the given jump,
13667     * EINA_FALSE otherwise
13668     */
13669    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
13670    /**
13671     * Gets whether browsing history is enabled for the given object
13672     *
13673     * @param obj The web object
13674     *
13675     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13676     */
13677    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
13678    /**
13679     * Enables or disables the browsing history
13680     *
13681     * @param obj The web object
13682     * @param enable Whether to enable or disable the browsing history
13683     */
13684    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13685    /**
13686     * Sets the zoom level of the web object
13687     *
13688     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13689     * values meaning zoom in and lower meaning zoom out. This function will
13690     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13691     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13692     *
13693     * @param obj The web object
13694     * @param zoom The zoom level to set
13695     */
13696    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
13697    /**
13698     * Gets the current zoom level set on the web object
13699     *
13700     * Note that this is the zoom level set on the web object and not that
13701     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13702     * the two zoom levels should match, but for the other two modes the
13703     * Webkit zoom is calculated internally to match the chosen mode without
13704     * changing the zoom level set for the web object.
13705     *
13706     * @param obj The web object
13707     *
13708     * @return The zoom level set on the object
13709     */
13710    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
13711    /**
13712     * Sets the zoom mode to use
13713     *
13714     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13715     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13716     *
13717     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13718     * with the elm_web_zoom_set() function.
13719     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13720     * make sure the entirety of the web object's contents are shown.
13721     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13722     * fit the contents in the web object's size, without leaving any space
13723     * unused.
13724     *
13725     * @param obj The web object
13726     * @param mode The mode to set
13727     */
13728    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13729    /**
13730     * Gets the currently set zoom mode
13731     *
13732     * @param obj The web object
13733     *
13734     * @return The current zoom mode set for the object, or
13735     * ::ELM_WEB_ZOOM_MODE_LAST on error
13736     */
13737    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
13738    /**
13739     * Shows the given region in the web object
13740     *
13741     * @param obj The web object
13742     * @param x The x coordinate of the region to show
13743     * @param y The y coordinate of the region to show
13744     * @param w The width of the region to show
13745     * @param h The height of the region to show
13746     */
13747    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13748    /**
13749     * Brings in the region to the visible area
13750     *
13751     * Like elm_web_region_show(), but it animates the scrolling of the object
13752     * to show the area
13753     *
13754     * @param obj The web object
13755     * @param x The x coordinate of the region to show
13756     * @param y The y coordinate of the region to show
13757     * @param w The width of the region to show
13758     * @param h The height of the region to show
13759     */
13760    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13761    /**
13762     * Sets the default dialogs to use an Inwin instead of a normal window
13763     *
13764     * If set, then the default implementation for the JavaScript dialogs and
13765     * file selector will be opened in an Inwin. Otherwise they will use a
13766     * normal separated window.
13767     *
13768     * @param obj The web object
13769     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13770     */
13771    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13772    /**
13773     * Gets whether Inwin mode is set for the current object
13774     *
13775     * @param obj The web object
13776     *
13777     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13778     */
13779    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
13780
13781    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13782    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13783    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);
13784    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13785
13786    /**
13787     * @}
13788     */
13789
13790    /**
13791     * @defgroup Hoversel Hoversel
13792     *
13793     * @image html img/widget/hoversel/preview-00.png
13794     * @image latex img/widget/hoversel/preview-00.eps
13795     *
13796     * A hoversel is a button that pops up a list of items (automatically
13797     * choosing the direction to display) that have a label and, optionally, an
13798     * icon to select from. It is a convenience widget to avoid the need to do
13799     * all the piecing together yourself. It is intended for a small number of
13800     * items in the hoversel menu (no more than 8), though is capable of many
13801     * more.
13802     *
13803     * Signals that you can add callbacks for are:
13804     * "clicked" - the user clicked the hoversel button and popped up the sel
13805     * "selected" - an item in the hoversel list is selected. event_info is the item
13806     * "dismissed" - the hover is dismissed
13807     *
13808     * See @ref tutorial_hoversel for an example.
13809     * @{
13810     */
13811    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13812    /**
13813     * @brief Add a new Hoversel object
13814     *
13815     * @param parent The parent object
13816     * @return The new object or NULL if it cannot be created
13817     */
13818    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13819    /**
13820     * @brief This sets the hoversel to expand horizontally.
13821     *
13822     * @param obj The hoversel object
13823     * @param horizontal If true, the hover will expand horizontally to the
13824     * right.
13825     *
13826     * @note The initial button will display horizontally regardless of this
13827     * setting.
13828     */
13829    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13830    /**
13831     * @brief This returns whether the hoversel is set to expand horizontally.
13832     *
13833     * @param obj The hoversel object
13834     * @return If true, the hover will expand horizontally to the right.
13835     *
13836     * @see elm_hoversel_horizontal_set()
13837     */
13838    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13839    /**
13840     * @brief Set the Hover parent
13841     *
13842     * @param obj The hoversel object
13843     * @param parent The parent to use
13844     *
13845     * Sets the hover parent object, the area that will be darkened when the
13846     * hoversel is clicked. Should probably be the window that the hoversel is
13847     * in. See @ref Hover objects for more information.
13848     */
13849    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13850    /**
13851     * @brief Get the Hover parent
13852     *
13853     * @param obj The hoversel object
13854     * @return The used parent
13855     *
13856     * Gets the hover parent object.
13857     *
13858     * @see elm_hoversel_hover_parent_set()
13859     */
13860    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13861    /**
13862     * @brief Set the hoversel button label
13863     *
13864     * @param obj The hoversel object
13865     * @param label The label text.
13866     *
13867     * This sets the label of the button that is always visible (before it is
13868     * clicked and expanded).
13869     *
13870     * @deprecated elm_object_text_set()
13871     */
13872    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13873    /**
13874     * @brief Get the hoversel button label
13875     *
13876     * @param obj The hoversel object
13877     * @return The label text.
13878     *
13879     * @deprecated elm_object_text_get()
13880     */
13881    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13882    /**
13883     * @brief Set the icon of the hoversel button
13884     *
13885     * @param obj The hoversel object
13886     * @param icon The icon object
13887     *
13888     * Sets the icon of the button that is always visible (before it is clicked
13889     * and expanded).  Once the icon object is set, a previously set one will be
13890     * deleted, if you want to keep that old content object, use the
13891     * elm_hoversel_icon_unset() function.
13892     *
13893     * @see elm_button_icon_set()
13894     */
13895    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13896    /**
13897     * @brief Get the icon of the hoversel button
13898     *
13899     * @param obj The hoversel object
13900     * @return The icon object
13901     *
13902     * Get the icon of the button that is always visible (before it is clicked
13903     * and expanded). Also see elm_button_icon_get().
13904     *
13905     * @see elm_hoversel_icon_set()
13906     */
13907    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13908    /**
13909     * @brief Get and unparent the icon of the hoversel button
13910     *
13911     * @param obj The hoversel object
13912     * @return The icon object that was being used
13913     *
13914     * Unparent and return the icon of the button that is always visible
13915     * (before it is clicked and expanded).
13916     *
13917     * @see elm_hoversel_icon_set()
13918     * @see elm_button_icon_unset()
13919     */
13920    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13921    /**
13922     * @brief This triggers the hoversel popup from code, the same as if the user
13923     * had clicked the button.
13924     *
13925     * @param obj The hoversel object
13926     */
13927    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
13928    /**
13929     * @brief This dismisses the hoversel popup as if the user had clicked
13930     * outside the hover.
13931     *
13932     * @param obj The hoversel object
13933     */
13934    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
13935    /**
13936     * @brief Returns whether the hoversel is expanded.
13937     *
13938     * @param obj The hoversel object
13939     * @return  This will return EINA_TRUE if the hoversel is expanded or
13940     * EINA_FALSE if it is not expanded.
13941     */
13942    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13943    /**
13944     * @brief This will remove all the children items from the hoversel.
13945     *
13946     * @param obj The hoversel object
13947     *
13948     * @warning Should @b not be called while the hoversel is active; use
13949     * elm_hoversel_expanded_get() to check first.
13950     *
13951     * @see elm_hoversel_item_del_cb_set()
13952     * @see elm_hoversel_item_del()
13953     */
13954    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13955    /**
13956     * @brief Get the list of items within the given hoversel.
13957     *
13958     * @param obj The hoversel object
13959     * @return Returns a list of Elm_Hoversel_Item*
13960     *
13961     * @see elm_hoversel_item_add()
13962     */
13963    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13964    /**
13965     * @brief Add an item to the hoversel button
13966     *
13967     * @param obj The hoversel object
13968     * @param label The text label to use for the item (NULL if not desired)
13969     * @param icon_file An image file path on disk to use for the icon or standard
13970     * icon name (NULL if not desired)
13971     * @param icon_type The icon type if relevant
13972     * @param func Convenience function to call when this item is selected
13973     * @param data Data to pass to item-related functions
13974     * @return A handle to the item added.
13975     *
13976     * This adds an item to the hoversel to show when it is clicked. Note: if you
13977     * need to use an icon from an edje file then use
13978     * elm_hoversel_item_icon_set() right after the this function, and set
13979     * icon_file to NULL here.
13980     *
13981     * For more information on what @p icon_file and @p icon_type are see the
13982     * @ref Icon "icon documentation".
13983     */
13984    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);
13985    /**
13986     * @brief Delete an item from the hoversel
13987     *
13988     * @param item The item to delete
13989     *
13990     * This deletes the item from the hoversel (should not be called while the
13991     * hoversel is active; use elm_hoversel_expanded_get() to check first).
13992     *
13993     * @see elm_hoversel_item_add()
13994     * @see elm_hoversel_item_del_cb_set()
13995     */
13996    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
13997    /**
13998     * @brief Set the function to be called when an item from the hoversel is
13999     * freed.
14000     *
14001     * @param item The item to set the callback on
14002     * @param func The function called
14003     *
14004     * That function will receive these parameters:
14005     * @li void *item_data
14006     * @li Evas_Object *the_item_object
14007     * @li Elm_Hoversel_Item *the_object_struct
14008     *
14009     * @see elm_hoversel_item_add()
14010     */
14011    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14012    /**
14013     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14014     * that will be passed to associated function callbacks.
14015     *
14016     * @param item The item to get the data from
14017     * @return The data pointer set with elm_hoversel_item_add()
14018     *
14019     * @see elm_hoversel_item_add()
14020     */
14021    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14022    /**
14023     * @brief This returns the label text of the given hoversel item.
14024     *
14025     * @param item The item to get the label
14026     * @return The label text of the hoversel item
14027     *
14028     * @see elm_hoversel_item_add()
14029     */
14030    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14031    /**
14032     * @brief This sets the icon for the given hoversel item.
14033     *
14034     * @param item The item to set the icon
14035     * @param icon_file An image file path on disk to use for the icon or standard
14036     * icon name
14037     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14038     * to NULL if the icon is not an edje file
14039     * @param icon_type The icon type
14040     *
14041     * The icon can be loaded from the standard set, from an image file, or from
14042     * an edje file.
14043     *
14044     * @see elm_hoversel_item_add()
14045     */
14046    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);
14047    /**
14048     * @brief Get the icon object of the hoversel item
14049     *
14050     * @param item The item to get the icon from
14051     * @param icon_file The image file path on disk used for the icon or standard
14052     * icon name
14053     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14054     * if the icon is not an edje file
14055     * @param icon_type The icon type
14056     *
14057     * @see elm_hoversel_item_icon_set()
14058     * @see elm_hoversel_item_add()
14059     */
14060    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);
14061    /**
14062     * @}
14063     */
14064
14065    /**
14066     * @defgroup Toolbar Toolbar
14067     * @ingroup Elementary
14068     *
14069     * @image html img/widget/toolbar/preview-00.png
14070     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14071     *
14072     * @image html img/toolbar.png
14073     * @image latex img/toolbar.eps width=\textwidth
14074     *
14075     * A toolbar is a widget that displays a list of items inside
14076     * a box. It can be scrollable, show a menu with items that don't fit
14077     * to toolbar size or even crop them.
14078     *
14079     * Only one item can be selected at a time.
14080     *
14081     * Items can have multiple states, or show menus when selected by the user.
14082     *
14083     * Smart callbacks one can listen to:
14084     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14085     *
14086     * Available styles for it:
14087     * - @c "default"
14088     * - @c "transparent" - no background or shadow, just show the content
14089     *
14090     * List of examples:
14091     * @li @ref toolbar_example_01
14092     * @li @ref toolbar_example_02
14093     * @li @ref toolbar_example_03
14094     */
14095
14096    /**
14097     * @addtogroup Toolbar
14098     * @{
14099     */
14100
14101    /**
14102     * @enum _Elm_Toolbar_Shrink_Mode
14103     * @typedef Elm_Toolbar_Shrink_Mode
14104     *
14105     * Set toolbar's items display behavior, it can be scrollabel,
14106     * show a menu with exceeding items, or simply hide them.
14107     *
14108     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14109     * from elm config.
14110     *
14111     * Values <b> don't </b> work as bitmask, only one can be choosen.
14112     *
14113     * @see elm_toolbar_mode_shrink_set()
14114     * @see elm_toolbar_mode_shrink_get()
14115     *
14116     * @ingroup Toolbar
14117     */
14118    typedef enum _Elm_Toolbar_Shrink_Mode
14119      {
14120         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
14121         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
14122         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14123         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
14124      } Elm_Toolbar_Shrink_Mode;
14125
14126    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(). */
14127
14128    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(). */
14129
14130    /**
14131     * Add a new toolbar widget to the given parent Elementary
14132     * (container) object.
14133     *
14134     * @param parent The parent object.
14135     * @return a new toolbar widget handle or @c NULL, on errors.
14136     *
14137     * This function inserts a new toolbar widget on the canvas.
14138     *
14139     * @ingroup Toolbar
14140     */
14141    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14142
14143    /**
14144     * Set the icon size, in pixels, to be used by toolbar items.
14145     *
14146     * @param obj The toolbar object
14147     * @param icon_size The icon size in pixels
14148     *
14149     * @note Default value is @c 32. It reads value from elm config.
14150     *
14151     * @see elm_toolbar_icon_size_get()
14152     *
14153     * @ingroup Toolbar
14154     */
14155    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14156
14157    /**
14158     * Get the icon size, in pixels, to be used by toolbar items.
14159     *
14160     * @param obj The toolbar object.
14161     * @return The icon size in pixels.
14162     *
14163     * @see elm_toolbar_icon_size_set() for details.
14164     *
14165     * @ingroup Toolbar
14166     */
14167    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14168
14169    /**
14170     * Sets icon lookup order, for toolbar items' icons.
14171     *
14172     * @param obj The toolbar object.
14173     * @param order The icon lookup order.
14174     *
14175     * Icons added before calling this function will not be affected.
14176     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14177     *
14178     * @see elm_toolbar_icon_order_lookup_get()
14179     *
14180     * @ingroup Toolbar
14181     */
14182    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14183
14184    /**
14185     * Gets the icon lookup order.
14186     *
14187     * @param obj The toolbar object.
14188     * @return The icon lookup order.
14189     *
14190     * @see elm_toolbar_icon_order_lookup_set() for details.
14191     *
14192     * @ingroup Toolbar
14193     */
14194    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14195
14196    /**
14197     * Set whether the toolbar should always have an item selected.
14198     *
14199     * @param obj The toolbar object.
14200     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14201     * disable it.
14202     *
14203     * This will cause the toolbar to always have an item selected, and clicking
14204     * the selected item will not cause a selected event to be emitted. Enabling this mode
14205     * will immediately select the first toolbar item.
14206     *
14207     * Always-selected is disabled by default.
14208     *
14209     * @see elm_toolbar_always_select_mode_get().
14210     *
14211     * @ingroup Toolbar
14212     */
14213    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14214
14215    /**
14216     * Get whether the toolbar should always have an item selected.
14217     *
14218     * @param obj The toolbar object.
14219     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14220     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14221     *
14222     * @see elm_toolbar_always_select_mode_set() for details.
14223     *
14224     * @ingroup Toolbar
14225     */
14226    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14227
14228    /**
14229     * Set whether the toolbar items' should be selected by the user or not.
14230     *
14231     * @param obj The toolbar object.
14232     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14233     * enable it.
14234     *
14235     * This will turn off the ability to select items entirely and they will
14236     * neither appear selected nor emit selected signals. The clicked
14237     * callback function will still be called.
14238     *
14239     * Selection is enabled by default.
14240     *
14241     * @see elm_toolbar_no_select_mode_get().
14242     *
14243     * @ingroup Toolbar
14244     */
14245    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14246
14247    /**
14248     * Set whether the toolbar items' should be selected by the user or not.
14249     *
14250     * @param obj The toolbar object.
14251     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14252     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14253     *
14254     * @see elm_toolbar_no_select_mode_set() for details.
14255     *
14256     * @ingroup Toolbar
14257     */
14258    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14259
14260    /**
14261     * Append item to the toolbar.
14262     *
14263     * @param obj The toolbar object.
14264     * @param icon A string with icon name or the absolute path of an image file.
14265     * @param label The label of the item.
14266     * @param func The function to call when the item is clicked.
14267     * @param data The data to associate with the item for related callbacks.
14268     * @return The created item or @c NULL upon failure.
14269     *
14270     * A new item will be created and appended to the toolbar, i.e., will
14271     * be set as @b last item.
14272     *
14273     * Items created with this method can be deleted with
14274     * elm_toolbar_item_del().
14275     *
14276     * Associated @p data can be properly freed when item is deleted if a
14277     * callback function is set with elm_toolbar_item_del_cb_set().
14278     *
14279     * If a function is passed as argument, it will be called everytime this item
14280     * is selected, i.e., the user clicks over an unselected item.
14281     * If such function isn't needed, just passing
14282     * @c NULL as @p func is enough. The same should be done for @p data.
14283     *
14284     * Toolbar will load icon image from fdo or current theme.
14285     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14286     * If an absolute path is provided it will load it direct from a file.
14287     *
14288     * @see elm_toolbar_item_icon_set()
14289     * @see elm_toolbar_item_del()
14290     * @see elm_toolbar_item_del_cb_set()
14291     *
14292     * @ingroup Toolbar
14293     */
14294    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);
14295
14296    /**
14297     * Prepend item to the toolbar.
14298     *
14299     * @param obj The toolbar object.
14300     * @param icon A string with icon name or the absolute path of an image file.
14301     * @param label The label of the item.
14302     * @param func The function to call when the item is clicked.
14303     * @param data The data to associate with the item for related callbacks.
14304     * @return The created item or @c NULL upon failure.
14305     *
14306     * A new item will be created and prepended to the toolbar, i.e., will
14307     * be set as @b first item.
14308     *
14309     * Items created with this method can be deleted with
14310     * elm_toolbar_item_del().
14311     *
14312     * Associated @p data can be properly freed when item is deleted if a
14313     * callback function is set with elm_toolbar_item_del_cb_set().
14314     *
14315     * If a function is passed as argument, it will be called everytime this item
14316     * is selected, i.e., the user clicks over an unselected item.
14317     * If such function isn't needed, just passing
14318     * @c NULL as @p func is enough. The same should be done for @p data.
14319     *
14320     * Toolbar will load icon image from fdo or current theme.
14321     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14322     * If an absolute path is provided it will load it direct from a file.
14323     *
14324     * @see elm_toolbar_item_icon_set()
14325     * @see elm_toolbar_item_del()
14326     * @see elm_toolbar_item_del_cb_set()
14327     *
14328     * @ingroup Toolbar
14329     */
14330    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);
14331
14332    /**
14333     * Insert a new item into the toolbar object before item @p before.
14334     *
14335     * @param obj The toolbar object.
14336     * @param before The toolbar item to insert before.
14337     * @param icon A string with icon name or the absolute path of an image file.
14338     * @param label The label of the item.
14339     * @param func The function to call when the item is clicked.
14340     * @param data The data to associate with the item for related callbacks.
14341     * @return The created item or @c NULL upon failure.
14342     *
14343     * A new item will be created and added to the toolbar. Its position in
14344     * this toolbar will be just before item @p before.
14345     *
14346     * Items created with this method can be deleted with
14347     * elm_toolbar_item_del().
14348     *
14349     * Associated @p data can be properly freed when item is deleted if a
14350     * callback function is set with elm_toolbar_item_del_cb_set().
14351     *
14352     * If a function is passed as argument, it will be called everytime this item
14353     * is selected, i.e., the user clicks over an unselected item.
14354     * If such function isn't needed, just passing
14355     * @c NULL as @p func is enough. The same should be done for @p data.
14356     *
14357     * Toolbar will load icon image from fdo or current theme.
14358     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14359     * If an absolute path is provided it will load it direct from a file.
14360     *
14361     * @see elm_toolbar_item_icon_set()
14362     * @see elm_toolbar_item_del()
14363     * @see elm_toolbar_item_del_cb_set()
14364     *
14365     * @ingroup Toolbar
14366     */
14367    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);
14368
14369    /**
14370     * Insert a new item into the toolbar object after item @p after.
14371     *
14372     * @param obj The toolbar object.
14373     * @param before The toolbar item to insert before.
14374     * @param icon A string with icon name or the absolute path of an image file.
14375     * @param label The label of the item.
14376     * @param func The function to call when the item is clicked.
14377     * @param data The data to associate with the item for related callbacks.
14378     * @return The created item or @c NULL upon failure.
14379     *
14380     * A new item will be created and added to the toolbar. Its position in
14381     * this toolbar will be just after item @p after.
14382     *
14383     * Items created with this method can be deleted with
14384     * elm_toolbar_item_del().
14385     *
14386     * Associated @p data can be properly freed when item is deleted if a
14387     * callback function is set with elm_toolbar_item_del_cb_set().
14388     *
14389     * If a function is passed as argument, it will be called everytime this item
14390     * is selected, i.e., the user clicks over an unselected item.
14391     * If such function isn't needed, just passing
14392     * @c NULL as @p func is enough. The same should be done for @p data.
14393     *
14394     * Toolbar will load icon image from fdo or current theme.
14395     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14396     * If an absolute path is provided it will load it direct from a file.
14397     *
14398     * @see elm_toolbar_item_icon_set()
14399     * @see elm_toolbar_item_del()
14400     * @see elm_toolbar_item_del_cb_set()
14401     *
14402     * @ingroup Toolbar
14403     */
14404    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);
14405
14406    /**
14407     * Get the first item in the given toolbar widget's list of
14408     * items.
14409     *
14410     * @param obj The toolbar object
14411     * @return The first item or @c NULL, if it has no items (and on
14412     * errors)
14413     *
14414     * @see elm_toolbar_item_append()
14415     * @see elm_toolbar_last_item_get()
14416     *
14417     * @ingroup Toolbar
14418     */
14419    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14420
14421    /**
14422     * Get the last item in the given toolbar widget's list of
14423     * items.
14424     *
14425     * @param obj The toolbar object
14426     * @return The last item or @c NULL, if it has no items (and on
14427     * errors)
14428     *
14429     * @see elm_toolbar_item_prepend()
14430     * @see elm_toolbar_first_item_get()
14431     *
14432     * @ingroup Toolbar
14433     */
14434    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14435
14436    /**
14437     * Get the item after @p item in toolbar.
14438     *
14439     * @param item The toolbar item.
14440     * @return The item after @p item, or @c NULL if none or on failure.
14441     *
14442     * @note If it is the last item, @c NULL will be returned.
14443     *
14444     * @see elm_toolbar_item_append()
14445     *
14446     * @ingroup Toolbar
14447     */
14448    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14449
14450    /**
14451     * Get the item before @p item in toolbar.
14452     *
14453     * @param item The toolbar item.
14454     * @return The item before @p item, or @c NULL if none or on failure.
14455     *
14456     * @note If it is the first item, @c NULL will be returned.
14457     *
14458     * @see elm_toolbar_item_prepend()
14459     *
14460     * @ingroup Toolbar
14461     */
14462    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14463
14464    /**
14465     * Get the toolbar object from an item.
14466     *
14467     * @param item The item.
14468     * @return The toolbar object.
14469     *
14470     * This returns the toolbar object itself that an item belongs to.
14471     *
14472     * @ingroup Toolbar
14473     */
14474    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14475
14476    /**
14477     * Set the priority of a toolbar item.
14478     *
14479     * @param item The toolbar item.
14480     * @param priority The item priority. The default is zero.
14481     *
14482     * This is used only when the toolbar shrink mode is set to
14483     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14484     * When space is less than required, items with low priority
14485     * will be removed from the toolbar and added to a dynamically-created menu,
14486     * while items with higher priority will remain on the toolbar,
14487     * with the same order they were added.
14488     *
14489     * @see elm_toolbar_item_priority_get()
14490     *
14491     * @ingroup Toolbar
14492     */
14493    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14494
14495    /**
14496     * Get the priority of a toolbar item.
14497     *
14498     * @param item The toolbar item.
14499     * @return The @p item priority, or @c 0 on failure.
14500     *
14501     * @see elm_toolbar_item_priority_set() for details.
14502     *
14503     * @ingroup Toolbar
14504     */
14505    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14506
14507    /**
14508     * Get the label of item.
14509     *
14510     * @param item The item of toolbar.
14511     * @return The label of item.
14512     *
14513     * The return value is a pointer to the label associated to @p item when
14514     * it was created, with function elm_toolbar_item_append() or similar,
14515     * or later,
14516     * with function elm_toolbar_item_label_set. If no label
14517     * was passed as argument, it will return @c NULL.
14518     *
14519     * @see elm_toolbar_item_label_set() for more details.
14520     * @see elm_toolbar_item_append()
14521     *
14522     * @ingroup Toolbar
14523     */
14524    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14525
14526    /**
14527     * Set the label of item.
14528     *
14529     * @param item The item of toolbar.
14530     * @param text The label of item.
14531     *
14532     * The label to be displayed by the item.
14533     * Label will be placed at icons bottom (if set).
14534     *
14535     * If a label was passed as argument on item creation, with function
14536     * elm_toolbar_item_append() or similar, it will be already
14537     * displayed by the item.
14538     *
14539     * @see elm_toolbar_item_label_get()
14540     * @see elm_toolbar_item_append()
14541     *
14542     * @ingroup Toolbar
14543     */
14544    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14545
14546    /**
14547     * Return the data associated with a given toolbar widget item.
14548     *
14549     * @param item The toolbar widget item handle.
14550     * @return The data associated with @p item.
14551     *
14552     * @see elm_toolbar_item_data_set()
14553     *
14554     * @ingroup Toolbar
14555     */
14556    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14557
14558    /**
14559     * Set the data associated with a given toolbar widget item.
14560     *
14561     * @param item The toolbar widget item handle.
14562     * @param data The new data pointer to set to @p item.
14563     *
14564     * This sets new item data on @p item.
14565     *
14566     * @warning The old data pointer won't be touched by this function, so
14567     * the user had better to free that old data himself/herself.
14568     *
14569     * @ingroup Toolbar
14570     */
14571    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14572
14573    /**
14574     * Returns a pointer to a toolbar item by its label.
14575     *
14576     * @param obj The toolbar object.
14577     * @param label The label of the item to find.
14578     *
14579     * @return The pointer to the toolbar item matching @p label or @c NULL
14580     * on failure.
14581     *
14582     * @ingroup Toolbar
14583     */
14584    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14585
14586    /*
14587     * Get whether the @p item is selected or not.
14588     *
14589     * @param item The toolbar item.
14590     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14591     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14592     *
14593     * @see elm_toolbar_selected_item_set() for details.
14594     * @see elm_toolbar_item_selected_get()
14595     *
14596     * @ingroup Toolbar
14597     */
14598    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14599
14600    /**
14601     * Set the selected state of an item.
14602     *
14603     * @param item The toolbar item
14604     * @param selected The selected state
14605     *
14606     * This sets the selected state of the given item @p it.
14607     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14608     *
14609     * If a new item is selected the previosly selected will be unselected.
14610     * Previoulsy selected item can be get with function
14611     * elm_toolbar_selected_item_get().
14612     *
14613     * Selected items will be highlighted.
14614     *
14615     * @see elm_toolbar_item_selected_get()
14616     * @see elm_toolbar_selected_item_get()
14617     *
14618     * @ingroup Toolbar
14619     */
14620    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14621
14622    /**
14623     * Get the selected item.
14624     *
14625     * @param obj The toolbar object.
14626     * @return The selected toolbar item.
14627     *
14628     * The selected item can be unselected with function
14629     * elm_toolbar_item_selected_set().
14630     *
14631     * The selected item always will be highlighted on toolbar.
14632     *
14633     * @see elm_toolbar_selected_items_get()
14634     *
14635     * @ingroup Toolbar
14636     */
14637    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14638
14639    /**
14640     * Set the icon associated with @p item.
14641     *
14642     * @param obj The parent of this item.
14643     * @param item The toolbar item.
14644     * @param icon A string with icon name or the absolute path of an image file.
14645     *
14646     * Toolbar will load icon image from fdo or current theme.
14647     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14648     * If an absolute path is provided it will load it direct from a file.
14649     *
14650     * @see elm_toolbar_icon_order_lookup_set()
14651     * @see elm_toolbar_icon_order_lookup_get()
14652     *
14653     * @ingroup Toolbar
14654     */
14655    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14656
14657    /**
14658     * Get the string used to set the icon of @p item.
14659     *
14660     * @param item The toolbar item.
14661     * @return The string associated with the icon object.
14662     *
14663     * @see elm_toolbar_item_icon_set() for details.
14664     *
14665     * @ingroup Toolbar
14666     */
14667    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14668
14669    /**
14670     * Get the object of @p item.
14671     *
14672     * @param item The toolbar item.
14673     * @return The object
14674     *
14675     * @ingroup Toolbar
14676     */
14677    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14678
14679    /**
14680     * Get the icon object of @p item.
14681     *
14682     * @param item The toolbar item.
14683     * @return The icon object
14684     *
14685     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14686     *
14687     * @ingroup Toolbar
14688     */
14689    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14690
14691    /**
14692     * Set the icon associated with @p item to an image in a binary buffer.
14693     *
14694     * @param item The toolbar item.
14695     * @param img The binary data that will be used as an image
14696     * @param size The size of binary data @p img
14697     * @param format Optional format of @p img to pass to the image loader
14698     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14699     *
14700     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14701     *
14702     * @note The icon image set by this function can be changed by
14703     * elm_toolbar_item_icon_set().
14704     * 
14705     * @ingroup Toolbar
14706     */
14707    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);
14708
14709    /**
14710     * Delete them item from the toolbar.
14711     *
14712     * @param item The item of toolbar to be deleted.
14713     *
14714     * @see elm_toolbar_item_append()
14715     * @see elm_toolbar_item_del_cb_set()
14716     *
14717     * @ingroup Toolbar
14718     */
14719    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14720
14721    /**
14722     * Set the function called when a toolbar item is freed.
14723     *
14724     * @param item The item to set the callback on.
14725     * @param func The function called.
14726     *
14727     * If there is a @p func, then it will be called prior item's memory release.
14728     * That will be called with the following arguments:
14729     * @li item's data;
14730     * @li item's Evas object;
14731     * @li item itself;
14732     *
14733     * This way, a data associated to a toolbar item could be properly freed.
14734     *
14735     * @ingroup Toolbar
14736     */
14737    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14738
14739    /**
14740     * Get a value whether toolbar item is disabled or not.
14741     *
14742     * @param item The item.
14743     * @return The disabled state.
14744     *
14745     * @see elm_toolbar_item_disabled_set() for more details.
14746     *
14747     * @ingroup Toolbar
14748     */
14749    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14750
14751    /**
14752     * Sets the disabled/enabled state of a toolbar item.
14753     *
14754     * @param item The item.
14755     * @param disabled The disabled state.
14756     *
14757     * A disabled item cannot be selected or unselected. It will also
14758     * change its appearance (generally greyed out). This sets the
14759     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14760     * enabled).
14761     *
14762     * @ingroup Toolbar
14763     */
14764    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14765
14766    /**
14767     * Set or unset item as a separator.
14768     *
14769     * @param item The toolbar item.
14770     * @param setting @c EINA_TRUE to set item @p item as separator or
14771     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14772     *
14773     * Items aren't set as separator by default.
14774     *
14775     * If set as separator it will display separator theme, so won't display
14776     * icons or label.
14777     *
14778     * @see elm_toolbar_item_separator_get()
14779     *
14780     * @ingroup Toolbar
14781     */
14782    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14783
14784    /**
14785     * Get a value whether item is a separator or not.
14786     *
14787     * @param item The toolbar item.
14788     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14789     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14790     *
14791     * @see elm_toolbar_item_separator_set() for details.
14792     *
14793     * @ingroup Toolbar
14794     */
14795    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14796
14797    /**
14798     * Set the shrink state of toolbar @p obj.
14799     *
14800     * @param obj The toolbar object.
14801     * @param shrink_mode Toolbar's items display behavior.
14802     *
14803     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14804     * but will enforce a minimun size so all the items will fit, won't scroll
14805     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14806     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14807     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14808     *
14809     * @ingroup Toolbar
14810     */
14811    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
14812
14813    /**
14814     * Get the shrink mode of toolbar @p obj.
14815     *
14816     * @param obj The toolbar object.
14817     * @return Toolbar's items display behavior.
14818     *
14819     * @see elm_toolbar_mode_shrink_set() for details.
14820     *
14821     * @ingroup Toolbar
14822     */
14823    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14824
14825    /**
14826     * Enable/disable homogenous mode.
14827     *
14828     * @param obj The toolbar object
14829     * @param homogeneous Assume the items within the toolbar are of the
14830     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14831     *
14832     * This will enable the homogeneous mode where items are of the same size.
14833     * @see elm_toolbar_homogeneous_get()
14834     *
14835     * @ingroup Toolbar
14836     */
14837    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14838
14839    /**
14840     * Get whether the homogenous mode is enabled.
14841     *
14842     * @param obj The toolbar object.
14843     * @return Assume the items within the toolbar are of the same height
14844     * and width (EINA_TRUE = on, EINA_FALSE = off).
14845     *
14846     * @see elm_toolbar_homogeneous_set()
14847     *
14848     * @ingroup Toolbar
14849     */
14850    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14851
14852    /**
14853     * Enable/disable homogenous mode.
14854     *
14855     * @param obj The toolbar object
14856     * @param homogeneous Assume the items within the toolbar are of the
14857     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14858     *
14859     * This will enable the homogeneous mode where items are of the same size.
14860     * @see elm_toolbar_homogeneous_get()
14861     *
14862     * @deprecated use elm_toolbar_homogeneous_set() instead.
14863     *
14864     * @ingroup Toolbar
14865     */
14866    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
14867
14868    /**
14869     * Get whether the homogenous mode is enabled.
14870     *
14871     * @param obj The toolbar object.
14872     * @return Assume the items within the toolbar are of the same height
14873     * and width (EINA_TRUE = on, EINA_FALSE = off).
14874     *
14875     * @see elm_toolbar_homogeneous_set()
14876     * @deprecated use elm_toolbar_homogeneous_get() instead.
14877     *
14878     * @ingroup Toolbar
14879     */
14880    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14881
14882    /**
14883     * Set the parent object of the toolbar items' menus.
14884     *
14885     * @param obj The toolbar object.
14886     * @param parent The parent of the menu objects.
14887     *
14888     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
14889     *
14890     * For more details about setting the parent for toolbar menus, see
14891     * elm_menu_parent_set().
14892     *
14893     * @see elm_menu_parent_set() for details.
14894     * @see elm_toolbar_item_menu_set() for details.
14895     *
14896     * @ingroup Toolbar
14897     */
14898    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14899
14900    /**
14901     * Get the parent object of the toolbar items' menus.
14902     *
14903     * @param obj The toolbar object.
14904     * @return The parent of the menu objects.
14905     *
14906     * @see elm_toolbar_menu_parent_set() for details.
14907     *
14908     * @ingroup Toolbar
14909     */
14910    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14911
14912    /**
14913     * Set the alignment of the items.
14914     *
14915     * @param obj The toolbar object.
14916     * @param align The new alignment, a float between <tt> 0.0 </tt>
14917     * and <tt> 1.0 </tt>.
14918     *
14919     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
14920     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
14921     * items.
14922     *
14923     * Centered items by default.
14924     *
14925     * @see elm_toolbar_align_get()
14926     *
14927     * @ingroup Toolbar
14928     */
14929    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
14930
14931    /**
14932     * Get the alignment of the items.
14933     *
14934     * @param obj The toolbar object.
14935     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
14936     * <tt> 1.0 </tt>.
14937     *
14938     * @see elm_toolbar_align_set() for details.
14939     *
14940     * @ingroup Toolbar
14941     */
14942    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14943
14944    /**
14945     * Set whether the toolbar item opens a menu.
14946     *
14947     * @param item The toolbar item.
14948     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
14949     *
14950     * A toolbar item can be set to be a menu, using this function.
14951     *
14952     * Once it is set to be a menu, it can be manipulated through the
14953     * menu-like function elm_toolbar_menu_parent_set() and the other
14954     * elm_menu functions, using the Evas_Object @c menu returned by
14955     * elm_toolbar_item_menu_get().
14956     *
14957     * So, items to be displayed in this item's menu should be added with
14958     * elm_menu_item_add().
14959     *
14960     * The following code exemplifies the most basic usage:
14961     * @code
14962     * tb = elm_toolbar_add(win)
14963     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
14964     * elm_toolbar_item_menu_set(item, EINA_TRUE);
14965     * elm_toolbar_menu_parent_set(tb, win);
14966     * menu = elm_toolbar_item_menu_get(item);
14967     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
14968     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
14969     * NULL);
14970     * @endcode
14971     *
14972     * @see elm_toolbar_item_menu_get()
14973     *
14974     * @ingroup Toolbar
14975     */
14976    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
14977
14978    /**
14979     * Get toolbar item's menu.
14980     *
14981     * @param item The toolbar item.
14982     * @return Item's menu object or @c NULL on failure.
14983     *
14984     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
14985     * this function will set it.
14986     *
14987     * @see elm_toolbar_item_menu_set() for details.
14988     *
14989     * @ingroup Toolbar
14990     */
14991    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14992
14993    /**
14994     * Add a new state to @p item.
14995     *
14996     * @param item The item.
14997     * @param icon A string with icon name or the absolute path of an image file.
14998     * @param label The label of the new state.
14999     * @param func The function to call when the item is clicked when this
15000     * state is selected.
15001     * @param data The data to associate with the state.
15002     * @return The toolbar item state, or @c NULL upon failure.
15003     *
15004     * Toolbar will load icon image from fdo or current theme.
15005     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15006     * If an absolute path is provided it will load it direct from a file.
15007     *
15008     * States created with this function can be removed with
15009     * elm_toolbar_item_state_del().
15010     *
15011     * @see elm_toolbar_item_state_del()
15012     * @see elm_toolbar_item_state_sel()
15013     * @see elm_toolbar_item_state_get()
15014     *
15015     * @ingroup Toolbar
15016     */
15017    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);
15018
15019    /**
15020     * Delete a previoulsy added state to @p item.
15021     *
15022     * @param item The toolbar item.
15023     * @param state The state to be deleted.
15024     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15025     *
15026     * @see elm_toolbar_item_state_add()
15027     */
15028    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15029
15030    /**
15031     * Set @p state as the current state of @p it.
15032     *
15033     * @param it The item.
15034     * @param state The state to use.
15035     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15036     *
15037     * If @p state is @c NULL, it won't select any state and the default item's
15038     * icon and label will be used. It's the same behaviour than
15039     * elm_toolbar_item_state_unser().
15040     *
15041     * @see elm_toolbar_item_state_unset()
15042     *
15043     * @ingroup Toolbar
15044     */
15045    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15046
15047    /**
15048     * Unset the state of @p it.
15049     *
15050     * @param it The item.
15051     *
15052     * The default icon and label from this item will be displayed.
15053     *
15054     * @see elm_toolbar_item_state_set() for more details.
15055     *
15056     * @ingroup Toolbar
15057     */
15058    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15059
15060    /**
15061     * Get the current state of @p it.
15062     *
15063     * @param item The item.
15064     * @return The selected state or @c NULL if none is selected or on failure.
15065     *
15066     * @see elm_toolbar_item_state_set() for details.
15067     * @see elm_toolbar_item_state_unset()
15068     * @see elm_toolbar_item_state_add()
15069     *
15070     * @ingroup Toolbar
15071     */
15072    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15073
15074    /**
15075     * Get the state after selected state in toolbar's @p item.
15076     *
15077     * @param it The toolbar item to change state.
15078     * @return The state after current state, or @c NULL on failure.
15079     *
15080     * If last state is selected, this function will return first state.
15081     *
15082     * @see elm_toolbar_item_state_set()
15083     * @see elm_toolbar_item_state_add()
15084     *
15085     * @ingroup Toolbar
15086     */
15087    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15088
15089    /**
15090     * Get the state before selected state in toolbar's @p item.
15091     *
15092     * @param it The toolbar item to change state.
15093     * @return The state before current state, or @c NULL on failure.
15094     *
15095     * If first state is selected, this function will return last state.
15096     *
15097     * @see elm_toolbar_item_state_set()
15098     * @see elm_toolbar_item_state_add()
15099     *
15100     * @ingroup Toolbar
15101     */
15102    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15103
15104    /**
15105     * Set the text to be shown in a given toolbar item's tooltips.
15106     *
15107     * @param item Target item.
15108     * @param text The text to set in the content.
15109     *
15110     * Setup the text as tooltip to object. The item can have only one tooltip,
15111     * so any previous tooltip data - set with this function or
15112     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15113     *
15114     * @see elm_object_tooltip_text_set() for more details.
15115     *
15116     * @ingroup Toolbar
15117     */
15118    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15119
15120    /**
15121     * Set the content to be shown in the tooltip item.
15122     *
15123     * Setup the tooltip to item. The item can have only one tooltip,
15124     * so any previous tooltip data is removed. @p func(with @p data) will
15125     * be called every time that need show the tooltip and it should
15126     * return a valid Evas_Object. This object is then managed fully by
15127     * tooltip system and is deleted when the tooltip is gone.
15128     *
15129     * @param item the toolbar item being attached a tooltip.
15130     * @param func the function used to create the tooltip contents.
15131     * @param data what to provide to @a func as callback data/context.
15132     * @param del_cb called when data is not needed anymore, either when
15133     *        another callback replaces @a func, the tooltip is unset with
15134     *        elm_toolbar_item_tooltip_unset() or the owner @a item
15135     *        dies. This callback receives as the first parameter the
15136     *        given @a data, and @c event_info is the item.
15137     *
15138     * @see elm_object_tooltip_content_cb_set() for more details.
15139     *
15140     * @ingroup Toolbar
15141     */
15142    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);
15143
15144    /**
15145     * Unset tooltip from item.
15146     *
15147     * @param item toolbar item to remove previously set tooltip.
15148     *
15149     * Remove tooltip from item. The callback provided as del_cb to
15150     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15151     * it is not used anymore.
15152     *
15153     * @see elm_object_tooltip_unset() for more details.
15154     * @see elm_toolbar_item_tooltip_content_cb_set()
15155     *
15156     * @ingroup Toolbar
15157     */
15158    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15159
15160    /**
15161     * Sets a different style for this item tooltip.
15162     *
15163     * @note before you set a style you should define a tooltip with
15164     *       elm_toolbar_item_tooltip_content_cb_set() or
15165     *       elm_toolbar_item_tooltip_text_set()
15166     *
15167     * @param item toolbar item with tooltip already set.
15168     * @param style the theme style to use (default, transparent, ...)
15169     *
15170     * @see elm_object_tooltip_style_set() for more details.
15171     *
15172     * @ingroup Toolbar
15173     */
15174    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15175
15176    /**
15177     * Get the style for this item tooltip.
15178     *
15179     * @param item toolbar item with tooltip already set.
15180     * @return style the theme style in use, defaults to "default". If the
15181     *         object does not have a tooltip set, then NULL is returned.
15182     *
15183     * @see elm_object_tooltip_style_get() for more details.
15184     * @see elm_toolbar_item_tooltip_style_set()
15185     *
15186     * @ingroup Toolbar
15187     */
15188    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15189
15190    /**
15191     * Set the type of mouse pointer/cursor decoration to be shown,
15192     * when the mouse pointer is over the given toolbar widget item
15193     *
15194     * @param item toolbar item to customize cursor on
15195     * @param cursor the cursor type's name
15196     *
15197     * This function works analogously as elm_object_cursor_set(), but
15198     * here the cursor's changing area is restricted to the item's
15199     * area, and not the whole widget's. Note that that item cursors
15200     * have precedence over widget cursors, so that a mouse over an
15201     * item with custom cursor set will always show @b that cursor.
15202     *
15203     * If this function is called twice for an object, a previously set
15204     * cursor will be unset on the second call.
15205     *
15206     * @see elm_object_cursor_set()
15207     * @see elm_toolbar_item_cursor_get()
15208     * @see elm_toolbar_item_cursor_unset()
15209     *
15210     * @ingroup Toolbar
15211     */
15212    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15213
15214    /*
15215     * Get the type of mouse pointer/cursor decoration set to be shown,
15216     * when the mouse pointer is over the given toolbar widget item
15217     *
15218     * @param item toolbar item with custom cursor set
15219     * @return the cursor type's name or @c NULL, if no custom cursors
15220     * were set to @p item (and on errors)
15221     *
15222     * @see elm_object_cursor_get()
15223     * @see elm_toolbar_item_cursor_set()
15224     * @see elm_toolbar_item_cursor_unset()
15225     *
15226     * @ingroup Toolbar
15227     */
15228    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15229
15230    /**
15231     * Unset any custom mouse pointer/cursor decoration set to be
15232     * shown, when the mouse pointer is over the given toolbar widget
15233     * item, thus making it show the @b default cursor again.
15234     *
15235     * @param item a toolbar item
15236     *
15237     * Use this call to undo any custom settings on this item's cursor
15238     * decoration, bringing it back to defaults (no custom style set).
15239     *
15240     * @see elm_object_cursor_unset()
15241     * @see elm_toolbar_item_cursor_set()
15242     *
15243     * @ingroup Toolbar
15244     */
15245    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15246
15247    /**
15248     * Set a different @b style for a given custom cursor set for a
15249     * toolbar item.
15250     *
15251     * @param item toolbar item with custom cursor set
15252     * @param style the <b>theme style</b> to use (e.g. @c "default",
15253     * @c "transparent", etc)
15254     *
15255     * This function only makes sense when one is using custom mouse
15256     * cursor decorations <b>defined in a theme file</b>, which can have,
15257     * given a cursor name/type, <b>alternate styles</b> on it. It
15258     * works analogously as elm_object_cursor_style_set(), but here
15259     * applyed only to toolbar item objects.
15260     *
15261     * @warning Before you set a cursor style you should have definen a
15262     *       custom cursor previously on the item, with
15263     *       elm_toolbar_item_cursor_set()
15264     *
15265     * @see elm_toolbar_item_cursor_engine_only_set()
15266     * @see elm_toolbar_item_cursor_style_get()
15267     *
15268     * @ingroup Toolbar
15269     */
15270    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15271
15272    /**
15273     * Get the current @b style set for a given toolbar item's custom
15274     * cursor
15275     *
15276     * @param item toolbar item with custom cursor set.
15277     * @return style the cursor style in use. If the object does not
15278     *         have a cursor set, then @c NULL is returned.
15279     *
15280     * @see elm_toolbar_item_cursor_style_set() for more details
15281     *
15282     * @ingroup Toolbar
15283     */
15284    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15285
15286    /**
15287     * Set if the (custom)cursor for a given toolbar item should be
15288     * searched in its theme, also, or should only rely on the
15289     * rendering engine.
15290     *
15291     * @param item item with custom (custom) cursor already set on
15292     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15293     * only on those provided by the rendering engine, @c EINA_FALSE to
15294     * have them searched on the widget's theme, as well.
15295     *
15296     * @note This call is of use only if you've set a custom cursor
15297     * for toolbar items, with elm_toolbar_item_cursor_set().
15298     *
15299     * @note By default, cursors will only be looked for between those
15300     * provided by the rendering engine.
15301     *
15302     * @ingroup Toolbar
15303     */
15304    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15305
15306    /**
15307     * Get if the (custom) cursor for a given toolbar item is being
15308     * searched in its theme, also, or is only relying on the rendering
15309     * engine.
15310     *
15311     * @param item a toolbar item
15312     * @return @c EINA_TRUE, if cursors are being looked for only on
15313     * those provided by the rendering engine, @c EINA_FALSE if they
15314     * are being searched on the widget's theme, as well.
15315     *
15316     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15317     *
15318     * @ingroup Toolbar
15319     */
15320    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15321
15322    /**
15323     * Change a toolbar's orientation
15324     * @param obj The toolbar object
15325     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15326     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15327     * @ingroup Toolbar
15328     */
15329    EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15330
15331    /**
15332     * Get a toolbar's orientation
15333     * @param obj The toolbar object
15334     * @return If @c EINA_TRUE, the toolbar is vertical
15335     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15336     * @ingroup Toolbar
15337     */
15338    EAPI Eina_Bool        elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
15339
15340    /**
15341     * @}
15342     */
15343
15344    /**
15345     * @defgroup Tooltips Tooltips
15346     *
15347     * The Tooltip is an (internal, for now) smart object used to show a
15348     * content in a frame on mouse hover of objects(or widgets), with
15349     * tips/information about them.
15350     *
15351     * @{
15352     */
15353
15354    EAPI double       elm_tooltip_delay_get(void);
15355    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
15356    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15357    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15358    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15359    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);
15360    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15361    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15362    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15363    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15364    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15365
15366    /**
15367     * @}
15368     */
15369
15370    /**
15371     * @defgroup Cursors Cursors
15372     *
15373     * The Elementary cursor is an internal smart object used to
15374     * customize the mouse cursor displayed over objects (or
15375     * widgets). In the most common scenario, the cursor decoration
15376     * comes from the graphical @b engine Elementary is running
15377     * on. Those engines may provide different decorations for cursors,
15378     * and Elementary provides functions to choose them (think of X11
15379     * cursors, as an example).
15380     *
15381     * There's also the possibility of, besides using engine provided
15382     * cursors, also use ones coming from Edje theming files. Both
15383     * globally and per widget, Elementary makes it possible for one to
15384     * make the cursors lookup to be held on engines only or on
15385     * Elementary's theme file, too.
15386     *
15387     * @{
15388     */
15389
15390    /**
15391     * Set the cursor to be shown when mouse is over the object
15392     *
15393     * Set the cursor that will be displayed when mouse is over the
15394     * object. The object can have only one cursor set to it, so if
15395     * this function is called twice for an object, the previous set
15396     * will be unset.
15397     * If using X cursors, a definition of all the valid cursor names
15398     * is listed on Elementary_Cursors.h. If an invalid name is set
15399     * the default cursor will be used.
15400     *
15401     * @param obj the object being set a cursor.
15402     * @param cursor the cursor name to be used.
15403     *
15404     * @ingroup Cursors
15405     */
15406    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15407
15408    /**
15409     * Get the cursor to be shown when mouse is over the object
15410     *
15411     * @param obj an object with cursor already set.
15412     * @return the cursor name.
15413     *
15414     * @ingroup Cursors
15415     */
15416    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15417
15418    /**
15419     * Unset cursor for object
15420     *
15421     * Unset cursor for object, and set the cursor to default if the mouse
15422     * was over this object.
15423     *
15424     * @param obj Target object
15425     * @see elm_object_cursor_set()
15426     *
15427     * @ingroup Cursors
15428     */
15429    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15430
15431    /**
15432     * Sets a different style for this object cursor.
15433     *
15434     * @note before you set a style you should define a cursor with
15435     *       elm_object_cursor_set()
15436     *
15437     * @param obj an object with cursor already set.
15438     * @param style the theme style to use (default, transparent, ...)
15439     *
15440     * @ingroup Cursors
15441     */
15442    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15443
15444    /**
15445     * Get the style for this object cursor.
15446     *
15447     * @param obj an object with cursor already set.
15448     * @return style the theme style in use, defaults to "default". If the
15449     *         object does not have a cursor set, then NULL is returned.
15450     *
15451     * @ingroup Cursors
15452     */
15453    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15454
15455    /**
15456     * Set if the cursor set should be searched on the theme or should use
15457     * the provided by the engine, only.
15458     *
15459     * @note before you set if should look on theme you should define a cursor
15460     * with elm_object_cursor_set(). By default it will only look for cursors
15461     * provided by the engine.
15462     *
15463     * @param obj an object with cursor already set.
15464     * @param engine_only boolean to define it cursors should be looked only
15465     * between the provided by the engine or searched on widget's theme as well.
15466     *
15467     * @ingroup Cursors
15468     */
15469    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15470
15471    /**
15472     * Get the cursor engine only usage for this object cursor.
15473     *
15474     * @param obj an object with cursor already set.
15475     * @return engine_only boolean to define it cursors should be
15476     * looked only between the provided by the engine or searched on
15477     * widget's theme as well. If the object does not have a cursor
15478     * set, then EINA_FALSE is returned.
15479     *
15480     * @ingroup Cursors
15481     */
15482    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15483
15484    /**
15485     * Get the configured cursor engine only usage
15486     *
15487     * This gets the globally configured exclusive usage of engine cursors.
15488     *
15489     * @return 1 if only engine cursors should be used
15490     * @ingroup Cursors
15491     */
15492    EAPI int          elm_cursor_engine_only_get(void);
15493
15494    /**
15495     * Set the configured cursor engine only usage
15496     *
15497     * This sets the globally configured exclusive usage of engine cursors.
15498     * It won't affect cursors set before changing this value.
15499     *
15500     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15501     * look for them on theme before.
15502     * @return EINA_TRUE if value is valid and setted (0 or 1)
15503     * @ingroup Cursors
15504     */
15505    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
15506
15507    /**
15508     * @}
15509     */
15510
15511    /**
15512     * @defgroup Menu Menu
15513     *
15514     * @image html img/widget/menu/preview-00.png
15515     * @image latex img/widget/menu/preview-00.eps
15516     *
15517     * A menu is a list of items displayed above its parent. When the menu is
15518     * showing its parent is darkened. Each item can have a sub-menu. The menu
15519     * object can be used to display a menu on a right click event, in a toolbar,
15520     * anywhere.
15521     *
15522     * Signals that you can add callbacks for are:
15523     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15524     *             event_info is NULL.
15525     *
15526     * @see @ref tutorial_menu
15527     * @{
15528     */
15529    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15530    /**
15531     * @brief Add a new menu to the parent
15532     *
15533     * @param parent The parent object.
15534     * @return The new object or NULL if it cannot be created.
15535     */
15536    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15537    /**
15538     * @brief Set the parent for the given menu widget
15539     *
15540     * @param obj The menu object.
15541     * @param parent The new parent.
15542     */
15543    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15544    /**
15545     * @brief Get the parent for the given menu widget
15546     *
15547     * @param obj The menu object.
15548     * @return The parent.
15549     *
15550     * @see elm_menu_parent_set()
15551     */
15552    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15553    /**
15554     * @brief Move the menu to a new position
15555     *
15556     * @param obj The menu object.
15557     * @param x The new position.
15558     * @param y The new position.
15559     *
15560     * Sets the top-left position of the menu to (@p x,@p y).
15561     *
15562     * @note @p x and @p y coordinates are relative to parent.
15563     */
15564    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15565    /**
15566     * @brief Close a opened menu
15567     *
15568     * @param obj the menu object
15569     * @return void
15570     *
15571     * Hides the menu and all it's sub-menus.
15572     */
15573    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15574    /**
15575     * @brief Returns a list of @p item's items.
15576     *
15577     * @param obj The menu object
15578     * @return An Eina_List* of @p item's items
15579     */
15580    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15581    /**
15582     * @brief Get the Evas_Object of an Elm_Menu_Item
15583     *
15584     * @param item The menu item object.
15585     * @return The edje object containing the swallowed content
15586     *
15587     * @warning Don't manipulate this object!
15588     */
15589    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15590    /**
15591     * @brief Add an item at the end of the given menu widget
15592     *
15593     * @param obj The menu object.
15594     * @param parent The parent menu item (optional)
15595     * @param icon A icon display on the item. The icon will be destryed by the menu.
15596     * @param label The label of the item.
15597     * @param func Function called when the user select the item.
15598     * @param data Data sent by the callback.
15599     * @return Returns the new item.
15600     */
15601    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);
15602    /**
15603     * @brief Add an object swallowed in an item at the end of the given menu
15604     * widget
15605     *
15606     * @param obj The menu object.
15607     * @param parent The parent menu item (optional)
15608     * @param subobj The object to swallow
15609     * @param func Function called when the user select the item.
15610     * @param data Data sent by the callback.
15611     * @return Returns the new item.
15612     *
15613     * Add an evas object as an item to the menu.
15614     */
15615    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);
15616    /**
15617     * @brief Set the label of a menu item
15618     *
15619     * @param item The menu item object.
15620     * @param label The label to set for @p item
15621     *
15622     * @warning Don't use this funcion on items created with
15623     * elm_menu_item_add_object() or elm_menu_item_separator_add().
15624     */
15625    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15626    /**
15627     * @brief Get the label of a menu item
15628     *
15629     * @param item The menu item object.
15630     * @return The label of @p item
15631     */
15632    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15633    /**
15634     * @brief Set the icon of a menu item to the standard icon with name @p icon
15635     *
15636     * @param item The menu item object.
15637     * @param icon The icon object to set for the content of @p item
15638     *
15639     * Once this icon is set, any previously set icon will be deleted.
15640     */
15641    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15642    /**
15643     * @brief Get the string representation from the icon of a menu item
15644     *
15645     * @param item The menu item object.
15646     * @return The string representation of @p item's icon or NULL
15647     *
15648     * @see elm_menu_item_object_icon_name_set()
15649     */
15650    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15651    /**
15652     * @brief Set the content object of a menu item
15653     *
15654     * @param item The menu item object
15655     * @param The content object or NULL
15656     * @return EINA_TRUE on success, else EINA_FALSE
15657     *
15658     * Use this function to change the object swallowed by a menu item, deleting
15659     * any previously swallowed object.
15660     */
15661    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15662    /**
15663     * @brief Get the content object of a menu item
15664     *
15665     * @param item The menu item object
15666     * @return The content object or NULL
15667     * @note If @p item was added with elm_menu_item_add_object, this
15668     * function will return the object passed, else it will return the
15669     * icon object.
15670     *
15671     * @see elm_menu_item_object_content_set()
15672     */
15673    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15674    /**
15675     * @brief Set the selected state of @p item.
15676     *
15677     * @param item The menu item object.
15678     * @param selected The selected/unselected state of the item
15679     */
15680    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15681    /**
15682     * @brief Get the selected state of @p item.
15683     *
15684     * @param item The menu item object.
15685     * @return The selected/unselected state of the item
15686     *
15687     * @see elm_menu_item_selected_set()
15688     */
15689    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15690    /**
15691     * @brief Set the disabled state of @p item.
15692     *
15693     * @param item The menu item object.
15694     * @param disabled The enabled/disabled state of the item
15695     */
15696    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15697    /**
15698     * @brief Get the disabled state of @p item.
15699     *
15700     * @param item The menu item object.
15701     * @return The enabled/disabled state of the item
15702     *
15703     * @see elm_menu_item_disabled_set()
15704     */
15705    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15706    /**
15707     * @brief Add a separator item to menu @p obj under @p parent.
15708     *
15709     * @param obj The menu object
15710     * @param parent The item to add the separator under
15711     * @return The created item or NULL on failure
15712     *
15713     * This is item is a @ref Separator.
15714     */
15715    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15716    /**
15717     * @brief Returns whether @p item is a separator.
15718     *
15719     * @param item The item to check
15720     * @return If true, @p item is a separator
15721     *
15722     * @see elm_menu_item_separator_add()
15723     */
15724    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15725    /**
15726     * @brief Deletes an item from the menu.
15727     *
15728     * @param item The item to delete.
15729     *
15730     * @see elm_menu_item_add()
15731     */
15732    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15733    /**
15734     * @brief Set the function called when a menu item is deleted.
15735     *
15736     * @param item The item to set the callback on
15737     * @param func The function called
15738     *
15739     * @see elm_menu_item_add()
15740     * @see elm_menu_item_del()
15741     */
15742    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15743    /**
15744     * @brief Returns the data associated with menu item @p item.
15745     *
15746     * @param item The item
15747     * @return The data associated with @p item or NULL if none was set.
15748     *
15749     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15750     */
15751    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15752    /**
15753     * @brief Sets the data to be associated with menu item @p item.
15754     *
15755     * @param item The item
15756     * @param data The data to be associated with @p item
15757     */
15758    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15759    /**
15760     * @brief Returns a list of @p item's subitems.
15761     *
15762     * @param item The item
15763     * @return An Eina_List* of @p item's subitems
15764     *
15765     * @see elm_menu_add()
15766     */
15767    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15768    /**
15769     * @brief Get the position of a menu item
15770     *
15771     * @param item The menu item
15772     * @return The item's index
15773     *
15774     * This function returns the index position of a menu item in a menu.
15775     * For a sub-menu, this number is relative to the first item in the sub-menu.
15776     *
15777     * @note Index values begin with 0
15778     */
15779    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15780    /**
15781     * @brief @brief Return a menu item's owner menu
15782     *
15783     * @param item The menu item
15784     * @return The menu object owning @p item, or NULL on failure
15785     *
15786     * Use this function to get the menu object owning an item.
15787     */
15788    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15789    /**
15790     * @brief Get the selected item in the menu
15791     *
15792     * @param obj The menu object
15793     * @return The selected item, or NULL if none
15794     *
15795     * @see elm_menu_item_selected_get()
15796     * @see elm_menu_item_selected_set()
15797     */
15798    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15799    /**
15800     * @brief Get the last item in the menu
15801     *
15802     * @param obj The menu object
15803     * @return The last item, or NULL if none
15804     */
15805    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15806    /**
15807     * @brief Get the first item in the menu
15808     *
15809     * @param obj The menu object
15810     * @return The first item, or NULL if none
15811     */
15812    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15813    /**
15814     * @brief Get the next item in the menu.
15815     *
15816     * @param item The menu item object.
15817     * @return The item after it, or NULL if none
15818     */
15819    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15820    /**
15821     * @brief Get the previous item in the menu.
15822     *
15823     * @param item The menu item object.
15824     * @return The item before it, or NULL if none
15825     */
15826    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15827    /**
15828     * @}
15829     */
15830
15831    /**
15832     * @defgroup List List
15833     * @ingroup Elementary
15834     *
15835     * @image html img/widget/list/preview-00.png
15836     * @image latex img/widget/list/preview-00.eps width=\textwidth
15837     *
15838     * @image html img/list.png
15839     * @image latex img/list.eps width=\textwidth
15840     *
15841     * A list widget is a container whose children are displayed vertically or
15842     * horizontally, in order, and can be selected.
15843     * The list can accept only one or multiple items selection. Also has many
15844     * modes of items displaying.
15845     *
15846     * A list is a very simple type of list widget.  For more robust
15847     * lists, @ref Genlist should probably be used.
15848     *
15849     * Smart callbacks one can listen to:
15850     * - @c "activated" - The user has double-clicked or pressed
15851     *   (enter|return|spacebar) on an item. The @c event_info parameter
15852     *   is the item that was activated.
15853     * - @c "clicked,double" - The user has double-clicked an item.
15854     *   The @c event_info parameter is the item that was double-clicked.
15855     * - "selected" - when the user selected an item
15856     * - "unselected" - when the user unselected an item
15857     * - "longpressed" - an item in the list is long-pressed
15858     * - "scroll,edge,top" - the list is scrolled until the top edge
15859     * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
15860     * - "scroll,edge,left" - the list is scrolled until the left edge
15861     * - "scroll,edge,right" - the list is scrolled until the right edge
15862     *
15863     * Available styles for it:
15864     * - @c "default"
15865     *
15866     * List of examples:
15867     * @li @ref list_example_01
15868     * @li @ref list_example_02
15869     * @li @ref list_example_03
15870     */
15871
15872    /**
15873     * @addtogroup List
15874     * @{
15875     */
15876
15877    /**
15878     * @enum _Elm_List_Mode
15879     * @typedef Elm_List_Mode
15880     *
15881     * Set list's resize behavior, transverse axis scroll and
15882     * items cropping. See each mode's description for more details.
15883     *
15884     * @note Default value is #ELM_LIST_SCROLL.
15885     *
15886     * Values <b> don't </b> work as bitmask, only one can be choosen.
15887     *
15888     * @see elm_list_mode_set()
15889     * @see elm_list_mode_get()
15890     *
15891     * @ingroup List
15892     */
15893    typedef enum _Elm_List_Mode
15894      {
15895         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. */
15896         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). */
15897         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. */
15898         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. */
15899         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
15900      } Elm_List_Mode;
15901
15902    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().  */
15903
15904    /**
15905     * Add a new list widget to the given parent Elementary
15906     * (container) object.
15907     *
15908     * @param parent The parent object.
15909     * @return a new list widget handle or @c NULL, on errors.
15910     *
15911     * This function inserts a new list widget on the canvas.
15912     *
15913     * @ingroup List
15914     */
15915    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15916
15917    /**
15918     * Starts the list.
15919     *
15920     * @param obj The list object
15921     *
15922     * @note Call before running show() on the list object.
15923     * @warning If not called, it won't display the list properly.
15924     *
15925     * @code
15926     * li = elm_list_add(win);
15927     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
15928     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
15929     * elm_list_go(li);
15930     * evas_object_show(li);
15931     * @endcode
15932     *
15933     * @ingroup List
15934     */
15935    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
15936
15937    /**
15938     * Enable or disable multiple items selection on the list object.
15939     *
15940     * @param obj The list object
15941     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
15942     * disable it.
15943     *
15944     * Disabled by default. If disabled, the user can select a single item of
15945     * the list each time. Selected items are highlighted on list.
15946     * If enabled, many items can be selected.
15947     *
15948     * If a selected item is selected again, it will be unselected.
15949     *
15950     * @see elm_list_multi_select_get()
15951     *
15952     * @ingroup List
15953     */
15954    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
15955
15956    /**
15957     * Get a value whether multiple items selection is enabled or not.
15958     *
15959     * @see elm_list_multi_select_set() for details.
15960     *
15961     * @param obj The list object.
15962     * @return @c EINA_TRUE means multiple items selection is enabled.
15963     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15964     * @c EINA_FALSE is returned.
15965     *
15966     * @ingroup List
15967     */
15968    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15969
15970    /**
15971     * Set which mode to use for the list object.
15972     *
15973     * @param obj The list object
15974     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15975     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
15976     *
15977     * Set list's resize behavior, transverse axis scroll and
15978     * items cropping. See each mode's description for more details.
15979     *
15980     * @note Default value is #ELM_LIST_SCROLL.
15981     *
15982     * Only one can be set, if a previous one was set, it will be changed
15983     * by the new mode set. Bitmask won't work as well.
15984     *
15985     * @see elm_list_mode_get()
15986     *
15987     * @ingroup List
15988     */
15989    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
15990
15991    /**
15992     * Get the mode the list is at.
15993     *
15994     * @param obj The list object
15995     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15996     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
15997     *
15998     * @note see elm_list_mode_set() for more information.
15999     *
16000     * @ingroup List
16001     */
16002    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16003
16004    /**
16005     * Enable or disable horizontal mode on the list object.
16006     *
16007     * @param obj The list object.
16008     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16009     * disable it, i.e., to enable vertical mode.
16010     *
16011     * @note Vertical mode is set by default.
16012     *
16013     * On horizontal mode items are displayed on list from left to right,
16014     * instead of from top to bottom. Also, the list will scroll horizontally.
16015     * Each item will presents left icon on top and right icon, or end, at
16016     * the bottom.
16017     *
16018     * @see elm_list_horizontal_get()
16019     *
16020     * @ingroup List
16021     */
16022    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16023
16024    /**
16025     * Get a value whether horizontal mode is enabled or not.
16026     *
16027     * @param obj The list object.
16028     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16029     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16030     * @c EINA_FALSE is returned.
16031     *
16032     * @see elm_list_horizontal_set() for details.
16033     *
16034     * @ingroup List
16035     */
16036    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16037
16038    /**
16039     * Enable or disable always select mode on the list object.
16040     *
16041     * @param obj The list object
16042     * @param always_select @c EINA_TRUE to enable always select mode or
16043     * @c EINA_FALSE to disable it.
16044     *
16045     * @note Always select mode is disabled by default.
16046     *
16047     * Default behavior of list items is to only call its callback function
16048     * the first time it's pressed, i.e., when it is selected. If a selected
16049     * item is pressed again, and multi-select is disabled, it won't call
16050     * this function (if multi-select is enabled it will unselect the item).
16051     *
16052     * If always select is enabled, it will call the callback function
16053     * everytime a item is pressed, so it will call when the item is selected,
16054     * and again when a selected item is pressed.
16055     *
16056     * @see elm_list_always_select_mode_get()
16057     * @see elm_list_multi_select_set()
16058     *
16059     * @ingroup List
16060     */
16061    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16062
16063    /**
16064     * Get a value whether always select mode is enabled or not, meaning that
16065     * an item will always call its callback function, even if already selected.
16066     *
16067     * @param obj The list object
16068     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16069     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16070     * @c EINA_FALSE is returned.
16071     *
16072     * @see elm_list_always_select_mode_set() for details.
16073     *
16074     * @ingroup List
16075     */
16076    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16077
16078    /**
16079     * Set bouncing behaviour when the scrolled content reaches an edge.
16080     *
16081     * Tell the internal scroller object whether it should bounce or not
16082     * when it reaches the respective edges for each axis.
16083     *
16084     * @param obj The list object
16085     * @param h_bounce Whether to bounce or not in the horizontal axis.
16086     * @param v_bounce Whether to bounce or not in the vertical axis.
16087     *
16088     * @see elm_scroller_bounce_set()
16089     *
16090     * @ingroup List
16091     */
16092    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16093
16094    /**
16095     * Get the bouncing behaviour of the internal scroller.
16096     *
16097     * Get whether the internal scroller should bounce when the edge of each
16098     * axis is reached scrolling.
16099     *
16100     * @param obj The list object.
16101     * @param h_bounce Pointer where to store the bounce state of the horizontal
16102     * axis.
16103     * @param v_bounce Pointer where to store the bounce state of the vertical
16104     * axis.
16105     *
16106     * @see elm_scroller_bounce_get()
16107     * @see elm_list_bounce_set()
16108     *
16109     * @ingroup List
16110     */
16111    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16112
16113    /**
16114     * Set the scrollbar policy.
16115     *
16116     * @param obj The list object
16117     * @param policy_h Horizontal scrollbar policy.
16118     * @param policy_v Vertical scrollbar policy.
16119     *
16120     * This sets the scrollbar visibility policy for the given scroller.
16121     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16122     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16123     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16124     * This applies respectively for the horizontal and vertical scrollbars.
16125     *
16126     * The both are disabled by default, i.e., are set to
16127     * #ELM_SCROLLER_POLICY_OFF.
16128     *
16129     * @ingroup List
16130     */
16131    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16132
16133    /**
16134     * Get the scrollbar policy.
16135     *
16136     * @see elm_list_scroller_policy_get() for details.
16137     *
16138     * @param obj The list object.
16139     * @param policy_h Pointer where to store horizontal scrollbar policy.
16140     * @param policy_v Pointer where to store vertical scrollbar policy.
16141     *
16142     * @ingroup List
16143     */
16144    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);
16145
16146    /**
16147     * Append a new item to the list object.
16148     *
16149     * @param obj The list object.
16150     * @param label The label of the list item.
16151     * @param icon The icon object to use for the left side of the item. An
16152     * icon can be any Evas object, but usually it is an icon created
16153     * with elm_icon_add().
16154     * @param end The icon object to use for the right side of the item. An
16155     * icon can be any Evas object.
16156     * @param func The function to call when the item is clicked.
16157     * @param data The data to associate with the item for related callbacks.
16158     *
16159     * @return The created item or @c NULL upon failure.
16160     *
16161     * A new item will be created and appended to the list, i.e., will
16162     * be set as @b last item.
16163     *
16164     * Items created with this method can be deleted with
16165     * elm_list_item_del().
16166     *
16167     * Associated @p data can be properly freed when item is deleted if a
16168     * callback function is set with elm_list_item_del_cb_set().
16169     *
16170     * If a function is passed as argument, it will be called everytime this item
16171     * is selected, i.e., the user clicks over an unselected item.
16172     * If always select is enabled it will call this function every time
16173     * user clicks over an item (already selected or not).
16174     * If such function isn't needed, just passing
16175     * @c NULL as @p func is enough. The same should be done for @p data.
16176     *
16177     * Simple example (with no function callback or data associated):
16178     * @code
16179     * li = elm_list_add(win);
16180     * ic = elm_icon_add(win);
16181     * elm_icon_file_set(ic, "path/to/image", NULL);
16182     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16183     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16184     * elm_list_go(li);
16185     * evas_object_show(li);
16186     * @endcode
16187     *
16188     * @see elm_list_always_select_mode_set()
16189     * @see elm_list_item_del()
16190     * @see elm_list_item_del_cb_set()
16191     * @see elm_list_clear()
16192     * @see elm_icon_add()
16193     *
16194     * @ingroup List
16195     */
16196    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);
16197
16198    /**
16199     * Prepend a new item to the list object.
16200     *
16201     * @param obj The list object.
16202     * @param label The label of the list item.
16203     * @param icon The icon object to use for the left side of the item. An
16204     * icon can be any Evas object, but usually it is an icon created
16205     * with elm_icon_add().
16206     * @param end The icon object to use for the right side of the item. An
16207     * icon can be any Evas object.
16208     * @param func The function to call when the item is clicked.
16209     * @param data The data to associate with the item for related callbacks.
16210     *
16211     * @return The created item or @c NULL upon failure.
16212     *
16213     * A new item will be created and prepended to the list, i.e., will
16214     * be set as @b first item.
16215     *
16216     * Items created with this method can be deleted with
16217     * elm_list_item_del().
16218     *
16219     * Associated @p data can be properly freed when item is deleted if a
16220     * callback function is set with elm_list_item_del_cb_set().
16221     *
16222     * If a function is passed as argument, it will be called everytime this item
16223     * is selected, i.e., the user clicks over an unselected item.
16224     * If always select is enabled it will call this function every time
16225     * user clicks over an item (already selected or not).
16226     * If such function isn't needed, just passing
16227     * @c NULL as @p func is enough. The same should be done for @p data.
16228     *
16229     * @see elm_list_item_append() for a simple code example.
16230     * @see elm_list_always_select_mode_set()
16231     * @see elm_list_item_del()
16232     * @see elm_list_item_del_cb_set()
16233     * @see elm_list_clear()
16234     * @see elm_icon_add()
16235     *
16236     * @ingroup List
16237     */
16238    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);
16239
16240    /**
16241     * Insert a new item into the list object before item @p before.
16242     *
16243     * @param obj The list object.
16244     * @param before The list item to insert before.
16245     * @param label The label of the list item.
16246     * @param icon The icon object to use for the left side of the item. An
16247     * icon can be any Evas object, but usually it is an icon created
16248     * with elm_icon_add().
16249     * @param end The icon object to use for the right side of the item. An
16250     * icon can be any Evas object.
16251     * @param func The function to call when the item is clicked.
16252     * @param data The data to associate with the item for related callbacks.
16253     *
16254     * @return The created item or @c NULL upon failure.
16255     *
16256     * A new item will be created and added to the list. Its position in
16257     * this list will be just before item @p before.
16258     *
16259     * Items created with this method can be deleted with
16260     * elm_list_item_del().
16261     *
16262     * Associated @p data can be properly freed when item is deleted if a
16263     * callback function is set with elm_list_item_del_cb_set().
16264     *
16265     * If a function is passed as argument, it will be called everytime this item
16266     * is selected, i.e., the user clicks over an unselected item.
16267     * If always select is enabled it will call this function every time
16268     * user clicks over an item (already selected or not).
16269     * If such function isn't needed, just passing
16270     * @c NULL as @p func is enough. The same should be done for @p data.
16271     *
16272     * @see elm_list_item_append() for a simple code example.
16273     * @see elm_list_always_select_mode_set()
16274     * @see elm_list_item_del()
16275     * @see elm_list_item_del_cb_set()
16276     * @see elm_list_clear()
16277     * @see elm_icon_add()
16278     *
16279     * @ingroup List
16280     */
16281    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);
16282
16283    /**
16284     * Insert a new item into the list object after item @p after.
16285     *
16286     * @param obj The list object.
16287     * @param after The list item to insert after.
16288     * @param label The label of the list item.
16289     * @param icon The icon object to use for the left side of the item. An
16290     * icon can be any Evas object, but usually it is an icon created
16291     * with elm_icon_add().
16292     * @param end The icon object to use for the right side of the item. An
16293     * icon can be any Evas object.
16294     * @param func The function to call when the item is clicked.
16295     * @param data The data to associate with the item for related callbacks.
16296     *
16297     * @return The created item or @c NULL upon failure.
16298     *
16299     * A new item will be created and added to the list. Its position in
16300     * this list will be just after item @p after.
16301     *
16302     * Items created with this method can be deleted with
16303     * elm_list_item_del().
16304     *
16305     * Associated @p data can be properly freed when item is deleted if a
16306     * callback function is set with elm_list_item_del_cb_set().
16307     *
16308     * If a function is passed as argument, it will be called everytime this item
16309     * is selected, i.e., the user clicks over an unselected item.
16310     * If always select is enabled it will call this function every time
16311     * user clicks over an item (already selected or not).
16312     * If such function isn't needed, just passing
16313     * @c NULL as @p func is enough. The same should be done for @p data.
16314     *
16315     * @see elm_list_item_append() for a simple code example.
16316     * @see elm_list_always_select_mode_set()
16317     * @see elm_list_item_del()
16318     * @see elm_list_item_del_cb_set()
16319     * @see elm_list_clear()
16320     * @see elm_icon_add()
16321     *
16322     * @ingroup List
16323     */
16324    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);
16325
16326    /**
16327     * Insert a new item into the sorted list object.
16328     *
16329     * @param obj The list object.
16330     * @param label The label of the list item.
16331     * @param icon The icon object to use for the left side of the item. An
16332     * icon can be any Evas object, but usually it is an icon created
16333     * with elm_icon_add().
16334     * @param end The icon object to use for the right side of the item. An
16335     * icon can be any Evas object.
16336     * @param func The function to call when the item is clicked.
16337     * @param data The data to associate with the item for related callbacks.
16338     * @param cmp_func The comparing function to be used to sort list
16339     * items <b>by #Elm_List_Item item handles</b>. This function will
16340     * receive two items and compare them, returning a non-negative integer
16341     * if the second item should be place after the first, or negative value
16342     * if should be placed before.
16343     *
16344     * @return The created item or @c NULL upon failure.
16345     *
16346     * @note This function inserts values into a list object assuming it was
16347     * sorted and the result will be sorted.
16348     *
16349     * A new item will be created and added to the list. Its position in
16350     * this list will be found comparing the new item with previously inserted
16351     * items using function @p cmp_func.
16352     *
16353     * Items created with this method can be deleted with
16354     * elm_list_item_del().
16355     *
16356     * Associated @p data can be properly freed when item is deleted if a
16357     * callback function is set with elm_list_item_del_cb_set().
16358     *
16359     * If a function is passed as argument, it will be called everytime this item
16360     * is selected, i.e., the user clicks over an unselected item.
16361     * If always select is enabled it will call this function every time
16362     * user clicks over an item (already selected or not).
16363     * If such function isn't needed, just passing
16364     * @c NULL as @p func is enough. The same should be done for @p data.
16365     *
16366     * @see elm_list_item_append() for a simple code example.
16367     * @see elm_list_always_select_mode_set()
16368     * @see elm_list_item_del()
16369     * @see elm_list_item_del_cb_set()
16370     * @see elm_list_clear()
16371     * @see elm_icon_add()
16372     *
16373     * @ingroup List
16374     */
16375    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);
16376
16377    /**
16378     * Remove all list's items.
16379     *
16380     * @param obj The list object
16381     *
16382     * @see elm_list_item_del()
16383     * @see elm_list_item_append()
16384     *
16385     * @ingroup List
16386     */
16387    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16388
16389    /**
16390     * Get a list of all the list items.
16391     *
16392     * @param obj The list object
16393     * @return An @c Eina_List of list items, #Elm_List_Item,
16394     * or @c NULL on failure.
16395     *
16396     * @see elm_list_item_append()
16397     * @see elm_list_item_del()
16398     * @see elm_list_clear()
16399     *
16400     * @ingroup List
16401     */
16402    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16403
16404    /**
16405     * Get the selected item.
16406     *
16407     * @param obj The list object.
16408     * @return The selected list item.
16409     *
16410     * The selected item can be unselected with function
16411     * elm_list_item_selected_set().
16412     *
16413     * The selected item always will be highlighted on list.
16414     *
16415     * @see elm_list_selected_items_get()
16416     *
16417     * @ingroup List
16418     */
16419    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16420
16421    /**
16422     * Return a list of the currently selected list items.
16423     *
16424     * @param obj The list object.
16425     * @return An @c Eina_List of list items, #Elm_List_Item,
16426     * or @c NULL on failure.
16427     *
16428     * Multiple items can be selected if multi select is enabled. It can be
16429     * done with elm_list_multi_select_set().
16430     *
16431     * @see elm_list_selected_item_get()
16432     * @see elm_list_multi_select_set()
16433     *
16434     * @ingroup List
16435     */
16436    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16437
16438    /**
16439     * Set the selected state of an item.
16440     *
16441     * @param item The list item
16442     * @param selected The selected state
16443     *
16444     * This sets the selected state of the given item @p it.
16445     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16446     *
16447     * If a new item is selected the previosly selected will be unselected,
16448     * unless multiple selection is enabled with elm_list_multi_select_set().
16449     * Previoulsy selected item can be get with function
16450     * elm_list_selected_item_get().
16451     *
16452     * Selected items will be highlighted.
16453     *
16454     * @see elm_list_item_selected_get()
16455     * @see elm_list_selected_item_get()
16456     * @see elm_list_multi_select_set()
16457     *
16458     * @ingroup List
16459     */
16460    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16461
16462    /*
16463     * Get whether the @p item is selected or not.
16464     *
16465     * @param item The list item.
16466     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16467     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16468     *
16469     * @see elm_list_selected_item_set() for details.
16470     * @see elm_list_item_selected_get()
16471     *
16472     * @ingroup List
16473     */
16474    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16475
16476    /**
16477     * Set or unset item as a separator.
16478     *
16479     * @param it The list item.
16480     * @param setting @c EINA_TRUE to set item @p it as separator or
16481     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16482     *
16483     * Items aren't set as separator by default.
16484     *
16485     * If set as separator it will display separator theme, so won't display
16486     * icons or label.
16487     *
16488     * @see elm_list_item_separator_get()
16489     *
16490     * @ingroup List
16491     */
16492    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16493
16494    /**
16495     * Get a value whether item is a separator or not.
16496     *
16497     * @see elm_list_item_separator_set() for details.
16498     *
16499     * @param it The list item.
16500     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16501     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16502     *
16503     * @ingroup List
16504     */
16505    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16506
16507    /**
16508     * Show @p item in the list view.
16509     *
16510     * @param item The list item to be shown.
16511     *
16512     * It won't animate list until item is visible. If such behavior is wanted,
16513     * use elm_list_bring_in() intead.
16514     *
16515     * @ingroup List
16516     */
16517    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16518
16519    /**
16520     * Bring in the given item to list view.
16521     *
16522     * @param item The item.
16523     *
16524     * This causes list to jump to the given item @p item and show it
16525     * (by scrolling), if it is not fully visible.
16526     *
16527     * This may use animation to do so and take a period of time.
16528     *
16529     * If animation isn't wanted, elm_list_item_show() can be used.
16530     *
16531     * @ingroup List
16532     */
16533    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16534
16535    /**
16536     * Delete them item from the list.
16537     *
16538     * @param item The item of list to be deleted.
16539     *
16540     * If deleting all list items is required, elm_list_clear()
16541     * should be used instead of getting items list and deleting each one.
16542     *
16543     * @see elm_list_clear()
16544     * @see elm_list_item_append()
16545     * @see elm_list_item_del_cb_set()
16546     *
16547     * @ingroup List
16548     */
16549    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16550
16551    /**
16552     * Set the function called when a list item is freed.
16553     *
16554     * @param item The item to set the callback on
16555     * @param func The function called
16556     *
16557     * If there is a @p func, then it will be called prior item's memory release.
16558     * That will be called with the following arguments:
16559     * @li item's data;
16560     * @li item's Evas object;
16561     * @li item itself;
16562     *
16563     * This way, a data associated to a list item could be properly freed.
16564     *
16565     * @ingroup List
16566     */
16567    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16568
16569    /**
16570     * Get the data associated to the item.
16571     *
16572     * @param item The list item
16573     * @return The data associated to @p item
16574     *
16575     * The return value is a pointer to data associated to @p item when it was
16576     * created, with function elm_list_item_append() or similar. If no data
16577     * was passed as argument, it will return @c NULL.
16578     *
16579     * @see elm_list_item_append()
16580     *
16581     * @ingroup List
16582     */
16583    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16584
16585    /**
16586     * Get the left side icon associated to the item.
16587     *
16588     * @param item The list item
16589     * @return The left side icon associated to @p item
16590     *
16591     * The return value is a pointer to the icon associated to @p item when
16592     * it was
16593     * created, with function elm_list_item_append() or similar, or later
16594     * with function elm_list_item_icon_set(). If no icon
16595     * was passed as argument, it will return @c NULL.
16596     *
16597     * @see elm_list_item_append()
16598     * @see elm_list_item_icon_set()
16599     *
16600     * @ingroup List
16601     */
16602    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16603
16604    /**
16605     * Set the left side icon associated to the item.
16606     *
16607     * @param item The list item
16608     * @param icon The left side icon object to associate with @p item
16609     *
16610     * The icon object to use at left side of the item. An
16611     * icon can be any Evas object, but usually it is an icon created
16612     * with elm_icon_add().
16613     *
16614     * Once the icon object is set, a previously set one will be deleted.
16615     * @warning Setting the same icon for two items will cause the icon to
16616     * dissapear from the first item.
16617     *
16618     * If an icon was passed as argument on item creation, with function
16619     * elm_list_item_append() or similar, it will be already
16620     * associated to the item.
16621     *
16622     * @see elm_list_item_append()
16623     * @see elm_list_item_icon_get()
16624     *
16625     * @ingroup List
16626     */
16627    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16628
16629    /**
16630     * Get the right side icon associated to the item.
16631     *
16632     * @param item The list item
16633     * @return The right side icon associated to @p item
16634     *
16635     * The return value is a pointer to the icon associated to @p item when
16636     * it was
16637     * created, with function elm_list_item_append() or similar, or later
16638     * with function elm_list_item_icon_set(). If no icon
16639     * was passed as argument, it will return @c NULL.
16640     *
16641     * @see elm_list_item_append()
16642     * @see elm_list_item_icon_set()
16643     *
16644     * @ingroup List
16645     */
16646    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16647
16648    /**
16649     * Set the right side icon associated to the item.
16650     *
16651     * @param item The list item
16652     * @param end The right side icon object to associate with @p item
16653     *
16654     * The icon object to use at right side of the item. An
16655     * icon can be any Evas object, but usually it is an icon created
16656     * with elm_icon_add().
16657     *
16658     * Once the icon object is set, a previously set one will be deleted.
16659     * @warning Setting the same icon for two items will cause the icon to
16660     * dissapear from the first item.
16661     *
16662     * If an icon was passed as argument on item creation, with function
16663     * elm_list_item_append() or similar, it will be already
16664     * associated to the item.
16665     *
16666     * @see elm_list_item_append()
16667     * @see elm_list_item_end_get()
16668     *
16669     * @ingroup List
16670     */
16671    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16672
16673    /**
16674     * Gets the base object of the item.
16675     *
16676     * @param item The list item
16677     * @return The base object associated with @p item
16678     *
16679     * Base object is the @c Evas_Object that represents that item.
16680     *
16681     * @ingroup List
16682     */
16683    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16684    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16685
16686    /**
16687     * Get the label of item.
16688     *
16689     * @param item The item of list.
16690     * @return The label of item.
16691     *
16692     * The return value is a pointer to the label associated to @p item when
16693     * it was created, with function elm_list_item_append(), or later
16694     * with function elm_list_item_label_set. If no label
16695     * was passed as argument, it will return @c NULL.
16696     *
16697     * @see elm_list_item_label_set() for more details.
16698     * @see elm_list_item_append()
16699     *
16700     * @ingroup List
16701     */
16702    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16703
16704    /**
16705     * Set the label of item.
16706     *
16707     * @param item The item of list.
16708     * @param text The label of item.
16709     *
16710     * The label to be displayed by the item.
16711     * Label will be placed between left and right side icons (if set).
16712     *
16713     * If a label was passed as argument on item creation, with function
16714     * elm_list_item_append() or similar, it will be already
16715     * displayed by the item.
16716     *
16717     * @see elm_list_item_label_get()
16718     * @see elm_list_item_append()
16719     *
16720     * @ingroup List
16721     */
16722    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16723
16724
16725    /**
16726     * Get the item before @p it in list.
16727     *
16728     * @param it The list item.
16729     * @return The item before @p it, or @c NULL if none or on failure.
16730     *
16731     * @note If it is the first item, @c NULL will be returned.
16732     *
16733     * @see elm_list_item_append()
16734     * @see elm_list_items_get()
16735     *
16736     * @ingroup List
16737     */
16738    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16739
16740    /**
16741     * Get the item after @p it in list.
16742     *
16743     * @param it The list item.
16744     * @return The item after @p it, or @c NULL if none or on failure.
16745     *
16746     * @note If it is the last item, @c NULL will be returned.
16747     *
16748     * @see elm_list_item_append()
16749     * @see elm_list_items_get()
16750     *
16751     * @ingroup List
16752     */
16753    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16754
16755    /**
16756     * Sets the disabled/enabled state of a list item.
16757     *
16758     * @param it The item.
16759     * @param disabled The disabled state.
16760     *
16761     * A disabled item cannot be selected or unselected. It will also
16762     * change its appearance (generally greyed out). This sets the
16763     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16764     * enabled).
16765     *
16766     * @ingroup List
16767     */
16768    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16769
16770    /**
16771     * Get a value whether list item is disabled or not.
16772     *
16773     * @param it The item.
16774     * @return The disabled state.
16775     *
16776     * @see elm_list_item_disabled_set() for more details.
16777     *
16778     * @ingroup List
16779     */
16780    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16781
16782    /**
16783     * Set the text to be shown in a given list item's tooltips.
16784     *
16785     * @param item Target item.
16786     * @param text The text to set in the content.
16787     *
16788     * Setup the text as tooltip to object. The item can have only one tooltip,
16789     * so any previous tooltip data - set with this function or
16790     * elm_list_item_tooltip_content_cb_set() - is removed.
16791     *
16792     * @see elm_object_tooltip_text_set() for more details.
16793     *
16794     * @ingroup List
16795     */
16796    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16797
16798
16799    /**
16800     * @brief Disable size restrictions on an object's tooltip
16801     * @param item The tooltip's anchor object
16802     * @param disable If EINA_TRUE, size restrictions are disabled
16803     * @return EINA_FALSE on failure, EINA_TRUE on success
16804     *
16805     * This function allows a tooltip to expand beyond its parant window's canvas.
16806     * It will instead be limited only by the size of the display.
16807     */
16808    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
16809    /**
16810     * @brief Retrieve size restriction state of an object's tooltip
16811     * @param obj The tooltip's anchor object
16812     * @return If EINA_TRUE, size restrictions are disabled
16813     *
16814     * This function returns whether a tooltip is allowed to expand beyond
16815     * its parant window's canvas.
16816     * It will instead be limited only by the size of the display.
16817     */
16818    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16819
16820    /**
16821     * Set the content to be shown in the tooltip item.
16822     *
16823     * Setup the tooltip to item. The item can have only one tooltip,
16824     * so any previous tooltip data is removed. @p func(with @p data) will
16825     * be called every time that need show the tooltip and it should
16826     * return a valid Evas_Object. This object is then managed fully by
16827     * tooltip system and is deleted when the tooltip is gone.
16828     *
16829     * @param item the list item being attached a tooltip.
16830     * @param func the function used to create the tooltip contents.
16831     * @param data what to provide to @a func as callback data/context.
16832     * @param del_cb called when data is not needed anymore, either when
16833     *        another callback replaces @a func, the tooltip is unset with
16834     *        elm_list_item_tooltip_unset() or the owner @a item
16835     *        dies. This callback receives as the first parameter the
16836     *        given @a data, and @c event_info is the item.
16837     *
16838     * @see elm_object_tooltip_content_cb_set() for more details.
16839     *
16840     * @ingroup List
16841     */
16842    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);
16843
16844    /**
16845     * Unset tooltip from item.
16846     *
16847     * @param item list item to remove previously set tooltip.
16848     *
16849     * Remove tooltip from item. The callback provided as del_cb to
16850     * elm_list_item_tooltip_content_cb_set() will be called to notify
16851     * it is not used anymore.
16852     *
16853     * @see elm_object_tooltip_unset() for more details.
16854     * @see elm_list_item_tooltip_content_cb_set()
16855     *
16856     * @ingroup List
16857     */
16858    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16859
16860    /**
16861     * Sets a different style for this item tooltip.
16862     *
16863     * @note before you set a style you should define a tooltip with
16864     *       elm_list_item_tooltip_content_cb_set() or
16865     *       elm_list_item_tooltip_text_set()
16866     *
16867     * @param item list item with tooltip already set.
16868     * @param style the theme style to use (default, transparent, ...)
16869     *
16870     * @see elm_object_tooltip_style_set() for more details.
16871     *
16872     * @ingroup List
16873     */
16874    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16875
16876    /**
16877     * Get the style for this item tooltip.
16878     *
16879     * @param item list item with tooltip already set.
16880     * @return style the theme style in use, defaults to "default". If the
16881     *         object does not have a tooltip set, then NULL is returned.
16882     *
16883     * @see elm_object_tooltip_style_get() for more details.
16884     * @see elm_list_item_tooltip_style_set()
16885     *
16886     * @ingroup List
16887     */
16888    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16889
16890    /**
16891     * Set the type of mouse pointer/cursor decoration to be shown,
16892     * when the mouse pointer is over the given list widget item
16893     *
16894     * @param item list item to customize cursor on
16895     * @param cursor the cursor type's name
16896     *
16897     * This function works analogously as elm_object_cursor_set(), but
16898     * here the cursor's changing area is restricted to the item's
16899     * area, and not the whole widget's. Note that that item cursors
16900     * have precedence over widget cursors, so that a mouse over an
16901     * item with custom cursor set will always show @b that cursor.
16902     *
16903     * If this function is called twice for an object, a previously set
16904     * cursor will be unset on the second call.
16905     *
16906     * @see elm_object_cursor_set()
16907     * @see elm_list_item_cursor_get()
16908     * @see elm_list_item_cursor_unset()
16909     *
16910     * @ingroup List
16911     */
16912    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
16913
16914    /*
16915     * Get the type of mouse pointer/cursor decoration set to be shown,
16916     * when the mouse pointer is over the given list widget item
16917     *
16918     * @param item list item with custom cursor set
16919     * @return the cursor type's name or @c NULL, if no custom cursors
16920     * were set to @p item (and on errors)
16921     *
16922     * @see elm_object_cursor_get()
16923     * @see elm_list_item_cursor_set()
16924     * @see elm_list_item_cursor_unset()
16925     *
16926     * @ingroup List
16927     */
16928    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16929
16930    /**
16931     * Unset any custom mouse pointer/cursor decoration set to be
16932     * shown, when the mouse pointer is over the given list widget
16933     * item, thus making it show the @b default cursor again.
16934     *
16935     * @param item a list item
16936     *
16937     * Use this call to undo any custom settings on this item's cursor
16938     * decoration, bringing it back to defaults (no custom style set).
16939     *
16940     * @see elm_object_cursor_unset()
16941     * @see elm_list_item_cursor_set()
16942     *
16943     * @ingroup List
16944     */
16945    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16946
16947    /**
16948     * Set a different @b style for a given custom cursor set for a
16949     * list item.
16950     *
16951     * @param item list item with custom cursor set
16952     * @param style the <b>theme style</b> to use (e.g. @c "default",
16953     * @c "transparent", etc)
16954     *
16955     * This function only makes sense when one is using custom mouse
16956     * cursor decorations <b>defined in a theme file</b>, which can have,
16957     * given a cursor name/type, <b>alternate styles</b> on it. It
16958     * works analogously as elm_object_cursor_style_set(), but here
16959     * applyed only to list item objects.
16960     *
16961     * @warning Before you set a cursor style you should have definen a
16962     *       custom cursor previously on the item, with
16963     *       elm_list_item_cursor_set()
16964     *
16965     * @see elm_list_item_cursor_engine_only_set()
16966     * @see elm_list_item_cursor_style_get()
16967     *
16968     * @ingroup List
16969     */
16970    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16971
16972    /**
16973     * Get the current @b style set for a given list item's custom
16974     * cursor
16975     *
16976     * @param item list item with custom cursor set.
16977     * @return style the cursor style in use. If the object does not
16978     *         have a cursor set, then @c NULL is returned.
16979     *
16980     * @see elm_list_item_cursor_style_set() for more details
16981     *
16982     * @ingroup List
16983     */
16984    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16985
16986    /**
16987     * Set if the (custom)cursor for a given list item should be
16988     * searched in its theme, also, or should only rely on the
16989     * rendering engine.
16990     *
16991     * @param item item with custom (custom) cursor already set on
16992     * @param engine_only Use @c EINA_TRUE to have cursors looked for
16993     * only on those provided by the rendering engine, @c EINA_FALSE to
16994     * have them searched on the widget's theme, as well.
16995     *
16996     * @note This call is of use only if you've set a custom cursor
16997     * for list items, with elm_list_item_cursor_set().
16998     *
16999     * @note By default, cursors will only be looked for between those
17000     * provided by the rendering engine.
17001     *
17002     * @ingroup List
17003     */
17004    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17005
17006    /**
17007     * Get if the (custom) cursor for a given list item is being
17008     * searched in its theme, also, or is only relying on the rendering
17009     * engine.
17010     *
17011     * @param item a list item
17012     * @return @c EINA_TRUE, if cursors are being looked for only on
17013     * those provided by the rendering engine, @c EINA_FALSE if they
17014     * are being searched on the widget's theme, as well.
17015     *
17016     * @see elm_list_item_cursor_engine_only_set(), for more details
17017     *
17018     * @ingroup List
17019     */
17020    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17021
17022    /**
17023     * @}
17024     */
17025
17026    /**
17027     * @defgroup Slider Slider
17028     * @ingroup Elementary
17029     *
17030     * @image html img/widget/slider/preview-00.png
17031     * @image latex img/widget/slider/preview-00.eps width=\textwidth
17032     *
17033     * The slider adds a dragable “slider” widget for selecting the value of
17034     * something within a range.
17035     *
17036     * A slider can be horizontal or vertical. It can contain an Icon and has a
17037     * primary label as well as a units label (that is formatted with floating
17038     * point values and thus accepts a printf-style format string, like
17039     * “%1.2f units”. There is also an indicator string that may be somewhere
17040     * else (like on the slider itself) that also accepts a format string like
17041     * units. Label, Icon Unit and Indicator strings/objects are optional.
17042     *
17043     * A slider may be inverted which means values invert, with high vales being
17044     * on the left or top and low values on the right or bottom (as opposed to
17045     * normally being low on the left or top and high on the bottom and right).
17046     *
17047     * The slider should have its minimum and maximum values set by the
17048     * application with  elm_slider_min_max_set() and value should also be set by
17049     * the application before use with  elm_slider_value_set(). The span of the
17050     * slider is its length (horizontally or vertically). This will be scaled by
17051     * the object or applications scaling factor. At any point code can query the
17052     * slider for its value with elm_slider_value_get().
17053     *
17054     * Smart callbacks one can listen to:
17055     * - "changed" - Whenever the slider value is changed by the user.
17056     * - "slider,drag,start" - dragging the slider indicator around has started.
17057     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17058     * - "delay,changed" - A short time after the value is changed by the user.
17059     * This will be called only when the user stops dragging for
17060     * a very short period or when they release their
17061     * finger/mouse, so it avoids possibly expensive reactions to
17062     * the value change.
17063     *
17064     * Available styles for it:
17065     * - @c "default"
17066     *
17067     * Here is an example on its usage:
17068     * @li @ref slider_example
17069     */
17070
17071    /**
17072     * @addtogroup Slider
17073     * @{
17074     */
17075
17076    /**
17077     * Add a new slider widget to the given parent Elementary
17078     * (container) object.
17079     *
17080     * @param parent The parent object.
17081     * @return a new slider widget handle or @c NULL, on errors.
17082     *
17083     * This function inserts a new slider widget on the canvas.
17084     *
17085     * @ingroup Slider
17086     */
17087    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17088
17089    /**
17090     * Set the label of a given slider widget
17091     *
17092     * @param obj The progress bar object
17093     * @param label The text label string, in UTF-8
17094     *
17095     * @ingroup Slider
17096     * @deprecated use elm_object_text_set() instead.
17097     */
17098    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17099
17100    /**
17101     * Get the label of a given slider widget
17102     *
17103     * @param obj The progressbar object
17104     * @return The text label string, in UTF-8
17105     *
17106     * @ingroup Slider
17107     * @deprecated use elm_object_text_get() instead.
17108     */
17109    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17110
17111    /**
17112     * Set the icon object of the slider object.
17113     *
17114     * @param obj The slider object.
17115     * @param icon The icon object.
17116     *
17117     * On horizontal mode, icon is placed at left, and on vertical mode,
17118     * placed at top.
17119     *
17120     * @note Once the icon object is set, a previously set one will be deleted.
17121     * If you want to keep that old content object, use the
17122     * elm_slider_icon_unset() function.
17123     *
17124     * @warning If the object being set does not have minimum size hints set,
17125     * it won't get properly displayed.
17126     *
17127     * @ingroup Slider
17128     */
17129    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17130
17131    /**
17132     * Unset an icon set on a given slider widget.
17133     *
17134     * @param obj The slider object.
17135     * @return The icon object that was being used, if any was set, or
17136     * @c NULL, otherwise (and on errors).
17137     *
17138     * On horizontal mode, icon is placed at left, and on vertical mode,
17139     * placed at top.
17140     *
17141     * This call will unparent and return the icon object which was set
17142     * for this widget, previously, on success.
17143     *
17144     * @see elm_slider_icon_set() for more details
17145     * @see elm_slider_icon_get()
17146     *
17147     * @ingroup Slider
17148     */
17149    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17150
17151    /**
17152     * Retrieve the icon object set for a given slider widget.
17153     *
17154     * @param obj The slider object.
17155     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17156     * otherwise (and on errors).
17157     *
17158     * On horizontal mode, icon is placed at left, and on vertical mode,
17159     * placed at top.
17160     *
17161     * @see elm_slider_icon_set() for more details
17162     * @see elm_slider_icon_unset()
17163     *
17164     * @ingroup Slider
17165     */
17166    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17167
17168    /**
17169     * Set the end object of the slider object.
17170     *
17171     * @param obj The slider object.
17172     * @param end The end object.
17173     *
17174     * On horizontal mode, end is placed at left, and on vertical mode,
17175     * placed at bottom.
17176     *
17177     * @note Once the icon object is set, a previously set one will be deleted.
17178     * If you want to keep that old content object, use the
17179     * elm_slider_end_unset() function.
17180     *
17181     * @warning If the object being set does not have minimum size hints set,
17182     * it won't get properly displayed.
17183     *
17184     * @ingroup Slider
17185     */
17186    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17187
17188    /**
17189     * Unset an end object set on a given slider widget.
17190     *
17191     * @param obj The slider object.
17192     * @return The end object that was being used, if any was set, or
17193     * @c NULL, otherwise (and on errors).
17194     *
17195     * On horizontal mode, end is placed at left, and on vertical mode,
17196     * placed at bottom.
17197     *
17198     * This call will unparent and return the icon object which was set
17199     * for this widget, previously, on success.
17200     *
17201     * @see elm_slider_end_set() for more details.
17202     * @see elm_slider_end_get()
17203     *
17204     * @ingroup Slider
17205     */
17206    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17207
17208    /**
17209     * Retrieve the end object set for a given slider widget.
17210     *
17211     * @param obj The slider object.
17212     * @return The end object's handle, if @p obj had one set, or @c NULL,
17213     * otherwise (and on errors).
17214     *
17215     * On horizontal mode, icon is placed at right, and on vertical mode,
17216     * placed at bottom.
17217     *
17218     * @see elm_slider_end_set() for more details.
17219     * @see elm_slider_end_unset()
17220     *
17221     * @ingroup Slider
17222     */
17223    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17224
17225    /**
17226     * Set the (exact) length of the bar region of a given slider widget.
17227     *
17228     * @param obj The slider object.
17229     * @param size The length of the slider's bar region.
17230     *
17231     * This sets the minimum width (when in horizontal mode) or height
17232     * (when in vertical mode) of the actual bar area of the slider
17233     * @p obj. This in turn affects the object's minimum size. Use
17234     * this when you're not setting other size hints expanding on the
17235     * given direction (like weight and alignment hints) and you would
17236     * like it to have a specific size.
17237     *
17238     * @note Icon, end, label, indicator and unit text around @p obj
17239     * will require their
17240     * own space, which will make @p obj to require more the @p size,
17241     * actually.
17242     *
17243     * @see elm_slider_span_size_get()
17244     *
17245     * @ingroup Slider
17246     */
17247    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17248
17249    /**
17250     * Get the length set for the bar region of a given slider widget
17251     *
17252     * @param obj The slider object.
17253     * @return The length of the slider's bar region.
17254     *
17255     * If that size was not set previously, with
17256     * elm_slider_span_size_set(), this call will return @c 0.
17257     *
17258     * @ingroup Slider
17259     */
17260    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17261
17262    /**
17263     * Set the format string for the unit label.
17264     *
17265     * @param obj The slider object.
17266     * @param format The format string for the unit display.
17267     *
17268     * Unit label is displayed all the time, if set, after slider's bar.
17269     * In horizontal mode, at right and in vertical mode, at bottom.
17270     *
17271     * If @c NULL, unit label won't be visible. If not it sets the format
17272     * string for the label text. To the label text is provided a floating point
17273     * value, so the label text can display up to 1 floating point value.
17274     * Note that this is optional.
17275     *
17276     * Use a format string such as "%1.2f meters" for example, and it will
17277     * display values like: "3.14 meters" for a value equal to 3.14159.
17278     *
17279     * Default is unit label disabled.
17280     *
17281     * @see elm_slider_indicator_format_get()
17282     *
17283     * @ingroup Slider
17284     */
17285    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17286
17287    /**
17288     * Get the unit label format of the slider.
17289     *
17290     * @param obj The slider object.
17291     * @return The unit label format string in UTF-8.
17292     *
17293     * Unit label is displayed all the time, if set, after slider's bar.
17294     * In horizontal mode, at right and in vertical mode, at bottom.
17295     *
17296     * @see elm_slider_unit_format_set() for more
17297     * information on how this works.
17298     *
17299     * @ingroup Slider
17300     */
17301    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17302
17303    /**
17304     * Set the format string for the indicator label.
17305     *
17306     * @param obj The slider object.
17307     * @param indicator The format string for the indicator display.
17308     *
17309     * The slider may display its value somewhere else then unit label,
17310     * for example, above the slider knob that is dragged around. This function
17311     * sets the format string used for this.
17312     *
17313     * If @c NULL, indicator label won't be visible. If not it sets the format
17314     * string for the label text. To the label text is provided a floating point
17315     * value, so the label text can display up to 1 floating point value.
17316     * Note that this is optional.
17317     *
17318     * Use a format string such as "%1.2f meters" for example, and it will
17319     * display values like: "3.14 meters" for a value equal to 3.14159.
17320     *
17321     * Default is indicator label disabled.
17322     *
17323     * @see elm_slider_indicator_format_get()
17324     *
17325     * @ingroup Slider
17326     */
17327    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17328
17329    /**
17330     * Get the indicator label format of the slider.
17331     *
17332     * @param obj The slider object.
17333     * @return The indicator label format string in UTF-8.
17334     *
17335     * The slider may display its value somewhere else then unit label,
17336     * for example, above the slider knob that is dragged around. This function
17337     * gets the format string used for this.
17338     *
17339     * @see elm_slider_indicator_format_set() for more
17340     * information on how this works.
17341     *
17342     * @ingroup Slider
17343     */
17344    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17345
17346    /**
17347     * Set the format function pointer for the indicator label
17348     *
17349     * @param obj The slider object.
17350     * @param func The indicator format function.
17351     * @param free_func The freeing function for the format string.
17352     *
17353     * Set the callback function to format the indicator string.
17354     *
17355     * @see elm_slider_indicator_format_set() for more info on how this works.
17356     *
17357     * @ingroup Slider
17358     */
17359   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);
17360
17361   /**
17362    * Set the format function pointer for the units label
17363    *
17364    * @param obj The slider object.
17365    * @param func The units format function.
17366    * @param free_func The freeing function for the format string.
17367    *
17368    * Set the callback function to format the indicator string.
17369    *
17370    * @see elm_slider_units_format_set() for more info on how this works.
17371    *
17372    * @ingroup Slider
17373    */
17374   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);
17375
17376   /**
17377    * Set the orientation of a given slider widget.
17378    *
17379    * @param obj The slider object.
17380    * @param horizontal Use @c EINA_TRUE to make @p obj to be
17381    * @b horizontal, @c EINA_FALSE to make it @b vertical.
17382    *
17383    * Use this function to change how your slider is to be
17384    * disposed: vertically or horizontally.
17385    *
17386    * By default it's displayed horizontally.
17387    *
17388    * @see elm_slider_horizontal_get()
17389    *
17390    * @ingroup Slider
17391    */
17392    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17393
17394    /**
17395     * Retrieve the orientation of a given slider widget
17396     *
17397     * @param obj The slider object.
17398     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17399     * @c EINA_FALSE if it's @b vertical (and on errors).
17400     *
17401     * @see elm_slider_horizontal_set() for more details.
17402     *
17403     * @ingroup Slider
17404     */
17405    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17406
17407    /**
17408     * Set the minimum and maximum values for the slider.
17409     *
17410     * @param obj The slider object.
17411     * @param min The minimum value.
17412     * @param max The maximum value.
17413     *
17414     * Define the allowed range of values to be selected by the user.
17415     *
17416     * If actual value is less than @p min, it will be updated to @p min. If it
17417     * is bigger then @p max, will be updated to @p max. Actual value can be
17418     * get with elm_slider_value_get().
17419     *
17420     * By default, min is equal to 0.0, and max is equal to 1.0.
17421     *
17422     * @warning Maximum must be greater than minimum, otherwise behavior
17423     * is undefined.
17424     *
17425     * @see elm_slider_min_max_get()
17426     *
17427     * @ingroup Slider
17428     */
17429    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17430
17431    /**
17432     * Get the minimum and maximum values of the slider.
17433     *
17434     * @param obj The slider object.
17435     * @param min Pointer where to store the minimum value.
17436     * @param max Pointer where to store the maximum value.
17437     *
17438     * @note If only one value is needed, the other pointer can be passed
17439     * as @c NULL.
17440     *
17441     * @see elm_slider_min_max_set() for details.
17442     *
17443     * @ingroup Slider
17444     */
17445    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17446
17447    /**
17448     * Set the value the slider displays.
17449     *
17450     * @param obj The slider object.
17451     * @param val The value to be displayed.
17452     *
17453     * Value will be presented on the unit label following format specified with
17454     * elm_slider_unit_format_set() and on indicator with
17455     * elm_slider_indicator_format_set().
17456     *
17457     * @warning The value must to be between min and max values. This values
17458     * are set by elm_slider_min_max_set().
17459     *
17460     * @see elm_slider_value_get()
17461     * @see elm_slider_unit_format_set()
17462     * @see elm_slider_indicator_format_set()
17463     * @see elm_slider_min_max_set()
17464     *
17465     * @ingroup Slider
17466     */
17467    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17468
17469    /**
17470     * Get the value displayed by the spinner.
17471     *
17472     * @param obj The spinner object.
17473     * @return The value displayed.
17474     *
17475     * @see elm_spinner_value_set() for details.
17476     *
17477     * @ingroup Slider
17478     */
17479    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17480
17481    /**
17482     * Invert a given slider widget's displaying values order
17483     *
17484     * @param obj The slider object.
17485     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17486     * @c EINA_FALSE to bring it back to default, non-inverted values.
17487     *
17488     * A slider may be @b inverted, in which state it gets its
17489     * values inverted, with high vales being on the left or top and
17490     * low values on the right or bottom, as opposed to normally have
17491     * the low values on the former and high values on the latter,
17492     * respectively, for horizontal and vertical modes.
17493     *
17494     * @see elm_slider_inverted_get()
17495     *
17496     * @ingroup Slider
17497     */
17498    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17499
17500    /**
17501     * Get whether a given slider widget's displaying values are
17502     * inverted or not.
17503     *
17504     * @param obj The slider object.
17505     * @return @c EINA_TRUE, if @p obj has inverted values,
17506     * @c EINA_FALSE otherwise (and on errors).
17507     *
17508     * @see elm_slider_inverted_set() for more details.
17509     *
17510     * @ingroup Slider
17511     */
17512    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17513
17514    /**
17515     * Set whether to enlarge slider indicator (augmented knob) or not.
17516     *
17517     * @param obj The slider object.
17518     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17519     * let the knob always at default size.
17520     *
17521     * By default, indicator will be bigger while dragged by the user.
17522     *
17523     * @warning It won't display values set with
17524     * elm_slider_indicator_format_set() if you disable indicator.
17525     *
17526     * @ingroup Slider
17527     */
17528    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17529
17530    /**
17531     * Get whether a given slider widget's enlarging indicator or not.
17532     *
17533     * @param obj The slider object.
17534     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17535     * @c EINA_FALSE otherwise (and on errors).
17536     *
17537     * @see elm_slider_indicator_show_set() for details.
17538     *
17539     * @ingroup Slider
17540     */
17541    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17542
17543    /**
17544     * @}
17545     */
17546
17547    /**
17548     * @addtogroup Actionslider Actionslider
17549     *
17550     * @image html img/widget/actionslider/preview-00.png
17551     * @image latex img/widget/actionslider/preview-00.eps
17552     *
17553     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
17554     * properties. The indicator is the element the user drags to choose a label.
17555     * When the position is set with magnet, when released the indicator will be
17556     * moved to it if it's nearest the magnetized position.
17557     *
17558     * @note By default all positions are set as enabled.
17559     *
17560     * Signals that you can add callbacks for are:
17561     *
17562     * "selected" - when user selects an enabled position (the label is passed
17563     *              as event info)".
17564     * @n
17565     * "pos_changed" - when the indicator reaches any of the positions("left",
17566     *                 "right" or "center").
17567     *
17568     * See an example of actionslider usage @ref actionslider_example_page "here"
17569     * @{
17570     */
17571    typedef enum _Elm_Actionslider_Pos
17572      {
17573         ELM_ACTIONSLIDER_NONE = 0,
17574         ELM_ACTIONSLIDER_LEFT = 1 << 0,
17575         ELM_ACTIONSLIDER_CENTER = 1 << 1,
17576         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17577         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17578      } Elm_Actionslider_Pos;
17579
17580    /**
17581     * Add a new actionslider to the parent.
17582     *
17583     * @param parent The parent object
17584     * @return The new actionslider object or NULL if it cannot be created
17585     */
17586    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17587    /**
17588     * Set actionslider labels.
17589     *
17590     * @param obj The actionslider object
17591     * @param left_label The label to be set on the left.
17592     * @param center_label The label to be set on the center.
17593     * @param right_label The label to be set on the right.
17594     * @deprecated use elm_object_text_set() instead.
17595     */
17596    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);
17597    /**
17598     * Get actionslider labels.
17599     *
17600     * @param obj The actionslider object
17601     * @param left_label A char** to place the left_label of @p obj into.
17602     * @param center_label A char** to place the center_label of @p obj into.
17603     * @param right_label A char** to place the right_label of @p obj into.
17604     * @deprecated use elm_object_text_set() instead.
17605     */
17606    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);
17607    /**
17608     * Get actionslider selected label.
17609     *
17610     * @param obj The actionslider object
17611     * @return The selected label
17612     */
17613    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17614    /**
17615     * Set actionslider indicator position.
17616     *
17617     * @param obj The actionslider object.
17618     * @param pos The position of the indicator.
17619     */
17620    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17621    /**
17622     * Get actionslider indicator position.
17623     *
17624     * @param obj The actionslider object.
17625     * @return The position of the indicator.
17626     */
17627    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17628    /**
17629     * Set actionslider magnet position. To make multiple positions magnets @c or
17630     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
17631     *
17632     * @param obj The actionslider object.
17633     * @param pos Bit mask indicating the magnet positions.
17634     */
17635    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17636    /**
17637     * Get actionslider magnet position.
17638     *
17639     * @param obj The actionslider object.
17640     * @return The positions with magnet property.
17641     */
17642    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17643    /**
17644     * Set actionslider enabled position. To set multiple positions as enabled @c or
17645     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
17646     *
17647     * @note All the positions are enabled by default.
17648     *
17649     * @param obj The actionslider object.
17650     * @param pos Bit mask indicating the enabled positions.
17651     */
17652    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17653    /**
17654     * Get actionslider enabled position.
17655     *
17656     * @param obj The actionslider object.
17657     * @return The enabled positions.
17658     */
17659    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17660    /**
17661     * Set the label used on the indicator.
17662     *
17663     * @param obj The actionslider object
17664     * @param label The label to be set on the indicator.
17665     * @deprecated use elm_object_text_set() instead.
17666     */
17667    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17668    /**
17669     * Get the label used on the indicator object.
17670     *
17671     * @param obj The actionslider object
17672     * @return The indicator label
17673     * @deprecated use elm_object_text_get() instead.
17674     */
17675    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17676    /**
17677     * @}
17678     */
17679
17680    /**
17681     * @defgroup Genlist Genlist
17682     *
17683     * @image html img/widget/genlist/preview-00.png
17684     * @image latex img/widget/genlist/preview-00.eps
17685     * @image html img/genlist.png
17686     * @image latex img/genlist.eps
17687     *
17688     * This widget aims to have more expansive list than the simple list in
17689     * Elementary that could have more flexible items and allow many more entries
17690     * while still being fast and low on memory usage. At the same time it was
17691     * also made to be able to do tree structures. But the price to pay is more
17692     * complexity when it comes to usage. If all you want is a simple list with
17693     * icons and a single label, use the normal @ref List object.
17694     *
17695     * Genlist has a fairly large API, mostly because it's relatively complex,
17696     * trying to be both expansive, powerful and efficient. First we will begin
17697     * an overview on the theory behind genlist.
17698     *
17699     * @section Genlist_Item_Class Genlist item classes - creating items
17700     *
17701     * In order to have the ability to add and delete items on the fly, genlist
17702     * implements a class (callback) system where the application provides a
17703     * structure with information about that type of item (genlist may contain
17704     * multiple different items with different classes, states and styles).
17705     * Genlist will call the functions in this struct (methods) when an item is
17706     * "realized" (i.e., created dynamically, while the user is scrolling the
17707     * grid). All objects will simply be deleted when no longer needed with
17708     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17709     * following members:
17710     * - @c item_style - This is a constant string and simply defines the name
17711     *   of the item style. It @b must be specified and the default should be @c
17712     *   "default".
17713     * - @c mode_item_style - This is a constant string and simply defines the
17714     *   name of the style that will be used for mode animations. It can be left
17715     *   as @c NULL if you don't plan to use Genlist mode. See
17716     *   elm_genlist_item_mode_set() for more info.
17717     *
17718     * - @c func - A struct with pointers to functions that will be called when
17719     *   an item is going to be actually created. All of them receive a @c data
17720     *   parameter that will point to the same data passed to
17721     *   elm_genlist_item_append() and related item creation functions, and a @c
17722     *   obj parameter that points to the genlist object itself.
17723     *
17724     * The function pointers inside @c func are @c label_get, @c icon_get, @c
17725     * state_get and @c del. The 3 first functions also receive a @c part
17726     * parameter described below. A brief description of these functions follows:
17727     *
17728     * - @c label_get - The @c part parameter is the name string of one of the
17729     *   existing text parts in the Edje group implementing the item's theme.
17730     *   This function @b must return a strdup'()ed string, as the caller will
17731     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17732     * - @c icon_get - The @c part parameter is the name string of one of the
17733     *   existing (icon) swallow parts in the Edje group implementing the item's
17734     *   theme. It must return @c NULL, when no icon is desired, or a valid
17735     *   object handle, otherwise.  The object will be deleted by the genlist on
17736     *   its deletion or when the item is "unrealized".  See
17737     *   #Elm_Genlist_Item_Icon_Get_Cb.
17738     * - @c func.state_get - The @c part parameter is the name string of one of
17739     *   the state parts in the Edje group implementing the item's theme. Return
17740     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17741     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17742     *   and @c "elm" as "emission" and "source" arguments, respectively, when
17743     *   the state is true (the default is false), where @c XXX is the name of
17744     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
17745     * - @c func.del - This is intended for use when genlist items are deleted,
17746     *   so any data attached to the item (e.g. its data parameter on creation)
17747     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
17748     *
17749     * available item styles:
17750     * - default
17751     * - default_style - The text part is a textblock
17752     *
17753     * @image html img/widget/genlist/preview-04.png
17754     * @image latex img/widget/genlist/preview-04.eps
17755     *
17756     * - double_label
17757     *
17758     * @image html img/widget/genlist/preview-01.png
17759     * @image latex img/widget/genlist/preview-01.eps
17760     *
17761     * - icon_top_text_bottom
17762     *
17763     * @image html img/widget/genlist/preview-02.png
17764     * @image latex img/widget/genlist/preview-02.eps
17765     *
17766     * - group_index
17767     *
17768     * @image html img/widget/genlist/preview-03.png
17769     * @image latex img/widget/genlist/preview-03.eps
17770     *
17771     * @section Genlist_Items Structure of items
17772     *
17773     * An item in a genlist can have 0 or more text labels (they can be regular
17774     * text or textblock Evas objects - that's up to the style to determine), 0
17775     * or more icons (which are simply objects swallowed into the genlist item's
17776     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
17777     * behavior left to the user to define. The Edje part names for each of
17778     * these properties will be looked up, in the theme file for the genlist,
17779     * under the Edje (string) data items named @c "labels", @c "icons" and @c
17780     * "states", respectively. For each of those properties, if more than one
17781     * part is provided, they must have names listed separated by spaces in the
17782     * data fields. For the default genlist item theme, we have @b one label
17783     * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
17784     * "elm.swallow.end") and @b no state parts.
17785     *
17786     * A genlist item may be at one of several styles. Elementary provides one
17787     * by default - "default", but this can be extended by system or application
17788     * custom themes/overlays/extensions (see @ref Theme "themes" for more
17789     * details).
17790     *
17791     * @section Genlist_Manipulation Editing and Navigating
17792     *
17793     * Items can be added by several calls. All of them return a @ref
17794     * Elm_Genlist_Item handle that is an internal member inside the genlist.
17795     * They all take a data parameter that is meant to be used for a handle to
17796     * the applications internal data (eg the struct with the original item
17797     * data). The parent parameter is the parent genlist item this belongs to if
17798     * it is a tree or an indexed group, and NULL if there is no parent. The
17799     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
17800     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
17801     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
17802     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
17803     * is set then this item is group index item that is displayed at the top
17804     * until the next group comes. The func parameter is a convenience callback
17805     * that is called when the item is selected and the data parameter will be
17806     * the func_data parameter, obj be the genlist object and event_info will be
17807     * the genlist item.
17808     *
17809     * elm_genlist_item_append() adds an item to the end of the list, or if
17810     * there is a parent, to the end of all the child items of the parent.
17811     * elm_genlist_item_prepend() is the same but adds to the beginning of
17812     * the list or children list. elm_genlist_item_insert_before() inserts at
17813     * item before another item and elm_genlist_item_insert_after() inserts after
17814     * the indicated item.
17815     *
17816     * The application can clear the list with elm_genlist_clear() which deletes
17817     * all the items in the list and elm_genlist_item_del() will delete a specific
17818     * item. elm_genlist_item_subitems_clear() will clear all items that are
17819     * children of the indicated parent item.
17820     *
17821     * To help inspect list items you can jump to the item at the top of the list
17822     * with elm_genlist_first_item_get() which will return the item pointer, and
17823     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
17824     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
17825     * and previous items respectively relative to the indicated item. Using
17826     * these calls you can walk the entire item list/tree. Note that as a tree
17827     * the items are flattened in the list, so elm_genlist_item_parent_get() will
17828     * let you know which item is the parent (and thus know how to skip them if
17829     * wanted).
17830     *
17831     * @section Genlist_Muti_Selection Multi-selection
17832     *
17833     * If the application wants multiple items to be able to be selected,
17834     * elm_genlist_multi_select_set() can enable this. If the list is
17835     * single-selection only (the default), then elm_genlist_selected_item_get()
17836     * will return the selected item, if any, or NULL I none is selected. If the
17837     * list is multi-select then elm_genlist_selected_items_get() will return a
17838     * list (that is only valid as long as no items are modified (added, deleted,
17839     * selected or unselected)).
17840     *
17841     * @section Genlist_Usage_Hints Usage hints
17842     *
17843     * There are also convenience functions. elm_genlist_item_genlist_get() will
17844     * return the genlist object the item belongs to. elm_genlist_item_show()
17845     * will make the scroller scroll to show that specific item so its visible.
17846     * elm_genlist_item_data_get() returns the data pointer set by the item
17847     * creation functions.
17848     *
17849     * If an item changes (state of boolean changes, label or icons change),
17850     * then use elm_genlist_item_update() to have genlist update the item with
17851     * the new state. Genlist will re-realize the item thus call the functions
17852     * in the _Elm_Genlist_Item_Class for that item.
17853     *
17854     * To programmatically (un)select an item use elm_genlist_item_selected_set().
17855     * To get its selected state use elm_genlist_item_selected_get(). Similarly
17856     * to expand/contract an item and get its expanded state, use
17857     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
17858     * again to make an item disabled (unable to be selected and appear
17859     * differently) use elm_genlist_item_disabled_set() to set this and
17860     * elm_genlist_item_disabled_get() to get the disabled state.
17861     *
17862     * In general to indicate how the genlist should expand items horizontally to
17863     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
17864     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
17865     * mode means that if items are too wide to fit, the scroller will scroll
17866     * horizontally. Otherwise items are expanded to fill the width of the
17867     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
17868     * to the viewport width and limited to that size. This can be combined with
17869     * a different style that uses edjes' ellipsis feature (cutting text off like
17870     * this: "tex...").
17871     *
17872     * Items will only call their selection func and callback when first becoming
17873     * selected. Any further clicks will do nothing, unless you enable always
17874     * select with elm_genlist_always_select_mode_set(). This means even if
17875     * selected, every click will make the selected callbacks be called.
17876     * elm_genlist_no_select_mode_set() will turn off the ability to select
17877     * items entirely and they will neither appear selected nor call selected
17878     * callback functions.
17879     *
17880     * Remember that you can create new styles and add your own theme augmentation
17881     * per application with elm_theme_extension_add(). If you absolutely must
17882     * have a specific style that overrides any theme the user or system sets up
17883     * you can use elm_theme_overlay_add() to add such a file.
17884     *
17885     * @section Genlist_Implementation Implementation
17886     *
17887     * Evas tracks every object you create. Every time it processes an event
17888     * (mouse move, down, up etc.) it needs to walk through objects and find out
17889     * what event that affects. Even worse every time it renders display updates,
17890     * in order to just calculate what to re-draw, it needs to walk through many
17891     * many many objects. Thus, the more objects you keep active, the more
17892     * overhead Evas has in just doing its work. It is advisable to keep your
17893     * active objects to the minimum working set you need. Also remember that
17894     * object creation and deletion carries an overhead, so there is a
17895     * middle-ground, which is not easily determined. But don't keep massive lists
17896     * of objects you can't see or use. Genlist does this with list objects. It
17897     * creates and destroys them dynamically as you scroll around. It groups them
17898     * into blocks so it can determine the visibility etc. of a whole block at
17899     * once as opposed to having to walk the whole list. This 2-level list allows
17900     * for very large numbers of items to be in the list (tests have used up to
17901     * 2,000,000 items). Also genlist employs a queue for adding items. As items
17902     * may be different sizes, every item added needs to be calculated as to its
17903     * size and thus this presents a lot of overhead on populating the list, this
17904     * genlist employs a queue. Any item added is queued and spooled off over
17905     * time, actually appearing some time later, so if your list has many members
17906     * you may find it takes a while for them to all appear, with your process
17907     * consuming a lot of CPU while it is busy spooling.
17908     *
17909     * Genlist also implements a tree structure, but it does so with callbacks to
17910     * the application, with the application filling in tree structures when
17911     * requested (allowing for efficient building of a very deep tree that could
17912     * even be used for file-management). See the above smart signal callbacks for
17913     * details.
17914     *
17915     * @section Genlist_Smart_Events Genlist smart events
17916     *
17917     * Signals that you can add callbacks for are:
17918     * - @c "activated" - The user has double-clicked or pressed
17919     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
17920     *   item that was activated.
17921     * - @c "clicked,double" - The user has double-clicked an item.  The @c
17922     *   event_info parameter is the item that was double-clicked.
17923     * - @c "selected" - This is called when a user has made an item selected.
17924     *   The event_info parameter is the genlist item that was selected.
17925     * - @c "unselected" - This is called when a user has made an item
17926     *   unselected. The event_info parameter is the genlist item that was
17927     *   unselected.
17928     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
17929     *   called and the item is now meant to be expanded. The event_info
17930     *   parameter is the genlist item that was indicated to expand.  It is the
17931     *   job of this callback to then fill in the child items.
17932     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
17933     *   called and the item is now meant to be contracted. The event_info
17934     *   parameter is the genlist item that was indicated to contract. It is the
17935     *   job of this callback to then delete the child items.
17936     * - @c "expand,request" - This is called when a user has indicated they want
17937     *   to expand a tree branch item. The callback should decide if the item can
17938     *   expand (has any children) and then call elm_genlist_item_expanded_set()
17939     *   appropriately to set the state. The event_info parameter is the genlist
17940     *   item that was indicated to expand.
17941     * - @c "contract,request" - This is called when a user has indicated they
17942     *   want to contract a tree branch item. The callback should decide if the
17943     *   item can contract (has any children) and then call
17944     *   elm_genlist_item_expanded_set() appropriately to set the state. The
17945     *   event_info parameter is the genlist item that was indicated to contract.
17946     * - @c "realized" - This is called when the item in the list is created as a
17947     *   real evas object. event_info parameter is the genlist item that was
17948     *   created. The object may be deleted at any time, so it is up to the
17949     *   caller to not use the object pointer from elm_genlist_item_object_get()
17950     *   in a way where it may point to freed objects.
17951     * - @c "unrealized" - This is called just before an item is unrealized.
17952     *   After this call icon objects provided will be deleted and the item
17953     *   object itself delete or be put into a floating cache.
17954     * - @c "drag,start,up" - This is called when the item in the list has been
17955     *   dragged (not scrolled) up.
17956     * - @c "drag,start,down" - This is called when the item in the list has been
17957     *   dragged (not scrolled) down.
17958     * - @c "drag,start,left" - This is called when the item in the list has been
17959     *   dragged (not scrolled) left.
17960     * - @c "drag,start,right" - This is called when the item in the list has
17961     *   been dragged (not scrolled) right.
17962     * - @c "drag,stop" - This is called when the item in the list has stopped
17963     *   being dragged.
17964     * - @c "drag" - This is called when the item in the list is being dragged.
17965     * - @c "longpressed" - This is called when the item is pressed for a certain
17966     *   amount of time. By default it's 1 second.
17967     * - @c "scroll,anim,start" - This is called when scrolling animation has
17968     *   started.
17969     * - @c "scroll,anim,stop" - This is called when scrolling animation has
17970     *   stopped.
17971     * - @c "scroll,drag,start" - This is called when dragging the content has
17972     *   started.
17973     * - @c "scroll,drag,stop" - This is called when dragging the content has
17974     *   stopped.
17975     * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
17976     *   the top edge.
17977     * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
17978     *   until the bottom edge.
17979     * - @c "scroll,edge,left" - This is called when the genlist is scrolled
17980     *   until the left edge.
17981     * - @c "scroll,edge,right" - This is called when the genlist is scrolled
17982     *   until the right edge.
17983     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
17984     *   swiped left.
17985     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
17986     *   swiped right.
17987     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
17988     *   swiped up.
17989     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
17990     *   swiped down.
17991     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
17992     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
17993     *   multi-touch pinched in.
17994     * - @c "swipe" - This is called when the genlist is swiped.
17995     *
17996     * @section Genlist_Examples Examples
17997     *
17998     * Here is a list of examples that use the genlist, trying to show some of
17999     * its capabilities:
18000     * - @ref genlist_example_01
18001     * - @ref genlist_example_02
18002     * - @ref genlist_example_03
18003     * - @ref genlist_example_04
18004     * - @ref genlist_example_05
18005     */
18006
18007    /**
18008     * @addtogroup Genlist
18009     * @{
18010     */
18011
18012    /**
18013     * @enum _Elm_Genlist_Item_Flags
18014     * @typedef Elm_Genlist_Item_Flags
18015     *
18016     * Defines if the item is of any special type (has subitems or it's the
18017     * index of a group), or is just a simple item.
18018     *
18019     * @ingroup Genlist
18020     */
18021    typedef enum _Elm_Genlist_Item_Flags
18022      {
18023         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18024         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18025         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18026      } Elm_Genlist_Item_Flags;
18027    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
18028    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18029    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18030    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
18031    typedef Evas_Object *(*Elm_Genlist_Item_Icon_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
18032    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. */
18033    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
18034    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
18035
18036    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
18037    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
18038    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
18039    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
18040
18041    /**
18042     * @struct _Elm_Genlist_Item_Class
18043     *
18044     * Genlist item class definition structs.
18045     *
18046     * This struct contains the style and fetching functions that will define the
18047     * contents of each item.
18048     *
18049     * @see @ref Genlist_Item_Class
18050     */
18051    struct _Elm_Genlist_Item_Class
18052      {
18053         const char                *item_style; /**< style of this class. */
18054         struct
18055           {
18056              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
18057              Elm_Genlist_Item_Icon_Get_Cb   icon_get; /**< Icon fetching class function for genlist item classes. */
18058              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
18059              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
18060              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
18061           } func;
18062         const char                *mode_item_style;
18063      };
18064
18065    /**
18066     * Add a new genlist widget to the given parent Elementary
18067     * (container) object
18068     *
18069     * @param parent The parent object
18070     * @return a new genlist widget handle or @c NULL, on errors
18071     *
18072     * This function inserts a new genlist widget on the canvas.
18073     *
18074     * @see elm_genlist_item_append()
18075     * @see elm_genlist_item_del()
18076     * @see elm_genlist_clear()
18077     *
18078     * @ingroup Genlist
18079     */
18080    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18081    /**
18082     * Remove all items from a given genlist widget.
18083     *
18084     * @param obj The genlist object
18085     *
18086     * This removes (and deletes) all items in @p obj, leaving it empty.
18087     *
18088     * @see elm_genlist_item_del(), to remove just one item.
18089     *
18090     * @ingroup Genlist
18091     */
18092    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18093    /**
18094     * Enable or disable multi-selection in the genlist
18095     *
18096     * @param obj The genlist object
18097     * @param multi Multi-select enable/disable. Default is disabled.
18098     *
18099     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18100     * the list. This allows more than 1 item to be selected. To retrieve the list
18101     * of selected items, use elm_genlist_selected_items_get().
18102     *
18103     * @see elm_genlist_selected_items_get()
18104     * @see elm_genlist_multi_select_get()
18105     *
18106     * @ingroup Genlist
18107     */
18108    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18109    /**
18110     * Gets if multi-selection in genlist is enabled or disabled.
18111     *
18112     * @param obj The genlist object
18113     * @return Multi-select enabled/disabled
18114     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18115     *
18116     * @see elm_genlist_multi_select_set()
18117     *
18118     * @ingroup Genlist
18119     */
18120    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18121    /**
18122     * This sets the horizontal stretching mode.
18123     *
18124     * @param obj The genlist object
18125     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18126     *
18127     * This sets the mode used for sizing items horizontally. Valid modes
18128     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18129     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18130     * the scroller will scroll horizontally. Otherwise items are expanded
18131     * to fill the width of the viewport of the scroller. If it is
18132     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18133     * limited to that size.
18134     *
18135     * @see elm_genlist_horizontal_get()
18136     *
18137     * @ingroup Genlist
18138     */
18139    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18140    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18141    /**
18142     * Gets the horizontal stretching mode.
18143     *
18144     * @param obj The genlist object
18145     * @return The mode to use
18146     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18147     *
18148     * @see elm_genlist_horizontal_set()
18149     *
18150     * @ingroup Genlist
18151     */
18152    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18153    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18154    /**
18155     * Set the always select mode.
18156     *
18157     * @param obj The genlist object
18158     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18159     * EINA_FALSE = off). Default is @c EINA_FALSE.
18160     *
18161     * Items will only call their selection func and callback when first
18162     * becoming selected. Any further clicks will do nothing, unless you
18163     * enable always select with elm_genlist_always_select_mode_set().
18164     * This means that, even if selected, every click will make the selected
18165     * callbacks be called.
18166     *
18167     * @see elm_genlist_always_select_mode_get()
18168     *
18169     * @ingroup Genlist
18170     */
18171    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18172    /**
18173     * Get the always select mode.
18174     *
18175     * @param obj The genlist object
18176     * @return The always select mode
18177     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18178     *
18179     * @see elm_genlist_always_select_mode_set()
18180     *
18181     * @ingroup Genlist
18182     */
18183    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18184    /**
18185     * Enable/disable the no select mode.
18186     *
18187     * @param obj The genlist object
18188     * @param no_select The no select mode
18189     * (EINA_TRUE = on, EINA_FALSE = off)
18190     *
18191     * This will turn off the ability to select items entirely and they
18192     * will neither appear selected nor call selected callback functions.
18193     *
18194     * @see elm_genlist_no_select_mode_get()
18195     *
18196     * @ingroup Genlist
18197     */
18198    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18199    /**
18200     * Gets whether the no select mode is enabled.
18201     *
18202     * @param obj The genlist object
18203     * @return The no select mode
18204     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18205     *
18206     * @see elm_genlist_no_select_mode_set()
18207     *
18208     * @ingroup Genlist
18209     */
18210    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18211    /**
18212     * Enable/disable compress mode.
18213     *
18214     * @param obj The genlist object
18215     * @param compress The compress mode
18216     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18217     *
18218     * This will enable the compress mode where items are "compressed"
18219     * horizontally to fit the genlist scrollable viewport width. This is
18220     * special for genlist.  Do not rely on
18221     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18222     * work as genlist needs to handle it specially.
18223     *
18224     * @see elm_genlist_compress_mode_get()
18225     *
18226     * @ingroup Genlist
18227     */
18228    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18229    /**
18230     * Get whether the compress mode is enabled.
18231     *
18232     * @param obj The genlist object
18233     * @return The compress mode
18234     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18235     *
18236     * @see elm_genlist_compress_mode_set()
18237     *
18238     * @ingroup Genlist
18239     */
18240    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18241    /**
18242     * Enable/disable height-for-width mode.
18243     *
18244     * @param obj The genlist object
18245     * @param setting The height-for-width mode (@c EINA_TRUE = on,
18246     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18247     *
18248     * With height-for-width mode the item width will be fixed (restricted
18249     * to a minimum of) to the list width when calculating its size in
18250     * order to allow the height to be calculated based on it. This allows,
18251     * for instance, text block to wrap lines if the Edje part is
18252     * configured with "text.min: 0 1".
18253     *
18254     * @note This mode will make list resize slower as it will have to
18255     *       recalculate every item height again whenever the list width
18256     *       changes!
18257     *
18258     * @note When height-for-width mode is enabled, it also enables
18259     *       compress mode (see elm_genlist_compress_mode_set()) and
18260     *       disables homogeneous (see elm_genlist_homogeneous_set()).
18261     *
18262     * @ingroup Genlist
18263     */
18264    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18265    /**
18266     * Get whether the height-for-width mode is enabled.
18267     *
18268     * @param obj The genlist object
18269     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18270     * off)
18271     *
18272     * @ingroup Genlist
18273     */
18274    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18275    /**
18276     * Enable/disable horizontal and vertical bouncing effect.
18277     *
18278     * @param obj The genlist object
18279     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18280     * EINA_FALSE = off). Default is @c EINA_FALSE.
18281     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18282     * EINA_FALSE = off). Default is @c EINA_TRUE.
18283     *
18284     * This will enable or disable the scroller bouncing effect for the
18285     * genlist. See elm_scroller_bounce_set() for details.
18286     *
18287     * @see elm_scroller_bounce_set()
18288     * @see elm_genlist_bounce_get()
18289     *
18290     * @ingroup Genlist
18291     */
18292    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18293    /**
18294     * Get whether the horizontal and vertical bouncing effect is enabled.
18295     *
18296     * @param obj The genlist object
18297     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18298     * option is set.
18299     * @param v_bounce Pointer to a bool to receive if the bounce vertically
18300     * option is set.
18301     *
18302     * @see elm_genlist_bounce_set()
18303     *
18304     * @ingroup Genlist
18305     */
18306    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18307    /**
18308     * Enable/disable homogenous mode.
18309     *
18310     * @param obj The genlist object
18311     * @param homogeneous Assume the items within the genlist are of the
18312     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18313     * EINA_FALSE.
18314     *
18315     * This will enable the homogeneous mode where items are of the same
18316     * height and width so that genlist may do the lazy-loading at its
18317     * maximum (which increases the performance for scrolling the list). This
18318     * implies 'compressed' mode.
18319     *
18320     * @see elm_genlist_compress_mode_set()
18321     * @see elm_genlist_homogeneous_get()
18322     *
18323     * @ingroup Genlist
18324     */
18325    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18326    /**
18327     * Get whether the homogenous mode is enabled.
18328     *
18329     * @param obj The genlist object
18330     * @return Assume the items within the genlist are of the same height
18331     * and width (EINA_TRUE = on, EINA_FALSE = off)
18332     *
18333     * @see elm_genlist_homogeneous_set()
18334     *
18335     * @ingroup Genlist
18336     */
18337    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18338    /**
18339     * Set the maximum number of items within an item block
18340     *
18341     * @param obj The genlist object
18342     * @param n   Maximum number of items within an item block. Default is 32.
18343     *
18344     * This will configure the block count to tune to the target with
18345     * particular performance matrix.
18346     *
18347     * A block of objects will be used to reduce the number of operations due to
18348     * many objects in the screen. It can determine the visibility, or if the
18349     * object has changed, it theme needs to be updated, etc. doing this kind of
18350     * calculation to the entire block, instead of per object.
18351     *
18352     * The default value for the block count is enough for most lists, so unless
18353     * you know you will have a lot of objects visible in the screen at the same
18354     * time, don't try to change this.
18355     *
18356     * @see elm_genlist_block_count_get()
18357     * @see @ref Genlist_Implementation
18358     *
18359     * @ingroup Genlist
18360     */
18361    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18362    /**
18363     * Get the maximum number of items within an item block
18364     *
18365     * @param obj The genlist object
18366     * @return Maximum number of items within an item block
18367     *
18368     * @see elm_genlist_block_count_set()
18369     *
18370     * @ingroup Genlist
18371     */
18372    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18373    /**
18374     * Set the timeout in seconds for the longpress event.
18375     *
18376     * @param obj The genlist object
18377     * @param timeout timeout in seconds. Default is 1.
18378     *
18379     * This option will change how long it takes to send an event "longpressed"
18380     * after the mouse down signal is sent to the list. If this event occurs, no
18381     * "clicked" event will be sent.
18382     *
18383     * @see elm_genlist_longpress_timeout_set()
18384     *
18385     * @ingroup Genlist
18386     */
18387    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18388    /**
18389     * Get the timeout in seconds for the longpress event.
18390     *
18391     * @param obj The genlist object
18392     * @return timeout in seconds
18393     *
18394     * @see elm_genlist_longpress_timeout_get()
18395     *
18396     * @ingroup Genlist
18397     */
18398    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18399    /**
18400     * Append a new item in a given genlist widget.
18401     *
18402     * @param obj The genlist object
18403     * @param itc The item class for the item
18404     * @param data The item data
18405     * @param parent The parent item, or NULL if none
18406     * @param flags Item flags
18407     * @param func Convenience function called when the item is selected
18408     * @param func_data Data passed to @p func above.
18409     * @return A handle to the item added or @c NULL if not possible
18410     *
18411     * This adds the given item to the end of the list or the end of
18412     * the children list if the @p parent is given.
18413     *
18414     * @see elm_genlist_item_prepend()
18415     * @see elm_genlist_item_insert_before()
18416     * @see elm_genlist_item_insert_after()
18417     * @see elm_genlist_item_del()
18418     *
18419     * @ingroup Genlist
18420     */
18421    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);
18422    /**
18423     * Prepend a new item in a given genlist widget.
18424     *
18425     * @param obj The genlist object
18426     * @param itc The item class for the item
18427     * @param data The item data
18428     * @param parent The parent item, or NULL if none
18429     * @param flags Item flags
18430     * @param func Convenience function called when the item is selected
18431     * @param func_data Data passed to @p func above.
18432     * @return A handle to the item added or NULL if not possible
18433     *
18434     * This adds an item to the beginning of the list or beginning of the
18435     * children of the parent if given.
18436     *
18437     * @see elm_genlist_item_append()
18438     * @see elm_genlist_item_insert_before()
18439     * @see elm_genlist_item_insert_after()
18440     * @see elm_genlist_item_del()
18441     *
18442     * @ingroup Genlist
18443     */
18444    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);
18445    /**
18446     * Insert an item before another in a genlist widget
18447     *
18448     * @param obj The genlist object
18449     * @param itc The item class for the item
18450     * @param data The item data
18451     * @param before The item to place this new one before.
18452     * @param flags Item flags
18453     * @param func Convenience function called when the item is selected
18454     * @param func_data Data passed to @p func above.
18455     * @return A handle to the item added or @c NULL if not possible
18456     *
18457     * This inserts an item before another in the list. It will be in the
18458     * same tree level or group as the item it is inserted before.
18459     *
18460     * @see elm_genlist_item_append()
18461     * @see elm_genlist_item_prepend()
18462     * @see elm_genlist_item_insert_after()
18463     * @see elm_genlist_item_del()
18464     *
18465     * @ingroup Genlist
18466     */
18467    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);
18468    /**
18469     * Insert an item after another in a genlist widget
18470     *
18471     * @param obj The genlist object
18472     * @param itc The item class for the item
18473     * @param data The item data
18474     * @param after The item to place this new one after.
18475     * @param flags Item flags
18476     * @param func Convenience function called when the item is selected
18477     * @param func_data Data passed to @p func above.
18478     * @return A handle to the item added or @c NULL if not possible
18479     *
18480     * This inserts an item after another in the list. It will be in the
18481     * same tree level or group as the item it is inserted after.
18482     *
18483     * @see elm_genlist_item_append()
18484     * @see elm_genlist_item_prepend()
18485     * @see elm_genlist_item_insert_before()
18486     * @see elm_genlist_item_del()
18487     *
18488     * @ingroup Genlist
18489     */
18490    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);
18491    /**
18492     * Insert a new item into the sorted genlist object
18493     *
18494     * @param obj The genlist object
18495     * @param itc The item class for the item
18496     * @param data The item data
18497     * @param parent The parent item, or NULL if none
18498     * @param flags Item flags
18499     * @param comp The function called for the sort
18500     * @param func Convenience function called when item selected
18501     * @param func_data Data passed to @p func above.
18502     * @return A handle to the item added or NULL if not possible
18503     *
18504     * @ingroup Genlist
18505     */
18506    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);
18507    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);
18508    /* operations to retrieve existing items */
18509    /**
18510     * Get the selectd item in the genlist.
18511     *
18512     * @param obj The genlist object
18513     * @return The selected item, or NULL if none is selected.
18514     *
18515     * This gets the selected item in the list (if multi-selection is enabled, only
18516     * the item that was first selected in the list is returned - which is not very
18517     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18518     * used).
18519     *
18520     * If no item is selected, NULL is returned.
18521     *
18522     * @see elm_genlist_selected_items_get()
18523     *
18524     * @ingroup Genlist
18525     */
18526    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18527    /**
18528     * Get a list of selected items in the genlist.
18529     *
18530     * @param obj The genlist object
18531     * @return The list of selected items, or NULL if none are selected.
18532     *
18533     * It returns a list of the selected items. This list pointer is only valid so
18534     * long as the selection doesn't change (no items are selected or unselected, or
18535     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18536     * pointers. The order of the items in this list is the order which they were
18537     * selected, i.e. the first item in this list is the first item that was
18538     * selected, and so on.
18539     *
18540     * @note If not in multi-select mode, consider using function
18541     * elm_genlist_selected_item_get() instead.
18542     *
18543     * @see elm_genlist_multi_select_set()
18544     * @see elm_genlist_selected_item_get()
18545     *
18546     * @ingroup Genlist
18547     */
18548    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18549    /**
18550     * Get a list of realized items in genlist
18551     *
18552     * @param obj The genlist object
18553     * @return The list of realized items, nor NULL if none are realized.
18554     *
18555     * This returns a list of the realized items in the genlist. The list
18556     * contains Elm_Genlist_Item pointers. The list must be freed by the
18557     * caller when done with eina_list_free(). The item pointers in the
18558     * list are only valid so long as those items are not deleted or the
18559     * genlist is not deleted.
18560     *
18561     * @see elm_genlist_realized_items_update()
18562     *
18563     * @ingroup Genlist
18564     */
18565    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18566    /**
18567     * Get the item that is at the x, y canvas coords.
18568     *
18569     * @param obj The gelinst object.
18570     * @param x The input x coordinate
18571     * @param y The input y coordinate
18572     * @param posret The position relative to the item returned here
18573     * @return The item at the coordinates or NULL if none
18574     *
18575     * This returns the item at the given coordinates (which are canvas
18576     * relative, not object-relative). If an item is at that coordinate,
18577     * that item handle is returned, and if @p posret is not NULL, the
18578     * integer pointed to is set to a value of -1, 0 or 1, depending if
18579     * the coordinate is on the upper portion of that item (-1), on the
18580     * middle section (0) or on the lower part (1). If NULL is returned as
18581     * an item (no item found there), then posret may indicate -1 or 1
18582     * based if the coordinate is above or below all items respectively in
18583     * the genlist.
18584     *
18585     * @ingroup Genlist
18586     */
18587    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);
18588    /**
18589     * Get the first item in the genlist
18590     *
18591     * This returns the first item in the list.
18592     *
18593     * @param obj The genlist object
18594     * @return The first item, or NULL if none
18595     *
18596     * @ingroup Genlist
18597     */
18598    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18599    /**
18600     * Get the last item in the genlist
18601     *
18602     * This returns the last item in the list.
18603     *
18604     * @return The last item, or NULL if none
18605     *
18606     * @ingroup Genlist
18607     */
18608    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18609    /**
18610     * Set the scrollbar policy
18611     *
18612     * @param obj The genlist object
18613     * @param policy_h Horizontal scrollbar policy.
18614     * @param policy_v Vertical scrollbar policy.
18615     *
18616     * This sets the scrollbar visibility policy for the given genlist
18617     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18618     * made visible if it is needed, and otherwise kept hidden.
18619     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18620     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18621     * respectively for the horizontal and vertical scrollbars. Default is
18622     * #ELM_SMART_SCROLLER_POLICY_AUTO
18623     *
18624     * @see elm_genlist_scroller_policy_get()
18625     *
18626     * @ingroup Genlist
18627     */
18628    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18629    /**
18630     * Get the scrollbar policy
18631     *
18632     * @param obj The genlist object
18633     * @param policy_h Pointer to store the horizontal scrollbar policy.
18634     * @param policy_v Pointer to store the vertical scrollbar policy.
18635     *
18636     * @see elm_genlist_scroller_policy_set()
18637     *
18638     * @ingroup Genlist
18639     */
18640    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);
18641    /**
18642     * Get the @b next item in a genlist widget's internal list of items,
18643     * given a handle to one of those items.
18644     *
18645     * @param item The genlist item to fetch next from
18646     * @return The item after @p item, or @c NULL if there's none (and
18647     * on errors)
18648     *
18649     * This returns the item placed after the @p item, on the container
18650     * genlist.
18651     *
18652     * @see elm_genlist_item_prev_get()
18653     *
18654     * @ingroup Genlist
18655     */
18656    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18657    /**
18658     * Get the @b previous item in a genlist widget's internal list of items,
18659     * given a handle to one of those items.
18660     *
18661     * @param item The genlist item to fetch previous from
18662     * @return The item before @p item, or @c NULL if there's none (and
18663     * on errors)
18664     *
18665     * This returns the item placed before the @p item, on the container
18666     * genlist.
18667     *
18668     * @see elm_genlist_item_next_get()
18669     *
18670     * @ingroup Genlist
18671     */
18672    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18673    /**
18674     * Get the genlist object's handle which contains a given genlist
18675     * item
18676     *
18677     * @param item The item to fetch the container from
18678     * @return The genlist (parent) object
18679     *
18680     * This returns the genlist object itself that an item belongs to.
18681     *
18682     * @ingroup Genlist
18683     */
18684    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18685    /**
18686     * Get the parent item of the given item
18687     *
18688     * @param it The item
18689     * @return The parent of the item or @c NULL if it has no parent.
18690     *
18691     * This returns the item that was specified as parent of the item @p it on
18692     * elm_genlist_item_append() and insertion related functions.
18693     *
18694     * @ingroup Genlist
18695     */
18696    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18697    /**
18698     * Remove all sub-items (children) of the given item
18699     *
18700     * @param it The item
18701     *
18702     * This removes all items that are children (and their descendants) of the
18703     * given item @p it.
18704     *
18705     * @see elm_genlist_clear()
18706     * @see elm_genlist_item_del()
18707     *
18708     * @ingroup Genlist
18709     */
18710    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18711    /**
18712     * Set whether a given genlist item is selected or not
18713     *
18714     * @param it The item
18715     * @param selected Use @c EINA_TRUE, to make it selected, @c
18716     * EINA_FALSE to make it unselected
18717     *
18718     * This sets the selected state of an item. If multi selection is
18719     * not enabled on the containing genlist and @p selected is @c
18720     * EINA_TRUE, any other previously selected items will get
18721     * unselected in favor of this new one.
18722     *
18723     * @see elm_genlist_item_selected_get()
18724     *
18725     * @ingroup Genlist
18726     */
18727    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18728    /**
18729     * Get whether a given genlist item is selected or not
18730     *
18731     * @param it The item
18732     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18733     *
18734     * @see elm_genlist_item_selected_set() for more details
18735     *
18736     * @ingroup Genlist
18737     */
18738    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18739    /**
18740     * Sets the expanded state of an item.
18741     *
18742     * @param it The item
18743     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18744     *
18745     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
18746     * expanded or not.
18747     *
18748     * The theme will respond to this change visually, and a signal "expanded" or
18749     * "contracted" will be sent from the genlist with a pointer to the item that
18750     * has been expanded/contracted.
18751     *
18752     * Calling this function won't show or hide any child of this item (if it is
18753     * a parent). You must manually delete and create them on the callbacks fo
18754     * the "expanded" or "contracted" signals.
18755     *
18756     * @see elm_genlist_item_expanded_get()
18757     *
18758     * @ingroup Genlist
18759     */
18760    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
18761    /**
18762     * Get the expanded state of an item
18763     *
18764     * @param it The item
18765     * @return The expanded state
18766     *
18767     * This gets the expanded state of an item.
18768     *
18769     * @see elm_genlist_item_expanded_set()
18770     *
18771     * @ingroup Genlist
18772     */
18773    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18774    /**
18775     * Get the depth of expanded item
18776     *
18777     * @param it The genlist item object
18778     * @return The depth of expanded item
18779     *
18780     * @ingroup Genlist
18781     */
18782    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18783    /**
18784     * Set whether a given genlist item is disabled or not.
18785     *
18786     * @param it The item
18787     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
18788     * to enable it back.
18789     *
18790     * A disabled item cannot be selected or unselected. It will also
18791     * change its appearance, to signal the user it's disabled.
18792     *
18793     * @see elm_genlist_item_disabled_get()
18794     *
18795     * @ingroup Genlist
18796     */
18797    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18798    /**
18799     * Get whether a given genlist item is disabled or not.
18800     *
18801     * @param it The item
18802     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
18803     * (and on errors).
18804     *
18805     * @see elm_genlist_item_disabled_set() for more details
18806     *
18807     * @ingroup Genlist
18808     */
18809    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18810    /**
18811     * Sets the display only state of an item.
18812     *
18813     * @param it The item
18814     * @param display_only @c EINA_TRUE if the item is display only, @c
18815     * EINA_FALSE otherwise.
18816     *
18817     * A display only item cannot be selected or unselected. It is for
18818     * display only and not selecting or otherwise clicking, dragging
18819     * etc. by the user, thus finger size rules will not be applied to
18820     * this item.
18821     *
18822     * It's good to set group index items to display only state.
18823     *
18824     * @see elm_genlist_item_display_only_get()
18825     *
18826     * @ingroup Genlist
18827     */
18828    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
18829    /**
18830     * Get the display only state of an item
18831     *
18832     * @param it The item
18833     * @return @c EINA_TRUE if the item is display only, @c
18834     * EINA_FALSE otherwise.
18835     *
18836     * @see elm_genlist_item_display_only_set()
18837     *
18838     * @ingroup Genlist
18839     */
18840    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18841    /**
18842     * Show the portion of a genlist's internal list containing a given
18843     * item, immediately.
18844     *
18845     * @param it The item to display
18846     *
18847     * This causes genlist to jump to the given item @p it and show it (by
18848     * immediately scrolling to that position), if it is not fully visible.
18849     *
18850     * @see elm_genlist_item_bring_in()
18851     * @see elm_genlist_item_top_show()
18852     * @see elm_genlist_item_middle_show()
18853     *
18854     * @ingroup Genlist
18855     */
18856    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18857    /**
18858     * Animatedly bring in, to the visible are of a genlist, a given
18859     * item on it.
18860     *
18861     * @param it The item to display
18862     *
18863     * This causes genlist to jump to the given item @p it and show it (by
18864     * animatedly scrolling), if it is not fully visible. This may use animation
18865     * to do so and take a period of time
18866     *
18867     * @see elm_genlist_item_show()
18868     * @see elm_genlist_item_top_bring_in()
18869     * @see elm_genlist_item_middle_bring_in()
18870     *
18871     * @ingroup Genlist
18872     */
18873    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18874    /**
18875     * Show the portion of a genlist's internal list containing a given
18876     * item, immediately.
18877     *
18878     * @param it The item to display
18879     *
18880     * This causes genlist to jump to the given item @p it and show it (by
18881     * immediately scrolling to that position), if it is not fully visible.
18882     *
18883     * The item will be positioned at the top of the genlist viewport.
18884     *
18885     * @see elm_genlist_item_show()
18886     * @see elm_genlist_item_top_bring_in()
18887     *
18888     * @ingroup Genlist
18889     */
18890    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18891    /**
18892     * Animatedly bring in, to the visible are of a genlist, a given
18893     * item on it.
18894     *
18895     * @param it The item
18896     *
18897     * This causes genlist to jump to the given item @p it and show it (by
18898     * animatedly scrolling), if it is not fully visible. This may use animation
18899     * to do so and take a period of time
18900     *
18901     * The item will be positioned at the top of the genlist viewport.
18902     *
18903     * @see elm_genlist_item_bring_in()
18904     * @see elm_genlist_item_top_show()
18905     *
18906     * @ingroup Genlist
18907     */
18908    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18909    /**
18910     * Show the portion of a genlist's internal list containing a given
18911     * item, immediately.
18912     *
18913     * @param it The item to display
18914     *
18915     * This causes genlist to jump to the given item @p it and show it (by
18916     * immediately scrolling to that position), if it is not fully visible.
18917     *
18918     * The item will be positioned at the middle of the genlist viewport.
18919     *
18920     * @see elm_genlist_item_show()
18921     * @see elm_genlist_item_middle_bring_in()
18922     *
18923     * @ingroup Genlist
18924     */
18925    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18926    /**
18927     * Animatedly bring in, to the visible are of a genlist, a given
18928     * item on it.
18929     *
18930     * @param it The item
18931     *
18932     * This causes genlist to jump to the given item @p it and show it (by
18933     * animatedly scrolling), if it is not fully visible. This may use animation
18934     * to do so and take a period of time
18935     *
18936     * The item will be positioned at the middle of the genlist viewport.
18937     *
18938     * @see elm_genlist_item_bring_in()
18939     * @see elm_genlist_item_middle_show()
18940     *
18941     * @ingroup Genlist
18942     */
18943    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18944    /**
18945     * Remove a genlist item from the its parent, deleting it.
18946     *
18947     * @param item The item to be removed.
18948     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
18949     *
18950     * @see elm_genlist_clear(), to remove all items in a genlist at
18951     * once.
18952     *
18953     * @ingroup Genlist
18954     */
18955    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18956    /**
18957     * Return the data associated to a given genlist item
18958     *
18959     * @param item The genlist item.
18960     * @return the data associated to this item.
18961     *
18962     * This returns the @c data value passed on the
18963     * elm_genlist_item_append() and related item addition calls.
18964     *
18965     * @see elm_genlist_item_append()
18966     * @see elm_genlist_item_data_set()
18967     *
18968     * @ingroup Genlist
18969     */
18970    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18971    /**
18972     * Set the data associated to a given genlist item
18973     *
18974     * @param item The genlist item
18975     * @param data The new data pointer to set on it
18976     *
18977     * This @b overrides the @c data value passed on the
18978     * elm_genlist_item_append() and related item addition calls. This
18979     * function @b won't call elm_genlist_item_update() automatically,
18980     * so you'd issue it afterwards if you want to hove the item
18981     * updated to reflect the that new data.
18982     *
18983     * @see elm_genlist_item_data_get()
18984     *
18985     * @ingroup Genlist
18986     */
18987    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
18988    /**
18989     * Tells genlist to "orphan" icons fetchs by the item class
18990     *
18991     * @param it The item
18992     *
18993     * This instructs genlist to release references to icons in the item,
18994     * meaning that they will no longer be managed by genlist and are
18995     * floating "orphans" that can be re-used elsewhere if the user wants
18996     * to.
18997     *
18998     * @ingroup Genlist
18999     */
19000    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19001    /**
19002     * Get the real Evas object created to implement the view of a
19003     * given genlist item
19004     *
19005     * @param item The genlist item.
19006     * @return the Evas object implementing this item's view.
19007     *
19008     * This returns the actual Evas object used to implement the
19009     * specified genlist item's view. This may be @c NULL, as it may
19010     * not have been created or may have been deleted, at any time, by
19011     * the genlist. <b>Do not modify this object</b> (move, resize,
19012     * show, hide, etc.), as the genlist is controlling it. This
19013     * function is for querying, emitting custom signals or hooking
19014     * lower level callbacks for events on that object. Do not delete
19015     * this object under any circumstances.
19016     *
19017     * @see elm_genlist_item_data_get()
19018     *
19019     * @ingroup Genlist
19020     */
19021    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19022    /**
19023     * Update the contents of an item
19024     *
19025     * @param it The item
19026     *
19027     * This updates an item by calling all the item class functions again
19028     * to get the icons, labels and states. Use this when the original
19029     * item data has changed and the changes are desired to be reflected.
19030     *
19031     * Use elm_genlist_realized_items_update() to update all already realized
19032     * items.
19033     *
19034     * @see elm_genlist_realized_items_update()
19035     *
19036     * @ingroup Genlist
19037     */
19038    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19039    /**
19040     * Update the item class of an item
19041     *
19042     * @param it The item
19043     * @param itc The item class for the item
19044     *
19045     * This sets another class fo the item, changing the way that it is
19046     * displayed. After changing the item class, elm_genlist_item_update() is
19047     * called on the item @p it.
19048     *
19049     * @ingroup Genlist
19050     */
19051    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19052    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19053    /**
19054     * Set the text to be shown in a given genlist item's tooltips.
19055     *
19056     * @param item The genlist item
19057     * @param text The text to set in the content
19058     *
19059     * This call will setup the text to be used as tooltip to that item
19060     * (analogous to elm_object_tooltip_text_set(), but being item
19061     * tooltips with higher precedence than object tooltips). It can
19062     * have only one tooltip at a time, so any previous tooltip data
19063     * will get removed.
19064     *
19065     * In order to set an icon or something else as a tooltip, look at
19066     * elm_genlist_item_tooltip_content_cb_set().
19067     *
19068     * @ingroup Genlist
19069     */
19070    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19071    /**
19072     * Set the content to be shown in a given genlist item's tooltips
19073     *
19074     * @param item The genlist item.
19075     * @param func The function returning the tooltip contents.
19076     * @param data What to provide to @a func as callback data/context.
19077     * @param del_cb Called when data is not needed anymore, either when
19078     *        another callback replaces @p func, the tooltip is unset with
19079     *        elm_genlist_item_tooltip_unset() or the owner @p item
19080     *        dies. This callback receives as its first parameter the
19081     *        given @p data, being @c event_info the item handle.
19082     *
19083     * This call will setup the tooltip's contents to @p item
19084     * (analogous to elm_object_tooltip_content_cb_set(), but being
19085     * item tooltips with higher precedence than object tooltips). It
19086     * can have only one tooltip at a time, so any previous tooltip
19087     * content will get removed. @p func (with @p data) will be called
19088     * every time Elementary needs to show the tooltip and it should
19089     * return a valid Evas object, which will be fully managed by the
19090     * tooltip system, getting deleted when the tooltip is gone.
19091     *
19092     * In order to set just a text as a tooltip, look at
19093     * elm_genlist_item_tooltip_text_set().
19094     *
19095     * @ingroup Genlist
19096     */
19097    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);
19098    /**
19099     * Unset a tooltip from a given genlist item
19100     *
19101     * @param item genlist item to remove a previously set tooltip from.
19102     *
19103     * This call removes any tooltip set on @p item. The callback
19104     * provided as @c del_cb to
19105     * elm_genlist_item_tooltip_content_cb_set() will be called to
19106     * notify it is not used anymore (and have resources cleaned, if
19107     * need be).
19108     *
19109     * @see elm_genlist_item_tooltip_content_cb_set()
19110     *
19111     * @ingroup Genlist
19112     */
19113    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19114    /**
19115     * Set a different @b style for a given genlist item's tooltip.
19116     *
19117     * @param item genlist item with tooltip set
19118     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19119     * "default", @c "transparent", etc)
19120     *
19121     * Tooltips can have <b>alternate styles</b> to be displayed on,
19122     * which are defined by the theme set on Elementary. This function
19123     * works analogously as elm_object_tooltip_style_set(), but here
19124     * applied only to genlist item objects. The default style for
19125     * tooltips is @c "default".
19126     *
19127     * @note before you set a style you should define a tooltip with
19128     *       elm_genlist_item_tooltip_content_cb_set() or
19129     *       elm_genlist_item_tooltip_text_set()
19130     *
19131     * @see elm_genlist_item_tooltip_style_get()
19132     *
19133     * @ingroup Genlist
19134     */
19135    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19136    /**
19137     * Get the style set a given genlist item's tooltip.
19138     *
19139     * @param item genlist item with tooltip already set on.
19140     * @return style the theme style in use, which defaults to
19141     *         "default". If the object does not have a tooltip set,
19142     *         then @c NULL is returned.
19143     *
19144     * @see elm_genlist_item_tooltip_style_set() for more details
19145     *
19146     * @ingroup Genlist
19147     */
19148    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19149    /**
19150     * @brief Disable size restrictions on an object's tooltip
19151     * @param item The tooltip's anchor object
19152     * @param disable If EINA_TRUE, size restrictions are disabled
19153     * @return EINA_FALSE on failure, EINA_TRUE on success
19154     *
19155     * This function allows a tooltip to expand beyond its parant window's canvas.
19156     * It will instead be limited only by the size of the display.
19157     */
19158    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19159    /**
19160     * @brief Retrieve size restriction state of an object's tooltip
19161     * @param item The tooltip's anchor object
19162     * @return If EINA_TRUE, size restrictions are disabled
19163     *
19164     * This function returns whether a tooltip is allowed to expand beyond
19165     * its parant window's canvas.
19166     * It will instead be limited only by the size of the display.
19167     */
19168    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19169    /**
19170     * Set the type of mouse pointer/cursor decoration to be shown,
19171     * when the mouse pointer is over the given genlist widget item
19172     *
19173     * @param item genlist item to customize cursor on
19174     * @param cursor the cursor type's name
19175     *
19176     * This function works analogously as elm_object_cursor_set(), but
19177     * here the cursor's changing area is restricted to the item's
19178     * area, and not the whole widget's. Note that that item cursors
19179     * have precedence over widget cursors, so that a mouse over @p
19180     * item will always show cursor @p type.
19181     *
19182     * If this function is called twice for an object, a previously set
19183     * cursor will be unset on the second call.
19184     *
19185     * @see elm_object_cursor_set()
19186     * @see elm_genlist_item_cursor_get()
19187     * @see elm_genlist_item_cursor_unset()
19188     *
19189     * @ingroup Genlist
19190     */
19191    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19192    /**
19193     * Get the type of mouse pointer/cursor decoration set to be shown,
19194     * when the mouse pointer is over the given genlist widget item
19195     *
19196     * @param item genlist item with custom cursor set
19197     * @return the cursor type's name or @c NULL, if no custom cursors
19198     * were set to @p item (and on errors)
19199     *
19200     * @see elm_object_cursor_get()
19201     * @see elm_genlist_item_cursor_set() for more details
19202     * @see elm_genlist_item_cursor_unset()
19203     *
19204     * @ingroup Genlist
19205     */
19206    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19207    /**
19208     * Unset any custom mouse pointer/cursor decoration set to be
19209     * shown, when the mouse pointer is over the given genlist widget
19210     * item, thus making it show the @b default cursor again.
19211     *
19212     * @param item a genlist item
19213     *
19214     * Use this call to undo any custom settings on this item's cursor
19215     * decoration, bringing it back to defaults (no custom style set).
19216     *
19217     * @see elm_object_cursor_unset()
19218     * @see elm_genlist_item_cursor_set() for more details
19219     *
19220     * @ingroup Genlist
19221     */
19222    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19223    /**
19224     * Set a different @b style for a given custom cursor set for a
19225     * genlist item.
19226     *
19227     * @param item genlist item with custom cursor set
19228     * @param style the <b>theme style</b> to use (e.g. @c "default",
19229     * @c "transparent", etc)
19230     *
19231     * This function only makes sense when one is using custom mouse
19232     * cursor decorations <b>defined in a theme file</b> , which can
19233     * have, given a cursor name/type, <b>alternate styles</b> on
19234     * it. It works analogously as elm_object_cursor_style_set(), but
19235     * here applied only to genlist item objects.
19236     *
19237     * @warning Before you set a cursor style you should have defined a
19238     *       custom cursor previously on the item, with
19239     *       elm_genlist_item_cursor_set()
19240     *
19241     * @see elm_genlist_item_cursor_engine_only_set()
19242     * @see elm_genlist_item_cursor_style_get()
19243     *
19244     * @ingroup Genlist
19245     */
19246    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19247    /**
19248     * Get the current @b style set for a given genlist item's custom
19249     * cursor
19250     *
19251     * @param item genlist item with custom cursor set.
19252     * @return style the cursor style in use. If the object does not
19253     *         have a cursor set, then @c NULL is returned.
19254     *
19255     * @see elm_genlist_item_cursor_style_set() for more details
19256     *
19257     * @ingroup Genlist
19258     */
19259    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19260    /**
19261     * Set if the (custom) cursor for a given genlist item should be
19262     * searched in its theme, also, or should only rely on the
19263     * rendering engine.
19264     *
19265     * @param item item with custom (custom) cursor already set on
19266     * @param engine_only Use @c EINA_TRUE to have cursors looked for
19267     * only on those provided by the rendering engine, @c EINA_FALSE to
19268     * have them searched on the widget's theme, as well.
19269     *
19270     * @note This call is of use only if you've set a custom cursor
19271     * for genlist items, with elm_genlist_item_cursor_set().
19272     *
19273     * @note By default, cursors will only be looked for between those
19274     * provided by the rendering engine.
19275     *
19276     * @ingroup Genlist
19277     */
19278    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19279    /**
19280     * Get if the (custom) cursor for a given genlist item is being
19281     * searched in its theme, also, or is only relying on the rendering
19282     * engine.
19283     *
19284     * @param item a genlist item
19285     * @return @c EINA_TRUE, if cursors are being looked for only on
19286     * those provided by the rendering engine, @c EINA_FALSE if they
19287     * are being searched on the widget's theme, as well.
19288     *
19289     * @see elm_genlist_item_cursor_engine_only_set(), for more details
19290     *
19291     * @ingroup Genlist
19292     */
19293    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19294    /**
19295     * Update the contents of all realized items.
19296     *
19297     * @param obj The genlist object.
19298     *
19299     * This updates all realized items by calling all the item class functions again
19300     * to get the icons, labels and states. Use this when the original
19301     * item data has changed and the changes are desired to be reflected.
19302     *
19303     * To update just one item, use elm_genlist_item_update().
19304     *
19305     * @see elm_genlist_realized_items_get()
19306     * @see elm_genlist_item_update()
19307     *
19308     * @ingroup Genlist
19309     */
19310    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19311    /**
19312     * Activate a genlist mode on an item
19313     *
19314     * @param item The genlist item
19315     * @param mode Mode name
19316     * @param mode_set Boolean to define set or unset mode.
19317     *
19318     * A genlist mode is a different way of selecting an item. Once a mode is
19319     * activated on an item, any other selected item is immediately unselected.
19320     * This feature provides an easy way of implementing a new kind of animation
19321     * for selecting an item, without having to entirely rewrite the item style
19322     * theme. However, the elm_genlist_selected_* API can't be used to get what
19323     * item is activate for a mode.
19324     *
19325     * The current item style will still be used, but applying a genlist mode to
19326     * an item will select it using a different kind of animation.
19327     *
19328     * The current active item for a mode can be found by
19329     * elm_genlist_mode_item_get().
19330     *
19331     * The characteristics of genlist mode are:
19332     * - Only one mode can be active at any time, and for only one item.
19333     * - Genlist handles deactivating other items when one item is activated.
19334     * - A mode is defined in the genlist theme (edc), and more modes can easily
19335     *   be added.
19336     * - A mode style and the genlist item style are different things. They
19337     *   can be combined to provide a default style to the item, with some kind
19338     *   of animation for that item when the mode is activated.
19339     *
19340     * When a mode is activated on an item, a new view for that item is created.
19341     * The theme of this mode defines the animation that will be used to transit
19342     * the item from the old view to the new view. This second (new) view will be
19343     * active for that item while the mode is active on the item, and will be
19344     * destroyed after the mode is totally deactivated from that item.
19345     *
19346     * @see elm_genlist_mode_get()
19347     * @see elm_genlist_mode_item_get()
19348     *
19349     * @ingroup Genlist
19350     */
19351    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19352    /**
19353     * Get the last (or current) genlist mode used.
19354     *
19355     * @param obj The genlist object
19356     *
19357     * This function just returns the name of the last used genlist mode. It will
19358     * be the current mode if it's still active.
19359     *
19360     * @see elm_genlist_item_mode_set()
19361     * @see elm_genlist_mode_item_get()
19362     *
19363     * @ingroup Genlist
19364     */
19365    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19366    /**
19367     * Get active genlist mode item
19368     *
19369     * @param obj The genlist object
19370     * @return The active item for that current mode. Or @c NULL if no item is
19371     * activated with any mode.
19372     *
19373     * This function returns the item that was activated with a mode, by the
19374     * function elm_genlist_item_mode_set().
19375     *
19376     * @see elm_genlist_item_mode_set()
19377     * @see elm_genlist_mode_get()
19378     *
19379     * @ingroup Genlist
19380     */
19381    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19382
19383    /**
19384     * Set reorder mode
19385     *
19386     * @param obj The genlist object
19387     * @param reorder_mode The reorder mode
19388     * (EINA_TRUE = on, EINA_FALSE = off)
19389     *
19390     * @ingroup Genlist
19391     */
19392    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19393
19394    /**
19395     * Get the reorder mode
19396     *
19397     * @param obj The genlist object
19398     * @return The reorder mode
19399     * (EINA_TRUE = on, EINA_FALSE = off)
19400     *
19401     * @ingroup Genlist
19402     */
19403    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19404
19405    /**
19406     * @}
19407     */
19408
19409    /**
19410     * @defgroup Check Check
19411     *
19412     * @image html img/widget/check/preview-00.png
19413     * @image latex img/widget/check/preview-00.eps
19414     * @image html img/widget/check/preview-01.png
19415     * @image latex img/widget/check/preview-01.eps
19416     * @image html img/widget/check/preview-02.png
19417     * @image latex img/widget/check/preview-02.eps
19418     *
19419     * @brief The check widget allows for toggling a value between true and
19420     * false.
19421     *
19422     * Check objects are a lot like radio objects in layout and functionality
19423     * except they do not work as a group, but independently and only toggle the
19424     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19425     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19426     * returns the current state. For convenience, like the radio objects, you
19427     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19428     * for it to modify.
19429     *
19430     * Signals that you can add callbacks for are:
19431     * "changed" - This is called whenever the user changes the state of one of
19432     *             the check object(event_info is NULL).
19433     *
19434     * @ref tutorial_check should give you a firm grasp of how to use this widget.
19435     * @{
19436     */
19437    /**
19438     * @brief Add a new Check object
19439     *
19440     * @param parent The parent object
19441     * @return The new object or NULL if it cannot be created
19442     */
19443    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19444    /**
19445     * @brief Set the text label of the check object
19446     *
19447     * @param obj The check object
19448     * @param label The text label string in UTF-8
19449     *
19450     * @deprecated use elm_object_text_set() instead.
19451     */
19452    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19453    /**
19454     * @brief Get the text label of the check object
19455     *
19456     * @param obj The check object
19457     * @return The text label string in UTF-8
19458     *
19459     * @deprecated use elm_object_text_get() instead.
19460     */
19461    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19462    /**
19463     * @brief Set the icon object of the check object
19464     *
19465     * @param obj The check object
19466     * @param icon The icon object
19467     *
19468     * Once the icon object is set, a previously set one will be deleted.
19469     * If you want to keep that old content object, use the
19470     * elm_check_icon_unset() function.
19471     */
19472    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19473    /**
19474     * @brief Get the icon object of the check object
19475     *
19476     * @param obj The check object
19477     * @return The icon object
19478     */
19479    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19480    /**
19481     * @brief Unset the icon used for the check object
19482     *
19483     * @param obj The check object
19484     * @return The icon object that was being used
19485     *
19486     * Unparent and return the icon object which was set for this widget.
19487     */
19488    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19489    /**
19490     * @brief Set the on/off state of the check object
19491     *
19492     * @param obj The check object
19493     * @param state The state to use (1 == on, 0 == off)
19494     *
19495     * This sets the state of the check. If set
19496     * with elm_check_state_pointer_set() the state of that variable is also
19497     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19498     */
19499    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19500    /**
19501     * @brief Get the state of the check object
19502     *
19503     * @param obj The check object
19504     * @return The boolean state
19505     */
19506    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19507    /**
19508     * @brief Set a convenience pointer to a boolean to change
19509     *
19510     * @param obj The check object
19511     * @param statep Pointer to the boolean to modify
19512     *
19513     * This sets a pointer to a boolean, that, in addition to the check objects
19514     * state will also be modified directly. To stop setting the object pointed
19515     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19516     * then when this is called, the check objects state will also be modified to
19517     * reflect the value of the boolean @p statep points to, just like calling
19518     * elm_check_state_set().
19519     */
19520    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19521    /**
19522     * @}
19523     */
19524
19525    /**
19526     * @defgroup Radio Radio
19527     *
19528     * @image html img/widget/radio/preview-00.png
19529     * @image latex img/widget/radio/preview-00.eps
19530     *
19531     * @brief Radio is a widget that allows for 1 or more options to be displayed
19532     * and have the user choose only 1 of them.
19533     *
19534     * A radio object contains an indicator, an optional Label and an optional
19535     * icon object. While it's possible to have a group of only one radio they,
19536     * are normally used in groups of 2 or more. To add a radio to a group use
19537     * elm_radio_group_add(). The radio object(s) will select from one of a set
19538     * of integer values, so any value they are configuring needs to be mapped to
19539     * a set of integers. To configure what value that radio object represents,
19540     * use  elm_radio_state_value_set() to set the integer it represents. To set
19541     * the value the whole group(which one is currently selected) is to indicate
19542     * use elm_radio_value_set() on any group member, and to get the groups value
19543     * use elm_radio_value_get(). For convenience the radio objects are also able
19544     * to directly set an integer(int) to the value that is selected. To specify
19545     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19546     * The radio objects will modify this directly. That implies the pointer must
19547     * point to valid memory for as long as the radio objects exist.
19548     *
19549     * Signals that you can add callbacks for are:
19550     * @li changed - This is called whenever the user changes the state of one of
19551     * the radio objects within the group of radio objects that work together.
19552     *
19553     * @ref tutorial_radio show most of this API in action.
19554     * @{
19555     */
19556    /**
19557     * @brief Add a new radio to the parent
19558     *
19559     * @param parent The parent object
19560     * @return The new object or NULL if it cannot be created
19561     */
19562    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19563    /**
19564     * @brief Set the text label of the radio object
19565     *
19566     * @param obj The radio object
19567     * @param label The text label string in UTF-8
19568     *
19569     * @deprecated use elm_object_text_set() instead.
19570     */
19571    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19572    /**
19573     * @brief Get the text label of the radio object
19574     *
19575     * @param obj The radio object
19576     * @return The text label string in UTF-8
19577     *
19578     * @deprecated use elm_object_text_set() instead.
19579     */
19580    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19581    /**
19582     * @brief Set the icon object of the radio object
19583     *
19584     * @param obj The radio object
19585     * @param icon The icon object
19586     *
19587     * Once the icon object is set, a previously set one will be deleted. If you
19588     * want to keep that old content object, use the elm_radio_icon_unset()
19589     * function.
19590     */
19591    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19592    /**
19593     * @brief Get the icon object of the radio object
19594     *
19595     * @param obj The radio object
19596     * @return The icon object
19597     *
19598     * @see elm_radio_icon_set()
19599     */
19600    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19601    /**
19602     * @brief Unset the icon used for the radio object
19603     *
19604     * @param obj The radio object
19605     * @return The icon object that was being used
19606     *
19607     * Unparent and return the icon object which was set for this widget.
19608     *
19609     * @see elm_radio_icon_set()
19610     */
19611    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19612    /**
19613     * @brief Add this radio to a group of other radio objects
19614     *
19615     * @param obj The radio object
19616     * @param group Any object whose group the @p obj is to join.
19617     *
19618     * Radio objects work in groups. Each member should have a different integer
19619     * value assigned. In order to have them work as a group, they need to know
19620     * about each other. This adds the given radio object to the group of which
19621     * the group object indicated is a member.
19622     */
19623    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19624    /**
19625     * @brief Set the integer value that this radio object represents
19626     *
19627     * @param obj The radio object
19628     * @param value The value to use if this radio object is selected
19629     *
19630     * This sets the value of the radio.
19631     */
19632    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19633    /**
19634     * @brief Get the integer value that this radio object represents
19635     *
19636     * @param obj The radio object
19637     * @return The value used if this radio object is selected
19638     *
19639     * This gets the value of the radio.
19640     *
19641     * @see elm_radio_value_set()
19642     */
19643    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19644    /**
19645     * @brief Set the value of the radio.
19646     *
19647     * @param obj The radio object
19648     * @param value The value to use for the group
19649     *
19650     * This sets the value of the radio group and will also set the value if
19651     * pointed to, to the value supplied, but will not call any callbacks.
19652     */
19653    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19654    /**
19655     * @brief Get the state of the radio object
19656     *
19657     * @param obj The radio object
19658     * @return The integer state
19659     */
19660    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19661    /**
19662     * @brief Set a convenience pointer to a integer to change
19663     *
19664     * @param obj The radio object
19665     * @param valuep Pointer to the integer to modify
19666     *
19667     * This sets a pointer to a integer, that, in addition to the radio objects
19668     * state will also be modified directly. To stop setting the object pointed
19669     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19670     * when this is called, the radio objects state will also be modified to
19671     * reflect the value of the integer valuep points to, just like calling
19672     * elm_radio_value_set().
19673     */
19674    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19675    /**
19676     * @}
19677     */
19678
19679    /**
19680     * @defgroup Pager Pager
19681     *
19682     * @image html img/widget/pager/preview-00.png
19683     * @image latex img/widget/pager/preview-00.eps
19684     *
19685     * @brief Widget that allows flipping between 1 or more “pages” of objects.
19686     *
19687     * The flipping between “pages” of objects is animated. All content in pager
19688     * is kept in a stack, the last content to be added will be on the top of the
19689     * stack(be visible).
19690     *
19691     * Objects can be pushed or popped from the stack or deleted as normal.
19692     * Pushes and pops will animate (and a pop will delete the object once the
19693     * animation is finished). Any object already in the pager can be promoted to
19694     * the top(from its current stacking position) through the use of
19695     * elm_pager_content_promote(). Objects are pushed to the top with
19696     * elm_pager_content_push() and when the top item is no longer wanted, simply
19697     * pop it with elm_pager_content_pop() and it will also be deleted. If an
19698     * object is no longer needed and is not the top item, just delete it as
19699     * normal. You can query which objects are the top and bottom with
19700     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
19701     *
19702     * Signals that you can add callbacks for are:
19703     * "hide,finished" - when the previous page is hided
19704     *
19705     * This widget has the following styles available:
19706     * @li default
19707     * @li fade
19708     * @li fade_translucide
19709     * @li fade_invisible
19710     * @note This styles affect only the flipping animations, the appearance when
19711     * not animating is unaffected by styles.
19712     *
19713     * @ref tutorial_pager gives a good overview of the usage of the API.
19714     * @{
19715     */
19716    /**
19717     * Add a new pager to the parent
19718     *
19719     * @param parent The parent object
19720     * @return The new object or NULL if it cannot be created
19721     *
19722     * @ingroup Pager
19723     */
19724    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19725    /**
19726     * @brief Push an object to the top of the pager stack (and show it).
19727     *
19728     * @param obj The pager object
19729     * @param content The object to push
19730     *
19731     * The object pushed becomes a child of the pager, it will be controlled and
19732     * deleted when the pager is deleted.
19733     *
19734     * @note If the content is already in the stack use
19735     * elm_pager_content_promote().
19736     * @warning Using this function on @p content already in the stack results in
19737     * undefined behavior.
19738     */
19739    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19740    /**
19741     * @brief Pop the object that is on top of the stack
19742     *
19743     * @param obj The pager object
19744     *
19745     * This pops the object that is on the top(visible) of the pager, makes it
19746     * disappear, then deletes the object. The object that was underneath it on
19747     * the stack will become visible.
19748     */
19749    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
19750    /**
19751     * @brief Moves an object already in the pager stack to the top of the stack.
19752     *
19753     * @param obj The pager object
19754     * @param content The object to promote
19755     *
19756     * This will take the @p content and move it to the top of the stack as
19757     * if it had been pushed there.
19758     *
19759     * @note If the content isn't already in the stack use
19760     * elm_pager_content_push().
19761     * @warning Using this function on @p content not already in the stack
19762     * results in undefined behavior.
19763     */
19764    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19765    /**
19766     * @brief Return the object at the bottom of the pager stack
19767     *
19768     * @param obj The pager object
19769     * @return The bottom object or NULL if none
19770     */
19771    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19772    /**
19773     * @brief  Return the object at the top of the pager stack
19774     *
19775     * @param obj The pager object
19776     * @return The top object or NULL if none
19777     */
19778    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19779
19780    /**
19781     * @}
19782     */
19783
19784    /**
19785     * @defgroup Slideshow Slideshow
19786     *
19787     * @image html img/widget/slideshow/preview-00.png
19788     * @image latex img/widget/slideshow/preview-00.eps
19789     *
19790     * This widget, as the name indicates, is a pre-made image
19791     * slideshow panel, with API functions acting on (child) image
19792     * items presentation. Between those actions, are:
19793     * - advance to next/previous image
19794     * - select the style of image transition animation
19795     * - set the exhibition time for each image
19796     * - start/stop the slideshow
19797     *
19798     * The transition animations are defined in the widget's theme,
19799     * consequently new animations can be added without having to
19800     * update the widget's code.
19801     *
19802     * @section Slideshow_Items Slideshow items
19803     *
19804     * For slideshow items, just like for @ref Genlist "genlist" ones,
19805     * the user defines a @b classes, specifying functions that will be
19806     * called on the item's creation and deletion times.
19807     *
19808     * The #Elm_Slideshow_Item_Class structure contains the following
19809     * members:
19810     *
19811     * - @c func.get - When an item is displayed, this function is
19812     *   called, and it's where one should create the item object, de
19813     *   facto. For example, the object can be a pure Evas image object
19814     *   or an Elementary @ref Photocam "photocam" widget. See
19815     *   #SlideshowItemGetFunc.
19816     * - @c func.del - When an item is no more displayed, this function
19817     *   is called, where the user must delete any data associated to
19818     *   the item. See #SlideshowItemDelFunc.
19819     *
19820     * @section Slideshow_Caching Slideshow caching
19821     *
19822     * The slideshow provides facilities to have items adjacent to the
19823     * one being displayed <b>already "realized"</b> (i.e. loaded) for
19824     * you, so that the system does not have to decode image data
19825     * anymore at the time it has to actually switch images on its
19826     * viewport. The user is able to set the numbers of items to be
19827     * cached @b before and @b after the current item, in the widget's
19828     * item list.
19829     *
19830     * Smart events one can add callbacks for are:
19831     *
19832     * - @c "changed" - when the slideshow switches its view to a new
19833     *   item
19834     *
19835     * List of examples for the slideshow widget:
19836     * @li @ref slideshow_example
19837     */
19838
19839    /**
19840     * @addtogroup Slideshow
19841     * @{
19842     */
19843
19844    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
19845    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
19846    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
19847    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
19848    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
19849
19850    /**
19851     * @struct _Elm_Slideshow_Item_Class
19852     *
19853     * Slideshow item class definition. See @ref Slideshow_Items for
19854     * field details.
19855     */
19856    struct _Elm_Slideshow_Item_Class
19857      {
19858         struct _Elm_Slideshow_Item_Class_Func
19859           {
19860              SlideshowItemGetFunc get;
19861              SlideshowItemDelFunc del;
19862           } func;
19863      }; /**< #Elm_Slideshow_Item_Class member definitions */
19864
19865    /**
19866     * Add a new slideshow widget to the given parent Elementary
19867     * (container) object
19868     *
19869     * @param parent The parent object
19870     * @return A new slideshow widget handle or @c NULL, on errors
19871     *
19872     * This function inserts a new slideshow widget on the canvas.
19873     *
19874     * @ingroup Slideshow
19875     */
19876    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19877
19878    /**
19879     * Add (append) a new item in a given slideshow widget.
19880     *
19881     * @param obj The slideshow object
19882     * @param itc The item class for the item
19883     * @param data The item's data
19884     * @return A handle to the item added or @c NULL, on errors
19885     *
19886     * Add a new item to @p obj's internal list of items, appending it.
19887     * The item's class must contain the function really fetching the
19888     * image object to show for this item, which could be an Evas image
19889     * object or an Elementary photo, for example. The @p data
19890     * parameter is going to be passed to both class functions of the
19891     * item.
19892     *
19893     * @see #Elm_Slideshow_Item_Class
19894     * @see elm_slideshow_item_sorted_insert()
19895     *
19896     * @ingroup Slideshow
19897     */
19898    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
19899
19900    /**
19901     * Insert a new item into the given slideshow widget, using the @p func
19902     * function to sort items (by item handles).
19903     *
19904     * @param obj The slideshow object
19905     * @param itc The item class for the item
19906     * @param data The item's data
19907     * @param func The comparing function to be used to sort slideshow
19908     * items <b>by #Elm_Slideshow_Item item handles</b>
19909     * @return Returns The slideshow item handle, on success, or
19910     * @c NULL, on errors
19911     *
19912     * Add a new item to @p obj's internal list of items, in a position
19913     * determined by the @p func comparing function. The item's class
19914     * must contain the function really fetching the image object to
19915     * show for this item, which could be an Evas image object or an
19916     * Elementary photo, for example. The @p data parameter is going to
19917     * be passed to both class functions of the item.
19918     *
19919     * @see #Elm_Slideshow_Item_Class
19920     * @see elm_slideshow_item_add()
19921     *
19922     * @ingroup Slideshow
19923     */
19924    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);
19925
19926    /**
19927     * Display a given slideshow widget's item, programmatically.
19928     *
19929     * @param obj The slideshow object
19930     * @param item The item to display on @p obj's viewport
19931     *
19932     * The change between the current item and @p item will use the
19933     * transition @p obj is set to use (@see
19934     * elm_slideshow_transition_set()).
19935     *
19936     * @ingroup Slideshow
19937     */
19938    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19939
19940    /**
19941     * Slide to the @b next item, in a given slideshow widget
19942     *
19943     * @param obj The slideshow object
19944     *
19945     * The sliding animation @p obj is set to use will be the
19946     * transition effect used, after this call is issued.
19947     *
19948     * @note If the end of the slideshow's internal list of items is
19949     * reached, it'll wrap around to the list's beginning, again.
19950     *
19951     * @ingroup Slideshow
19952     */
19953    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
19954
19955    /**
19956     * Slide to the @b previous item, in a given slideshow widget
19957     *
19958     * @param obj The slideshow object
19959     *
19960     * The sliding animation @p obj is set to use will be the
19961     * transition effect used, after this call is issued.
19962     *
19963     * @note If the beginning of the slideshow's internal list of items
19964     * is reached, it'll wrap around to the list's end, again.
19965     *
19966     * @ingroup Slideshow
19967     */
19968    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
19969
19970    /**
19971     * Returns the list of sliding transition/effect names available, for a
19972     * given slideshow widget.
19973     *
19974     * @param obj The slideshow object
19975     * @return The list of transitions (list of @b stringshared strings
19976     * as data)
19977     *
19978     * The transitions, which come from @p obj's theme, must be an EDC
19979     * data item named @c "transitions" on the theme file, with (prefix)
19980     * names of EDC programs actually implementing them.
19981     *
19982     * The available transitions for slideshows on the default theme are:
19983     * - @c "fade" - the current item fades out, while the new one
19984     *   fades in to the slideshow's viewport.
19985     * - @c "black_fade" - the current item fades to black, and just
19986     *   then, the new item will fade in.
19987     * - @c "horizontal" - the current item slides horizontally, until
19988     *   it gets out of the slideshow's viewport, while the new item
19989     *   comes from the left to take its place.
19990     * - @c "vertical" - the current item slides vertically, until it
19991     *   gets out of the slideshow's viewport, while the new item comes
19992     *   from the bottom to take its place.
19993     * - @c "square" - the new item starts to appear from the middle of
19994     *   the current one, but with a tiny size, growing until its
19995     *   target (full) size and covering the old one.
19996     *
19997     * @warning The stringshared strings get no new references
19998     * exclusive to the user grabbing the list, here, so if you'd like
19999     * to use them out of this call's context, you'd better @c
20000     * eina_stringshare_ref() them.
20001     *
20002     * @see elm_slideshow_transition_set()
20003     *
20004     * @ingroup Slideshow
20005     */
20006    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20007
20008    /**
20009     * Set the current slide transition/effect in use for a given
20010     * slideshow widget
20011     *
20012     * @param obj The slideshow object
20013     * @param transition The new transition's name string
20014     *
20015     * If @p transition is implemented in @p obj's theme (i.e., is
20016     * contained in the list returned by
20017     * elm_slideshow_transitions_get()), this new sliding effect will
20018     * be used on the widget.
20019     *
20020     * @see elm_slideshow_transitions_get() for more details
20021     *
20022     * @ingroup Slideshow
20023     */
20024    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20025
20026    /**
20027     * Get the current slide transition/effect in use for a given
20028     * slideshow widget
20029     *
20030     * @param obj The slideshow object
20031     * @return The current transition's name
20032     *
20033     * @see elm_slideshow_transition_set() for more details
20034     *
20035     * @ingroup Slideshow
20036     */
20037    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20038
20039    /**
20040     * Set the interval between each image transition on a given
20041     * slideshow widget, <b>and start the slideshow, itself</b>
20042     *
20043     * @param obj The slideshow object
20044     * @param timeout The new displaying timeout for images
20045     *
20046     * After this call, the slideshow widget will start cycling its
20047     * view, sequentially and automatically, with the images of the
20048     * items it has. The time between each new image displayed is going
20049     * to be @p timeout, in @b seconds. If a different timeout was set
20050     * previously and an slideshow was in progress, it will continue
20051     * with the new time between transitions, after this call.
20052     *
20053     * @note A value less than or equal to 0 on @p timeout will disable
20054     * the widget's internal timer, thus halting any slideshow which
20055     * could be happening on @p obj.
20056     *
20057     * @see elm_slideshow_timeout_get()
20058     *
20059     * @ingroup Slideshow
20060     */
20061    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20062
20063    /**
20064     * Get the interval set for image transitions on a given slideshow
20065     * widget.
20066     *
20067     * @param obj The slideshow object
20068     * @return Returns the timeout set on it
20069     *
20070     * @see elm_slideshow_timeout_set() for more details
20071     *
20072     * @ingroup Slideshow
20073     */
20074    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20075
20076    /**
20077     * Set if, after a slideshow is started, for a given slideshow
20078     * widget, its items should be displayed cyclically or not.
20079     *
20080     * @param obj The slideshow object
20081     * @param loop Use @c EINA_TRUE to make it cycle through items or
20082     * @c EINA_FALSE for it to stop at the end of @p obj's internal
20083     * list of items
20084     *
20085     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20086     * ignore what is set by this functions, i.e., they'll @b always
20087     * cycle through items. This affects only the "automatic"
20088     * slideshow, as set by elm_slideshow_timeout_set().
20089     *
20090     * @see elm_slideshow_loop_get()
20091     *
20092     * @ingroup Slideshow
20093     */
20094    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20095
20096    /**
20097     * Get if, after a slideshow is started, for a given slideshow
20098     * widget, its items are to be displayed cyclically or not.
20099     *
20100     * @param obj The slideshow object
20101     * @return @c EINA_TRUE, if the items in @p obj will be cycled
20102     * through or @c EINA_FALSE, otherwise
20103     *
20104     * @see elm_slideshow_loop_set() for more details
20105     *
20106     * @ingroup Slideshow
20107     */
20108    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20109
20110    /**
20111     * Remove all items from a given slideshow widget
20112     *
20113     * @param obj The slideshow object
20114     *
20115     * This removes (and deletes) all items in @p obj, leaving it
20116     * empty.
20117     *
20118     * @see elm_slideshow_item_del(), to remove just one item.
20119     *
20120     * @ingroup Slideshow
20121     */
20122    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20123
20124    /**
20125     * Get the internal list of items in a given slideshow widget.
20126     *
20127     * @param obj The slideshow object
20128     * @return The list of items (#Elm_Slideshow_Item as data) or
20129     * @c NULL on errors.
20130     *
20131     * This list is @b not to be modified in any way and must not be
20132     * freed. Use the list members with functions like
20133     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20134     *
20135     * @warning This list is only valid until @p obj object's internal
20136     * items list is changed. It should be fetched again with another
20137     * call to this function when changes happen.
20138     *
20139     * @ingroup Slideshow
20140     */
20141    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20142
20143    /**
20144     * Delete a given item from a slideshow widget.
20145     *
20146     * @param item The slideshow item
20147     *
20148     * @ingroup Slideshow
20149     */
20150    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20151
20152    /**
20153     * Return the data associated with a given slideshow item
20154     *
20155     * @param item The slideshow item
20156     * @return Returns the data associated to this item
20157     *
20158     * @ingroup Slideshow
20159     */
20160    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20161
20162    /**
20163     * Returns the currently displayed item, in a given slideshow widget
20164     *
20165     * @param obj The slideshow object
20166     * @return A handle to the item being displayed in @p obj or
20167     * @c NULL, if none is (and on errors)
20168     *
20169     * @ingroup Slideshow
20170     */
20171    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20172
20173    /**
20174     * Get the real Evas object created to implement the view of a
20175     * given slideshow item
20176     *
20177     * @param item The slideshow item.
20178     * @return the Evas object implementing this item's view.
20179     *
20180     * This returns the actual Evas object used to implement the
20181     * specified slideshow item's view. This may be @c NULL, as it may
20182     * not have been created or may have been deleted, at any time, by
20183     * the slideshow. <b>Do not modify this object</b> (move, resize,
20184     * show, hide, etc.), as the slideshow is controlling it. This
20185     * function is for querying, emitting custom signals or hooking
20186     * lower level callbacks for events on that object. Do not delete
20187     * this object under any circumstances.
20188     *
20189     * @see elm_slideshow_item_data_get()
20190     *
20191     * @ingroup Slideshow
20192     */
20193    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20194
20195    /**
20196     * Get the the item, in a given slideshow widget, placed at
20197     * position @p nth, in its internal items list
20198     *
20199     * @param obj The slideshow object
20200     * @param nth The number of the item to grab a handle to (0 being
20201     * the first)
20202     * @return The item stored in @p obj at position @p nth or @c NULL,
20203     * if there's no item with that index (and on errors)
20204     *
20205     * @ingroup Slideshow
20206     */
20207    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20208
20209    /**
20210     * Set the current slide layout in use for a given slideshow widget
20211     *
20212     * @param obj The slideshow object
20213     * @param layout The new layout's name string
20214     *
20215     * If @p layout is implemented in @p obj's theme (i.e., is contained
20216     * in the list returned by elm_slideshow_layouts_get()), this new
20217     * images layout will be used on the widget.
20218     *
20219     * @see elm_slideshow_layouts_get() for more details
20220     *
20221     * @ingroup Slideshow
20222     */
20223    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20224
20225    /**
20226     * Get the current slide layout in use for a given slideshow widget
20227     *
20228     * @param obj The slideshow object
20229     * @return The current layout's name
20230     *
20231     * @see elm_slideshow_layout_set() for more details
20232     *
20233     * @ingroup Slideshow
20234     */
20235    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20236
20237    /**
20238     * Returns the list of @b layout names available, for a given
20239     * slideshow widget.
20240     *
20241     * @param obj The slideshow object
20242     * @return The list of layouts (list of @b stringshared strings
20243     * as data)
20244     *
20245     * Slideshow layouts will change how the widget is to dispose each
20246     * image item in its viewport, with regard to cropping, scaling,
20247     * etc.
20248     *
20249     * The layouts, which come from @p obj's theme, must be an EDC
20250     * data item name @c "layouts" on the theme file, with (prefix)
20251     * names of EDC programs actually implementing them.
20252     *
20253     * The available layouts for slideshows on the default theme are:
20254     * - @c "fullscreen" - item images with original aspect, scaled to
20255     *   touch top and down slideshow borders or, if the image's heigh
20256     *   is not enough, left and right slideshow borders.
20257     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20258     *   one, but always leaving 10% of the slideshow's dimensions of
20259     *   distance between the item image's borders and the slideshow
20260     *   borders, for each axis.
20261     *
20262     * @warning The stringshared strings get no new references
20263     * exclusive to the user grabbing the list, here, so if you'd like
20264     * to use them out of this call's context, you'd better @c
20265     * eina_stringshare_ref() them.
20266     *
20267     * @see elm_slideshow_layout_set()
20268     *
20269     * @ingroup Slideshow
20270     */
20271    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20272
20273    /**
20274     * Set the number of items to cache, on a given slideshow widget,
20275     * <b>before the current item</b>
20276     *
20277     * @param obj The slideshow object
20278     * @param count Number of items to cache before the current one
20279     *
20280     * The default value for this property is @c 2. See
20281     * @ref Slideshow_Caching "slideshow caching" for more details.
20282     *
20283     * @see elm_slideshow_cache_before_get()
20284     *
20285     * @ingroup Slideshow
20286     */
20287    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20288
20289    /**
20290     * Retrieve the number of items to cache, on a given slideshow widget,
20291     * <b>before the current item</b>
20292     *
20293     * @param obj The slideshow object
20294     * @return The number of items set to be cached before the current one
20295     *
20296     * @see elm_slideshow_cache_before_set() for more details
20297     *
20298     * @ingroup Slideshow
20299     */
20300    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20301
20302    /**
20303     * Set the number of items to cache, on a given slideshow widget,
20304     * <b>after the current item</b>
20305     *
20306     * @param obj The slideshow object
20307     * @param count Number of items to cache after the current one
20308     *
20309     * The default value for this property is @c 2. See
20310     * @ref Slideshow_Caching "slideshow caching" for more details.
20311     *
20312     * @see elm_slideshow_cache_after_get()
20313     *
20314     * @ingroup Slideshow
20315     */
20316    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20317
20318    /**
20319     * Retrieve the number of items to cache, on a given slideshow widget,
20320     * <b>after the current item</b>
20321     *
20322     * @param obj The slideshow object
20323     * @return The number of items set to be cached after the current one
20324     *
20325     * @see elm_slideshow_cache_after_set() for more details
20326     *
20327     * @ingroup Slideshow
20328     */
20329    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20330
20331    /**
20332     * Get the number of items stored in a given slideshow widget
20333     *
20334     * @param obj The slideshow object
20335     * @return The number of items on @p obj, at the moment of this call
20336     *
20337     * @ingroup Slideshow
20338     */
20339    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20340
20341    /**
20342     * @}
20343     */
20344
20345    /**
20346     * @defgroup Fileselector File Selector
20347     *
20348     * @image html img/widget/fileselector/preview-00.png
20349     * @image latex img/widget/fileselector/preview-00.eps
20350     *
20351     * A file selector is a widget that allows a user to navigate
20352     * through a file system, reporting file selections back via its
20353     * API.
20354     *
20355     * It contains shortcut buttons for home directory (@c ~) and to
20356     * jump one directory upwards (..), as well as cancel/ok buttons to
20357     * confirm/cancel a given selection. After either one of those two
20358     * former actions, the file selector will issue its @c "done" smart
20359     * callback.
20360     *
20361     * There's a text entry on it, too, showing the name of the current
20362     * selection. There's the possibility of making it editable, so it
20363     * is useful on file saving dialogs on applications, where one
20364     * gives a file name to save contents to, in a given directory in
20365     * the system. This custom file name will be reported on the @c
20366     * "done" smart callback (explained in sequence).
20367     *
20368     * Finally, it has a view to display file system items into in two
20369     * possible forms:
20370     * - list
20371     * - grid
20372     *
20373     * If Elementary is built with support of the Ethumb thumbnailing
20374     * library, the second form of view will display preview thumbnails
20375     * of files which it supports.
20376     *
20377     * Smart callbacks one can register to:
20378     *
20379     * - @c "selected" - the user has clicked on a file (when not in
20380     *      folders-only mode) or directory (when in folders-only mode)
20381     * - @c "directory,open" - the list has been populated with new
20382     *      content (@c event_info is a pointer to the directory's
20383     *      path, a @b stringshared string)
20384     * - @c "done" - the user has clicked on the "ok" or "cancel"
20385     *      buttons (@c event_info is a pointer to the selection's
20386     *      path, a @b stringshared string)
20387     *
20388     * Here is an example on its usage:
20389     * @li @ref fileselector_example
20390     */
20391
20392    /**
20393     * @addtogroup Fileselector
20394     * @{
20395     */
20396
20397    /**
20398     * Defines how a file selector widget is to layout its contents
20399     * (file system entries).
20400     */
20401    typedef enum _Elm_Fileselector_Mode
20402      {
20403         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20404         ELM_FILESELECTOR_GRID, /**< layout as a grid */
20405         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20406      } Elm_Fileselector_Mode;
20407
20408    /**
20409     * Add a new file selector widget to the given parent Elementary
20410     * (container) object
20411     *
20412     * @param parent The parent object
20413     * @return a new file selector widget handle or @c NULL, on errors
20414     *
20415     * This function inserts a new file selector widget on the canvas.
20416     *
20417     * @ingroup Fileselector
20418     */
20419    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20420
20421    /**
20422     * Enable/disable the file name entry box where the user can type
20423     * in a name for a file, in a given file selector widget
20424     *
20425     * @param obj The file selector object
20426     * @param is_save @c EINA_TRUE to make the file selector a "saving
20427     * dialog", @c EINA_FALSE otherwise
20428     *
20429     * Having the entry editable is useful on file saving dialogs on
20430     * applications, where one gives a file name to save contents to,
20431     * in a given directory in the system. This custom file name will
20432     * be reported on the @c "done" smart callback.
20433     *
20434     * @see elm_fileselector_is_save_get()
20435     *
20436     * @ingroup Fileselector
20437     */
20438    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20439
20440    /**
20441     * Get whether the given file selector is in "saving dialog" mode
20442     *
20443     * @param obj The file selector object
20444     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20445     * mode, @c EINA_FALSE otherwise (and on errors)
20446     *
20447     * @see elm_fileselector_is_save_set() for more details
20448     *
20449     * @ingroup Fileselector
20450     */
20451    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20452
20453    /**
20454     * Enable/disable folder-only view for a given file selector widget
20455     *
20456     * @param obj The file selector object
20457     * @param only @c EINA_TRUE to make @p obj only display
20458     * directories, @c EINA_FALSE to make files to be displayed in it
20459     * too
20460     *
20461     * If enabled, the widget's view will only display folder items,
20462     * naturally.
20463     *
20464     * @see elm_fileselector_folder_only_get()
20465     *
20466     * @ingroup Fileselector
20467     */
20468    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20469
20470    /**
20471     * Get whether folder-only view is set for a given file selector
20472     * widget
20473     *
20474     * @param obj The file selector object
20475     * @return only @c EINA_TRUE if @p obj is only displaying
20476     * directories, @c EINA_FALSE if files are being displayed in it
20477     * too (and on errors)
20478     *
20479     * @see elm_fileselector_folder_only_get()
20480     *
20481     * @ingroup Fileselector
20482     */
20483    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20484
20485    /**
20486     * Enable/disable the "ok" and "cancel" buttons on a given file
20487     * selector widget
20488     *
20489     * @param obj The file selector object
20490     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20491     *
20492     * @note A file selector without those buttons will never emit the
20493     * @c "done" smart event, and is only usable if one is just hooking
20494     * to the other two events.
20495     *
20496     * @see elm_fileselector_buttons_ok_cancel_get()
20497     *
20498     * @ingroup Fileselector
20499     */
20500    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20501
20502    /**
20503     * Get whether the "ok" and "cancel" buttons on a given file
20504     * selector widget are being shown.
20505     *
20506     * @param obj The file selector object
20507     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20508     * otherwise (and on errors)
20509     *
20510     * @see elm_fileselector_buttons_ok_cancel_set() for more details
20511     *
20512     * @ingroup Fileselector
20513     */
20514    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20515
20516    /**
20517     * Enable/disable a tree view in the given file selector widget,
20518     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20519     *
20520     * @param obj The file selector object
20521     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20522     * disable
20523     *
20524     * In a tree view, arrows are created on the sides of directories,
20525     * allowing them to expand in place.
20526     *
20527     * @note If it's in other mode, the changes made by this function
20528     * will only be visible when one switches back to "list" mode.
20529     *
20530     * @see elm_fileselector_expandable_get()
20531     *
20532     * @ingroup Fileselector
20533     */
20534    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20535
20536    /**
20537     * Get whether tree view is enabled for the given file selector
20538     * widget
20539     *
20540     * @param obj The file selector object
20541     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20542     * otherwise (and or errors)
20543     *
20544     * @see elm_fileselector_expandable_set() for more details
20545     *
20546     * @ingroup Fileselector
20547     */
20548    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20549
20550    /**
20551     * Set, programmatically, the @b directory that a given file
20552     * selector widget will display contents from
20553     *
20554     * @param obj The file selector object
20555     * @param path The path to display in @p obj
20556     *
20557     * This will change the @b directory that @p obj is displaying. It
20558     * will also clear the text entry area on the @p obj object, which
20559     * displays select files' names.
20560     *
20561     * @see elm_fileselector_path_get()
20562     *
20563     * @ingroup Fileselector
20564     */
20565    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20566
20567    /**
20568     * Get the parent directory's path that a given file selector
20569     * widget is displaying
20570     *
20571     * @param obj The file selector object
20572     * @return The (full) path of the directory the file selector is
20573     * displaying, a @b stringshared string
20574     *
20575     * @see elm_fileselector_path_set()
20576     *
20577     * @ingroup Fileselector
20578     */
20579    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20580
20581    /**
20582     * Set, programmatically, the currently selected file/directory in
20583     * the given file selector widget
20584     *
20585     * @param obj The file selector object
20586     * @param path The (full) path to a file or directory
20587     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20588     * latter case occurs if the directory or file pointed to do not
20589     * exist.
20590     *
20591     * @see elm_fileselector_selected_get()
20592     *
20593     * @ingroup Fileselector
20594     */
20595    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20596
20597    /**
20598     * Get the currently selected item's (full) path, in the given file
20599     * selector widget
20600     *
20601     * @param obj The file selector object
20602     * @return The absolute path of the selected item, a @b
20603     * stringshared string
20604     *
20605     * @note Custom editions on @p obj object's text entry, if made,
20606     * will appear on the return string of this function, naturally.
20607     *
20608     * @see elm_fileselector_selected_set() for more details
20609     *
20610     * @ingroup Fileselector
20611     */
20612    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20613
20614    /**
20615     * Set the mode in which a given file selector widget will display
20616     * (layout) file system entries in its view
20617     *
20618     * @param obj The file selector object
20619     * @param mode The mode of the fileselector, being it one of
20620     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20621     * first one, naturally, will display the files in a list. The
20622     * latter will make the widget to display its entries in a grid
20623     * form.
20624     *
20625     * @note By using elm_fileselector_expandable_set(), the user may
20626     * trigger a tree view for that list.
20627     *
20628     * @note If Elementary is built with support of the Ethumb
20629     * thumbnailing library, the second form of view will display
20630     * preview thumbnails of files which it supports. You must have
20631     * elm_need_ethumb() called in your Elementary for thumbnailing to
20632     * work, though.
20633     *
20634     * @see elm_fileselector_expandable_set().
20635     * @see elm_fileselector_mode_get().
20636     *
20637     * @ingroup Fileselector
20638     */
20639    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20640
20641    /**
20642     * Get the mode in which a given file selector widget is displaying
20643     * (layouting) file system entries in its view
20644     *
20645     * @param obj The fileselector object
20646     * @return The mode in which the fileselector is at
20647     *
20648     * @see elm_fileselector_mode_set() for more details
20649     *
20650     * @ingroup Fileselector
20651     */
20652    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20653
20654    /**
20655     * @}
20656     */
20657
20658    /**
20659     * @defgroup Progressbar Progress bar
20660     *
20661     * The progress bar is a widget for visually representing the
20662     * progress status of a given job/task.
20663     *
20664     * A progress bar may be horizontal or vertical. It may display an
20665     * icon besides it, as well as primary and @b units labels. The
20666     * former is meant to label the widget as a whole, while the
20667     * latter, which is formatted with floating point values (and thus
20668     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20669     * units"</c>), is meant to label the widget's <b>progress
20670     * value</b>. Label, icon and unit strings/objects are @b optional
20671     * for progress bars.
20672     *
20673     * A progress bar may be @b inverted, in which state it gets its
20674     * values inverted, with high values being on the left or top and
20675     * low values on the right or bottom, as opposed to normally have
20676     * the low values on the former and high values on the latter,
20677     * respectively, for horizontal and vertical modes.
20678     *
20679     * The @b span of the progress, as set by
20680     * elm_progressbar_span_size_set(), is its length (horizontally or
20681     * vertically), unless one puts size hints on the widget to expand
20682     * on desired directions, by any container. That length will be
20683     * scaled by the object or applications scaling factor. At any
20684     * point code can query the progress bar for its value with
20685     * elm_progressbar_value_get().
20686     *
20687     * Available widget styles for progress bars:
20688     * - @c "default"
20689     * - @c "wheel" (simple style, no text, no progression, only
20690     *      "pulse" effect is available)
20691     *
20692     * Here is an example on its usage:
20693     * @li @ref progressbar_example
20694     */
20695
20696    /**
20697     * Add a new progress bar widget to the given parent Elementary
20698     * (container) object
20699     *
20700     * @param parent The parent object
20701     * @return a new progress bar widget handle or @c NULL, on errors
20702     *
20703     * This function inserts a new progress bar widget on the canvas.
20704     *
20705     * @ingroup Progressbar
20706     */
20707    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20708
20709    /**
20710     * Set whether a given progress bar widget is at "pulsing mode" or
20711     * not.
20712     *
20713     * @param obj The progress bar object
20714     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
20715     * @c EINA_FALSE to put it back to its default one
20716     *
20717     * By default, progress bars will display values from the low to
20718     * high value boundaries. There are, though, contexts in which the
20719     * state of progression of a given task is @b unknown.  For those,
20720     * one can set a progress bar widget to a "pulsing state", to give
20721     * the user an idea that some computation is being held, but
20722     * without exact progress values. In the default theme it will
20723     * animate its bar with the contents filling in constantly and back
20724     * to non-filled, in a loop. To start and stop this pulsing
20725     * animation, one has to explicitly call elm_progressbar_pulse().
20726     *
20727     * @see elm_progressbar_pulse_get()
20728     * @see elm_progressbar_pulse()
20729     *
20730     * @ingroup Progressbar
20731     */
20732    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
20733
20734    /**
20735     * Get whether a given progress bar widget is at "pulsing mode" or
20736     * not.
20737     *
20738     * @param obj The progress bar object
20739     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
20740     * if it's in the default one (and on errors)
20741     *
20742     * @ingroup Progressbar
20743     */
20744    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20745
20746    /**
20747     * Start/stop a given progress bar "pulsing" animation, if its
20748     * under that mode
20749     *
20750     * @param obj The progress bar object
20751     * @param state @c EINA_TRUE, to @b start the pulsing animation,
20752     * @c EINA_FALSE to @b stop it
20753     *
20754     * @note This call won't do anything if @p obj is not under "pulsing mode".
20755     *
20756     * @see elm_progressbar_pulse_set() for more details.
20757     *
20758     * @ingroup Progressbar
20759     */
20760    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20761
20762    /**
20763     * Set the progress value (in percentage) on a given progress bar
20764     * widget
20765     *
20766     * @param obj The progress bar object
20767     * @param val The progress value (@b must be between @c 0.0 and @c
20768     * 1.0)
20769     *
20770     * Use this call to set progress bar levels.
20771     *
20772     * @note If you passes a value out of the specified range for @p
20773     * val, it will be interpreted as the @b closest of the @b boundary
20774     * values in the range.
20775     *
20776     * @ingroup Progressbar
20777     */
20778    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20779
20780    /**
20781     * Get the progress value (in percentage) on a given progress bar
20782     * widget
20783     *
20784     * @param obj The progress bar object
20785     * @return The value of the progressbar
20786     *
20787     * @see elm_progressbar_value_set() for more details
20788     *
20789     * @ingroup Progressbar
20790     */
20791    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20792
20793    /**
20794     * Set the label of a given progress bar widget
20795     *
20796     * @param obj The progress bar object
20797     * @param label The text label string, in UTF-8
20798     *
20799     * @ingroup Progressbar
20800     * @deprecated use elm_object_text_set() instead.
20801     */
20802    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20803
20804    /**
20805     * Get the label of a given progress bar widget
20806     *
20807     * @param obj The progressbar object
20808     * @return The text label string, in UTF-8
20809     *
20810     * @ingroup Progressbar
20811     * @deprecated use elm_object_text_set() instead.
20812     */
20813    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20814
20815    /**
20816     * Set the icon object of a given progress bar widget
20817     *
20818     * @param obj The progress bar object
20819     * @param icon The icon object
20820     *
20821     * Use this call to decorate @p obj with an icon next to it.
20822     *
20823     * @note Once the icon object is set, a previously set one will be
20824     * deleted. If you want to keep that old content object, use the
20825     * elm_progressbar_icon_unset() function.
20826     *
20827     * @see elm_progressbar_icon_get()
20828     *
20829     * @ingroup Progressbar
20830     */
20831    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20832
20833    /**
20834     * Retrieve the icon object set for a given progress bar widget
20835     *
20836     * @param obj The progress bar object
20837     * @return The icon object's handle, if @p obj had one set, or @c NULL,
20838     * otherwise (and on errors)
20839     *
20840     * @see elm_progressbar_icon_set() for more details
20841     *
20842     * @ingroup Progressbar
20843     */
20844    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20845
20846    /**
20847     * Unset an icon set on a given progress bar widget
20848     *
20849     * @param obj The progress bar object
20850     * @return The icon object that was being used, if any was set, or
20851     * @c NULL, otherwise (and on errors)
20852     *
20853     * This call will unparent and return the icon object which was set
20854     * for this widget, previously, on success.
20855     *
20856     * @see elm_progressbar_icon_set() for more details
20857     *
20858     * @ingroup Progressbar
20859     */
20860    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20861
20862    /**
20863     * Set the (exact) length of the bar region of a given progress bar
20864     * widget
20865     *
20866     * @param obj The progress bar object
20867     * @param size The length of the progress bar's bar region
20868     *
20869     * This sets the minimum width (when in horizontal mode) or height
20870     * (when in vertical mode) of the actual bar area of the progress
20871     * bar @p obj. This in turn affects the object's minimum size. Use
20872     * this when you're not setting other size hints expanding on the
20873     * given direction (like weight and alignment hints) and you would
20874     * like it to have a specific size.
20875     *
20876     * @note Icon, label and unit text around @p obj will require their
20877     * own space, which will make @p obj to require more the @p size,
20878     * actually.
20879     *
20880     * @see elm_progressbar_span_size_get()
20881     *
20882     * @ingroup Progressbar
20883     */
20884    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
20885
20886    /**
20887     * Get the length set for the bar region of a given progress bar
20888     * widget
20889     *
20890     * @param obj The progress bar object
20891     * @return The length of the progress bar's bar region
20892     *
20893     * If that size was not set previously, with
20894     * elm_progressbar_span_size_set(), this call will return @c 0.
20895     *
20896     * @ingroup Progressbar
20897     */
20898    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20899
20900    /**
20901     * Set the format string for a given progress bar widget's units
20902     * label
20903     *
20904     * @param obj The progress bar object
20905     * @param format The format string for @p obj's units label
20906     *
20907     * If @c NULL is passed on @p format, it will make @p obj's units
20908     * area to be hidden completely. If not, it'll set the <b>format
20909     * string</b> for the units label's @b text. The units label is
20910     * provided a floating point value, so the units text is up display
20911     * at most one floating point falue. Note that the units label is
20912     * optional. Use a format string such as "%1.2f meters" for
20913     * example.
20914     *
20915     * @note The default format string for a progress bar is an integer
20916     * percentage, as in @c "%.0f %%".
20917     *
20918     * @see elm_progressbar_unit_format_get()
20919     *
20920     * @ingroup Progressbar
20921     */
20922    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
20923
20924    /**
20925     * Retrieve the format string set for a given progress bar widget's
20926     * units label
20927     *
20928     * @param obj The progress bar object
20929     * @return The format set string for @p obj's units label or
20930     * @c NULL, if none was set (and on errors)
20931     *
20932     * @see elm_progressbar_unit_format_set() for more details
20933     *
20934     * @ingroup Progressbar
20935     */
20936    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20937
20938    /**
20939     * Set the orientation of a given progress bar widget
20940     *
20941     * @param obj The progress bar object
20942     * @param horizontal Use @c EINA_TRUE to make @p obj to be
20943     * @b horizontal, @c EINA_FALSE to make it @b vertical
20944     *
20945     * Use this function to change how your progress bar is to be
20946     * disposed: vertically or horizontally.
20947     *
20948     * @see elm_progressbar_horizontal_get()
20949     *
20950     * @ingroup Progressbar
20951     */
20952    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20953
20954    /**
20955     * Retrieve the orientation of a given progress bar widget
20956     *
20957     * @param obj The progress bar object
20958     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20959     * @c EINA_FALSE if it's @b vertical (and on errors)
20960     *
20961     * @see elm_progressbar_horizontal_set() for more details
20962     *
20963     * @ingroup Progressbar
20964     */
20965    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20966
20967    /**
20968     * Invert a given progress bar widget's displaying values order
20969     *
20970     * @param obj The progress bar object
20971     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
20972     * @c EINA_FALSE to bring it back to default, non-inverted values.
20973     *
20974     * A progress bar may be @b inverted, in which state it gets its
20975     * values inverted, with high values being on the left or top and
20976     * low values on the right or bottom, as opposed to normally have
20977     * the low values on the former and high values on the latter,
20978     * respectively, for horizontal and vertical modes.
20979     *
20980     * @see elm_progressbar_inverted_get()
20981     *
20982     * @ingroup Progressbar
20983     */
20984    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
20985
20986    /**
20987     * Get whether a given progress bar widget's displaying values are
20988     * inverted or not
20989     *
20990     * @param obj The progress bar object
20991     * @return @c EINA_TRUE, if @p obj has inverted values,
20992     * @c EINA_FALSE otherwise (and on errors)
20993     *
20994     * @see elm_progressbar_inverted_set() for more details
20995     *
20996     * @ingroup Progressbar
20997     */
20998    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20999
21000    /**
21001     * @defgroup Separator Separator
21002     *
21003     * @brief Separator is a very thin object used to separate other objects.
21004     *
21005     * A separator can be vertical or horizontal.
21006     *
21007     * @ref tutorial_separator is a good example of how to use a separator.
21008     * @{
21009     */
21010    /**
21011     * @brief Add a separator object to @p parent
21012     *
21013     * @param parent The parent object
21014     *
21015     * @return The separator object, or NULL upon failure
21016     */
21017    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21018    /**
21019     * @brief Set the horizontal mode of a separator object
21020     *
21021     * @param obj The separator object
21022     * @param horizontal If true, the separator is horizontal
21023     */
21024    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21025    /**
21026     * @brief Get the horizontal mode of a separator object
21027     *
21028     * @param obj The separator object
21029     * @return If true, the separator is horizontal
21030     *
21031     * @see elm_separator_horizontal_set()
21032     */
21033    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21034    /**
21035     * @}
21036     */
21037
21038    /**
21039     * @defgroup Spinner Spinner
21040     * @ingroup Elementary
21041     *
21042     * @image html img/widget/spinner/preview-00.png
21043     * @image latex img/widget/spinner/preview-00.eps
21044     *
21045     * A spinner is a widget which allows the user to increase or decrease
21046     * numeric values using arrow buttons, or edit values directly, clicking
21047     * over it and typing the new value.
21048     *
21049     * By default the spinner will not wrap and has a label
21050     * of "%.0f" (just showing the integer value of the double).
21051     *
21052     * A spinner has a label that is formatted with floating
21053     * point values and thus accepts a printf-style format string, like
21054     * “%1.2f units”.
21055     *
21056     * It also allows specific values to be replaced by pre-defined labels.
21057     *
21058     * Smart callbacks one can register to:
21059     *
21060     * - "changed" - Whenever the spinner value is changed.
21061     * - "delay,changed" - A short time after the value is changed by the user.
21062     *    This will be called only when the user stops dragging for a very short
21063     *    period or when they release their finger/mouse, so it avoids possibly
21064     *    expensive reactions to the value change.
21065     *
21066     * Available styles for it:
21067     * - @c "default";
21068     * - @c "vertical": up/down buttons at the right side and text left aligned.
21069     *
21070     * Here is an example on its usage:
21071     * @ref spinner_example
21072     */
21073
21074    /**
21075     * @addtogroup Spinner
21076     * @{
21077     */
21078
21079    /**
21080     * Add a new spinner widget to the given parent Elementary
21081     * (container) object.
21082     *
21083     * @param parent The parent object.
21084     * @return a new spinner widget handle or @c NULL, on errors.
21085     *
21086     * This function inserts a new spinner widget on the canvas.
21087     *
21088     * @ingroup Spinner
21089     *
21090     */
21091    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21092
21093    /**
21094     * Set the format string of the displayed label.
21095     *
21096     * @param obj The spinner object.
21097     * @param fmt The format string for the label display.
21098     *
21099     * If @c NULL, this sets the format to "%.0f". If not it sets the format
21100     * string for the label text. The label text is provided a floating point
21101     * value, so the label text can display up to 1 floating point value.
21102     * Note that this is optional.
21103     *
21104     * Use a format string such as "%1.2f meters" for example, and it will
21105     * display values like: "3.14 meters" for a value equal to 3.14159.
21106     *
21107     * Default is "%0.f".
21108     *
21109     * @see elm_spinner_label_format_get()
21110     *
21111     * @ingroup Spinner
21112     */
21113    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21114
21115    /**
21116     * Get the label format of the spinner.
21117     *
21118     * @param obj The spinner object.
21119     * @return The text label format string in UTF-8.
21120     *
21121     * @see elm_spinner_label_format_set() for details.
21122     *
21123     * @ingroup Spinner
21124     */
21125    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21126
21127    /**
21128     * Set the minimum and maximum values for the spinner.
21129     *
21130     * @param obj The spinner object.
21131     * @param min The minimum value.
21132     * @param max The maximum value.
21133     *
21134     * Define the allowed range of values to be selected by the user.
21135     *
21136     * If actual value is less than @p min, it will be updated to @p min. If it
21137     * is bigger then @p max, will be updated to @p max. Actual value can be
21138     * get with elm_spinner_value_get().
21139     *
21140     * By default, min is equal to 0, and max is equal to 100.
21141     *
21142     * @warning Maximum must be greater than minimum.
21143     *
21144     * @see elm_spinner_min_max_get()
21145     *
21146     * @ingroup Spinner
21147     */
21148    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21149
21150    /**
21151     * Get the minimum and maximum values of the spinner.
21152     *
21153     * @param obj The spinner object.
21154     * @param min Pointer where to store the minimum value.
21155     * @param max Pointer where to store the maximum value.
21156     *
21157     * @note If only one value is needed, the other pointer can be passed
21158     * as @c NULL.
21159     *
21160     * @see elm_spinner_min_max_set() for details.
21161     *
21162     * @ingroup Spinner
21163     */
21164    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21165
21166    /**
21167     * Set the step used to increment or decrement the spinner value.
21168     *
21169     * @param obj The spinner object.
21170     * @param step The step value.
21171     *
21172     * This value will be incremented or decremented to the displayed value.
21173     * It will be incremented while the user keep right or top arrow pressed,
21174     * and will be decremented while the user keep left or bottom arrow pressed.
21175     *
21176     * The interval to increment / decrement can be set with
21177     * elm_spinner_interval_set().
21178     *
21179     * By default step value is equal to 1.
21180     *
21181     * @see elm_spinner_step_get()
21182     *
21183     * @ingroup Spinner
21184     */
21185    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21186
21187    /**
21188     * Get the step used to increment or decrement the spinner value.
21189     *
21190     * @param obj The spinner object.
21191     * @return The step value.
21192     *
21193     * @see elm_spinner_step_get() for more details.
21194     *
21195     * @ingroup Spinner
21196     */
21197    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21198
21199    /**
21200     * Set the value the spinner displays.
21201     *
21202     * @param obj The spinner object.
21203     * @param val The value to be displayed.
21204     *
21205     * Value will be presented on the label following format specified with
21206     * elm_spinner_format_set().
21207     *
21208     * @warning The value must to be between min and max values. This values
21209     * are set by elm_spinner_min_max_set().
21210     *
21211     * @see elm_spinner_value_get().
21212     * @see elm_spinner_format_set().
21213     * @see elm_spinner_min_max_set().
21214     *
21215     * @ingroup Spinner
21216     */
21217    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21218
21219    /**
21220     * Get the value displayed by the spinner.
21221     *
21222     * @param obj The spinner object.
21223     * @return The value displayed.
21224     *
21225     * @see elm_spinner_value_set() for details.
21226     *
21227     * @ingroup Spinner
21228     */
21229    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21230
21231    /**
21232     * Set whether the spinner should wrap when it reaches its
21233     * minimum or maximum value.
21234     *
21235     * @param obj The spinner object.
21236     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21237     * disable it.
21238     *
21239     * Disabled by default. If disabled, when the user tries to increment the
21240     * value,
21241     * but displayed value plus step value is bigger than maximum value,
21242     * the spinner
21243     * won't allow it. The same happens when the user tries to decrement it,
21244     * but the value less step is less than minimum value.
21245     *
21246     * When wrap is enabled, in such situations it will allow these changes,
21247     * but will get the value that would be less than minimum and subtracts
21248     * from maximum. Or add the value that would be more than maximum to
21249     * the minimum.
21250     *
21251     * E.g.:
21252     * @li min value = 10
21253     * @li max value = 50
21254     * @li step value = 20
21255     * @li displayed value = 20
21256     *
21257     * When the user decrement value (using left or bottom arrow), it will
21258     * displays @c 40, because max - (min - (displayed - step)) is
21259     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21260     *
21261     * @see elm_spinner_wrap_get().
21262     *
21263     * @ingroup Spinner
21264     */
21265    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21266
21267    /**
21268     * Get whether the spinner should wrap when it reaches its
21269     * minimum or maximum value.
21270     *
21271     * @param obj The spinner object
21272     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21273     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21274     *
21275     * @see elm_spinner_wrap_set() for details.
21276     *
21277     * @ingroup Spinner
21278     */
21279    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21280
21281    /**
21282     * Set whether the spinner can be directly edited by the user or not.
21283     *
21284     * @param obj The spinner object.
21285     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21286     * don't allow users to edit it directly.
21287     *
21288     * Spinner objects can have edition @b disabled, in which state they will
21289     * be changed only by arrows.
21290     * Useful for contexts
21291     * where you don't want your users to interact with it writting the value.
21292     * Specially
21293     * when using special values, the user can see real value instead
21294     * of special label on edition.
21295     *
21296     * It's enabled by default.
21297     *
21298     * @see elm_spinner_editable_get()
21299     *
21300     * @ingroup Spinner
21301     */
21302    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21303
21304    /**
21305     * Get whether the spinner can be directly edited by the user or not.
21306     *
21307     * @param obj The spinner object.
21308     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21309     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21310     *
21311     * @see elm_spinner_editable_set() for details.
21312     *
21313     * @ingroup Spinner
21314     */
21315    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21316
21317    /**
21318     * Set a special string to display in the place of the numerical value.
21319     *
21320     * @param obj The spinner object.
21321     * @param value The value to be replaced.
21322     * @param label The label to be used.
21323     *
21324     * It's useful for cases when a user should select an item that is
21325     * better indicated by a label than a value. For example, weekdays or months.
21326     *
21327     * E.g.:
21328     * @code
21329     * sp = elm_spinner_add(win);
21330     * elm_spinner_min_max_set(sp, 1, 3);
21331     * elm_spinner_special_value_add(sp, 1, "January");
21332     * elm_spinner_special_value_add(sp, 2, "February");
21333     * elm_spinner_special_value_add(sp, 3, "March");
21334     * evas_object_show(sp);
21335     * @endcode
21336     *
21337     * @ingroup Spinner
21338     */
21339    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21340
21341    /**
21342     * Set the interval on time updates for an user mouse button hold
21343     * on spinner widgets' arrows.
21344     *
21345     * @param obj The spinner object.
21346     * @param interval The (first) interval value in seconds.
21347     *
21348     * This interval value is @b decreased while the user holds the
21349     * mouse pointer either incrementing or decrementing spinner's value.
21350     *
21351     * This helps the user to get to a given value distant from the
21352     * current one easier/faster, as it will start to change quicker and
21353     * quicker on mouse button holds.
21354     *
21355     * The calculation for the next change interval value, starting from
21356     * the one set with this call, is the previous interval divided by
21357     * @c 1.05, so it decreases a little bit.
21358     *
21359     * The default starting interval value for automatic changes is
21360     * @c 0.85 seconds.
21361     *
21362     * @see elm_spinner_interval_get()
21363     *
21364     * @ingroup Spinner
21365     */
21366    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21367
21368    /**
21369     * Get the interval on time updates for an user mouse button hold
21370     * on spinner widgets' arrows.
21371     *
21372     * @param obj The spinner object.
21373     * @return The (first) interval value, in seconds, set on it.
21374     *
21375     * @see elm_spinner_interval_set() for more details.
21376     *
21377     * @ingroup Spinner
21378     */
21379    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21380
21381    /**
21382     * @}
21383     */
21384
21385    /**
21386     * @defgroup Index Index
21387     *
21388     * @image html img/widget/index/preview-00.png
21389     * @image latex img/widget/index/preview-00.eps
21390     *
21391     * An index widget gives you an index for fast access to whichever
21392     * group of other UI items one might have. It's a list of text
21393     * items (usually letters, for alphabetically ordered access).
21394     *
21395     * Index widgets are by default hidden and just appear when the
21396     * user clicks over it's reserved area in the canvas. In its
21397     * default theme, it's an area one @ref Fingers "finger" wide on
21398     * the right side of the index widget's container.
21399     *
21400     * When items on the index are selected, smart callbacks get
21401     * called, so that its user can make other container objects to
21402     * show a given area or child object depending on the index item
21403     * selected. You'd probably be using an index together with @ref
21404     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21405     * "general grids".
21406     *
21407     * Smart events one  can add callbacks for are:
21408     * - @c "changed" - When the selected index item changes. @c
21409     *      event_info is the selected item's data pointer.
21410     * - @c "delay,changed" - When the selected index item changes, but
21411     *      after a small idling period. @c event_info is the selected
21412     *      item's data pointer.
21413     * - @c "selected" - When the user releases a mouse button and
21414     *      selects an item. @c event_info is the selected item's data
21415     *      pointer.
21416     * - @c "level,up" - when the user moves a finger from the first
21417     *      level to the second level
21418     * - @c "level,down" - when the user moves a finger from the second
21419     *      level to the first level
21420     *
21421     * The @c "delay,changed" event is so that it'll wait a small time
21422     * before actually reporting those events and, moreover, just the
21423     * last event happening on those time frames will actually be
21424     * reported.
21425     *
21426     * Here are some examples on its usage:
21427     * @li @ref index_example_01
21428     * @li @ref index_example_02
21429     */
21430
21431    /**
21432     * @addtogroup Index
21433     * @{
21434     */
21435
21436    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21437
21438    /**
21439     * Add a new index widget to the given parent Elementary
21440     * (container) object
21441     *
21442     * @param parent The parent object
21443     * @return a new index widget handle or @c NULL, on errors
21444     *
21445     * This function inserts a new index widget on the canvas.
21446     *
21447     * @ingroup Index
21448     */
21449    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21450
21451    /**
21452     * Set whether a given index widget is or not visible,
21453     * programatically.
21454     *
21455     * @param obj The index object
21456     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21457     *
21458     * Not to be confused with visible as in @c evas_object_show() --
21459     * visible with regard to the widget's auto hiding feature.
21460     *
21461     * @see elm_index_active_get()
21462     *
21463     * @ingroup Index
21464     */
21465    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21466
21467    /**
21468     * Get whether a given index widget is currently visible or not.
21469     *
21470     * @param obj The index object
21471     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21472     *
21473     * @see elm_index_active_set() for more details
21474     *
21475     * @ingroup Index
21476     */
21477    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21478
21479    /**
21480     * Set the items level for a given index widget.
21481     *
21482     * @param obj The index object.
21483     * @param level @c 0 or @c 1, the currently implemented levels.
21484     *
21485     * @see elm_index_item_level_get()
21486     *
21487     * @ingroup Index
21488     */
21489    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21490
21491    /**
21492     * Get the items level set for a given index widget.
21493     *
21494     * @param obj The index object.
21495     * @return @c 0 or @c 1, which are the levels @p obj might be at.
21496     *
21497     * @see elm_index_item_level_set() for more information
21498     *
21499     * @ingroup Index
21500     */
21501    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21502
21503    /**
21504     * Returns the last selected item's data, for a given index widget.
21505     *
21506     * @param obj The index object.
21507     * @return The item @b data associated to the last selected item on
21508     * @p obj (or @c NULL, on errors).
21509     *
21510     * @warning The returned value is @b not an #Elm_Index_Item item
21511     * handle, but the data associated to it (see the @c item parameter
21512     * in elm_index_item_append(), as an example).
21513     *
21514     * @ingroup Index
21515     */
21516    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21517
21518    /**
21519     * Append a new item on a given index widget.
21520     *
21521     * @param obj The index object.
21522     * @param letter Letter under which the item should be indexed
21523     * @param item The item data to set for the index's item
21524     *
21525     * Despite the most common usage of the @p letter argument is for
21526     * single char strings, one could use arbitrary strings as index
21527     * entries.
21528     *
21529     * @c item will be the pointer returned back on @c "changed", @c
21530     * "delay,changed" and @c "selected" smart events.
21531     *
21532     * @ingroup Index
21533     */
21534    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21535
21536    /**
21537     * Prepend a new item on a given index widget.
21538     *
21539     * @param obj The index object.
21540     * @param letter Letter under which the item should be indexed
21541     * @param item The item data to set for the index's item
21542     *
21543     * Despite the most common usage of the @p letter argument is for
21544     * single char strings, one could use arbitrary strings as index
21545     * entries.
21546     *
21547     * @c item will be the pointer returned back on @c "changed", @c
21548     * "delay,changed" and @c "selected" smart events.
21549     *
21550     * @ingroup Index
21551     */
21552    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21553
21554    /**
21555     * Append a new item, on a given index widget, <b>after the item
21556     * having @p relative as data</b>.
21557     *
21558     * @param obj The index object.
21559     * @param letter Letter under which the item should be indexed
21560     * @param item The item data to set for the index's item
21561     * @param relative The item data of the index item to be the
21562     * predecessor of this new one
21563     *
21564     * Despite the most common usage of the @p letter argument is for
21565     * single char strings, one could use arbitrary strings as index
21566     * entries.
21567     *
21568     * @c item will be the pointer returned back on @c "changed", @c
21569     * "delay,changed" and @c "selected" smart events.
21570     *
21571     * @note If @p relative is @c NULL or if it's not found to be data
21572     * set on any previous item on @p obj, this function will behave as
21573     * elm_index_item_append().
21574     *
21575     * @ingroup Index
21576     */
21577    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21578
21579    /**
21580     * Prepend a new item, on a given index widget, <b>after the item
21581     * having @p relative as data</b>.
21582     *
21583     * @param obj The index object.
21584     * @param letter Letter under which the item should be indexed
21585     * @param item The item data to set for the index's item
21586     * @param relative The item data of the index item to be the
21587     * successor of this new one
21588     *
21589     * Despite the most common usage of the @p letter argument is for
21590     * single char strings, one could use arbitrary strings as index
21591     * entries.
21592     *
21593     * @c item will be the pointer returned back on @c "changed", @c
21594     * "delay,changed" and @c "selected" smart events.
21595     *
21596     * @note If @p relative is @c NULL or if it's not found to be data
21597     * set on any previous item on @p obj, this function will behave as
21598     * elm_index_item_prepend().
21599     *
21600     * @ingroup Index
21601     */
21602    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21603
21604    /**
21605     * Insert a new item into the given index widget, using @p cmp_func
21606     * function to sort items (by item handles).
21607     *
21608     * @param obj The index object.
21609     * @param letter Letter under which the item should be indexed
21610     * @param item The item data to set for the index's item
21611     * @param cmp_func The comparing function to be used to sort index
21612     * items <b>by #Elm_Index_Item item handles</b>
21613     * @param cmp_data_func A @b fallback function to be called for the
21614     * sorting of index items <b>by item data</b>). It will be used
21615     * when @p cmp_func returns @c 0 (equality), which means an index
21616     * item with provided item data already exists. To decide which
21617     * data item should be pointed to by the index item in question, @p
21618     * cmp_data_func will be used. If @p cmp_data_func returns a
21619     * non-negative value, the previous index item data will be
21620     * replaced by the given @p item pointer. If the previous data need
21621     * to be freed, it should be done by the @p cmp_data_func function,
21622     * because all references to it will be lost. If this function is
21623     * not provided (@c NULL is given), index items will be @b
21624     * duplicated, if @p cmp_func returns @c 0.
21625     *
21626     * Despite the most common usage of the @p letter argument is for
21627     * single char strings, one could use arbitrary strings as index
21628     * entries.
21629     *
21630     * @c item will be the pointer returned back on @c "changed", @c
21631     * "delay,changed" and @c "selected" smart events.
21632     *
21633     * @ingroup Index
21634     */
21635    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);
21636
21637    /**
21638     * Remove an item from a given index widget, <b>to be referenced by
21639     * it's data value</b>.
21640     *
21641     * @param obj The index object
21642     * @param item The item's data pointer for the item to be removed
21643     * from @p obj
21644     *
21645     * If a deletion callback is set, via elm_index_item_del_cb_set(),
21646     * that callback function will be called by this one.
21647     *
21648     * @warning The item to be removed from @p obj will be found via
21649     * its item data pointer, and not by an #Elm_Index_Item handle.
21650     *
21651     * @ingroup Index
21652     */
21653    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21654
21655    /**
21656     * Find a given index widget's item, <b>using item data</b>.
21657     *
21658     * @param obj The index object
21659     * @param item The item data pointed to by the desired index item
21660     * @return The index item handle, if found, or @c NULL otherwise
21661     *
21662     * @ingroup Index
21663     */
21664    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21665
21666    /**
21667     * Removes @b all items from a given index widget.
21668     *
21669     * @param obj The index object.
21670     *
21671     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21672     * that callback function will be called for each item in @p obj.
21673     *
21674     * @ingroup Index
21675     */
21676    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21677
21678    /**
21679     * Go to a given items level on a index widget
21680     *
21681     * @param obj The index object
21682     * @param level The index level (one of @c 0 or @c 1)
21683     *
21684     * @ingroup Index
21685     */
21686    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21687
21688    /**
21689     * Return the data associated with a given index widget item
21690     *
21691     * @param it The index widget item handle
21692     * @return The data associated with @p it
21693     *
21694     * @see elm_index_item_data_set()
21695     *
21696     * @ingroup Index
21697     */
21698    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21699
21700    /**
21701     * Set the data associated with a given index widget item
21702     *
21703     * @param it The index widget item handle
21704     * @param data The new data pointer to set to @p it
21705     *
21706     * This sets new item data on @p it.
21707     *
21708     * @warning The old data pointer won't be touched by this function, so
21709     * the user had better to free that old data himself/herself.
21710     *
21711     * @ingroup Index
21712     */
21713    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
21714
21715    /**
21716     * Set the function to be called when a given index widget item is freed.
21717     *
21718     * @param it The item to set the callback on
21719     * @param func The function to call on the item's deletion
21720     *
21721     * When called, @p func will have both @c data and @c event_info
21722     * arguments with the @p it item's data value and, naturally, the
21723     * @c obj argument with a handle to the parent index widget.
21724     *
21725     * @ingroup Index
21726     */
21727    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
21728
21729    /**
21730     * Get the letter (string) set on a given index widget item.
21731     *
21732     * @param it The index item handle
21733     * @return The letter string set on @p it
21734     *
21735     * @ingroup Index
21736     */
21737    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21738
21739    /**
21740     * @}
21741     */
21742
21743    /**
21744     * @defgroup Photocam Photocam
21745     *
21746     * @image html img/widget/photocam/preview-00.png
21747     * @image latex img/widget/photocam/preview-00.eps
21748     *
21749     * This is a widget specifically for displaying high-resolution digital
21750     * camera photos giving speedy feedback (fast load), low memory footprint
21751     * and zooming and panning as well as fitting logic. It is entirely focused
21752     * on jpeg images, and takes advantage of properties of the jpeg format (via
21753     * evas loader features in the jpeg loader).
21754     *
21755     * Signals that you can add callbacks for are:
21756     * @li "clicked" - This is called when a user has clicked the photo without
21757     *                 dragging around.
21758     * @li "press" - This is called when a user has pressed down on the photo.
21759     * @li "longpressed" - This is called when a user has pressed down on the
21760     *                     photo for a long time without dragging around.
21761     * @li "clicked,double" - This is called when a user has double-clicked the
21762     *                        photo.
21763     * @li "load" - Photo load begins.
21764     * @li "loaded" - This is called when the image file load is complete for the
21765     *                first view (low resolution blurry version).
21766     * @li "load,detail" - Photo detailed data load begins.
21767     * @li "loaded,detail" - This is called when the image file load is complete
21768     *                      for the detailed image data (full resolution needed).
21769     * @li "zoom,start" - Zoom animation started.
21770     * @li "zoom,stop" - Zoom animation stopped.
21771     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
21772     * @li "scroll" - the content has been scrolled (moved)
21773     * @li "scroll,anim,start" - scrolling animation has started
21774     * @li "scroll,anim,stop" - scrolling animation has stopped
21775     * @li "scroll,drag,start" - dragging the contents around has started
21776     * @li "scroll,drag,stop" - dragging the contents around has stopped
21777     *
21778     * @ref tutorial_photocam shows the API in action.
21779     * @{
21780     */
21781    /**
21782     * @brief Types of zoom available.
21783     */
21784    typedef enum _Elm_Photocam_Zoom_Mode
21785      {
21786         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
21787         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
21788         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
21789         ELM_PHOTOCAM_ZOOM_MODE_LAST
21790      } Elm_Photocam_Zoom_Mode;
21791    /**
21792     * @brief Add a new Photocam object
21793     *
21794     * @param parent The parent object
21795     * @return The new object or NULL if it cannot be created
21796     */
21797    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21798    /**
21799     * @brief Set the photo file to be shown
21800     *
21801     * @param obj The photocam object
21802     * @param file The photo file
21803     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
21804     *
21805     * This sets (and shows) the specified file (with a relative or absolute
21806     * path) and will return a load error (same error that
21807     * evas_object_image_load_error_get() will return). The image will change and
21808     * adjust its size at this point and begin a background load process for this
21809     * photo that at some time in the future will be displayed at the full
21810     * quality needed.
21811     */
21812    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
21813    /**
21814     * @brief Returns the path of the current image file
21815     *
21816     * @param obj The photocam object
21817     * @return Returns the path
21818     *
21819     * @see elm_photocam_file_set()
21820     */
21821    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21822    /**
21823     * @brief Set the zoom level of the photo
21824     *
21825     * @param obj The photocam object
21826     * @param zoom The zoom level to set
21827     *
21828     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
21829     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
21830     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
21831     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
21832     * 16, 32, etc.).
21833     */
21834    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
21835    /**
21836     * @brief Get the zoom level of the photo
21837     *
21838     * @param obj The photocam object
21839     * @return The current zoom level
21840     *
21841     * This returns the current zoom level of the photocam object. Note that if
21842     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
21843     * (which is the default), the zoom level may be changed at any time by the
21844     * photocam object itself to account for photo size and photocam viewpoer
21845     * size.
21846     *
21847     * @see elm_photocam_zoom_set()
21848     * @see elm_photocam_zoom_mode_set()
21849     */
21850    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21851    /**
21852     * @brief Set the zoom mode
21853     *
21854     * @param obj The photocam object
21855     * @param mode The desired mode
21856     *
21857     * This sets the zoom mode to manual or one of several automatic levels.
21858     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
21859     * elm_photocam_zoom_set() and will stay at that level until changed by code
21860     * or until zoom mode is changed. This is the default mode. The Automatic
21861     * modes will allow the photocam object to automatically adjust zoom mode
21862     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
21863     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
21864     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
21865     * pixels within the frame are left unfilled.
21866     */
21867    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21868    /**
21869     * @brief Get the zoom mode
21870     *
21871     * @param obj The photocam object
21872     * @return The current zoom mode
21873     *
21874     * This gets the current zoom mode of the photocam object.
21875     *
21876     * @see elm_photocam_zoom_mode_set()
21877     */
21878    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21879    /**
21880     * @brief Get the current image pixel width and height
21881     *
21882     * @param obj The photocam object
21883     * @param w A pointer to the width return
21884     * @param h A pointer to the height return
21885     *
21886     * This gets the current photo pixel width and height (for the original).
21887     * The size will be returned in the integers @p w and @p h that are pointed
21888     * to.
21889     */
21890    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
21891    /**
21892     * @brief Get the area of the image that is currently shown
21893     *
21894     * @param obj
21895     * @param x A pointer to the X-coordinate of region
21896     * @param y A pointer to the Y-coordinate of region
21897     * @param w A pointer to the width
21898     * @param h A pointer to the height
21899     *
21900     * @see elm_photocam_image_region_show()
21901     * @see elm_photocam_image_region_bring_in()
21902     */
21903    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
21904    /**
21905     * @brief Set the viewed portion of the image
21906     *
21907     * @param obj The photocam object
21908     * @param x X-coordinate of region in image original pixels
21909     * @param y Y-coordinate of region in image original pixels
21910     * @param w Width of region in image original pixels
21911     * @param h Height of region in image original pixels
21912     *
21913     * This shows the region of the image without using animation.
21914     */
21915    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21916    /**
21917     * @brief Bring in the viewed portion of the image
21918     *
21919     * @param obj The photocam object
21920     * @param x X-coordinate of region in image original pixels
21921     * @param y Y-coordinate of region in image original pixels
21922     * @param w Width of region in image original pixels
21923     * @param h Height of region in image original pixels
21924     *
21925     * This shows the region of the image using animation.
21926     */
21927    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21928    /**
21929     * @brief Set the paused state for photocam
21930     *
21931     * @param obj The photocam object
21932     * @param paused The pause state to set
21933     *
21934     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
21935     * photocam. The default is off. This will stop zooming using animation on
21936     * zoom levels changes and change instantly. This will stop any existing
21937     * animations that are running.
21938     */
21939    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21940    /**
21941     * @brief Get the paused state for photocam
21942     *
21943     * @param obj The photocam object
21944     * @return The current paused state
21945     *
21946     * This gets the current paused state for the photocam object.
21947     *
21948     * @see elm_photocam_paused_set()
21949     */
21950    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21951    /**
21952     * @brief Get the internal low-res image used for photocam
21953     *
21954     * @param obj The photocam object
21955     * @return The internal image object handle, or NULL if none exists
21956     *
21957     * This gets the internal image object inside photocam. Do not modify it. It
21958     * is for inspection only, and hooking callbacks to. Nothing else. It may be
21959     * deleted at any time as well.
21960     */
21961    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21962    /**
21963     * @brief Set the photocam scrolling bouncing.
21964     *
21965     * @param obj The photocam object
21966     * @param h_bounce bouncing for horizontal
21967     * @param v_bounce bouncing for vertical
21968     */
21969    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
21970    /**
21971     * @brief Get the photocam scrolling bouncing.
21972     *
21973     * @param obj The photocam object
21974     * @param h_bounce bouncing for horizontal
21975     * @param v_bounce bouncing for vertical
21976     *
21977     * @see elm_photocam_bounce_set()
21978     */
21979    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
21980    /**
21981     * @}
21982     */
21983
21984    /**
21985     * @defgroup Map Map
21986     * @ingroup Elementary
21987     *
21988     * @image html img/widget/map/preview-00.png
21989     * @image latex img/widget/map/preview-00.eps
21990     *
21991     * This is a widget specifically for displaying a map. It uses basically
21992     * OpenStreetMap provider http://www.openstreetmap.org/,
21993     * but custom providers can be added.
21994     *
21995     * It supports some basic but yet nice features:
21996     * @li zoom and scroll
21997     * @li markers with content to be displayed when user clicks over it
21998     * @li group of markers
21999     * @li routes
22000     *
22001     * Smart callbacks one can listen to:
22002     *
22003     * - "clicked" - This is called when a user has clicked the map without
22004     *   dragging around.
22005     * - "press" - This is called when a user has pressed down on the map.
22006     * - "longpressed" - This is called when a user has pressed down on the map
22007     *   for a long time without dragging around.
22008     * - "clicked,double" - This is called when a user has double-clicked
22009     *   the map.
22010     * - "load,detail" - Map detailed data load begins.
22011     * - "loaded,detail" - This is called when all currently visible parts of
22012     *   the map are loaded.
22013     * - "zoom,start" - Zoom animation started.
22014     * - "zoom,stop" - Zoom animation stopped.
22015     * - "zoom,change" - Zoom changed when using an auto zoom mode.
22016     * - "scroll" - the content has been scrolled (moved).
22017     * - "scroll,anim,start" - scrolling animation has started.
22018     * - "scroll,anim,stop" - scrolling animation has stopped.
22019     * - "scroll,drag,start" - dragging the contents around has started.
22020     * - "scroll,drag,stop" - dragging the contents around has stopped.
22021     * - "downloaded" - This is called when all currently required map images
22022     *   are downloaded.
22023     * - "route,load" - This is called when route request begins.
22024     * - "route,loaded" - This is called when route request ends.
22025     * - "name,load" - This is called when name request begins.
22026     * - "name,loaded- This is called when name request ends.
22027     *
22028     * Available style for map widget:
22029     * - @c "default"
22030     *
22031     * Available style for markers:
22032     * - @c "radio"
22033     * - @c "radio2"
22034     * - @c "empty"
22035     *
22036     * Available style for marker bubble:
22037     * - @c "default"
22038     *
22039     * List of examples:
22040     * @li @ref map_example_01
22041     * @li @ref map_example_02
22042     * @li @ref map_example_03
22043     */
22044
22045    /**
22046     * @addtogroup Map
22047     * @{
22048     */
22049
22050    /**
22051     * @enum _Elm_Map_Zoom_Mode
22052     * @typedef Elm_Map_Zoom_Mode
22053     *
22054     * Set map's zoom behavior. It can be set to manual or automatic.
22055     *
22056     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22057     *
22058     * Values <b> don't </b> work as bitmask, only one can be choosen.
22059     *
22060     * @note Valid sizes are 2^zoom, consequently the map may be smaller
22061     * than the scroller view.
22062     *
22063     * @see elm_map_zoom_mode_set()
22064     * @see elm_map_zoom_mode_get()
22065     *
22066     * @ingroup Map
22067     */
22068    typedef enum _Elm_Map_Zoom_Mode
22069      {
22070         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22071         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22072         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22073         ELM_MAP_ZOOM_MODE_LAST
22074      } Elm_Map_Zoom_Mode;
22075
22076    /**
22077     * @enum _Elm_Map_Route_Sources
22078     * @typedef Elm_Map_Route_Sources
22079     *
22080     * Set route service to be used. By default used source is
22081     * #ELM_MAP_ROUTE_SOURCE_YOURS.
22082     *
22083     * @see elm_map_route_source_set()
22084     * @see elm_map_route_source_get()
22085     *
22086     * @ingroup Map
22087     */
22088    typedef enum _Elm_Map_Route_Sources
22089      {
22090         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22091         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. */
22092         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22093         ELM_MAP_ROUTE_SOURCE_LAST
22094      } Elm_Map_Route_Sources;
22095
22096    typedef enum _Elm_Map_Name_Sources
22097      {
22098         ELM_MAP_NAME_SOURCE_NOMINATIM,
22099         ELM_MAP_NAME_SOURCE_LAST
22100      } Elm_Map_Name_Sources;
22101
22102    /**
22103     * @enum _Elm_Map_Route_Type
22104     * @typedef Elm_Map_Route_Type
22105     *
22106     * Set type of transport used on route.
22107     *
22108     * @see elm_map_route_add()
22109     *
22110     * @ingroup Map
22111     */
22112    typedef enum _Elm_Map_Route_Type
22113      {
22114         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22115         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22116         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22117         ELM_MAP_ROUTE_TYPE_LAST
22118      } Elm_Map_Route_Type;
22119
22120    /**
22121     * @enum _Elm_Map_Route_Method
22122     * @typedef Elm_Map_Route_Method
22123     *
22124     * Set the routing method, what should be priorized, time or distance.
22125     *
22126     * @see elm_map_route_add()
22127     *
22128     * @ingroup Map
22129     */
22130    typedef enum _Elm_Map_Route_Method
22131      {
22132         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22133         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22134         ELM_MAP_ROUTE_METHOD_LAST
22135      } Elm_Map_Route_Method;
22136
22137    typedef enum _Elm_Map_Name_Method
22138      {
22139         ELM_MAP_NAME_METHOD_SEARCH,
22140         ELM_MAP_NAME_METHOD_REVERSE,
22141         ELM_MAP_NAME_METHOD_LAST
22142      } Elm_Map_Name_Method;
22143
22144    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(). */
22145    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(). */
22146    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(). */
22147    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(). */
22148    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
22149    typedef struct _Elm_Map_Track           Elm_Map_Track;
22150
22151    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. */
22152    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22153    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22154    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22155
22156    typedef char        *(*ElmMapModuleSourceFunc) (void);
22157    typedef int          (*ElmMapModuleZoomMinFunc) (void);
22158    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
22159    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22160    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
22161    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22162    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22163    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22164    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22165
22166    /**
22167     * Add a new map widget to the given parent Elementary (container) object.
22168     *
22169     * @param parent The parent object.
22170     * @return a new map widget handle or @c NULL, on errors.
22171     *
22172     * This function inserts a new map widget on the canvas.
22173     *
22174     * @ingroup Map
22175     */
22176    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22177
22178    /**
22179     * Set the zoom level of the map.
22180     *
22181     * @param obj The map object.
22182     * @param zoom The zoom level to set.
22183     *
22184     * This sets the zoom level.
22185     *
22186     * It will respect limits defined by elm_map_source_zoom_min_set() and
22187     * elm_map_source_zoom_max_set().
22188     *
22189     * By default these values are 0 (world map) and 18 (maximum zoom).
22190     *
22191     * This function should be used when zoom mode is set to
22192     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22193     * with elm_map_zoom_mode_set().
22194     *
22195     * @see elm_map_zoom_mode_set().
22196     * @see elm_map_zoom_get().
22197     *
22198     * @ingroup Map
22199     */
22200    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22201
22202    /**
22203     * Get the zoom level of the map.
22204     *
22205     * @param obj The map object.
22206     * @return The current zoom level.
22207     *
22208     * This returns the current zoom level of the map object.
22209     *
22210     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22211     * (which is the default), the zoom level may be changed at any time by the
22212     * map object itself to account for map size and map viewport size.
22213     *
22214     * @see elm_map_zoom_set() for details.
22215     *
22216     * @ingroup Map
22217     */
22218    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22219
22220    /**
22221     * Set the zoom mode used by the map object.
22222     *
22223     * @param obj The map object.
22224     * @param mode The zoom mode of the map, being it one of
22225     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22226     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22227     *
22228     * This sets the zoom mode to manual or one of the automatic levels.
22229     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22230     * elm_map_zoom_set() and will stay at that level until changed by code
22231     * or until zoom mode is changed. This is the default mode.
22232     *
22233     * The Automatic modes will allow the map object to automatically
22234     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22235     * adjust zoom so the map fits inside the scroll frame with no pixels
22236     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22237     * ensure no pixels within the frame are left unfilled. Do not forget that
22238     * the valid sizes are 2^zoom, consequently the map may be smaller than
22239     * the scroller view.
22240     *
22241     * @see elm_map_zoom_set()
22242     *
22243     * @ingroup Map
22244     */
22245    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22246
22247    /**
22248     * Get the zoom mode used by the map object.
22249     *
22250     * @param obj The map object.
22251     * @return The zoom mode of the map, being it one of
22252     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22253     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22254     *
22255     * This function returns the current zoom mode used by the map object.
22256     *
22257     * @see elm_map_zoom_mode_set() for more details.
22258     *
22259     * @ingroup Map
22260     */
22261    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22262
22263    /**
22264     * Get the current coordinates of the map.
22265     *
22266     * @param obj The map object.
22267     * @param lon Pointer where to store longitude.
22268     * @param lat Pointer where to store latitude.
22269     *
22270     * This gets the current center coordinates of the map object. It can be
22271     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22272     *
22273     * @see elm_map_geo_region_bring_in()
22274     * @see elm_map_geo_region_show()
22275     *
22276     * @ingroup Map
22277     */
22278    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22279
22280    /**
22281     * Animatedly bring in given coordinates to the center of the map.
22282     *
22283     * @param obj The map object.
22284     * @param lon Longitude to center at.
22285     * @param lat Latitude to center at.
22286     *
22287     * This causes map to jump to the given @p lat and @p lon coordinates
22288     * and show it (by scrolling) in the center of the viewport, if it is not
22289     * already centered. This will use animation to do so and take a period
22290     * of time to complete.
22291     *
22292     * @see elm_map_geo_region_show() for a function to avoid animation.
22293     * @see elm_map_geo_region_get()
22294     *
22295     * @ingroup Map
22296     */
22297    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22298
22299    /**
22300     * Show the given coordinates at the center of the map, @b immediately.
22301     *
22302     * @param obj The map object.
22303     * @param lon Longitude to center at.
22304     * @param lat Latitude to center at.
22305     *
22306     * This causes map to @b redraw its viewport's contents to the
22307     * region contining the given @p lat and @p lon, that will be moved to the
22308     * center of the map.
22309     *
22310     * @see elm_map_geo_region_bring_in() for a function to move with animation.
22311     * @see elm_map_geo_region_get()
22312     *
22313     * @ingroup Map
22314     */
22315    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22316
22317    /**
22318     * Pause or unpause the map.
22319     *
22320     * @param obj The map object.
22321     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22322     * to unpause it.
22323     *
22324     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22325     * for map.
22326     *
22327     * The default is off.
22328     *
22329     * This will stop zooming using animation, changing zoom levels will
22330     * change instantly. This will stop any existing animations that are running.
22331     *
22332     * @see elm_map_paused_get()
22333     *
22334     * @ingroup Map
22335     */
22336    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22337
22338    /**
22339     * Get a value whether map is paused or not.
22340     *
22341     * @param obj The map object.
22342     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22343     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22344     *
22345     * This gets the current paused state for the map object.
22346     *
22347     * @see elm_map_paused_set() for details.
22348     *
22349     * @ingroup Map
22350     */
22351    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22352
22353    /**
22354     * Set to show markers during zoom level changes or not.
22355     *
22356     * @param obj The map object.
22357     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22358     * to show them.
22359     *
22360     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22361     * for map.
22362     *
22363     * The default is off.
22364     *
22365     * This will stop zooming using animation, changing zoom levels will
22366     * change instantly. This will stop any existing animations that are running.
22367     *
22368     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22369     * for the markers.
22370     *
22371     * The default  is off.
22372     *
22373     * Enabling it will force the map to stop displaying the markers during
22374     * zoom level changes. Set to on if you have a large number of markers.
22375     *
22376     * @see elm_map_paused_markers_get()
22377     *
22378     * @ingroup Map
22379     */
22380    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22381
22382    /**
22383     * Get a value whether markers will be displayed on zoom level changes or not
22384     *
22385     * @param obj The map object.
22386     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22387     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22388     *
22389     * This gets the current markers paused state for the map object.
22390     *
22391     * @see elm_map_paused_markers_set() for details.
22392     *
22393     * @ingroup Map
22394     */
22395    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22396
22397    /**
22398     * Get the information of downloading status.
22399     *
22400     * @param obj The map object.
22401     * @param try_num Pointer where to store number of tiles being downloaded.
22402     * @param finish_num Pointer where to store number of tiles successfully
22403     * downloaded.
22404     *
22405     * This gets the current downloading status for the map object, the number
22406     * of tiles being downloaded and the number of tiles already downloaded.
22407     *
22408     * @ingroup Map
22409     */
22410    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22411
22412    /**
22413     * Convert a pixel coordinate (x,y) into a geographic coordinate
22414     * (longitude, latitude).
22415     *
22416     * @param obj The map object.
22417     * @param x the coordinate.
22418     * @param y the coordinate.
22419     * @param size the size in pixels of the map.
22420     * The map is a square and generally his size is : pow(2.0, zoom)*256.
22421     * @param lon Pointer where to store the longitude that correspond to x.
22422     * @param lat Pointer where to store the latitude that correspond to y.
22423     *
22424     * @note Origin pixel point is the top left corner of the viewport.
22425     * Map zoom and size are taken on account.
22426     *
22427     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22428     *
22429     * @ingroup Map
22430     */
22431    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);
22432
22433    /**
22434     * Convert a geographic coordinate (longitude, latitude) into a pixel
22435     * coordinate (x, y).
22436     *
22437     * @param obj The map object.
22438     * @param lon the longitude.
22439     * @param lat the latitude.
22440     * @param size the size in pixels of the map. The map is a square
22441     * and generally his size is : pow(2.0, zoom)*256.
22442     * @param x Pointer where to store the horizontal pixel coordinate that
22443     * correspond to the longitude.
22444     * @param y Pointer where to store the vertical pixel coordinate that
22445     * correspond to the latitude.
22446     *
22447     * @note Origin pixel point is the top left corner of the viewport.
22448     * Map zoom and size are taken on account.
22449     *
22450     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22451     *
22452     * @ingroup Map
22453     */
22454    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);
22455
22456    /**
22457     * Convert a geographic coordinate (longitude, latitude) into a name
22458     * (address).
22459     *
22460     * @param obj The map object.
22461     * @param lon the longitude.
22462     * @param lat the latitude.
22463     * @return name A #Elm_Map_Name handle for this coordinate.
22464     *
22465     * To get the string for this address, elm_map_name_address_get()
22466     * should be used.
22467     *
22468     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22469     *
22470     * @ingroup Map
22471     */
22472    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22473
22474    /**
22475     * Convert a name (address) into a geographic coordinate
22476     * (longitude, latitude).
22477     *
22478     * @param obj The map object.
22479     * @param name The address.
22480     * @return name A #Elm_Map_Name handle for this address.
22481     *
22482     * To get the longitude and latitude, elm_map_name_region_get()
22483     * should be used.
22484     *
22485     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22486     *
22487     * @ingroup Map
22488     */
22489    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22490
22491    /**
22492     * Convert a pixel coordinate into a rotated pixel coordinate.
22493     *
22494     * @param obj The map object.
22495     * @param x horizontal coordinate of the point to rotate.
22496     * @param y vertical coordinate of the point to rotate.
22497     * @param cx rotation's center horizontal position.
22498     * @param cy rotation's center vertical position.
22499     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22500     * @param xx Pointer where to store rotated x.
22501     * @param yy Pointer where to store rotated y.
22502     *
22503     * @ingroup Map
22504     */
22505    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);
22506
22507    /**
22508     * Add a new marker to the map object.
22509     *
22510     * @param obj The map object.
22511     * @param lon The longitude of the marker.
22512     * @param lat The latitude of the marker.
22513     * @param clas The class, to use when marker @b isn't grouped to others.
22514     * @param clas_group The class group, to use when marker is grouped to others
22515     * @param data The data passed to the callbacks.
22516     *
22517     * @return The created marker or @c NULL upon failure.
22518     *
22519     * A marker will be created and shown in a specific point of the map, defined
22520     * by @p lon and @p lat.
22521     *
22522     * It will be displayed using style defined by @p class when this marker
22523     * is displayed alone (not grouped). A new class can be created with
22524     * elm_map_marker_class_new().
22525     *
22526     * If the marker is grouped to other markers, it will be displayed with
22527     * style defined by @p class_group. Markers with the same group are grouped
22528     * if they are close. A new group class can be created with
22529     * elm_map_marker_group_class_new().
22530     *
22531     * Markers created with this method can be deleted with
22532     * elm_map_marker_remove().
22533     *
22534     * A marker can have associated content to be displayed by a bubble,
22535     * when a user click over it, as well as an icon. These objects will
22536     * be fetch using class' callback functions.
22537     *
22538     * @see elm_map_marker_class_new()
22539     * @see elm_map_marker_group_class_new()
22540     * @see elm_map_marker_remove()
22541     *
22542     * @ingroup Map
22543     */
22544    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);
22545
22546    /**
22547     * Set the maximum numbers of markers' content to be displayed in a group.
22548     *
22549     * @param obj The map object.
22550     * @param max The maximum numbers of items displayed in a bubble.
22551     *
22552     * A bubble will be displayed when the user clicks over the group,
22553     * and will place the content of markers that belong to this group
22554     * inside it.
22555     *
22556     * A group can have a long list of markers, consequently the creation
22557     * of the content of the bubble can be very slow.
22558     *
22559     * In order to avoid this, a maximum number of items is displayed
22560     * in a bubble.
22561     *
22562     * By default this number is 30.
22563     *
22564     * Marker with the same group class are grouped if they are close.
22565     *
22566     * @see elm_map_marker_add()
22567     *
22568     * @ingroup Map
22569     */
22570    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22571
22572    /**
22573     * Remove a marker from the map.
22574     *
22575     * @param marker The marker to remove.
22576     *
22577     * @see elm_map_marker_add()
22578     *
22579     * @ingroup Map
22580     */
22581    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22582
22583    /**
22584     * Get the current coordinates of the marker.
22585     *
22586     * @param marker marker.
22587     * @param lat Pointer where to store the marker's latitude.
22588     * @param lon Pointer where to store the marker's longitude.
22589     *
22590     * These values are set when adding markers, with function
22591     * elm_map_marker_add().
22592     *
22593     * @see elm_map_marker_add()
22594     *
22595     * @ingroup Map
22596     */
22597    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22598
22599    /**
22600     * Animatedly bring in given marker to the center of the map.
22601     *
22602     * @param marker The marker to center at.
22603     *
22604     * This causes map to jump to the given @p marker's coordinates
22605     * and show it (by scrolling) in the center of the viewport, if it is not
22606     * already centered. This will use animation to do so and take a period
22607     * of time to complete.
22608     *
22609     * @see elm_map_marker_show() for a function to avoid animation.
22610     * @see elm_map_marker_region_get()
22611     *
22612     * @ingroup Map
22613     */
22614    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22615
22616    /**
22617     * Show the given marker at the center of the map, @b immediately.
22618     *
22619     * @param marker The marker to center at.
22620     *
22621     * This causes map to @b redraw its viewport's contents to the
22622     * region contining the given @p marker's coordinates, that will be
22623     * moved to the center of the map.
22624     *
22625     * @see elm_map_marker_bring_in() for a function to move with animation.
22626     * @see elm_map_markers_list_show() if more than one marker need to be
22627     * displayed.
22628     * @see elm_map_marker_region_get()
22629     *
22630     * @ingroup Map
22631     */
22632    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22633
22634    /**
22635     * Move and zoom the map to display a list of markers.
22636     *
22637     * @param markers A list of #Elm_Map_Marker handles.
22638     *
22639     * The map will be centered on the center point of the markers in the list.
22640     * Then the map will be zoomed in order to fit the markers using the maximum
22641     * zoom which allows display of all the markers.
22642     *
22643     * @warning All the markers should belong to the same map object.
22644     *
22645     * @see elm_map_marker_show() to show a single marker.
22646     * @see elm_map_marker_bring_in()
22647     *
22648     * @ingroup Map
22649     */
22650    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22651
22652    /**
22653     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22654     *
22655     * @param marker The marker wich content should be returned.
22656     * @return Return the evas object if it exists, else @c NULL.
22657     *
22658     * To set callback function #ElmMapMarkerGetFunc for the marker class,
22659     * elm_map_marker_class_get_cb_set() should be used.
22660     *
22661     * This content is what will be inside the bubble that will be displayed
22662     * when an user clicks over the marker.
22663     *
22664     * This returns the actual Evas object used to be placed inside
22665     * the bubble. This may be @c NULL, as it may
22666     * not have been created or may have been deleted, at any time, by
22667     * the map. <b>Do not modify this object</b> (move, resize,
22668     * show, hide, etc.), as the map is controlling it. This
22669     * function is for querying, emitting custom signals or hooking
22670     * lower level callbacks for events on that object. Do not delete
22671     * this object under any circumstances.
22672     *
22673     * @ingroup Map
22674     */
22675    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22676
22677    /**
22678     * Update the marker
22679     *
22680     * @param marker The marker to be updated.
22681     *
22682     * If a content is set to this marker, it will call function to delete it,
22683     * #ElmMapMarkerDelFunc, and then will fetch the content again with
22684     * #ElmMapMarkerGetFunc.
22685     *
22686     * These functions are set for the marker class with
22687     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
22688     *
22689     * @ingroup Map
22690     */
22691    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22692
22693    /**
22694     * Close all the bubbles opened by the user.
22695     *
22696     * @param obj The map object.
22697     *
22698     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
22699     * when the user clicks on a marker.
22700     *
22701     * This functions is set for the marker class with
22702     * elm_map_marker_class_get_cb_set().
22703     *
22704     * @ingroup Map
22705     */
22706    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
22707
22708    /**
22709     * Create a new group class.
22710     *
22711     * @param obj The map object.
22712     * @return Returns the new group class.
22713     *
22714     * Each marker must be associated to a group class. Markers in the same
22715     * group are grouped if they are close.
22716     *
22717     * The group class defines the style of the marker when a marker is grouped
22718     * to others markers. When it is alone, another class will be used.
22719     *
22720     * A group class will need to be provided when creating a marker with
22721     * elm_map_marker_add().
22722     *
22723     * Some properties and functions can be set by class, as:
22724     * - style, with elm_map_group_class_style_set()
22725     * - data - to be associated to the group class. It can be set using
22726     *   elm_map_group_class_data_set().
22727     * - min zoom to display markers, set with
22728     *   elm_map_group_class_zoom_displayed_set().
22729     * - max zoom to group markers, set using
22730     *   elm_map_group_class_zoom_grouped_set().
22731     * - visibility - set if markers will be visible or not, set with
22732     *   elm_map_group_class_hide_set().
22733     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
22734     *   It can be set using elm_map_group_class_icon_cb_set().
22735     *
22736     * @see elm_map_marker_add()
22737     * @see elm_map_group_class_style_set()
22738     * @see elm_map_group_class_data_set()
22739     * @see elm_map_group_class_zoom_displayed_set()
22740     * @see elm_map_group_class_zoom_grouped_set()
22741     * @see elm_map_group_class_hide_set()
22742     * @see elm_map_group_class_icon_cb_set()
22743     *
22744     * @ingroup Map
22745     */
22746    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22747
22748    /**
22749     * Set the marker's style of a group class.
22750     *
22751     * @param clas The group class.
22752     * @param style The style to be used by markers.
22753     *
22754     * Each marker must be associated to a group class, and will use the style
22755     * defined by such class when grouped to other markers.
22756     *
22757     * The following styles are provided by default theme:
22758     * @li @c radio - blue circle
22759     * @li @c radio2 - green circle
22760     * @li @c empty
22761     *
22762     * @see elm_map_group_class_new() for more details.
22763     * @see elm_map_marker_add()
22764     *
22765     * @ingroup Map
22766     */
22767    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22768
22769    /**
22770     * Set the icon callback function of a group class.
22771     *
22772     * @param clas The group class.
22773     * @param icon_get The callback function that will return the icon.
22774     *
22775     * Each marker must be associated to a group class, and it can display a
22776     * custom icon. The function @p icon_get must return this icon.
22777     *
22778     * @see elm_map_group_class_new() for more details.
22779     * @see elm_map_marker_add()
22780     *
22781     * @ingroup Map
22782     */
22783    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22784
22785    /**
22786     * Set the data associated to the group class.
22787     *
22788     * @param clas The group class.
22789     * @param data The new user data.
22790     *
22791     * This data will be passed for callback functions, like icon get callback,
22792     * that can be set with elm_map_group_class_icon_cb_set().
22793     *
22794     * If a data was previously set, the object will lose the pointer for it,
22795     * so if needs to be freed, you must do it yourself.
22796     *
22797     * @see elm_map_group_class_new() for more details.
22798     * @see elm_map_group_class_icon_cb_set()
22799     * @see elm_map_marker_add()
22800     *
22801     * @ingroup Map
22802     */
22803    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
22804
22805    /**
22806     * Set the minimum zoom from where the markers are displayed.
22807     *
22808     * @param clas The group class.
22809     * @param zoom The minimum zoom.
22810     *
22811     * Markers only will be displayed when the map is displayed at @p zoom
22812     * or bigger.
22813     *
22814     * @see elm_map_group_class_new() for more details.
22815     * @see elm_map_marker_add()
22816     *
22817     * @ingroup Map
22818     */
22819    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22820
22821    /**
22822     * Set the zoom from where the markers are no more grouped.
22823     *
22824     * @param clas The group class.
22825     * @param zoom The maximum zoom.
22826     *
22827     * Markers only will be grouped when the map is displayed at
22828     * less than @p zoom.
22829     *
22830     * @see elm_map_group_class_new() for more details.
22831     * @see elm_map_marker_add()
22832     *
22833     * @ingroup Map
22834     */
22835    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22836
22837    /**
22838     * Set if the markers associated to the group class @clas are hidden or not.
22839     *
22840     * @param clas The group class.
22841     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
22842     * to show them.
22843     *
22844     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
22845     * is to show them.
22846     *
22847     * @ingroup Map
22848     */
22849    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
22850
22851    /**
22852     * Create a new marker class.
22853     *
22854     * @param obj The map object.
22855     * @return Returns the new group class.
22856     *
22857     * Each marker must be associated to a class.
22858     *
22859     * The marker class defines the style of the marker when a marker is
22860     * displayed alone, i.e., not grouped to to others markers. When grouped
22861     * it will use group class style.
22862     *
22863     * A marker class will need to be provided when creating a marker with
22864     * elm_map_marker_add().
22865     *
22866     * Some properties and functions can be set by class, as:
22867     * - style, with elm_map_marker_class_style_set()
22868     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
22869     *   It can be set using elm_map_marker_class_icon_cb_set().
22870     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
22871     *   Set using elm_map_marker_class_get_cb_set().
22872     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
22873     *   Set using elm_map_marker_class_del_cb_set().
22874     *
22875     * @see elm_map_marker_add()
22876     * @see elm_map_marker_class_style_set()
22877     * @see elm_map_marker_class_icon_cb_set()
22878     * @see elm_map_marker_class_get_cb_set()
22879     * @see elm_map_marker_class_del_cb_set()
22880     *
22881     * @ingroup Map
22882     */
22883    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22884
22885    /**
22886     * Set the marker's style of a marker class.
22887     *
22888     * @param clas The marker class.
22889     * @param style The style to be used by markers.
22890     *
22891     * Each marker must be associated to a marker class, and will use the style
22892     * defined by such class when alone, i.e., @b not grouped to other markers.
22893     *
22894     * The following styles are provided by default theme:
22895     * @li @c radio
22896     * @li @c radio2
22897     * @li @c empty
22898     *
22899     * @see elm_map_marker_class_new() for more details.
22900     * @see elm_map_marker_add()
22901     *
22902     * @ingroup Map
22903     */
22904    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22905
22906    /**
22907     * Set the icon callback function of a marker class.
22908     *
22909     * @param clas The marker class.
22910     * @param icon_get The callback function that will return the icon.
22911     *
22912     * Each marker must be associated to a marker class, and it can display a
22913     * custom icon. The function @p icon_get must return this icon.
22914     *
22915     * @see elm_map_marker_class_new() for more details.
22916     * @see elm_map_marker_add()
22917     *
22918     * @ingroup Map
22919     */
22920    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22921
22922    /**
22923     * Set the bubble content callback function of a marker class.
22924     *
22925     * @param clas The marker class.
22926     * @param get The callback function that will return the content.
22927     *
22928     * Each marker must be associated to a marker class, and it can display a
22929     * a content on a bubble that opens when the user click over the marker.
22930     * The function @p get must return this content object.
22931     *
22932     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
22933     * can be used.
22934     *
22935     * @see elm_map_marker_class_new() for more details.
22936     * @see elm_map_marker_class_del_cb_set()
22937     * @see elm_map_marker_add()
22938     *
22939     * @ingroup Map
22940     */
22941    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
22942
22943    /**
22944     * Set the callback function used to delete bubble content of a marker class.
22945     *
22946     * @param clas The marker class.
22947     * @param del The callback function that will delete the content.
22948     *
22949     * Each marker must be associated to a marker class, and it can display a
22950     * a content on a bubble that opens when the user click over the marker.
22951     * The function to return such content can be set with
22952     * elm_map_marker_class_get_cb_set().
22953     *
22954     * If this content must be freed, a callback function need to be
22955     * set for that task with this function.
22956     *
22957     * If this callback is defined it will have to delete (or not) the
22958     * object inside, but if the callback is not defined the object will be
22959     * destroyed with evas_object_del().
22960     *
22961     * @see elm_map_marker_class_new() for more details.
22962     * @see elm_map_marker_class_get_cb_set()
22963     * @see elm_map_marker_add()
22964     *
22965     * @ingroup Map
22966     */
22967    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
22968
22969    /**
22970     * Get the list of available sources.
22971     *
22972     * @param obj The map object.
22973     * @return The source names list.
22974     *
22975     * It will provide a list with all available sources, that can be set as
22976     * current source with elm_map_source_name_set(), or get with
22977     * elm_map_source_name_get().
22978     *
22979     * Available sources:
22980     * @li "Mapnik"
22981     * @li "Osmarender"
22982     * @li "CycleMap"
22983     * @li "Maplint"
22984     *
22985     * @see elm_map_source_name_set() for more details.
22986     * @see elm_map_source_name_get()
22987     *
22988     * @ingroup Map
22989     */
22990    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22991
22992    /**
22993     * Set the source of the map.
22994     *
22995     * @param obj The map object.
22996     * @param source The source to be used.
22997     *
22998     * Map widget retrieves images that composes the map from a web service.
22999     * This web service can be set with this method.
23000     *
23001     * A different service can return a different maps with different
23002     * information and it can use different zoom values.
23003     *
23004     * The @p source_name need to match one of the names provided by
23005     * elm_map_source_names_get().
23006     *
23007     * The current source can be get using elm_map_source_name_get().
23008     *
23009     * @see elm_map_source_names_get()
23010     * @see elm_map_source_name_get()
23011     *
23012     *
23013     * @ingroup Map
23014     */
23015    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23016
23017    /**
23018     * Get the name of currently used source.
23019     *
23020     * @param obj The map object.
23021     * @return Returns the name of the source in use.
23022     *
23023     * @see elm_map_source_name_set() for more details.
23024     *
23025     * @ingroup Map
23026     */
23027    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23028
23029    /**
23030     * Set the source of the route service to be used by the map.
23031     *
23032     * @param obj The map object.
23033     * @param source The route service to be used, being it one of
23034     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23035     * and #ELM_MAP_ROUTE_SOURCE_ORS.
23036     *
23037     * Each one has its own algorithm, so the route retrieved may
23038     * differ depending on the source route. Now, only the default is working.
23039     *
23040     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23041     * http://www.yournavigation.org/.
23042     *
23043     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23044     * assumptions. Its routing core is based on Contraction Hierarchies.
23045     *
23046     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23047     *
23048     * @see elm_map_route_source_get().
23049     *
23050     * @ingroup Map
23051     */
23052    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23053
23054    /**
23055     * Get the current route source.
23056     *
23057     * @param obj The map object.
23058     * @return The source of the route service used by the map.
23059     *
23060     * @see elm_map_route_source_set() for details.
23061     *
23062     * @ingroup Map
23063     */
23064    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23065
23066    /**
23067     * Set the minimum zoom of the source.
23068     *
23069     * @param obj The map object.
23070     * @param zoom New minimum zoom value to be used.
23071     *
23072     * By default, it's 0.
23073     *
23074     * @ingroup Map
23075     */
23076    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23077
23078    /**
23079     * Get the minimum zoom of the source.
23080     *
23081     * @param obj The map object.
23082     * @return Returns the minimum zoom of the source.
23083     *
23084     * @see elm_map_source_zoom_min_set() for details.
23085     *
23086     * @ingroup Map
23087     */
23088    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23089
23090    /**
23091     * Set the maximum zoom of the source.
23092     *
23093     * @param obj The map object.
23094     * @param zoom New maximum zoom value to be used.
23095     *
23096     * By default, it's 18.
23097     *
23098     * @ingroup Map
23099     */
23100    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23101
23102    /**
23103     * Get the maximum zoom of the source.
23104     *
23105     * @param obj The map object.
23106     * @return Returns the maximum zoom of the source.
23107     *
23108     * @see elm_map_source_zoom_min_set() for details.
23109     *
23110     * @ingroup Map
23111     */
23112    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23113
23114    /**
23115     * Set the user agent used by the map object to access routing services.
23116     *
23117     * @param obj The map object.
23118     * @param user_agent The user agent to be used by the map.
23119     *
23120     * User agent is a client application implementing a network protocol used
23121     * in communications within a client–server distributed computing system
23122     *
23123     * The @p user_agent identification string will transmitted in a header
23124     * field @c User-Agent.
23125     *
23126     * @see elm_map_user_agent_get()
23127     *
23128     * @ingroup Map
23129     */
23130    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23131
23132    /**
23133     * Get the user agent used by the map object.
23134     *
23135     * @param obj The map object.
23136     * @return The user agent identification string used by the map.
23137     *
23138     * @see elm_map_user_agent_set() for details.
23139     *
23140     * @ingroup Map
23141     */
23142    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23143
23144    /**
23145     * Add a new route to the map object.
23146     *
23147     * @param obj The map object.
23148     * @param type The type of transport to be considered when tracing a route.
23149     * @param method The routing method, what should be priorized.
23150     * @param flon The start longitude.
23151     * @param flat The start latitude.
23152     * @param tlon The destination longitude.
23153     * @param tlat The destination latitude.
23154     *
23155     * @return The created route or @c NULL upon failure.
23156     *
23157     * A route will be traced by point on coordinates (@p flat, @p flon)
23158     * to point on coordinates (@p tlat, @p tlon), using the route service
23159     * set with elm_map_route_source_set().
23160     *
23161     * It will take @p type on consideration to define the route,
23162     * depending if the user will be walking or driving, the route may vary.
23163     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23164     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23165     *
23166     * Another parameter is what the route should priorize, the minor distance
23167     * or the less time to be spend on the route. So @p method should be one
23168     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23169     *
23170     * Routes created with this method can be deleted with
23171     * elm_map_route_remove(), colored with elm_map_route_color_set(),
23172     * and distance can be get with elm_map_route_distance_get().
23173     *
23174     * @see elm_map_route_remove()
23175     * @see elm_map_route_color_set()
23176     * @see elm_map_route_distance_get()
23177     * @see elm_map_route_source_set()
23178     *
23179     * @ingroup Map
23180     */
23181    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);
23182
23183    /**
23184     * Remove a route from the map.
23185     *
23186     * @param route The route to remove.
23187     *
23188     * @see elm_map_route_add()
23189     *
23190     * @ingroup Map
23191     */
23192    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23193
23194    /**
23195     * Set the route color.
23196     *
23197     * @param route The route object.
23198     * @param r Red channel value, from 0 to 255.
23199     * @param g Green channel value, from 0 to 255.
23200     * @param b Blue channel value, from 0 to 255.
23201     * @param a Alpha channel value, from 0 to 255.
23202     *
23203     * It uses an additive color model, so each color channel represents
23204     * how much of each primary colors must to be used. 0 represents
23205     * ausence of this color, so if all of the three are set to 0,
23206     * the color will be black.
23207     *
23208     * These component values should be integers in the range 0 to 255,
23209     * (single 8-bit byte).
23210     *
23211     * This sets the color used for the route. By default, it is set to
23212     * solid red (r = 255, g = 0, b = 0, a = 255).
23213     *
23214     * For alpha channel, 0 represents completely transparent, and 255, opaque.
23215     *
23216     * @see elm_map_route_color_get()
23217     *
23218     * @ingroup Map
23219     */
23220    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23221
23222    /**
23223     * Get the route color.
23224     *
23225     * @param route The route object.
23226     * @param r Pointer where to store the red channel value.
23227     * @param g Pointer where to store the green channel value.
23228     * @param b Pointer where to store the blue channel value.
23229     * @param a Pointer where to store the alpha channel value.
23230     *
23231     * @see elm_map_route_color_set() for details.
23232     *
23233     * @ingroup Map
23234     */
23235    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23236
23237    /**
23238     * Get the route distance in kilometers.
23239     *
23240     * @param route The route object.
23241     * @return The distance of route (unit : km).
23242     *
23243     * @ingroup Map
23244     */
23245    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23246
23247    /**
23248     * Get the information of route nodes.
23249     *
23250     * @param route The route object.
23251     * @return Returns a string with the nodes of route.
23252     *
23253     * @ingroup Map
23254     */
23255    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23256
23257    /**
23258     * Get the information of route waypoint.
23259     *
23260     * @param route the route object.
23261     * @return Returns a string with information about waypoint of route.
23262     *
23263     * @ingroup Map
23264     */
23265    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23266
23267    /**
23268     * Get the address of the name.
23269     *
23270     * @param name The name handle.
23271     * @return Returns the address string of @p name.
23272     *
23273     * This gets the coordinates of the @p name, created with one of the
23274     * conversion functions.
23275     *
23276     * @see elm_map_utils_convert_name_into_coord()
23277     * @see elm_map_utils_convert_coord_into_name()
23278     *
23279     * @ingroup Map
23280     */
23281    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23282
23283    /**
23284     * Get the current coordinates of the name.
23285     *
23286     * @param name The name handle.
23287     * @param lat Pointer where to store the latitude.
23288     * @param lon Pointer where to store The longitude.
23289     *
23290     * This gets the coordinates of the @p name, created with one of the
23291     * conversion functions.
23292     *
23293     * @see elm_map_utils_convert_name_into_coord()
23294     * @see elm_map_utils_convert_coord_into_name()
23295     *
23296     * @ingroup Map
23297     */
23298    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23299
23300    /**
23301     * Remove a name from the map.
23302     *
23303     * @param name The name to remove.
23304     *
23305     * Basically the struct handled by @p name will be freed, so convertions
23306     * between address and coordinates will be lost.
23307     *
23308     * @see elm_map_utils_convert_name_into_coord()
23309     * @see elm_map_utils_convert_coord_into_name()
23310     *
23311     * @ingroup Map
23312     */
23313    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23314
23315    /**
23316     * Rotate the map.
23317     *
23318     * @param obj The map object.
23319     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23320     * @param cx Rotation's center horizontal position.
23321     * @param cy Rotation's center vertical position.
23322     *
23323     * @see elm_map_rotate_get()
23324     *
23325     * @ingroup Map
23326     */
23327    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23328
23329    /**
23330     * Get the rotate degree of the map
23331     *
23332     * @param obj The map object
23333     * @param degree Pointer where to store degrees from 0.0 to 360.0
23334     * to rotate arount Z axis.
23335     * @param cx Pointer where to store rotation's center horizontal position.
23336     * @param cy Pointer where to store rotation's center vertical position.
23337     *
23338     * @see elm_map_rotate_set() to set map rotation.
23339     *
23340     * @ingroup Map
23341     */
23342    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);
23343
23344    /**
23345     * Enable or disable mouse wheel to be used to zoom in / out the map.
23346     *
23347     * @param obj The map object.
23348     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23349     * to enable it.
23350     *
23351     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23352     *
23353     * It's disabled by default.
23354     *
23355     * @see elm_map_wheel_disabled_get()
23356     *
23357     * @ingroup Map
23358     */
23359    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23360
23361    /**
23362     * Get a value whether mouse wheel is enabled or not.
23363     *
23364     * @param obj The map object.
23365     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23366     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23367     *
23368     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23369     *
23370     * @see elm_map_wheel_disabled_set() for details.
23371     *
23372     * @ingroup Map
23373     */
23374    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23375
23376 #ifdef ELM_EMAP
23377    /**
23378     * Add a track on the map
23379     *
23380     * @param obj The map object.
23381     * @param emap The emap route object.
23382     * @return The route object. This is an elm object of type Route.
23383     *
23384     * @see elm_route_add() for details.
23385     *
23386     * @ingroup Map
23387     */
23388    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23389 #endif
23390
23391    /**
23392     * Remove a track from the map
23393     *
23394     * @param obj The map object.
23395     * @param route The track to remove.
23396     *
23397     * @ingroup Map
23398     */
23399    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23400
23401    /**
23402     * @}
23403     */
23404
23405    /* Route */
23406    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23407 #ifdef ELM_EMAP
23408    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23409 #endif
23410    EAPI double elm_route_lon_min_get(Evas_Object *obj);
23411    EAPI double elm_route_lat_min_get(Evas_Object *obj);
23412    EAPI double elm_route_lon_max_get(Evas_Object *obj);
23413    EAPI double elm_route_lat_max_get(Evas_Object *obj);
23414
23415
23416    /**
23417     * @defgroup Panel Panel
23418     *
23419     * @image html img/widget/panel/preview-00.png
23420     * @image latex img/widget/panel/preview-00.eps
23421     *
23422     * @brief A panel is a type of animated container that contains subobjects.
23423     * It can be expanded or contracted by clicking the button on it's edge.
23424     *
23425     * Orientations are as follows:
23426     * @li ELM_PANEL_ORIENT_TOP
23427     * @li ELM_PANEL_ORIENT_LEFT
23428     * @li ELM_PANEL_ORIENT_RIGHT
23429     *
23430     * @ref tutorial_panel shows one way to use this widget.
23431     * @{
23432     */
23433    typedef enum _Elm_Panel_Orient
23434      {
23435         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23436         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23437         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23438         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23439      } Elm_Panel_Orient;
23440    /**
23441     * @brief Adds a panel object
23442     *
23443     * @param parent The parent object
23444     *
23445     * @return The panel object, or NULL on failure
23446     */
23447    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23448    /**
23449     * @brief Sets the orientation of the panel
23450     *
23451     * @param parent The parent object
23452     * @param orient The panel orientation. Can be one of the following:
23453     * @li ELM_PANEL_ORIENT_TOP
23454     * @li ELM_PANEL_ORIENT_LEFT
23455     * @li ELM_PANEL_ORIENT_RIGHT
23456     *
23457     * Sets from where the panel will (dis)appear.
23458     */
23459    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23460    /**
23461     * @brief Get the orientation of the panel.
23462     *
23463     * @param obj The panel object
23464     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23465     */
23466    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23467    /**
23468     * @brief Set the content of the panel.
23469     *
23470     * @param obj The panel object
23471     * @param content The panel content
23472     *
23473     * Once the content object is set, a previously set one will be deleted.
23474     * If you want to keep that old content object, use the
23475     * elm_panel_content_unset() function.
23476     */
23477    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23478    /**
23479     * @brief Get the content of the panel.
23480     *
23481     * @param obj The panel object
23482     * @return The content that is being used
23483     *
23484     * Return the content object which is set for this widget.
23485     *
23486     * @see elm_panel_content_set()
23487     */
23488    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23489    /**
23490     * @brief Unset the content of the panel.
23491     *
23492     * @param obj The panel object
23493     * @return The content that was being used
23494     *
23495     * Unparent and return the content object which was set for this widget.
23496     *
23497     * @see elm_panel_content_set()
23498     */
23499    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23500    /**
23501     * @brief Set the state of the panel.
23502     *
23503     * @param obj The panel object
23504     * @param hidden If true, the panel will run the animation to contract
23505     */
23506    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23507    /**
23508     * @brief Get the state of the panel.
23509     *
23510     * @param obj The panel object
23511     * @param hidden If true, the panel is in the "hide" state
23512     */
23513    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23514    /**
23515     * @brief Toggle the hidden state of the panel from code
23516     *
23517     * @param obj The panel object
23518     */
23519    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23520    /**
23521     * @}
23522     */
23523
23524    /**
23525     * @defgroup Panes Panes
23526     * @ingroup Elementary
23527     *
23528     * @image html img/widget/panes/preview-00.png
23529     * @image latex img/widget/panes/preview-00.eps width=\textwidth
23530     *
23531     * @image html img/panes.png
23532     * @image latex img/panes.eps width=\textwidth
23533     *
23534     * The panes adds a dragable bar between two contents. When dragged
23535     * this bar will resize contents size.
23536     *
23537     * Panes can be displayed vertically or horizontally, and contents
23538     * size proportion can be customized (homogeneous by default).
23539     *
23540     * Smart callbacks one can listen to:
23541     * - "press" - The panes has been pressed (button wasn't released yet).
23542     * - "unpressed" - The panes was released after being pressed.
23543     * - "clicked" - The panes has been clicked>
23544     * - "clicked,double" - The panes has been double clicked
23545     *
23546     * Available styles for it:
23547     * - @c "default"
23548     *
23549     * Here is an example on its usage:
23550     * @li @ref panes_example
23551     */
23552
23553    /**
23554     * @addtogroup Panes
23555     * @{
23556     */
23557
23558    /**
23559     * Add a new panes widget to the given parent Elementary
23560     * (container) object.
23561     *
23562     * @param parent The parent object.
23563     * @return a new panes widget handle or @c NULL, on errors.
23564     *
23565     * This function inserts a new panes widget on the canvas.
23566     *
23567     * @ingroup Panes
23568     */
23569    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23570
23571    /**
23572     * Set the left content of the panes widget.
23573     *
23574     * @param obj The panes object.
23575     * @param content The new left content object.
23576     *
23577     * Once the content object is set, a previously set one will be deleted.
23578     * If you want to keep that old content object, use the
23579     * elm_panes_content_left_unset() function.
23580     *
23581     * If panes is displayed vertically, left content will be displayed at
23582     * top.
23583     *
23584     * @see elm_panes_content_left_get()
23585     * @see elm_panes_content_right_set() to set content on the other side.
23586     *
23587     * @ingroup Panes
23588     */
23589    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23590
23591    /**
23592     * Set the right content of the panes widget.
23593     *
23594     * @param obj The panes object.
23595     * @param content The new right content object.
23596     *
23597     * Once the content object is set, a previously set one will be deleted.
23598     * If you want to keep that old content object, use the
23599     * elm_panes_content_right_unset() function.
23600     *
23601     * If panes is displayed vertically, left content will be displayed at
23602     * bottom.
23603     *
23604     * @see elm_panes_content_right_get()
23605     * @see elm_panes_content_left_set() to set content on the other side.
23606     *
23607     * @ingroup Panes
23608     */
23609    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23610
23611    /**
23612     * Get the left content of the panes.
23613     *
23614     * @param obj The panes object.
23615     * @return The left content object that is being used.
23616     *
23617     * Return the left content object which is set for this widget.
23618     *
23619     * @see elm_panes_content_left_set() for details.
23620     *
23621     * @ingroup Panes
23622     */
23623    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23624
23625    /**
23626     * Get the right content of the panes.
23627     *
23628     * @param obj The panes object
23629     * @return The right content object that is being used
23630     *
23631     * Return the right content object which is set for this widget.
23632     *
23633     * @see elm_panes_content_right_set() for details.
23634     *
23635     * @ingroup Panes
23636     */
23637    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23638
23639    /**
23640     * Unset the left content used for the panes.
23641     *
23642     * @param obj The panes object.
23643     * @return The left content object that was being used.
23644     *
23645     * Unparent and return the left content object which was set for this widget.
23646     *
23647     * @see elm_panes_content_left_set() for details.
23648     * @see elm_panes_content_left_get().
23649     *
23650     * @ingroup Panes
23651     */
23652    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23653
23654    /**
23655     * Unset the right content used for the panes.
23656     *
23657     * @param obj The panes object.
23658     * @return The right content object that was being used.
23659     *
23660     * Unparent and return the right content object which was set for this
23661     * widget.
23662     *
23663     * @see elm_panes_content_right_set() for details.
23664     * @see elm_panes_content_right_get().
23665     *
23666     * @ingroup Panes
23667     */
23668    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23669
23670    /**
23671     * Get the size proportion of panes widget's left side.
23672     *
23673     * @param obj The panes object.
23674     * @return float value between 0.0 and 1.0 representing size proportion
23675     * of left side.
23676     *
23677     * @see elm_panes_content_left_size_set() for more details.
23678     *
23679     * @ingroup Panes
23680     */
23681    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23682
23683    /**
23684     * Set the size proportion of panes widget's left side.
23685     *
23686     * @param obj The panes object.
23687     * @param size Value between 0.0 and 1.0 representing size proportion
23688     * of left side.
23689     *
23690     * By default it's homogeneous, i.e., both sides have the same size.
23691     *
23692     * If something different is required, it can be set with this function.
23693     * For example, if the left content should be displayed over
23694     * 75% of the panes size, @p size should be passed as @c 0.75.
23695     * This way, right content will be resized to 25% of panes size.
23696     *
23697     * If displayed vertically, left content is displayed at top, and
23698     * right content at bottom.
23699     *
23700     * @note This proportion will change when user drags the panes bar.
23701     *
23702     * @see elm_panes_content_left_size_get()
23703     *
23704     * @ingroup Panes
23705     */
23706    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
23707
23708   /**
23709    * Set the orientation of a given panes widget.
23710    *
23711    * @param obj The panes object.
23712    * @param horizontal Use @c EINA_TRUE to make @p obj to be
23713    * @b horizontal, @c EINA_FALSE to make it @b vertical.
23714    *
23715    * Use this function to change how your panes is to be
23716    * disposed: vertically or horizontally.
23717    *
23718    * By default it's displayed horizontally.
23719    *
23720    * @see elm_panes_horizontal_get()
23721    *
23722    * @ingroup Panes
23723    */
23724    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
23725
23726    /**
23727     * Retrieve the orientation of a given panes widget.
23728     *
23729     * @param obj The panes object.
23730     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
23731     * @c EINA_FALSE if it's @b vertical (and on errors).
23732     *
23733     * @see elm_panes_horizontal_set() for more details.
23734     *
23735     * @ingroup Panes
23736     */
23737    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23738    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
23739    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23740
23741    /**
23742     * @}
23743     */
23744
23745    /**
23746     * @defgroup Flip Flip
23747     *
23748     * @image html img/widget/flip/preview-00.png
23749     * @image latex img/widget/flip/preview-00.eps
23750     *
23751     * This widget holds 2 content objects(Evas_Object): one on the front and one
23752     * on the back. It allows you to flip from front to back and vice-versa using
23753     * various animations.
23754     *
23755     * If either the front or back contents are not set the flip will treat that
23756     * as transparent. So if you wore to set the front content but not the back,
23757     * and then call elm_flip_go() you would see whatever is below the flip.
23758     *
23759     * For a list of supported animations see elm_flip_go().
23760     *
23761     * Signals that you can add callbacks for are:
23762     * "animate,begin" - when a flip animation was started
23763     * "animate,done" - when a flip animation is finished
23764     *
23765     * @ref tutorial_flip show how to use most of the API.
23766     *
23767     * @{
23768     */
23769    typedef enum _Elm_Flip_Mode
23770      {
23771         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
23772         ELM_FLIP_ROTATE_X_CENTER_AXIS,
23773         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
23774         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
23775         ELM_FLIP_CUBE_LEFT,
23776         ELM_FLIP_CUBE_RIGHT,
23777         ELM_FLIP_CUBE_UP,
23778         ELM_FLIP_CUBE_DOWN,
23779         ELM_FLIP_PAGE_LEFT,
23780         ELM_FLIP_PAGE_RIGHT,
23781         ELM_FLIP_PAGE_UP,
23782         ELM_FLIP_PAGE_DOWN
23783      } Elm_Flip_Mode;
23784    typedef enum _Elm_Flip_Interaction
23785      {
23786         ELM_FLIP_INTERACTION_NONE,
23787         ELM_FLIP_INTERACTION_ROTATE,
23788         ELM_FLIP_INTERACTION_CUBE,
23789         ELM_FLIP_INTERACTION_PAGE
23790      } Elm_Flip_Interaction;
23791    typedef enum _Elm_Flip_Direction
23792      {
23793         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
23794         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
23795         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
23796         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
23797      } Elm_Flip_Direction;
23798    /**
23799     * @brief Add a new flip to the parent
23800     *
23801     * @param parent The parent object
23802     * @return The new object or NULL if it cannot be created
23803     */
23804    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23805    /**
23806     * @brief Set the front content of the flip widget.
23807     *
23808     * @param obj The flip object
23809     * @param content The new front content object
23810     *
23811     * Once the content object is set, a previously set one will be deleted.
23812     * If you want to keep that old content object, use the
23813     * elm_flip_content_front_unset() function.
23814     */
23815    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23816    /**
23817     * @brief Set the back content of the flip widget.
23818     *
23819     * @param obj The flip object
23820     * @param content The new back content object
23821     *
23822     * Once the content object is set, a previously set one will be deleted.
23823     * If you want to keep that old content object, use the
23824     * elm_flip_content_back_unset() function.
23825     */
23826    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23827    /**
23828     * @brief Get the front content used for the flip
23829     *
23830     * @param obj The flip object
23831     * @return The front content object that is being used
23832     *
23833     * Return the front content object which is set for this widget.
23834     */
23835    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23836    /**
23837     * @brief Get the back content used for the flip
23838     *
23839     * @param obj The flip object
23840     * @return The back content object that is being used
23841     *
23842     * Return the back content object which is set for this widget.
23843     */
23844    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23845    /**
23846     * @brief Unset the front content used for the flip
23847     *
23848     * @param obj The flip object
23849     * @return The front content object that was being used
23850     *
23851     * Unparent and return the front content object which was set for this widget.
23852     */
23853    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23854    /**
23855     * @brief Unset the back content used for the flip
23856     *
23857     * @param obj The flip object
23858     * @return The back content object that was being used
23859     *
23860     * Unparent and return the back content object which was set for this widget.
23861     */
23862    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23863    /**
23864     * @brief Get flip front visibility state
23865     *
23866     * @param obj The flip objct
23867     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
23868     * showing.
23869     */
23870    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23871    /**
23872     * @brief Set flip perspective
23873     *
23874     * @param obj The flip object
23875     * @param foc The coordinate to set the focus on
23876     * @param x The X coordinate
23877     * @param y The Y coordinate
23878     *
23879     * @warning This function currently does nothing.
23880     */
23881    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
23882    /**
23883     * @brief Runs the flip animation
23884     *
23885     * @param obj The flip object
23886     * @param mode The mode type
23887     *
23888     * Flips the front and back contents using the @p mode animation. This
23889     * efectively hides the currently visible content and shows the hidden one.
23890     *
23891     * There a number of possible animations to use for the flipping:
23892     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
23893     * around a horizontal axis in the middle of its height, the other content
23894     * is shown as the other side of the flip.
23895     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
23896     * around a vertical axis in the middle of its width, the other content is
23897     * shown as the other side of the flip.
23898     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
23899     * around a diagonal axis in the middle of its width, the other content is
23900     * shown as the other side of the flip.
23901     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
23902     * around a diagonal axis in the middle of its height, the other content is
23903     * shown as the other side of the flip.
23904     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
23905     * as if the flip was a cube, the other content is show as the right face of
23906     * the cube.
23907     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
23908     * right as if the flip was a cube, the other content is show as the left
23909     * face of the cube.
23910     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
23911     * flip was a cube, the other content is show as the bottom face of the cube.
23912     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
23913     * the flip was a cube, the other content is show as the upper face of the
23914     * cube.
23915     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
23916     * if the flip was a book, the other content is shown as the page below that.
23917     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
23918     * as if the flip was a book, the other content is shown as the page below
23919     * that.
23920     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
23921     * flip was a book, the other content is shown as the page below that.
23922     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
23923     * flip was a book, the other content is shown as the page below that.
23924     *
23925     * @image html elm_flip.png
23926     * @image latex elm_flip.eps width=\textwidth
23927     */
23928    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
23929    /**
23930     * @brief Set the interactive flip mode
23931     *
23932     * @param obj The flip object
23933     * @param mode The interactive flip mode to use
23934     *
23935     * This sets if the flip should be interactive (allow user to click and
23936     * drag a side of the flip to reveal the back page and cause it to flip).
23937     * By default a flip is not interactive. You may also need to set which
23938     * sides of the flip are "active" for flipping and how much space they use
23939     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
23940     * and elm_flip_interacton_direction_hitsize_set()
23941     *
23942     * The four avilable mode of interaction are:
23943     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
23944     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
23945     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
23946     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
23947     *
23948     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
23949     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
23950     * happen, those can only be acheived with elm_flip_go();
23951     */
23952    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
23953    /**
23954     * @brief Get the interactive flip mode
23955     *
23956     * @param obj The flip object
23957     * @return The interactive flip mode
23958     *
23959     * Returns the interactive flip mode set by elm_flip_interaction_set()
23960     */
23961    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
23962    /**
23963     * @brief Set which directions of the flip respond to interactive flip
23964     *
23965     * @param obj The flip object
23966     * @param dir The direction to change
23967     * @param enabled If that direction is enabled or not
23968     *
23969     * By default all directions are disabled, so you may want to enable the
23970     * desired directions for flipping if you need interactive flipping. You must
23971     * call this function once for each direction that should be enabled.
23972     *
23973     * @see elm_flip_interaction_set()
23974     */
23975    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
23976    /**
23977     * @brief Get the enabled state of that flip direction
23978     *
23979     * @param obj The flip object
23980     * @param dir The direction to check
23981     * @return If that direction is enabled or not
23982     *
23983     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
23984     *
23985     * @see elm_flip_interaction_set()
23986     */
23987    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
23988    /**
23989     * @brief Set the amount of the flip that is sensitive to interactive flip
23990     *
23991     * @param obj The flip object
23992     * @param dir The direction to modify
23993     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
23994     *
23995     * Set the amount of the flip that is sensitive to interactive flip, with 0
23996     * representing no area in the flip and 1 representing the entire flip. There
23997     * is however a consideration to be made in that the area will never be
23998     * smaller than the finger size set(as set in your Elementary configuration).
23999     *
24000     * @see elm_flip_interaction_set()
24001     */
24002    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24003    /**
24004     * @brief Get the amount of the flip that is sensitive to interactive flip
24005     *
24006     * @param obj The flip object
24007     * @param dir The direction to check
24008     * @return The size set for that direction
24009     *
24010     * Returns the amount os sensitive area set by
24011     * elm_flip_interacton_direction_hitsize_set().
24012     */
24013    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24014    /**
24015     * @}
24016     */
24017
24018    /* scrolledentry */
24019    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24020    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24021    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24022    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24023    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24024    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24025    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24026    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24027    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24028    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24029    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24030    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24031    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24032    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24033    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24034    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24035    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24036    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24037    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24038    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24039    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24040    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24041    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24042    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24043    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24044    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24045    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24046    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24047    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24048    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24049    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24050    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24051    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24052    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24053    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24054    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);
24055    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24056    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24057    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);
24058    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24059    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);
24060    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24061    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24062    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24063    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24064    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24065    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24066    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24067    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24068    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);
24069    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);
24070    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);
24071    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);
24072    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);
24073    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);
24074    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24075    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24076    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24077    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24078    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24079    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24080    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24081
24082    /**
24083     * @defgroup Conformant Conformant
24084     * @ingroup Elementary
24085     *
24086     * @image html img/widget/conformant/preview-00.png
24087     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24088     *
24089     * @image html img/conformant.png
24090     * @image latex img/conformant.eps width=\textwidth
24091     *
24092     * The aim is to provide a widget that can be used in elementary apps to
24093     * account for space taken up by the indicator, virtual keypad & softkey
24094     * windows when running the illume2 module of E17.
24095     *
24096     * So conformant content will be sized and positioned considering the
24097     * space required for such stuff, and when they popup, as a keyboard
24098     * shows when an entry is selected, conformant content won't change.
24099     *
24100     * Available styles for it:
24101     * - @c "default"
24102     *
24103     * See how to use this widget in this example:
24104     * @ref conformant_example
24105     */
24106
24107    /**
24108     * @addtogroup Conformant
24109     * @{
24110     */
24111
24112    /**
24113     * Add a new conformant widget to the given parent Elementary
24114     * (container) object.
24115     *
24116     * @param parent The parent object.
24117     * @return A new conformant widget handle or @c NULL, on errors.
24118     *
24119     * This function inserts a new conformant widget on the canvas.
24120     *
24121     * @ingroup Conformant
24122     */
24123    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24124
24125    /**
24126     * Set the content of the conformant widget.
24127     *
24128     * @param obj The conformant object.
24129     * @param content The content to be displayed by the conformant.
24130     *
24131     * Content will be sized and positioned considering the space required
24132     * to display a virtual keyboard. So it won't fill all the conformant
24133     * size. This way is possible to be sure that content won't resize
24134     * or be re-positioned after the keyboard is displayed.
24135     *
24136     * Once the content object is set, a previously set one will be deleted.
24137     * If you want to keep that old content object, use the
24138     * elm_conformat_content_unset() function.
24139     *
24140     * @see elm_conformant_content_unset()
24141     * @see elm_conformant_content_get()
24142     *
24143     * @ingroup Conformant
24144     */
24145    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24146
24147    /**
24148     * Get the content of the conformant widget.
24149     *
24150     * @param obj The conformant object.
24151     * @return The content that is being used.
24152     *
24153     * Return the content object which is set for this widget.
24154     * It won't be unparent from conformant. For that, use
24155     * elm_conformant_content_unset().
24156     *
24157     * @see elm_conformant_content_set() for more details.
24158     * @see elm_conformant_content_unset()
24159     *
24160     * @ingroup Conformant
24161     */
24162    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24163
24164    /**
24165     * Unset the content of the conformant widget.
24166     *
24167     * @param obj The conformant object.
24168     * @return The content that was being used.
24169     *
24170     * Unparent and return the content object which was set for this widget.
24171     *
24172     * @see elm_conformant_content_set() for more details.
24173     *
24174     * @ingroup Conformant
24175     */
24176    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24177
24178    /**
24179     * Returns the Evas_Object that represents the content area.
24180     *
24181     * @param obj The conformant object.
24182     * @return The content area of the widget.
24183     *
24184     * @ingroup Conformant
24185     */
24186    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24187
24188    /**
24189     * @}
24190     */
24191
24192    /**
24193     * @defgroup Mapbuf Mapbuf
24194     * @ingroup Elementary
24195     *
24196     * @image html img/widget/mapbuf/preview-00.png
24197     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24198     *
24199     * This holds one content object and uses an Evas Map of transformation
24200     * points to be later used with this content. So the content will be
24201     * moved, resized, etc as a single image. So it will improve performance
24202     * when you have a complex interafce, with a lot of elements, and will
24203     * need to resize or move it frequently (the content object and its
24204     * children).
24205     *
24206     * See how to use this widget in this example:
24207     * @ref mapbuf_example
24208     */
24209
24210    /**
24211     * @addtogroup Mapbuf
24212     * @{
24213     */
24214
24215    /**
24216     * Add a new mapbuf widget to the given parent Elementary
24217     * (container) object.
24218     *
24219     * @param parent The parent object.
24220     * @return A new mapbuf widget handle or @c NULL, on errors.
24221     *
24222     * This function inserts a new mapbuf widget on the canvas.
24223     *
24224     * @ingroup Mapbuf
24225     */
24226    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24227
24228    /**
24229     * Set the content of the mapbuf.
24230     *
24231     * @param obj The mapbuf object.
24232     * @param content The content that will be filled in this mapbuf object.
24233     *
24234     * Once the content object is set, a previously set one will be deleted.
24235     * If you want to keep that old content object, use the
24236     * elm_mapbuf_content_unset() function.
24237     *
24238     * To enable map, elm_mapbuf_enabled_set() should be used.
24239     *
24240     * @ingroup Mapbuf
24241     */
24242    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24243
24244    /**
24245     * Get the content of the mapbuf.
24246     *
24247     * @param obj The mapbuf object.
24248     * @return The content that is being used.
24249     *
24250     * Return the content object which is set for this widget.
24251     *
24252     * @see elm_mapbuf_content_set() for details.
24253     *
24254     * @ingroup Mapbuf
24255     */
24256    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24257
24258    /**
24259     * Unset the content of the mapbuf.
24260     *
24261     * @param obj The mapbuf object.
24262     * @return The content that was being used.
24263     *
24264     * Unparent and return the content object which was set for this widget.
24265     *
24266     * @see elm_mapbuf_content_set() for details.
24267     *
24268     * @ingroup Mapbuf
24269     */
24270    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24271
24272    /**
24273     * Enable or disable the map.
24274     *
24275     * @param obj The mapbuf object.
24276     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24277     *
24278     * This enables the map that is set or disables it. On enable, the object
24279     * geometry will be saved, and the new geometry will change (position and
24280     * size) to reflect the map geometry set.
24281     *
24282     * Also, when enabled, alpha and smooth states will be used, so if the
24283     * content isn't solid, alpha should be enabled, for example, otherwise
24284     * a black retangle will fill the content.
24285     *
24286     * When disabled, the stored map will be freed and geometry prior to
24287     * enabling the map will be restored.
24288     *
24289     * It's disabled by default.
24290     *
24291     * @see elm_mapbuf_alpha_set()
24292     * @see elm_mapbuf_smooth_set()
24293     *
24294     * @ingroup Mapbuf
24295     */
24296    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24297
24298    /**
24299     * Get a value whether map is enabled or not.
24300     *
24301     * @param obj The mapbuf object.
24302     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24303     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24304     *
24305     * @see elm_mapbuf_enabled_set() for details.
24306     *
24307     * @ingroup Mapbuf
24308     */
24309    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24310
24311    /**
24312     * Enable or disable smooth map rendering.
24313     *
24314     * @param obj The mapbuf object.
24315     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24316     * to disable it.
24317     *
24318     * This sets smoothing for map rendering. If the object is a type that has
24319     * its own smoothing settings, then both the smooth settings for this object
24320     * and the map must be turned off.
24321     *
24322     * By default smooth maps are enabled.
24323     *
24324     * @ingroup Mapbuf
24325     */
24326    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24327
24328    /**
24329     * Get a value whether smooth map rendering is enabled or not.
24330     *
24331     * @param obj The mapbuf object.
24332     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24333     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24334     *
24335     * @see elm_mapbuf_smooth_set() for details.
24336     *
24337     * @ingroup Mapbuf
24338     */
24339    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24340
24341    /**
24342     * Set or unset alpha flag for map rendering.
24343     *
24344     * @param obj The mapbuf object.
24345     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24346     * to disable it.
24347     *
24348     * This sets alpha flag for map rendering. If the object is a type that has
24349     * its own alpha settings, then this will take precedence. Only image objects
24350     * have this currently. It stops alpha blending of the map area, and is
24351     * useful if you know the object and/or all sub-objects is 100% solid.
24352     *
24353     * Alpha is enabled by default.
24354     *
24355     * @ingroup Mapbuf
24356     */
24357    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24358
24359    /**
24360     * Get a value whether alpha blending is enabled or not.
24361     *
24362     * @param obj The mapbuf object.
24363     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24364     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24365     *
24366     * @see elm_mapbuf_alpha_set() for details.
24367     *
24368     * @ingroup Mapbuf
24369     */
24370    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24371
24372    /**
24373     * @}
24374     */
24375
24376    /**
24377     * @defgroup Flipselector Flip Selector
24378     *
24379     * @image html img/widget/flipselector/preview-00.png
24380     * @image latex img/widget/flipselector/preview-00.eps
24381     *
24382     * A flip selector is a widget to show a set of @b text items, one
24383     * at a time, with the same sheet switching style as the @ref Clock
24384     * "clock" widget, when one changes the current displaying sheet
24385     * (thus, the "flip" in the name).
24386     *
24387     * User clicks to flip sheets which are @b held for some time will
24388     * make the flip selector to flip continuosly and automatically for
24389     * the user. The interval between flips will keep growing in time,
24390     * so that it helps the user to reach an item which is distant from
24391     * the current selection.
24392     *
24393     * Smart callbacks one can register to:
24394     * - @c "selected" - when the widget's selected text item is changed
24395     * - @c "overflowed" - when the widget's current selection is changed
24396     *   from the first item in its list to the last
24397     * - @c "underflowed" - when the widget's current selection is changed
24398     *   from the last item in its list to the first
24399     *
24400     * Available styles for it:
24401     * - @c "default"
24402     *
24403     * Here is an example on its usage:
24404     * @li @ref flipselector_example
24405     */
24406
24407    /**
24408     * @addtogroup Flipselector
24409     * @{
24410     */
24411
24412    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24413
24414    /**
24415     * Add a new flip selector widget to the given parent Elementary
24416     * (container) widget
24417     *
24418     * @param parent The parent object
24419     * @return a new flip selector widget handle or @c NULL, on errors
24420     *
24421     * This function inserts a new flip selector widget on the canvas.
24422     *
24423     * @ingroup Flipselector
24424     */
24425    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24426
24427    /**
24428     * Programmatically select the next item of a flip selector widget
24429     *
24430     * @param obj The flipselector object
24431     *
24432     * @note The selection will be animated. Also, if it reaches the
24433     * end of its list of member items, it will continue with the first
24434     * one onwards.
24435     *
24436     * @ingroup Flipselector
24437     */
24438    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24439
24440    /**
24441     * Programmatically select the previous item of a flip selector
24442     * widget
24443     *
24444     * @param obj The flipselector object
24445     *
24446     * @note The selection will be animated.  Also, if it reaches the
24447     * beginning of its list of member items, it will continue with the
24448     * last one backwards.
24449     *
24450     * @ingroup Flipselector
24451     */
24452    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24453
24454    /**
24455     * Append a (text) item to a flip selector widget
24456     *
24457     * @param obj The flipselector object
24458     * @param label The (text) label of the new item
24459     * @param func Convenience callback function to take place when
24460     * item is selected
24461     * @param data Data passed to @p func, above
24462     * @return A handle to the item added or @c NULL, on errors
24463     *
24464     * The widget's list of labels to show will be appended with the
24465     * given value. If the user wishes so, a callback function pointer
24466     * can be passed, which will get called when this same item is
24467     * selected.
24468     *
24469     * @note The current selection @b won't be modified by appending an
24470     * element to the list.
24471     *
24472     * @note The maximum length of the text label is going to be
24473     * determined <b>by the widget's theme</b>. Strings larger than
24474     * that value are going to be @b truncated.
24475     *
24476     * @ingroup Flipselector
24477     */
24478    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24479
24480    /**
24481     * Prepend a (text) item to a flip selector widget
24482     *
24483     * @param obj The flipselector object
24484     * @param label The (text) label of the new item
24485     * @param func Convenience callback function to take place when
24486     * item is selected
24487     * @param data Data passed to @p func, above
24488     * @return A handle to the item added or @c NULL, on errors
24489     *
24490     * The widget's list of labels to show will be prepended with the
24491     * given value. If the user wishes so, a callback function pointer
24492     * can be passed, which will get called when this same item is
24493     * selected.
24494     *
24495     * @note The current selection @b won't be modified by prepending
24496     * an element to the list.
24497     *
24498     * @note The maximum length of the text label is going to be
24499     * determined <b>by the widget's theme</b>. Strings larger than
24500     * that value are going to be @b truncated.
24501     *
24502     * @ingroup Flipselector
24503     */
24504    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24505
24506    /**
24507     * Get the internal list of items in a given flip selector widget.
24508     *
24509     * @param obj The flipselector object
24510     * @return The list of items (#Elm_Flipselector_Item as data) or
24511     * @c NULL on errors.
24512     *
24513     * This list is @b not to be modified in any way and must not be
24514     * freed. Use the list members with functions like
24515     * elm_flipselector_item_label_set(),
24516     * elm_flipselector_item_label_get(),
24517     * elm_flipselector_item_del(),
24518     * elm_flipselector_item_selected_get(),
24519     * elm_flipselector_item_selected_set().
24520     *
24521     * @warning This list is only valid until @p obj object's internal
24522     * items list is changed. It should be fetched again with another
24523     * call to this function when changes happen.
24524     *
24525     * @ingroup Flipselector
24526     */
24527    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24528
24529    /**
24530     * Get the first item in the given flip selector widget's list of
24531     * items.
24532     *
24533     * @param obj The flipselector object
24534     * @return The first item or @c NULL, if it has no items (and on
24535     * errors)
24536     *
24537     * @see elm_flipselector_item_append()
24538     * @see elm_flipselector_last_item_get()
24539     *
24540     * @ingroup Flipselector
24541     */
24542    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24543
24544    /**
24545     * Get the last item in the given flip selector widget's list of
24546     * items.
24547     *
24548     * @param obj The flipselector object
24549     * @return The last item or @c NULL, if it has no items (and on
24550     * errors)
24551     *
24552     * @see elm_flipselector_item_prepend()
24553     * @see elm_flipselector_first_item_get()
24554     *
24555     * @ingroup Flipselector
24556     */
24557    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24558
24559    /**
24560     * Get the currently selected item in a flip selector widget.
24561     *
24562     * @param obj The flipselector object
24563     * @return The selected item or @c NULL, if the widget has no items
24564     * (and on erros)
24565     *
24566     * @ingroup Flipselector
24567     */
24568    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24569
24570    /**
24571     * Set whether a given flip selector widget's item should be the
24572     * currently selected one.
24573     *
24574     * @param item The flip selector item
24575     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24576     *
24577     * This sets whether @p item is or not the selected (thus, under
24578     * display) one. If @p item is different than one under display,
24579     * the latter will be unselected. If the @p item is set to be
24580     * unselected, on the other hand, the @b first item in the widget's
24581     * internal members list will be the new selected one.
24582     *
24583     * @see elm_flipselector_item_selected_get()
24584     *
24585     * @ingroup Flipselector
24586     */
24587    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24588
24589    /**
24590     * Get whether a given flip selector widget's item is the currently
24591     * selected one.
24592     *
24593     * @param item The flip selector item
24594     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24595     * (or on errors).
24596     *
24597     * @see elm_flipselector_item_selected_set()
24598     *
24599     * @ingroup Flipselector
24600     */
24601    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24602
24603    /**
24604     * Delete a given item from a flip selector widget.
24605     *
24606     * @param item The item to delete
24607     *
24608     * @ingroup Flipselector
24609     */
24610    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24611
24612    /**
24613     * Get the label of a given flip selector widget's item.
24614     *
24615     * @param item The item to get label from
24616     * @return The text label of @p item or @c NULL, on errors
24617     *
24618     * @see elm_flipselector_item_label_set()
24619     *
24620     * @ingroup Flipselector
24621     */
24622    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24623
24624    /**
24625     * Set the label of a given flip selector widget's item.
24626     *
24627     * @param item The item to set label on
24628     * @param label The text label string, in UTF-8 encoding
24629     *
24630     * @see elm_flipselector_item_label_get()
24631     *
24632     * @ingroup Flipselector
24633     */
24634    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24635
24636    /**
24637     * Gets the item before @p item in a flip selector widget's
24638     * internal list of items.
24639     *
24640     * @param item The item to fetch previous from
24641     * @return The item before the @p item, in its parent's list. If
24642     *         there is no previous item for @p item or there's an
24643     *         error, @c NULL is returned.
24644     *
24645     * @see elm_flipselector_item_next_get()
24646     *
24647     * @ingroup Flipselector
24648     */
24649    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24650
24651    /**
24652     * Gets the item after @p item in a flip selector widget's
24653     * internal list of items.
24654     *
24655     * @param item The item to fetch next from
24656     * @return The item after the @p item, in its parent's list. If
24657     *         there is no next item for @p item or there's an
24658     *         error, @c NULL is returned.
24659     *
24660     * @see elm_flipselector_item_next_get()
24661     *
24662     * @ingroup Flipselector
24663     */
24664    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24665
24666    /**
24667     * Set the interval on time updates for an user mouse button hold
24668     * on a flip selector widget.
24669     *
24670     * @param obj The flip selector object
24671     * @param interval The (first) interval value in seconds
24672     *
24673     * This interval value is @b decreased while the user holds the
24674     * mouse pointer either flipping up or flipping doww a given flip
24675     * selector.
24676     *
24677     * This helps the user to get to a given item distant from the
24678     * current one easier/faster, as it will start to flip quicker and
24679     * quicker on mouse button holds.
24680     *
24681     * The calculation for the next flip interval value, starting from
24682     * the one set with this call, is the previous interval divided by
24683     * 1.05, so it decreases a little bit.
24684     *
24685     * The default starting interval value for automatic flips is
24686     * @b 0.85 seconds.
24687     *
24688     * @see elm_flipselector_interval_get()
24689     *
24690     * @ingroup Flipselector
24691     */
24692    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24693
24694    /**
24695     * Get the interval on time updates for an user mouse button hold
24696     * on a flip selector widget.
24697     *
24698     * @param obj The flip selector object
24699     * @return The (first) interval value, in seconds, set on it
24700     *
24701     * @see elm_flipselector_interval_set() for more details
24702     *
24703     * @ingroup Flipselector
24704     */
24705    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24706    /**
24707     * @}
24708     */
24709
24710    /**
24711     * @addtogroup Calendar
24712     * @{
24713     */
24714
24715    /**
24716     * @enum _Elm_Calendar_Mark_Repeat
24717     * @typedef Elm_Calendar_Mark_Repeat
24718     *
24719     * Event periodicity, used to define if a mark should be repeated
24720     * @b beyond event's day. It's set when a mark is added.
24721     *
24722     * So, for a mark added to 13th May with periodicity set to WEEKLY,
24723     * there will be marks every week after this date. Marks will be displayed
24724     * at 13th, 20th, 27th, 3rd June ...
24725     *
24726     * Values don't work as bitmask, only one can be choosen.
24727     *
24728     * @see elm_calendar_mark_add()
24729     *
24730     * @ingroup Calendar
24731     */
24732    typedef enum _Elm_Calendar_Mark_Repeat
24733      {
24734         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
24735         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
24736         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
24737         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*/
24738         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. */
24739      } Elm_Calendar_Mark_Repeat;
24740
24741    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(). */
24742
24743    /**
24744     * Add a new calendar widget to the given parent Elementary
24745     * (container) object.
24746     *
24747     * @param parent The parent object.
24748     * @return a new calendar widget handle or @c NULL, on errors.
24749     *
24750     * This function inserts a new calendar widget on the canvas.
24751     *
24752     * @ref calendar_example_01
24753     *
24754     * @ingroup Calendar
24755     */
24756    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24757
24758    /**
24759     * Get weekdays names displayed by the calendar.
24760     *
24761     * @param obj The calendar object.
24762     * @return Array of seven strings to be used as weekday names.
24763     *
24764     * By default, weekdays abbreviations get from system are displayed:
24765     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24766     * The first string is related to Sunday, the second to Monday...
24767     *
24768     * @see elm_calendar_weekdays_name_set()
24769     *
24770     * @ref calendar_example_05
24771     *
24772     * @ingroup Calendar
24773     */
24774    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24775
24776    /**
24777     * Set weekdays names to be displayed by the calendar.
24778     *
24779     * @param obj The calendar object.
24780     * @param weekdays Array of seven strings to be used as weekday names.
24781     * @warning It must have 7 elements, or it will access invalid memory.
24782     * @warning The strings must be NULL terminated ('@\0').
24783     *
24784     * By default, weekdays abbreviations get from system are displayed:
24785     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24786     *
24787     * The first string should be related to Sunday, the second to Monday...
24788     *
24789     * The usage should be like this:
24790     * @code
24791     *   const char *weekdays[] =
24792     *   {
24793     *      "Sunday", "Monday", "Tuesday", "Wednesday",
24794     *      "Thursday", "Friday", "Saturday"
24795     *   };
24796     *   elm_calendar_weekdays_names_set(calendar, weekdays);
24797     * @endcode
24798     *
24799     * @see elm_calendar_weekdays_name_get()
24800     *
24801     * @ref calendar_example_02
24802     *
24803     * @ingroup Calendar
24804     */
24805    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
24806
24807    /**
24808     * Set the minimum and maximum values for the year
24809     *
24810     * @param obj The calendar object
24811     * @param min The minimum year, greater than 1901;
24812     * @param max The maximum year;
24813     *
24814     * Maximum must be greater than minimum, except if you don't wan't to set
24815     * maximum year.
24816     * Default values are 1902 and -1.
24817     *
24818     * If the maximum year is a negative value, it will be limited depending
24819     * on the platform architecture (year 2037 for 32 bits);
24820     *
24821     * @see elm_calendar_min_max_year_get()
24822     *
24823     * @ref calendar_example_03
24824     *
24825     * @ingroup Calendar
24826     */
24827    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
24828
24829    /**
24830     * Get the minimum and maximum values for the year
24831     *
24832     * @param obj The calendar object.
24833     * @param min The minimum year.
24834     * @param max The maximum year.
24835     *
24836     * Default values are 1902 and -1.
24837     *
24838     * @see elm_calendar_min_max_year_get() for more details.
24839     *
24840     * @ref calendar_example_05
24841     *
24842     * @ingroup Calendar
24843     */
24844    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
24845
24846    /**
24847     * Enable or disable day selection
24848     *
24849     * @param obj The calendar object.
24850     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
24851     * disable it.
24852     *
24853     * Enabled by default. If disabled, the user still can select months,
24854     * but not days. Selected days are highlighted on calendar.
24855     * It should be used if you won't need such selection for the widget usage.
24856     *
24857     * When a day is selected, or month is changed, smart callbacks for
24858     * signal "changed" will be called.
24859     *
24860     * @see elm_calendar_day_selection_enable_get()
24861     *
24862     * @ref calendar_example_04
24863     *
24864     * @ingroup Calendar
24865     */
24866    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24867
24868    /**
24869     * Get a value whether day selection is enabled or not.
24870     *
24871     * @see elm_calendar_day_selection_enable_set() for details.
24872     *
24873     * @param obj The calendar object.
24874     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
24875     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
24876     *
24877     * @ref calendar_example_05
24878     *
24879     * @ingroup Calendar
24880     */
24881    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24882
24883
24884    /**
24885     * Set selected date to be highlighted on calendar.
24886     *
24887     * @param obj The calendar object.
24888     * @param selected_time A @b tm struct to represent the selected date.
24889     *
24890     * Set the selected date, changing the displayed month if needed.
24891     * Selected date changes when the user goes to next/previous month or
24892     * select a day pressing over it on calendar.
24893     *
24894     * @see elm_calendar_selected_time_get()
24895     *
24896     * @ref calendar_example_04
24897     *
24898     * @ingroup Calendar
24899     */
24900    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
24901
24902    /**
24903     * Get selected date.
24904     *
24905     * @param obj The calendar object
24906     * @param selected_time A @b tm struct to point to selected date
24907     * @return EINA_FALSE means an error ocurred and returned time shouldn't
24908     * be considered.
24909     *
24910     * Get date selected by the user or set by function
24911     * elm_calendar_selected_time_set().
24912     * Selected date changes when the user goes to next/previous month or
24913     * select a day pressing over it on calendar.
24914     *
24915     * @see elm_calendar_selected_time_get()
24916     *
24917     * @ref calendar_example_05
24918     *
24919     * @ingroup Calendar
24920     */
24921    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
24922
24923    /**
24924     * Set a function to format the string that will be used to display
24925     * month and year;
24926     *
24927     * @param obj The calendar object
24928     * @param format_function Function to set the month-year string given
24929     * the selected date
24930     *
24931     * By default it uses strftime with "%B %Y" format string.
24932     * It should allocate the memory that will be used by the string,
24933     * that will be freed by the widget after usage.
24934     * A pointer to the string and a pointer to the time struct will be provided.
24935     *
24936     * Example:
24937     * @code
24938     * static char *
24939     * _format_month_year(struct tm *selected_time)
24940     * {
24941     *    char buf[32];
24942     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
24943     *    return strdup(buf);
24944     * }
24945     *
24946     * elm_calendar_format_function_set(calendar, _format_month_year);
24947     * @endcode
24948     *
24949     * @ref calendar_example_02
24950     *
24951     * @ingroup Calendar
24952     */
24953    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
24954
24955    /**
24956     * Add a new mark to the calendar
24957     *
24958     * @param obj The calendar object
24959     * @param mark_type A string used to define the type of mark. It will be
24960     * emitted to the theme, that should display a related modification on these
24961     * days representation.
24962     * @param mark_time A time struct to represent the date of inclusion of the
24963     * mark. For marks that repeats it will just be displayed after the inclusion
24964     * date in the calendar.
24965     * @param repeat Repeat the event following this periodicity. Can be a unique
24966     * mark (that don't repeat), daily, weekly, monthly or annually.
24967     * @return The created mark or @p NULL upon failure.
24968     *
24969     * Add a mark that will be drawn in the calendar respecting the insertion
24970     * time and periodicity. It will emit the type as signal to the widget theme.
24971     * Default theme supports "holiday" and "checked", but it can be extended.
24972     *
24973     * It won't immediately update the calendar, drawing the marks.
24974     * For this, call elm_calendar_marks_draw(). However, when user selects
24975     * next or previous month calendar forces marks drawn.
24976     *
24977     * Marks created with this method can be deleted with
24978     * elm_calendar_mark_del().
24979     *
24980     * Example
24981     * @code
24982     * struct tm selected_time;
24983     * time_t current_time;
24984     *
24985     * current_time = time(NULL) + 5 * 84600;
24986     * localtime_r(&current_time, &selected_time);
24987     * elm_calendar_mark_add(cal, "holiday", selected_time,
24988     *     ELM_CALENDAR_ANNUALLY);
24989     *
24990     * current_time = time(NULL) + 1 * 84600;
24991     * localtime_r(&current_time, &selected_time);
24992     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
24993     *
24994     * elm_calendar_marks_draw(cal);
24995     * @endcode
24996     *
24997     * @see elm_calendar_marks_draw()
24998     * @see elm_calendar_mark_del()
24999     *
25000     * @ref calendar_example_06
25001     *
25002     * @ingroup Calendar
25003     */
25004    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);
25005
25006    /**
25007     * Delete mark from the calendar.
25008     *
25009     * @param mark The mark to be deleted.
25010     *
25011     * If deleting all calendar marks is required, elm_calendar_marks_clear()
25012     * should be used instead of getting marks list and deleting each one.
25013     *
25014     * @see elm_calendar_mark_add()
25015     *
25016     * @ref calendar_example_06
25017     *
25018     * @ingroup Calendar
25019     */
25020    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25021
25022    /**
25023     * Remove all calendar's marks
25024     *
25025     * @param obj The calendar object.
25026     *
25027     * @see elm_calendar_mark_add()
25028     * @see elm_calendar_mark_del()
25029     *
25030     * @ingroup Calendar
25031     */
25032    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25033
25034
25035    /**
25036     * Get a list of all the calendar marks.
25037     *
25038     * @param obj The calendar object.
25039     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25040     *
25041     * @see elm_calendar_mark_add()
25042     * @see elm_calendar_mark_del()
25043     * @see elm_calendar_marks_clear()
25044     *
25045     * @ingroup Calendar
25046     */
25047    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25048
25049    /**
25050     * Draw calendar marks.
25051     *
25052     * @param obj The calendar object.
25053     *
25054     * Should be used after adding, removing or clearing marks.
25055     * It will go through the entire marks list updating the calendar.
25056     * If lots of marks will be added, add all the marks and then call
25057     * this function.
25058     *
25059     * When the month is changed, i.e. user selects next or previous month,
25060     * marks will be drawed.
25061     *
25062     * @see elm_calendar_mark_add()
25063     * @see elm_calendar_mark_del()
25064     * @see elm_calendar_marks_clear()
25065     *
25066     * @ref calendar_example_06
25067     *
25068     * @ingroup Calendar
25069     */
25070    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25071
25072    /**
25073     * Set a day text color to the same that represents Saturdays.
25074     *
25075     * @param obj The calendar object.
25076     * @param pos The text position. Position is the cell counter, from left
25077     * to right, up to down. It starts on 0 and ends on 41.
25078     *
25079     * @deprecated use elm_calendar_mark_add() instead like:
25080     *
25081     * @code
25082     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25083     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25084     * @endcode
25085     *
25086     * @see elm_calendar_mark_add()
25087     *
25088     * @ingroup Calendar
25089     */
25090    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25091
25092    /**
25093     * Set a day text color to the same that represents Sundays.
25094     *
25095     * @param obj The calendar object.
25096     * @param pos The text position. Position is the cell counter, from left
25097     * to right, up to down. It starts on 0 and ends on 41.
25098
25099     * @deprecated use elm_calendar_mark_add() instead like:
25100     *
25101     * @code
25102     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25103     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25104     * @endcode
25105     *
25106     * @see elm_calendar_mark_add()
25107     *
25108     * @ingroup Calendar
25109     */
25110    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25111
25112    /**
25113     * Set a day text color to the same that represents Weekdays.
25114     *
25115     * @param obj The calendar object
25116     * @param pos The text position. Position is the cell counter, from left
25117     * to right, up to down. It starts on 0 and ends on 41.
25118     *
25119     * @deprecated use elm_calendar_mark_add() instead like:
25120     *
25121     * @code
25122     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25123     *
25124     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25125     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25126     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25127     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25128     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25129     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25130     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25131     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25132     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25133     * @endcode
25134     *
25135     * @see elm_calendar_mark_add()
25136     *
25137     * @ingroup Calendar
25138     */
25139    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25140
25141    /**
25142     * Set the interval on time updates for an user mouse button hold
25143     * on calendar widgets' month selection.
25144     *
25145     * @param obj The calendar object
25146     * @param interval The (first) interval value in seconds
25147     *
25148     * This interval value is @b decreased while the user holds the
25149     * mouse pointer either selecting next or previous month.
25150     *
25151     * This helps the user to get to a given month distant from the
25152     * current one easier/faster, as it will start to change quicker and
25153     * quicker on mouse button holds.
25154     *
25155     * The calculation for the next change interval value, starting from
25156     * the one set with this call, is the previous interval divided by
25157     * 1.05, so it decreases a little bit.
25158     *
25159     * The default starting interval value for automatic changes is
25160     * @b 0.85 seconds.
25161     *
25162     * @see elm_calendar_interval_get()
25163     *
25164     * @ingroup Calendar
25165     */
25166    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25167
25168    /**
25169     * Get the interval on time updates for an user mouse button hold
25170     * on calendar widgets' month selection.
25171     *
25172     * @param obj The calendar object
25173     * @return The (first) interval value, in seconds, set on it
25174     *
25175     * @see elm_calendar_interval_set() for more details
25176     *
25177     * @ingroup Calendar
25178     */
25179    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25180
25181    /**
25182     * @}
25183     */
25184
25185    /**
25186     * @defgroup Diskselector Diskselector
25187     * @ingroup Elementary
25188     *
25189     * @image html img/widget/diskselector/preview-00.png
25190     * @image latex img/widget/diskselector/preview-00.eps
25191     *
25192     * A diskselector is a kind of list widget. It scrolls horizontally,
25193     * and can contain label and icon objects. Three items are displayed
25194     * with the selected one in the middle.
25195     *
25196     * It can act like a circular list with round mode and labels can be
25197     * reduced for a defined length for side items.
25198     *
25199     * Smart callbacks one can listen to:
25200     * - "selected" - when item is selected, i.e. scroller stops.
25201     *
25202     * Available styles for it:
25203     * - @c "default"
25204     *
25205     * List of examples:
25206     * @li @ref diskselector_example_01
25207     * @li @ref diskselector_example_02
25208     */
25209
25210    /**
25211     * @addtogroup Diskselector
25212     * @{
25213     */
25214
25215    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(). */
25216
25217    /**
25218     * Add a new diskselector widget to the given parent Elementary
25219     * (container) object.
25220     *
25221     * @param parent The parent object.
25222     * @return a new diskselector widget handle or @c NULL, on errors.
25223     *
25224     * This function inserts a new diskselector widget on the canvas.
25225     *
25226     * @ingroup Diskselector
25227     */
25228    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25229
25230    /**
25231     * Enable or disable round mode.
25232     *
25233     * @param obj The diskselector object.
25234     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25235     * disable it.
25236     *
25237     * Disabled by default. If round mode is enabled the items list will
25238     * work like a circle list, so when the user reaches the last item,
25239     * the first one will popup.
25240     *
25241     * @see elm_diskselector_round_get()
25242     *
25243     * @ingroup Diskselector
25244     */
25245    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25246
25247    /**
25248     * Get a value whether round mode is enabled or not.
25249     *
25250     * @see elm_diskselector_round_set() for details.
25251     *
25252     * @param obj The diskselector object.
25253     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25254     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25255     *
25256     * @ingroup Diskselector
25257     */
25258    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25259
25260    /**
25261     * Get the side labels max length.
25262     *
25263     * @deprecated use elm_diskselector_side_label_length_get() instead:
25264     *
25265     * @param obj The diskselector object.
25266     * @return The max length defined for side labels, or 0 if not a valid
25267     * diskselector.
25268     *
25269     * @ingroup Diskselector
25270     */
25271    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25272
25273    /**
25274     * Set the side labels max length.
25275     *
25276     * @deprecated use elm_diskselector_side_label_length_set() instead:
25277     *
25278     * @param obj The diskselector object.
25279     * @param len The max length defined for side labels.
25280     *
25281     * @ingroup Diskselector
25282     */
25283    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25284
25285    /**
25286     * Get the side labels max length.
25287     *
25288     * @see elm_diskselector_side_label_length_set() for details.
25289     *
25290     * @param obj The diskselector object.
25291     * @return The max length defined for side labels, or 0 if not a valid
25292     * diskselector.
25293     *
25294     * @ingroup Diskselector
25295     */
25296    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25297
25298    /**
25299     * Set the side labels max length.
25300     *
25301     * @param obj The diskselector object.
25302     * @param len The max length defined for side labels.
25303     *
25304     * Length is the number of characters of items' label that will be
25305     * visible when it's set on side positions. It will just crop
25306     * the string after defined size. E.g.:
25307     *
25308     * An item with label "January" would be displayed on side position as
25309     * "Jan" if max length is set to 3, or "Janu", if this property
25310     * is set to 4.
25311     *
25312     * When it's selected, the entire label will be displayed, except for
25313     * width restrictions. In this case label will be cropped and "..."
25314     * will be concatenated.
25315     *
25316     * Default side label max length is 3.
25317     *
25318     * This property will be applyed over all items, included before or
25319     * later this function call.
25320     *
25321     * @ingroup Diskselector
25322     */
25323    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25324
25325    /**
25326     * Set the number of items to be displayed.
25327     *
25328     * @param obj The diskselector object.
25329     * @param num The number of items the diskselector will display.
25330     *
25331     * Default value is 3, and also it's the minimun. If @p num is less
25332     * than 3, it will be set to 3.
25333     *
25334     * Also, it can be set on theme, using data item @c display_item_num
25335     * on group "elm/diskselector/item/X", where X is style set.
25336     * E.g.:
25337     *
25338     * group { name: "elm/diskselector/item/X";
25339     * data {
25340     *     item: "display_item_num" "5";
25341     *     }
25342     *
25343     * @ingroup Diskselector
25344     */
25345    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25346
25347    /**
25348     * Get the number of items in the diskselector object.
25349     *
25350     * @param obj The diskselector object.
25351     *
25352     * @ingroup Diskselector
25353     */
25354    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25355
25356    /**
25357     * Set bouncing behaviour when the scrolled content reaches an edge.
25358     *
25359     * Tell the internal scroller object whether it should bounce or not
25360     * when it reaches the respective edges for each axis.
25361     *
25362     * @param obj The diskselector object.
25363     * @param h_bounce Whether to bounce or not in the horizontal axis.
25364     * @param v_bounce Whether to bounce or not in the vertical axis.
25365     *
25366     * @see elm_scroller_bounce_set()
25367     *
25368     * @ingroup Diskselector
25369     */
25370    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25371
25372    /**
25373     * Get the bouncing behaviour of the internal scroller.
25374     *
25375     * Get whether the internal scroller should bounce when the edge of each
25376     * axis is reached scrolling.
25377     *
25378     * @param obj The diskselector object.
25379     * @param h_bounce Pointer where to store the bounce state of the horizontal
25380     * axis.
25381     * @param v_bounce Pointer where to store the bounce state of the vertical
25382     * axis.
25383     *
25384     * @see elm_scroller_bounce_get()
25385     * @see elm_diskselector_bounce_set()
25386     *
25387     * @ingroup Diskselector
25388     */
25389    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25390
25391    /**
25392     * Get the scrollbar policy.
25393     *
25394     * @see elm_diskselector_scroller_policy_get() for details.
25395     *
25396     * @param obj The diskselector object.
25397     * @param policy_h Pointer where to store horizontal scrollbar policy.
25398     * @param policy_v Pointer where to store vertical scrollbar policy.
25399     *
25400     * @ingroup Diskselector
25401     */
25402    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);
25403
25404    /**
25405     * Set the scrollbar policy.
25406     *
25407     * @param obj The diskselector object.
25408     * @param policy_h Horizontal scrollbar policy.
25409     * @param policy_v Vertical scrollbar policy.
25410     *
25411     * This sets the scrollbar visibility policy for the given scroller.
25412     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25413     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25414     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25415     * This applies respectively for the horizontal and vertical scrollbars.
25416     *
25417     * The both are disabled by default, i.e., are set to
25418     * #ELM_SCROLLER_POLICY_OFF.
25419     *
25420     * @ingroup Diskselector
25421     */
25422    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25423
25424    /**
25425     * Remove all diskselector's items.
25426     *
25427     * @param obj The diskselector object.
25428     *
25429     * @see elm_diskselector_item_del()
25430     * @see elm_diskselector_item_append()
25431     *
25432     * @ingroup Diskselector
25433     */
25434    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25435
25436    /**
25437     * Get a list of all the diskselector items.
25438     *
25439     * @param obj The diskselector object.
25440     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25441     * or @c NULL on failure.
25442     *
25443     * @see elm_diskselector_item_append()
25444     * @see elm_diskselector_item_del()
25445     * @see elm_diskselector_clear()
25446     *
25447     * @ingroup Diskselector
25448     */
25449    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25450
25451    /**
25452     * Appends a new item to the diskselector object.
25453     *
25454     * @param obj The diskselector object.
25455     * @param label The label of the diskselector item.
25456     * @param icon The icon object to use at left side of the item. An
25457     * icon can be any Evas object, but usually it is an icon created
25458     * with elm_icon_add().
25459     * @param func The function to call when the item is selected.
25460     * @param data The data to associate with the item for related callbacks.
25461     *
25462     * @return The created item or @c NULL upon failure.
25463     *
25464     * A new item will be created and appended to the diskselector, i.e., will
25465     * be set as last item. Also, if there is no selected item, it will
25466     * be selected. This will always happens for the first appended item.
25467     *
25468     * If no icon is set, label will be centered on item position, otherwise
25469     * the icon will be placed at left of the label, that will be shifted
25470     * to the right.
25471     *
25472     * Items created with this method can be deleted with
25473     * elm_diskselector_item_del().
25474     *
25475     * Associated @p data can be properly freed when item is deleted if a
25476     * callback function is set with elm_diskselector_item_del_cb_set().
25477     *
25478     * If a function is passed as argument, it will be called everytime this item
25479     * is selected, i.e., the user stops the diskselector with this
25480     * item on center position. If such function isn't needed, just passing
25481     * @c NULL as @p func is enough. The same should be done for @p data.
25482     *
25483     * Simple example (with no function callback or data associated):
25484     * @code
25485     * disk = elm_diskselector_add(win);
25486     * ic = elm_icon_add(win);
25487     * elm_icon_file_set(ic, "path/to/image", NULL);
25488     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25489     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25490     * @endcode
25491     *
25492     * @see elm_diskselector_item_del()
25493     * @see elm_diskselector_item_del_cb_set()
25494     * @see elm_diskselector_clear()
25495     * @see elm_icon_add()
25496     *
25497     * @ingroup Diskselector
25498     */
25499    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);
25500
25501
25502    /**
25503     * Delete them item from the diskselector.
25504     *
25505     * @param it The item of diskselector to be deleted.
25506     *
25507     * If deleting all diskselector items is required, elm_diskselector_clear()
25508     * should be used instead of getting items list and deleting each one.
25509     *
25510     * @see elm_diskselector_clear()
25511     * @see elm_diskselector_item_append()
25512     * @see elm_diskselector_item_del_cb_set()
25513     *
25514     * @ingroup Diskselector
25515     */
25516    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25517
25518    /**
25519     * Set the function called when a diskselector item is freed.
25520     *
25521     * @param it The item to set the callback on
25522     * @param func The function called
25523     *
25524     * If there is a @p func, then it will be called prior item's memory release.
25525     * That will be called with the following arguments:
25526     * @li item's data;
25527     * @li item's Evas object;
25528     * @li item itself;
25529     *
25530     * This way, a data associated to a diskselector item could be properly
25531     * freed.
25532     *
25533     * @ingroup Diskselector
25534     */
25535    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25536
25537    /**
25538     * Get the data associated to the item.
25539     *
25540     * @param it The diskselector item
25541     * @return The data associated to @p it
25542     *
25543     * The return value is a pointer to data associated to @p item when it was
25544     * created, with function elm_diskselector_item_append(). If no data
25545     * was passed as argument, it will return @c NULL.
25546     *
25547     * @see elm_diskselector_item_append()
25548     *
25549     * @ingroup Diskselector
25550     */
25551    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25552
25553    /**
25554     * Set the icon associated to the item.
25555     *
25556     * @param it The diskselector item
25557     * @param icon The icon object to associate with @p it
25558     *
25559     * The icon object to use at left side of the item. An
25560     * icon can be any Evas object, but usually it is an icon created
25561     * with elm_icon_add().
25562     *
25563     * Once the icon object is set, a previously set one will be deleted.
25564     * @warning Setting the same icon for two items will cause the icon to
25565     * dissapear from the first item.
25566     *
25567     * If an icon was passed as argument on item creation, with function
25568     * elm_diskselector_item_append(), it will be already
25569     * associated to the item.
25570     *
25571     * @see elm_diskselector_item_append()
25572     * @see elm_diskselector_item_icon_get()
25573     *
25574     * @ingroup Diskselector
25575     */
25576    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25577
25578    /**
25579     * Get the icon associated to the item.
25580     *
25581     * @param it The diskselector item
25582     * @return The icon associated to @p it
25583     *
25584     * The return value is a pointer to the icon associated to @p item when it was
25585     * created, with function elm_diskselector_item_append(), or later
25586     * with function elm_diskselector_item_icon_set. If no icon
25587     * was passed as argument, it will return @c NULL.
25588     *
25589     * @see elm_diskselector_item_append()
25590     * @see elm_diskselector_item_icon_set()
25591     *
25592     * @ingroup Diskselector
25593     */
25594    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25595
25596    /**
25597     * Set the label of item.
25598     *
25599     * @param it The item of diskselector.
25600     * @param label The label of item.
25601     *
25602     * The label to be displayed by the item.
25603     *
25604     * If no icon is set, label will be centered on item position, otherwise
25605     * the icon will be placed at left of the label, that will be shifted
25606     * to the right.
25607     *
25608     * An item with label "January" would be displayed on side position as
25609     * "Jan" if max length is set to 3 with function
25610     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25611     * is set to 4.
25612     *
25613     * When this @p item is selected, the entire label will be displayed,
25614     * except for width restrictions.
25615     * In this case label will be cropped and "..." will be concatenated,
25616     * but only for display purposes. It will keep the entire string, so
25617     * if diskselector is resized the remaining characters will be displayed.
25618     *
25619     * If a label was passed as argument on item creation, with function
25620     * elm_diskselector_item_append(), it will be already
25621     * displayed by the item.
25622     *
25623     * @see elm_diskselector_side_label_lenght_set()
25624     * @see elm_diskselector_item_label_get()
25625     * @see elm_diskselector_item_append()
25626     *
25627     * @ingroup Diskselector
25628     */
25629    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25630
25631    /**
25632     * Get the label of item.
25633     *
25634     * @param it The item of diskselector.
25635     * @return The label of item.
25636     *
25637     * The return value is a pointer to the label associated to @p item when it was
25638     * created, with function elm_diskselector_item_append(), or later
25639     * with function elm_diskselector_item_label_set. If no label
25640     * was passed as argument, it will return @c NULL.
25641     *
25642     * @see elm_diskselector_item_label_set() for more details.
25643     * @see elm_diskselector_item_append()
25644     *
25645     * @ingroup Diskselector
25646     */
25647    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25648
25649    /**
25650     * Get the selected item.
25651     *
25652     * @param obj The diskselector object.
25653     * @return The selected diskselector item.
25654     *
25655     * The selected item can be unselected with function
25656     * elm_diskselector_item_selected_set(), and the first item of
25657     * diskselector will be selected.
25658     *
25659     * The selected item always will be centered on diskselector, with
25660     * full label displayed, i.e., max lenght set to side labels won't
25661     * apply on the selected item. More details on
25662     * elm_diskselector_side_label_length_set().
25663     *
25664     * @ingroup Diskselector
25665     */
25666    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25667
25668    /**
25669     * Set the selected state of an item.
25670     *
25671     * @param it The diskselector item
25672     * @param selected The selected state
25673     *
25674     * This sets the selected state of the given item @p it.
25675     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25676     *
25677     * If a new item is selected the previosly selected will be unselected.
25678     * Previoulsy selected item can be get with function
25679     * elm_diskselector_selected_item_get().
25680     *
25681     * If the item @p it is unselected, the first item of diskselector will
25682     * be selected.
25683     *
25684     * Selected items will be visible on center position of diskselector.
25685     * So if it was on another position before selected, or was invisible,
25686     * diskselector will animate items until the selected item reaches center
25687     * position.
25688     *
25689     * @see elm_diskselector_item_selected_get()
25690     * @see elm_diskselector_selected_item_get()
25691     *
25692     * @ingroup Diskselector
25693     */
25694    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25695
25696    /*
25697     * Get whether the @p item is selected or not.
25698     *
25699     * @param it The diskselector item.
25700     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
25701     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
25702     *
25703     * @see elm_diskselector_selected_item_set() for details.
25704     * @see elm_diskselector_item_selected_get()
25705     *
25706     * @ingroup Diskselector
25707     */
25708    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25709
25710    /**
25711     * Get the first item of the diskselector.
25712     *
25713     * @param obj The diskselector object.
25714     * @return The first item, or @c NULL if none.
25715     *
25716     * The list of items follows append order. So it will return the first
25717     * item appended to the widget that wasn't deleted.
25718     *
25719     * @see elm_diskselector_item_append()
25720     * @see elm_diskselector_items_get()
25721     *
25722     * @ingroup Diskselector
25723     */
25724    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25725
25726    /**
25727     * Get the last item of the diskselector.
25728     *
25729     * @param obj The diskselector object.
25730     * @return The last item, or @c NULL if none.
25731     *
25732     * The list of items follows append order. So it will return last first
25733     * item appended to the widget that wasn't deleted.
25734     *
25735     * @see elm_diskselector_item_append()
25736     * @see elm_diskselector_items_get()
25737     *
25738     * @ingroup Diskselector
25739     */
25740    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25741
25742    /**
25743     * Get the item before @p item in diskselector.
25744     *
25745     * @param it The diskselector item.
25746     * @return The item before @p item, or @c NULL if none or on failure.
25747     *
25748     * The list of items follows append order. So it will return item appended
25749     * just before @p item and that wasn't deleted.
25750     *
25751     * If it is the first item, @c NULL will be returned.
25752     * First item can be get by elm_diskselector_first_item_get().
25753     *
25754     * @see elm_diskselector_item_append()
25755     * @see elm_diskselector_items_get()
25756     *
25757     * @ingroup Diskselector
25758     */
25759    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25760
25761    /**
25762     * Get the item after @p item in diskselector.
25763     *
25764     * @param it The diskselector item.
25765     * @return The item after @p item, or @c NULL if none or on failure.
25766     *
25767     * The list of items follows append order. So it will return item appended
25768     * just after @p item and that wasn't deleted.
25769     *
25770     * If it is the last item, @c NULL will be returned.
25771     * Last item can be get by elm_diskselector_last_item_get().
25772     *
25773     * @see elm_diskselector_item_append()
25774     * @see elm_diskselector_items_get()
25775     *
25776     * @ingroup Diskselector
25777     */
25778    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25779
25780    /**
25781     * Set the text to be shown in the diskselector item.
25782     *
25783     * @param item Target item
25784     * @param text The text to set in the content
25785     *
25786     * Setup the text as tooltip to object. The item can have only one tooltip,
25787     * so any previous tooltip data is removed.
25788     *
25789     * @see elm_object_tooltip_text_set() for more details.
25790     *
25791     * @ingroup Diskselector
25792     */
25793    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
25794
25795    /**
25796     * Set the content to be shown in the tooltip item.
25797     *
25798     * Setup the tooltip to item. The item can have only one tooltip,
25799     * so any previous tooltip data is removed. @p func(with @p data) will
25800     * be called every time that need show the tooltip and it should
25801     * return a valid Evas_Object. This object is then managed fully by
25802     * tooltip system and is deleted when the tooltip is gone.
25803     *
25804     * @param item the diskselector item being attached a tooltip.
25805     * @param func the function used to create the tooltip contents.
25806     * @param data what to provide to @a func as callback data/context.
25807     * @param del_cb called when data is not needed anymore, either when
25808     *        another callback replaces @p func, the tooltip is unset with
25809     *        elm_diskselector_item_tooltip_unset() or the owner @a item
25810     *        dies. This callback receives as the first parameter the
25811     *        given @a data, and @c event_info is the item.
25812     *
25813     * @see elm_object_tooltip_content_cb_set() for more details.
25814     *
25815     * @ingroup Diskselector
25816     */
25817    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);
25818
25819    /**
25820     * Unset tooltip from item.
25821     *
25822     * @param item diskselector item to remove previously set tooltip.
25823     *
25824     * Remove tooltip from item. The callback provided as del_cb to
25825     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
25826     * it is not used anymore.
25827     *
25828     * @see elm_object_tooltip_unset() for more details.
25829     * @see elm_diskselector_item_tooltip_content_cb_set()
25830     *
25831     * @ingroup Diskselector
25832     */
25833    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25834
25835
25836    /**
25837     * Sets a different style for this item tooltip.
25838     *
25839     * @note before you set a style you should define a tooltip with
25840     *       elm_diskselector_item_tooltip_content_cb_set() or
25841     *       elm_diskselector_item_tooltip_text_set()
25842     *
25843     * @param item diskselector item with tooltip already set.
25844     * @param style the theme style to use (default, transparent, ...)
25845     *
25846     * @see elm_object_tooltip_style_set() for more details.
25847     *
25848     * @ingroup Diskselector
25849     */
25850    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
25851
25852    /**
25853     * Get the style for this item tooltip.
25854     *
25855     * @param item diskselector item with tooltip already set.
25856     * @return style the theme style in use, defaults to "default". If the
25857     *         object does not have a tooltip set, then NULL is returned.
25858     *
25859     * @see elm_object_tooltip_style_get() for more details.
25860     * @see elm_diskselector_item_tooltip_style_set()
25861     *
25862     * @ingroup Diskselector
25863     */
25864    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25865
25866    /**
25867     * Set the cursor to be shown when mouse is over the diskselector item
25868     *
25869     * @param item Target item
25870     * @param cursor the cursor name to be used.
25871     *
25872     * @see elm_object_cursor_set() for more details.
25873     *
25874     * @ingroup Diskselector
25875     */
25876    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
25877
25878    /**
25879     * Get the cursor to be shown when mouse is over the diskselector item
25880     *
25881     * @param item diskselector item with cursor already set.
25882     * @return the cursor name.
25883     *
25884     * @see elm_object_cursor_get() for more details.
25885     * @see elm_diskselector_cursor_set()
25886     *
25887     * @ingroup Diskselector
25888     */
25889    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25890
25891
25892    /**
25893     * Unset the cursor to be shown when mouse is over the diskselector item
25894     *
25895     * @param item Target item
25896     *
25897     * @see elm_object_cursor_unset() for more details.
25898     * @see elm_diskselector_cursor_set()
25899     *
25900     * @ingroup Diskselector
25901     */
25902    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25903
25904    /**
25905     * Sets a different style for this item cursor.
25906     *
25907     * @note before you set a style you should define a cursor with
25908     *       elm_diskselector_item_cursor_set()
25909     *
25910     * @param item diskselector item with cursor already set.
25911     * @param style the theme style to use (default, transparent, ...)
25912     *
25913     * @see elm_object_cursor_style_set() for more details.
25914     *
25915     * @ingroup Diskselector
25916     */
25917    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
25918
25919
25920    /**
25921     * Get the style for this item cursor.
25922     *
25923     * @param item diskselector item with cursor already set.
25924     * @return style the theme style in use, defaults to "default". If the
25925     *         object does not have a cursor set, then @c NULL is returned.
25926     *
25927     * @see elm_object_cursor_style_get() for more details.
25928     * @see elm_diskselector_item_cursor_style_set()
25929     *
25930     * @ingroup Diskselector
25931     */
25932    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25933
25934
25935    /**
25936     * Set if the cursor set should be searched on the theme or should use
25937     * the provided by the engine, only.
25938     *
25939     * @note before you set if should look on theme you should define a cursor
25940     * with elm_diskselector_item_cursor_set().
25941     * By default it will only look for cursors provided by the engine.
25942     *
25943     * @param item widget item with cursor already set.
25944     * @param engine_only boolean to define if cursors set with
25945     * elm_diskselector_item_cursor_set() should be searched only
25946     * between cursors provided by the engine or searched on widget's
25947     * theme as well.
25948     *
25949     * @see elm_object_cursor_engine_only_set() for more details.
25950     *
25951     * @ingroup Diskselector
25952     */
25953    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
25954
25955    /**
25956     * Get the cursor engine only usage for this item cursor.
25957     *
25958     * @param item widget item with cursor already set.
25959     * @return engine_only boolean to define it cursors should be looked only
25960     * between the provided by the engine or searched on widget's theme as well.
25961     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
25962     *
25963     * @see elm_object_cursor_engine_only_get() for more details.
25964     * @see elm_diskselector_item_cursor_engine_only_set()
25965     *
25966     * @ingroup Diskselector
25967     */
25968    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25969
25970    /**
25971     * @}
25972     */
25973
25974    /**
25975     * @defgroup Colorselector Colorselector
25976     *
25977     * @{
25978     *
25979     * @image html img/widget/colorselector/preview-00.png
25980     * @image latex img/widget/colorselector/preview-00.eps
25981     *
25982     * @brief Widget for user to select a color.
25983     *
25984     * Signals that you can add callbacks for are:
25985     * "changed" - When the color value changes(event_info is NULL).
25986     *
25987     * See @ref tutorial_colorselector.
25988     */
25989    /**
25990     * @brief Add a new colorselector to the parent
25991     *
25992     * @param parent The parent object
25993     * @return The new object or NULL if it cannot be created
25994     *
25995     * @ingroup Colorselector
25996     */
25997    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25998    /**
25999     * Set a color for the colorselector
26000     *
26001     * @param obj   Colorselector object
26002     * @param r     r-value of color
26003     * @param g     g-value of color
26004     * @param b     b-value of color
26005     * @param a     a-value of color
26006     *
26007     * @ingroup Colorselector
26008     */
26009    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26010    /**
26011     * Get a color from the colorselector
26012     *
26013     * @param obj   Colorselector object
26014     * @param r     integer pointer for r-value of color
26015     * @param g     integer pointer for g-value of color
26016     * @param b     integer pointer for b-value of color
26017     * @param a     integer pointer for a-value of color
26018     *
26019     * @ingroup Colorselector
26020     */
26021    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26022    /**
26023     * @}
26024     */
26025
26026    /**
26027     * @defgroup Ctxpopup Ctxpopup
26028     *
26029     * @image html img/widget/ctxpopup/preview-00.png
26030     * @image latex img/widget/ctxpopup/preview-00.eps
26031     *
26032     * @brief Context popup widet.
26033     *
26034     * A ctxpopup is a widget that, when shown, pops up a list of items.
26035     * It automatically chooses an area inside its parent object's view
26036     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26037     * optimally fit into it. In the default theme, it will also point an
26038     * arrow to it's top left position at the time one shows it. Ctxpopup
26039     * items have a label and/or an icon. It is intended for a small
26040     * number of items (hence the use of list, not genlist).
26041     *
26042     * @note Ctxpopup is a especialization of @ref Hover.
26043     *
26044     * Signals that you can add callbacks for are:
26045     * "dismissed" - the ctxpopup was dismissed
26046     *
26047     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26048     * @{
26049     */
26050    typedef enum _Elm_Ctxpopup_Direction
26051      {
26052         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26053                                           area */
26054         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26055                                            the clicked area */
26056         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26057                                           the clicked area */
26058         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26059                                         area */
26060         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26061      } Elm_Ctxpopup_Direction;
26062
26063    /**
26064     * @brief Add a new Ctxpopup object to the parent.
26065     *
26066     * @param parent Parent object
26067     * @return New object or @c NULL, if it cannot be created
26068     */
26069    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26070    /**
26071     * @brief Set the Ctxpopup's parent
26072     *
26073     * @param obj The ctxpopup object
26074     * @param area The parent to use
26075     *
26076     * Set the parent object.
26077     *
26078     * @note elm_ctxpopup_add() will automatically call this function
26079     * with its @c parent argument.
26080     *
26081     * @see elm_ctxpopup_add()
26082     * @see elm_hover_parent_set()
26083     */
26084    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26085    /**
26086     * @brief Get the Ctxpopup's parent
26087     *
26088     * @param obj The ctxpopup object
26089     *
26090     * @see elm_ctxpopup_hover_parent_set() for more information
26091     */
26092    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26093    /**
26094     * @brief Clear all items in the given ctxpopup object.
26095     *
26096     * @param obj Ctxpopup object
26097     */
26098    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26099    /**
26100     * @brief Change the ctxpopup's orientation to horizontal or vertical.
26101     *
26102     * @param obj Ctxpopup object
26103     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26104     */
26105    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26106    /**
26107     * @brief Get the value of current ctxpopup object's orientation.
26108     *
26109     * @param obj Ctxpopup object
26110     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26111     *
26112     * @see elm_ctxpopup_horizontal_set()
26113     */
26114    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26115    /**
26116     * @brief Add a new item to a ctxpopup object.
26117     *
26118     * @param obj Ctxpopup object
26119     * @param icon Icon to be set on new item
26120     * @param label The Label of the new item
26121     * @param func Convenience function called when item selected
26122     * @param data Data passed to @p func
26123     * @return A handle to the item added or @c NULL, on errors
26124     *
26125     * @warning Ctxpopup can't hold both an item list and a content at the same
26126     * time. When an item is added, any previous content will be removed.
26127     *
26128     * @see elm_ctxpopup_content_set()
26129     */
26130    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);
26131    /**
26132     * @brief Delete the given item in a ctxpopup object.
26133     *
26134     * @param it Ctxpopup item to be deleted
26135     *
26136     * @see elm_ctxpopup_item_append()
26137     */
26138    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26139    /**
26140     * @brief Set the ctxpopup item's state as disabled or enabled.
26141     *
26142     * @param it Ctxpopup item to be enabled/disabled
26143     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26144     *
26145     * When disabled the item is greyed out to indicate it's state.
26146     */
26147    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26148    /**
26149     * @brief Get the ctxpopup item's disabled/enabled state.
26150     *
26151     * @param it Ctxpopup item to be enabled/disabled
26152     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26153     *
26154     * @see elm_ctxpopup_item_disabled_set()
26155     */
26156    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26157    /**
26158     * @brief Get the icon object for the given ctxpopup item.
26159     *
26160     * @param it Ctxpopup item
26161     * @return icon object or @c NULL, if the item does not have icon or an error
26162     * occurred
26163     *
26164     * @see elm_ctxpopup_item_append()
26165     * @see elm_ctxpopup_item_icon_set()
26166     */
26167    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26168    /**
26169     * @brief Sets the side icon associated with the ctxpopup item
26170     *
26171     * @param it Ctxpopup item
26172     * @param icon Icon object to be set
26173     *
26174     * Once the icon object is set, a previously set one will be deleted.
26175     * @warning Setting the same icon for two items will cause the icon to
26176     * dissapear from the first item.
26177     *
26178     * @see elm_ctxpopup_item_append()
26179     */
26180    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26181    /**
26182     * @brief Get the label for the given ctxpopup item.
26183     *
26184     * @param it Ctxpopup item
26185     * @return label string or @c NULL, if the item does not have label or an
26186     * error occured
26187     *
26188     * @see elm_ctxpopup_item_append()
26189     * @see elm_ctxpopup_item_label_set()
26190     */
26191    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26192    /**
26193     * @brief (Re)set the label on the given ctxpopup item.
26194     *
26195     * @param it Ctxpopup item
26196     * @param label String to set as label
26197     */
26198    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26199    /**
26200     * @brief Set an elm widget as the content of the ctxpopup.
26201     *
26202     * @param obj Ctxpopup object
26203     * @param content Content to be swallowed
26204     *
26205     * If the content object is already set, a previous one will bedeleted. If
26206     * you want to keep that old content object, use the
26207     * elm_ctxpopup_content_unset() function.
26208     *
26209     * @deprecated use elm_object_content_set()
26210     *
26211     * @warning Ctxpopup can't hold both a item list and a content at the same
26212     * time. When a content is set, any previous items will be removed.
26213     */
26214    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26215    /**
26216     * @brief Unset the ctxpopup content
26217     *
26218     * @param obj Ctxpopup object
26219     * @return The content that was being used
26220     *
26221     * Unparent and return the content object which was set for this widget.
26222     *
26223     * @deprecated use elm_object_content_unset()
26224     *
26225     * @see elm_ctxpopup_content_set()
26226     */
26227    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26228    /**
26229     * @brief Set the direction priority of a ctxpopup.
26230     *
26231     * @param obj Ctxpopup object
26232     * @param first 1st priority of direction
26233     * @param second 2nd priority of direction
26234     * @param third 3th priority of direction
26235     * @param fourth 4th priority of direction
26236     *
26237     * This functions gives a chance to user to set the priority of ctxpopup
26238     * showing direction. This doesn't guarantee the ctxpopup will appear in the
26239     * requested direction.
26240     *
26241     * @see Elm_Ctxpopup_Direction
26242     */
26243    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);
26244    /**
26245     * @brief Get the direction priority of a ctxpopup.
26246     *
26247     * @param obj Ctxpopup object
26248     * @param first 1st priority of direction to be returned
26249     * @param second 2nd priority of direction to be returned
26250     * @param third 3th priority of direction to be returned
26251     * @param fourth 4th priority of direction to be returned
26252     *
26253     * @see elm_ctxpopup_direction_priority_set() for more information.
26254     */
26255    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);
26256
26257    /**
26258     * @brief Get the current direction of a ctxpopup.
26259     *
26260     * @param obj Ctxpopup object
26261     * @return current direction of a ctxpopup
26262     *
26263     * @warning Once the ctxpopup showed up, the direction would be determined
26264     */
26265    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26266
26267    /**
26268     * @}
26269     */
26270
26271    /* transit */
26272    /**
26273     *
26274     * @defgroup Transit Transit
26275     * @ingroup Elementary
26276     *
26277     * Transit is designed to apply various animated transition effects to @c
26278     * Evas_Object, such like translation, rotation, etc. For using these
26279     * effects, create an @ref Elm_Transit and add the desired transition effects.
26280     *
26281     * Once the effects are added into transit, they will be automatically
26282     * managed (their callback will be called until the duration is ended, and
26283     * they will be deleted on completion).
26284     *
26285     * Example:
26286     * @code
26287     * Elm_Transit *trans = elm_transit_add();
26288     * elm_transit_object_add(trans, obj);
26289     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26290     * elm_transit_duration_set(transit, 1);
26291     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26292     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26293     * elm_transit_repeat_times_set(transit, 3);
26294     * @endcode
26295     *
26296     * Some transition effects are used to change the properties of objects. They
26297     * are:
26298     * @li @ref elm_transit_effect_translation_add
26299     * @li @ref elm_transit_effect_color_add
26300     * @li @ref elm_transit_effect_rotation_add
26301     * @li @ref elm_transit_effect_wipe_add
26302     * @li @ref elm_transit_effect_zoom_add
26303     * @li @ref elm_transit_effect_resizing_add
26304     *
26305     * Other transition effects are used to make one object disappear and another
26306     * object appear on its old place. These effects are:
26307     *
26308     * @li @ref elm_transit_effect_flip_add
26309     * @li @ref elm_transit_effect_resizable_flip_add
26310     * @li @ref elm_transit_effect_fade_add
26311     * @li @ref elm_transit_effect_blend_add
26312     *
26313     * It's also possible to make a transition chain with @ref
26314     * elm_transit_chain_transit_add.
26315     *
26316     * @warning We strongly recommend to use elm_transit just when edje can not do
26317     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26318     * animations can be manipulated inside the theme.
26319     *
26320     * List of examples:
26321     * @li @ref transit_example_01_explained
26322     * @li @ref transit_example_02_explained
26323     * @li @ref transit_example_03_c
26324     * @li @ref transit_example_04_c
26325     *
26326     * @{
26327     */
26328
26329    /**
26330     * @enum Elm_Transit_Tween_Mode
26331     *
26332     * The type of acceleration used in the transition.
26333     */
26334    typedef enum
26335      {
26336         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26337         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26338                                              over time, then decrease again
26339                                              and stop slowly */
26340         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26341                                              speed over time */
26342         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26343                                             over time */
26344      } Elm_Transit_Tween_Mode;
26345
26346    /**
26347     * @enum Elm_Transit_Effect_Flip_Axis
26348     *
26349     * The axis where flip effect should be applied.
26350     */
26351    typedef enum
26352      {
26353         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26354         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26355      } Elm_Transit_Effect_Flip_Axis;
26356    /**
26357     * @enum Elm_Transit_Effect_Wipe_Dir
26358     *
26359     * The direction where the wipe effect should occur.
26360     */
26361    typedef enum
26362      {
26363         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26364         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26365         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26366         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26367      } Elm_Transit_Effect_Wipe_Dir;
26368    /** @enum Elm_Transit_Effect_Wipe_Type
26369     *
26370     * Whether the wipe effect should show or hide the object.
26371     */
26372    typedef enum
26373      {
26374         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26375                                              animation */
26376         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26377                                             animation */
26378      } Elm_Transit_Effect_Wipe_Type;
26379
26380    /**
26381     * @typedef Elm_Transit
26382     *
26383     * The Transit created with elm_transit_add(). This type has the information
26384     * about the objects which the transition will be applied, and the
26385     * transition effects that will be used. It also contains info about
26386     * duration, number of repetitions, auto-reverse, etc.
26387     */
26388    typedef struct _Elm_Transit Elm_Transit;
26389    typedef void Elm_Transit_Effect;
26390    /**
26391     * @typedef Elm_Transit_Effect_Transition_Cb
26392     *
26393     * Transition callback called for this effect on each transition iteration.
26394     */
26395    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26396    /**
26397     * Elm_Transit_Effect_End_Cb
26398     *
26399     * Transition callback called for this effect when the transition is over.
26400     */
26401    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26402
26403    /**
26404     * Elm_Transit_Del_Cb
26405     *
26406     * A callback called when the transit is deleted.
26407     */
26408    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26409
26410    /**
26411     * Add new transit.
26412     *
26413     * @note Is not necessary to delete the transit object, it will be deleted at
26414     * the end of its operation.
26415     * @note The transit will start playing when the program enter in the main loop, is not
26416     * necessary to give a start to the transit.
26417     *
26418     * @return The transit object.
26419     *
26420     * @ingroup Transit
26421     */
26422    EAPI Elm_Transit                *elm_transit_add(void);
26423
26424    /**
26425     * Stops the animation and delete the @p transit object.
26426     *
26427     * Call this function if you wants to stop the animation before the duration
26428     * time. Make sure the @p transit object is still alive with
26429     * elm_transit_del_cb_set() function.
26430     * All added effects will be deleted, calling its repective data_free_cb
26431     * functions. The function setted by elm_transit_del_cb_set() will be called.
26432     *
26433     * @see elm_transit_del_cb_set()
26434     *
26435     * @param transit The transit object to be deleted.
26436     *
26437     * @ingroup Transit
26438     * @warning Just call this function if you are sure the transit is alive.
26439     */
26440    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26441
26442    /**
26443     * Add a new effect to the transit.
26444     *
26445     * @note The cb function and the data are the key to the effect. If you try to
26446     * add an already added effect, nothing is done.
26447     * @note After the first addition of an effect in @p transit, if its
26448     * effect list become empty again, the @p transit will be killed by
26449     * elm_transit_del(transit) function.
26450     *
26451     * Exemple:
26452     * @code
26453     * Elm_Transit *transit = elm_transit_add();
26454     * elm_transit_effect_add(transit,
26455     *                        elm_transit_effect_blend_op,
26456     *                        elm_transit_effect_blend_context_new(),
26457     *                        elm_transit_effect_blend_context_free);
26458     * @endcode
26459     *
26460     * @param transit The transit object.
26461     * @param transition_cb The operation function. It is called when the
26462     * animation begins, it is the function that actually performs the animation.
26463     * It is called with the @p data, @p transit and the time progression of the
26464     * animation (a double value between 0.0 and 1.0).
26465     * @param effect The context data of the effect.
26466     * @param end_cb The function to free the context data, it will be called
26467     * at the end of the effect, it must finalize the animation and free the
26468     * @p data.
26469     *
26470     * @ingroup Transit
26471     * @warning The transit free the context data at the and of the transition with
26472     * the data_free_cb function, do not use the context data in another transit.
26473     */
26474    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);
26475
26476    /**
26477     * Delete an added effect.
26478     *
26479     * This function will remove the effect from the @p transit, calling the
26480     * data_free_cb to free the @p data.
26481     *
26482     * @see elm_transit_effect_add()
26483     *
26484     * @note If the effect is not found, nothing is done.
26485     * @note If the effect list become empty, this function will call
26486     * elm_transit_del(transit), that is, it will kill the @p transit.
26487     *
26488     * @param transit The transit object.
26489     * @param transition_cb The operation function.
26490     * @param effect The context data of the effect.
26491     *
26492     * @ingroup Transit
26493     */
26494    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);
26495
26496    /**
26497     * Add new object to apply the effects.
26498     *
26499     * @note After the first addition of an object in @p transit, if its
26500     * object list become empty again, the @p transit will be killed by
26501     * elm_transit_del(transit) function.
26502     * @note If the @p obj belongs to another transit, the @p obj will be
26503     * removed from it and it will only belong to the @p transit. If the old
26504     * transit stays without objects, it will die.
26505     * @note When you add an object into the @p transit, its state from
26506     * evas_object_pass_events_get(obj) is saved, and it is applied when the
26507     * transit ends, if you change this state whith evas_object_pass_events_set()
26508     * after add the object, this state will change again when @p transit stops to
26509     * run.
26510     *
26511     * @param transit The transit object.
26512     * @param obj Object to be animated.
26513     *
26514     * @ingroup Transit
26515     * @warning It is not allowed to add a new object after transit begins to go.
26516     */
26517    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26518
26519    /**
26520     * Removes an added object from the transit.
26521     *
26522     * @note If the @p obj is not in the @p transit, nothing is done.
26523     * @note If the list become empty, this function will call
26524     * elm_transit_del(transit), that is, it will kill the @p transit.
26525     *
26526     * @param transit The transit object.
26527     * @param obj Object to be removed from @p transit.
26528     *
26529     * @ingroup Transit
26530     * @warning It is not allowed to remove objects after transit begins to go.
26531     */
26532    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26533
26534    /**
26535     * Get the objects of the transit.
26536     *
26537     * @param transit The transit object.
26538     * @return a Eina_List with the objects from the transit.
26539     *
26540     * @ingroup Transit
26541     */
26542    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26543
26544    /**
26545     * Enable/disable keeping up the objects states.
26546     * If it is not kept, the objects states will be reset when transition ends.
26547     *
26548     * @note @p transit can not be NULL.
26549     * @note One state includes geometry, color, map data.
26550     *
26551     * @param transit The transit object.
26552     * @param state_keep Keeping or Non Keeping.
26553     *
26554     * @ingroup Transit
26555     */
26556    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26557
26558    /**
26559     * Get a value whether the objects states will be reset or not.
26560     *
26561     * @note @p transit can not be NULL
26562     *
26563     * @see elm_transit_objects_final_state_keep_set()
26564     *
26565     * @param transit The transit object.
26566     * @return EINA_TRUE means the states of the objects will be reset.
26567     * If @p transit is NULL, EINA_FALSE is returned
26568     *
26569     * @ingroup Transit
26570     */
26571    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26572
26573    /**
26574     * Set the event enabled when transit is operating.
26575     *
26576     * If @p enabled is EINA_TRUE, the objects of the transit will receives
26577     * events from mouse and keyboard during the animation.
26578     * @note When you add an object with elm_transit_object_add(), its state from
26579     * evas_object_pass_events_get(obj) is saved, and it is applied when the
26580     * transit ends, if you change this state with evas_object_pass_events_set()
26581     * after adding the object, this state will change again when @p transit stops
26582     * to run.
26583     *
26584     * @param transit The transit object.
26585     * @param enabled Events are received when enabled is @c EINA_TRUE, and
26586     * ignored otherwise.
26587     *
26588     * @ingroup Transit
26589     */
26590    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26591
26592    /**
26593     * Get the value of event enabled status.
26594     *
26595     * @see elm_transit_event_enabled_set()
26596     *
26597     * @param transit The Transit object
26598     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26599     * EINA_FALSE is returned
26600     *
26601     * @ingroup Transit
26602     */
26603    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26604
26605    /**
26606     * Set the user-callback function when the transit is deleted.
26607     *
26608     * @note Using this function twice will overwrite the first function setted.
26609     * @note the @p transit object will be deleted after call @p cb function.
26610     *
26611     * @param transit The transit object.
26612     * @param cb Callback function pointer. This function will be called before
26613     * the deletion of the transit.
26614     * @param data Callback funtion user data. It is the @p op parameter.
26615     *
26616     * @ingroup Transit
26617     */
26618    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26619
26620    /**
26621     * Set reverse effect automatically.
26622     *
26623     * If auto reverse is setted, after running the effects with the progress
26624     * parameter from 0 to 1, it will call the effecs again with the progress
26625     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26626     * where the duration was setted with the function elm_transit_add and
26627     * the repeat with the function elm_transit_repeat_times_set().
26628     *
26629     * @param transit The transit object.
26630     * @param reverse EINA_TRUE means the auto_reverse is on.
26631     *
26632     * @ingroup Transit
26633     */
26634    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26635
26636    /**
26637     * Get if the auto reverse is on.
26638     *
26639     * @see elm_transit_auto_reverse_set()
26640     *
26641     * @param transit The transit object.
26642     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
26643     * EINA_FALSE is returned
26644     *
26645     * @ingroup Transit
26646     */
26647    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26648
26649    /**
26650     * Set the transit repeat count. Effect will be repeated by repeat count.
26651     *
26652     * This function sets the number of repetition the transit will run after
26653     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
26654     * If the @p repeat is a negative number, it will repeat infinite times.
26655     *
26656     * @note If this function is called during the transit execution, the transit
26657     * will run @p repeat times, ignoring the times it already performed.
26658     *
26659     * @param transit The transit object
26660     * @param repeat Repeat count
26661     *
26662     * @ingroup Transit
26663     */
26664    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
26665
26666    /**
26667     * Get the transit repeat count.
26668     *
26669     * @see elm_transit_repeat_times_set()
26670     *
26671     * @param transit The Transit object.
26672     * @return The repeat count. If @p transit is NULL
26673     * 0 is returned
26674     *
26675     * @ingroup Transit
26676     */
26677    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26678
26679    /**
26680     * Set the transit animation acceleration type.
26681     *
26682     * This function sets the tween mode of the transit that can be:
26683     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
26684     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
26685     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
26686     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
26687     *
26688     * @param transit The transit object.
26689     * @param tween_mode The tween type.
26690     *
26691     * @ingroup Transit
26692     */
26693    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
26694
26695    /**
26696     * Get the transit animation acceleration type.
26697     *
26698     * @note @p transit can not be NULL
26699     *
26700     * @param transit The transit object.
26701     * @return The tween type. If @p transit is NULL
26702     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
26703     *
26704     * @ingroup Transit
26705     */
26706    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26707
26708    /**
26709     * Set the transit animation time
26710     *
26711     * @note @p transit can not be NULL
26712     *
26713     * @param transit The transit object.
26714     * @param duration The animation time.
26715     *
26716     * @ingroup Transit
26717     */
26718    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
26719
26720    /**
26721     * Get the transit animation time
26722     *
26723     * @note @p transit can not be NULL
26724     *
26725     * @param transit The transit object.
26726     *
26727     * @return The transit animation time.
26728     *
26729     * @ingroup Transit
26730     */
26731    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26732
26733    /**
26734     * Starts the transition.
26735     * Once this API is called, the transit begins to measure the time.
26736     *
26737     * @note @p transit can not be NULL
26738     *
26739     * @param transit The transit object.
26740     *
26741     * @ingroup Transit
26742     */
26743    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26744
26745    /**
26746     * Pause/Resume the transition.
26747     *
26748     * If you call elm_transit_go again, the transit will be started from the
26749     * beginning, and will be unpaused.
26750     *
26751     * @note @p transit can not be NULL
26752     *
26753     * @param transit The transit object.
26754     * @param paused Whether the transition should be paused or not.
26755     *
26756     * @ingroup Transit
26757     */
26758    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
26759
26760    /**
26761     * Get the value of paused status.
26762     *
26763     * @see elm_transit_paused_set()
26764     *
26765     * @note @p transit can not be NULL
26766     *
26767     * @param transit The transit object.
26768     * @return EINA_TRUE means transition is paused. If @p transit is NULL
26769     * EINA_FALSE is returned
26770     *
26771     * @ingroup Transit
26772     */
26773    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26774
26775    /**
26776     * Get the time progression of the animation (a double value between 0.0 and 1.0).
26777     *
26778     * The value returned is a fraction (current time / total time). It
26779     * represents the progression position relative to the total.
26780     *
26781     * @note @p transit can not be NULL
26782     *
26783     * @param transit The transit object.
26784     *
26785     * @return The time progression value. If @p transit is NULL
26786     * 0 is returned
26787     *
26788     * @ingroup Transit
26789     */
26790    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26791
26792    /**
26793     * Makes the chain relationship between two transits.
26794     *
26795     * @note @p transit can not be NULL. Transit would have multiple chain transits.
26796     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
26797     *
26798     * @param transit The transit object.
26799     * @param chain_transit The chain transit object. This transit will be operated
26800     *        after transit is done.
26801     *
26802     * This function adds @p chain_transit transition to a chain after the @p
26803     * transit, and will be started as soon as @p transit ends. See @ref
26804     * transit_example_02_explained for a full example.
26805     *
26806     * @ingroup Transit
26807     */
26808    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
26809
26810    /**
26811     * Cut off the chain relationship between two transits.
26812     *
26813     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
26814     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
26815     *
26816     * @param transit The transit object.
26817     * @param chain_transit The chain transit object.
26818     *
26819     * This function remove the @p chain_transit transition from the @p transit.
26820     *
26821     * @ingroup Transit
26822     */
26823    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
26824
26825    /**
26826     * Get the current chain transit list.
26827     *
26828     * @note @p transit can not be NULL.
26829     *
26830     * @param transit The transit object.
26831     * @return chain transit list.
26832     *
26833     * @ingroup Transit
26834     */
26835    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
26836
26837    /**
26838     * Add the Resizing Effect to Elm_Transit.
26839     *
26840     * @note This API is one of the facades. It creates resizing effect context
26841     * and add it's required APIs to elm_transit_effect_add.
26842     *
26843     * @see elm_transit_effect_add()
26844     *
26845     * @param transit Transit object.
26846     * @param from_w Object width size when effect begins.
26847     * @param from_h Object height size when effect begins.
26848     * @param to_w Object width size when effect ends.
26849     * @param to_h Object height size when effect ends.
26850     * @return Resizing effect context data.
26851     *
26852     * @ingroup Transit
26853     */
26854    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);
26855
26856    /**
26857     * Add the Translation Effect to Elm_Transit.
26858     *
26859     * @note This API is one of the facades. It creates translation effect context
26860     * and add it's required APIs to elm_transit_effect_add.
26861     *
26862     * @see elm_transit_effect_add()
26863     *
26864     * @param transit Transit object.
26865     * @param from_dx X Position variation when effect begins.
26866     * @param from_dy Y Position variation when effect begins.
26867     * @param to_dx X Position variation when effect ends.
26868     * @param to_dy Y Position variation when effect ends.
26869     * @return Translation effect context data.
26870     *
26871     * @ingroup Transit
26872     * @warning It is highly recommended just create a transit with this effect when
26873     * the window that the objects of the transit belongs has already been created.
26874     * This is because this effect needs the geometry information about the objects,
26875     * and if the window was not created yet, it can get a wrong information.
26876     */
26877    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);
26878
26879    /**
26880     * Add the Zoom Effect to Elm_Transit.
26881     *
26882     * @note This API is one of the facades. It creates zoom effect context
26883     * and add it's required APIs to elm_transit_effect_add.
26884     *
26885     * @see elm_transit_effect_add()
26886     *
26887     * @param transit Transit object.
26888     * @param from_rate Scale rate when effect begins (1 is current rate).
26889     * @param to_rate Scale rate when effect ends.
26890     * @return Zoom effect context data.
26891     *
26892     * @ingroup Transit
26893     * @warning It is highly recommended just create a transit with this effect when
26894     * the window that the objects of the transit belongs has already been created.
26895     * This is because this effect needs the geometry information about the objects,
26896     * and if the window was not created yet, it can get a wrong information.
26897     */
26898    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
26899
26900    /**
26901     * Add the Flip Effect to Elm_Transit.
26902     *
26903     * @note This API is one of the facades. It creates flip effect context
26904     * and add it's required APIs to elm_transit_effect_add.
26905     * @note This effect is applied to each pair of objects in the order they are listed
26906     * in the transit list of objects. The first object in the pair will be the
26907     * "front" object and the second will be the "back" object.
26908     *
26909     * @see elm_transit_effect_add()
26910     *
26911     * @param transit Transit object.
26912     * @param axis Flipping Axis(X or Y).
26913     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
26914     * @return Flip effect context data.
26915     *
26916     * @ingroup Transit
26917     * @warning It is highly recommended just create a transit with this effect when
26918     * the window that the objects of the transit belongs has already been created.
26919     * This is because this effect needs the geometry information about the objects,
26920     * and if the window was not created yet, it can get a wrong information.
26921     */
26922    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
26923
26924    /**
26925     * Add the Resizable Flip Effect to Elm_Transit.
26926     *
26927     * @note This API is one of the facades. It creates resizable flip effect context
26928     * and add it's required APIs to elm_transit_effect_add.
26929     * @note This effect is applied to each pair of objects in the order they are listed
26930     * in the transit list of objects. The first object in the pair will be the
26931     * "front" object and the second will be the "back" object.
26932     *
26933     * @see elm_transit_effect_add()
26934     *
26935     * @param transit Transit object.
26936     * @param axis Flipping Axis(X or Y).
26937     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
26938     * @return Resizable flip effect context data.
26939     *
26940     * @ingroup Transit
26941     * @warning It is highly recommended just create a transit with this effect when
26942     * the window that the objects of the transit belongs has already been created.
26943     * This is because this effect needs the geometry information about the objects,
26944     * and if the window was not created yet, it can get a wrong information.
26945     */
26946    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
26947
26948    /**
26949     * Add the Wipe Effect to Elm_Transit.
26950     *
26951     * @note This API is one of the facades. It creates wipe effect context
26952     * and add it's required APIs to elm_transit_effect_add.
26953     *
26954     * @see elm_transit_effect_add()
26955     *
26956     * @param transit Transit object.
26957     * @param type Wipe type. Hide or show.
26958     * @param dir Wipe Direction.
26959     * @return Wipe effect context data.
26960     *
26961     * @ingroup Transit
26962     * @warning It is highly recommended just create a transit with this effect when
26963     * the window that the objects of the transit belongs has already been created.
26964     * This is because this effect needs the geometry information about the objects,
26965     * and if the window was not created yet, it can get a wrong information.
26966     */
26967    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
26968
26969    /**
26970     * Add the Color Effect to Elm_Transit.
26971     *
26972     * @note This API is one of the facades. It creates color effect context
26973     * and add it's required APIs to elm_transit_effect_add.
26974     *
26975     * @see elm_transit_effect_add()
26976     *
26977     * @param transit        Transit object.
26978     * @param  from_r        RGB R when effect begins.
26979     * @param  from_g        RGB G when effect begins.
26980     * @param  from_b        RGB B when effect begins.
26981     * @param  from_a        RGB A when effect begins.
26982     * @param  to_r          RGB R when effect ends.
26983     * @param  to_g          RGB G when effect ends.
26984     * @param  to_b          RGB B when effect ends.
26985     * @param  to_a          RGB A when effect ends.
26986     * @return               Color effect context data.
26987     *
26988     * @ingroup Transit
26989     */
26990    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);
26991
26992    /**
26993     * Add the Fade Effect to Elm_Transit.
26994     *
26995     * @note This API is one of the facades. It creates fade effect context
26996     * and add it's required APIs to elm_transit_effect_add.
26997     * @note This effect is applied to each pair of objects in the order they are listed
26998     * in the transit list of objects. The first object in the pair will be the
26999     * "before" object and the second will be the "after" object.
27000     *
27001     * @see elm_transit_effect_add()
27002     *
27003     * @param transit Transit object.
27004     * @return Fade effect context data.
27005     *
27006     * @ingroup Transit
27007     * @warning It is highly recommended just create a transit with this effect when
27008     * the window that the objects of the transit belongs has already been created.
27009     * This is because this effect needs the color information about the objects,
27010     * and if the window was not created yet, it can get a wrong information.
27011     */
27012    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27013
27014    /**
27015     * Add the Blend Effect to Elm_Transit.
27016     *
27017     * @note This API is one of the facades. It creates blend effect context
27018     * and add it's required APIs to elm_transit_effect_add.
27019     * @note This effect is applied to each pair of objects in the order they are listed
27020     * in the transit list of objects. The first object in the pair will be the
27021     * "before" object and the second will be the "after" object.
27022     *
27023     * @see elm_transit_effect_add()
27024     *
27025     * @param transit Transit object.
27026     * @return Blend effect context data.
27027     *
27028     * @ingroup Transit
27029     * @warning It is highly recommended just create a transit with this effect when
27030     * the window that the objects of the transit belongs has already been created.
27031     * This is because this effect needs the color information about the objects,
27032     * and if the window was not created yet, it can get a wrong information.
27033     */
27034    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27035
27036    /**
27037     * Add the Rotation Effect to Elm_Transit.
27038     *
27039     * @note This API is one of the facades. It creates rotation effect context
27040     * and add it's required APIs to elm_transit_effect_add.
27041     *
27042     * @see elm_transit_effect_add()
27043     *
27044     * @param transit Transit object.
27045     * @param from_degree Degree when effect begins.
27046     * @param to_degree Degree when effect is ends.
27047     * @return Rotation effect context data.
27048     *
27049     * @ingroup Transit
27050     * @warning It is highly recommended just create a transit with this effect when
27051     * the window that the objects of the transit belongs has already been created.
27052     * This is because this effect needs the geometry information about the objects,
27053     * and if the window was not created yet, it can get a wrong information.
27054     */
27055    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27056
27057    /**
27058     * Add the ImageAnimation Effect to Elm_Transit.
27059     *
27060     * @note This API is one of the facades. It creates image animation effect context
27061     * and add it's required APIs to elm_transit_effect_add.
27062     * The @p images parameter is a list images paths. This list and
27063     * its contents will be deleted at the end of the effect by
27064     * elm_transit_effect_image_animation_context_free() function.
27065     *
27066     * Example:
27067     * @code
27068     * char buf[PATH_MAX];
27069     * Eina_List *images = NULL;
27070     * Elm_Transit *transi = elm_transit_add();
27071     *
27072     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27073     * images = eina_list_append(images, eina_stringshare_add(buf));
27074     *
27075     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27076     * images = eina_list_append(images, eina_stringshare_add(buf));
27077     * elm_transit_effect_image_animation_add(transi, images);
27078     *
27079     * @endcode
27080     *
27081     * @see elm_transit_effect_add()
27082     *
27083     * @param transit Transit object.
27084     * @param images Eina_List of images file paths. This list and
27085     * its contents will be deleted at the end of the effect by
27086     * elm_transit_effect_image_animation_context_free() function.
27087     * @return Image Animation effect context data.
27088     *
27089     * @ingroup Transit
27090     */
27091    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27092    /**
27093     * @}
27094     */
27095
27096    typedef struct _Elm_Store                      Elm_Store;
27097    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
27098    typedef struct _Elm_Store_Item                 Elm_Store_Item;
27099    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
27100    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
27101    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27102    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
27103    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
27104    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
27105    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
27106    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
27107
27108    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27109    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27110    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27111    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27112
27113    typedef enum
27114      {
27115         ELM_STORE_ITEM_MAPPING_NONE = 0,
27116         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27117         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27118         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27119         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27120         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27121         // can add more here as needed by common apps
27122         ELM_STORE_ITEM_MAPPING_LAST
27123      } Elm_Store_Item_Mapping_Type;
27124
27125    struct _Elm_Store_Item_Mapping_Icon
27126      {
27127         // FIXME: allow edje file icons
27128         int                   w, h;
27129         Elm_Icon_Lookup_Order lookup_order;
27130         Eina_Bool             standard_name : 1;
27131         Eina_Bool             no_scale : 1;
27132         Eina_Bool             smooth : 1;
27133         Eina_Bool             scale_up : 1;
27134         Eina_Bool             scale_down : 1;
27135      };
27136
27137    struct _Elm_Store_Item_Mapping_Empty
27138      {
27139         Eina_Bool             dummy;
27140      };
27141
27142    struct _Elm_Store_Item_Mapping_Photo
27143      {
27144         int                   size;
27145      };
27146
27147    struct _Elm_Store_Item_Mapping_Custom
27148      {
27149         Elm_Store_Item_Mapping_Cb func;
27150      };
27151
27152    struct _Elm_Store_Item_Mapping
27153      {
27154         Elm_Store_Item_Mapping_Type     type;
27155         const char                     *part;
27156         int                             offset;
27157         union
27158           {
27159              Elm_Store_Item_Mapping_Empty  empty;
27160              Elm_Store_Item_Mapping_Icon   icon;
27161              Elm_Store_Item_Mapping_Photo  photo;
27162              Elm_Store_Item_Mapping_Custom custom;
27163              // add more types here
27164           } details;
27165      };
27166
27167    struct _Elm_Store_Item_Info
27168      {
27169         Elm_Genlist_Item_Class       *item_class;
27170         const Elm_Store_Item_Mapping *mapping;
27171         void                         *data;
27172         char                         *sort_id;
27173      };
27174
27175    struct _Elm_Store_Item_Info_Filesystem
27176      {
27177         Elm_Store_Item_Info  base;
27178         char                *path;
27179      };
27180
27181 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27182 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27183
27184    EAPI void                    elm_store_free(Elm_Store *st);
27185
27186    EAPI Elm_Store              *elm_store_filesystem_new(void);
27187    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27188    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27189    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27190
27191    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27192
27193    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27194    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27195    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27196    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27197    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27198    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27199
27200    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27201    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27202    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27203    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27204    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27205    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27206    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27207
27208    /**
27209     * @defgroup SegmentControl SegmentControl
27210     * @ingroup Elementary
27211     *
27212     * @image html img/widget/segment_control/preview-00.png
27213     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27214     *
27215     * @image html img/segment_control.png
27216     * @image latex img/segment_control.eps width=\textwidth
27217     *
27218     * Segment control widget is a horizontal control made of multiple segment
27219     * items, each segment item functioning similar to discrete two state button.
27220     * A segment control groups the items together and provides compact
27221     * single button with multiple equal size segments.
27222     *
27223     * Segment item size is determined by base widget
27224     * size and the number of items added.
27225     * Only one segment item can be at selected state. A segment item can display
27226     * combination of Text and any Evas_Object like Images or other widget.
27227     *
27228     * Smart callbacks one can listen to:
27229     * - "changed" - When the user clicks on a segment item which is not
27230     *   previously selected and get selected. The event_info parameter is the
27231     *   segment item index.
27232     *
27233     * Available styles for it:
27234     * - @c "default"
27235     *
27236     * Here is an example on its usage:
27237     * @li @ref segment_control_example
27238     */
27239
27240    /**
27241     * @addtogroup SegmentControl
27242     * @{
27243     */
27244
27245    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27246
27247    /**
27248     * Add a new segment control widget to the given parent Elementary
27249     * (container) object.
27250     *
27251     * @param parent The parent object.
27252     * @return a new segment control widget handle or @c NULL, on errors.
27253     *
27254     * This function inserts a new segment control widget on the canvas.
27255     *
27256     * @ingroup SegmentControl
27257     */
27258    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27259
27260    /**
27261     * Append a new item to the segment control object.
27262     *
27263     * @param obj The segment control object.
27264     * @param icon The icon object to use for the left side of the item. An
27265     * icon can be any Evas object, but usually it is an icon created
27266     * with elm_icon_add().
27267     * @param label The label of the item.
27268     *        Note that, NULL is different from empty string "".
27269     * @return The created item or @c NULL upon failure.
27270     *
27271     * A new item will be created and appended to the segment control, i.e., will
27272     * be set as @b last item.
27273     *
27274     * If it should be inserted at another position,
27275     * elm_segment_control_item_insert_at() should be used instead.
27276     *
27277     * Items created with this function can be deleted with function
27278     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27279     *
27280     * @note @p label set to @c NULL is different from empty string "".
27281     * If an item
27282     * only has icon, it will be displayed bigger and centered. If it has
27283     * icon and label, even that an empty string, icon will be smaller and
27284     * positioned at left.
27285     *
27286     * Simple example:
27287     * @code
27288     * sc = elm_segment_control_add(win);
27289     * ic = elm_icon_add(win);
27290     * elm_icon_file_set(ic, "path/to/image", NULL);
27291     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27292     * elm_segment_control_item_add(sc, ic, "label");
27293     * evas_object_show(sc);
27294     * @endcode
27295     *
27296     * @see elm_segment_control_item_insert_at()
27297     * @see elm_segment_control_item_del()
27298     *
27299     * @ingroup SegmentControl
27300     */
27301    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27302
27303    /**
27304     * Insert a new item to the segment control object at specified position.
27305     *
27306     * @param obj The segment control object.
27307     * @param icon The icon object to use for the left side of the item. An
27308     * icon can be any Evas object, but usually it is an icon created
27309     * with elm_icon_add().
27310     * @param label The label of the item.
27311     * @param index Item position. Value should be between 0 and items count.
27312     * @return The created item or @c NULL upon failure.
27313
27314     * Index values must be between @c 0, when item will be prepended to
27315     * segment control, and items count, that can be get with
27316     * elm_segment_control_item_count_get(), case when item will be appended
27317     * to segment control, just like elm_segment_control_item_add().
27318     *
27319     * Items created with this function can be deleted with function
27320     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27321     *
27322     * @note @p label set to @c NULL is different from empty string "".
27323     * If an item
27324     * only has icon, it will be displayed bigger and centered. If it has
27325     * icon and label, even that an empty string, icon will be smaller and
27326     * positioned at left.
27327     *
27328     * @see elm_segment_control_item_add()
27329     * @see elm_segment_control_item_count_get()
27330     * @see elm_segment_control_item_del()
27331     *
27332     * @ingroup SegmentControl
27333     */
27334    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);
27335
27336    /**
27337     * Remove a segment control item from its parent, deleting it.
27338     *
27339     * @param it The item to be removed.
27340     *
27341     * Items can be added with elm_segment_control_item_add() or
27342     * elm_segment_control_item_insert_at().
27343     *
27344     * @ingroup SegmentControl
27345     */
27346    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27347
27348    /**
27349     * Remove a segment control item at given index from its parent,
27350     * deleting it.
27351     *
27352     * @param obj The segment control object.
27353     * @param index The position of the segment control item to be deleted.
27354     *
27355     * Items can be added with elm_segment_control_item_add() or
27356     * elm_segment_control_item_insert_at().
27357     *
27358     * @ingroup SegmentControl
27359     */
27360    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27361
27362    /**
27363     * Get the Segment items count from segment control.
27364     *
27365     * @param obj The segment control object.
27366     * @return Segment items count.
27367     *
27368     * It will just return the number of items added to segment control @p obj.
27369     *
27370     * @ingroup SegmentControl
27371     */
27372    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27373
27374    /**
27375     * Get the item placed at specified index.
27376     *
27377     * @param obj The segment control object.
27378     * @param index The index of the segment item.
27379     * @return The segment control item or @c NULL on failure.
27380     *
27381     * Index is the position of an item in segment control widget. Its
27382     * range is from @c 0 to <tt> count - 1 </tt>.
27383     * Count is the number of items, that can be get with
27384     * elm_segment_control_item_count_get().
27385     *
27386     * @ingroup SegmentControl
27387     */
27388    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27389
27390    /**
27391     * Get the label of item.
27392     *
27393     * @param obj The segment control object.
27394     * @param index The index of the segment item.
27395     * @return The label of the item at @p index.
27396     *
27397     * The return value is a pointer to the label associated to the item when
27398     * it was created, with function elm_segment_control_item_add(), or later
27399     * with function elm_segment_control_item_label_set. If no label
27400     * was passed as argument, it will return @c NULL.
27401     *
27402     * @see elm_segment_control_item_label_set() for more details.
27403     * @see elm_segment_control_item_add()
27404     *
27405     * @ingroup SegmentControl
27406     */
27407    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27408
27409    /**
27410     * Set the label of item.
27411     *
27412     * @param it The item of segment control.
27413     * @param text The label of item.
27414     *
27415     * The label to be displayed by the item.
27416     * Label will be at right of the icon (if set).
27417     *
27418     * If a label was passed as argument on item creation, with function
27419     * elm_control_segment_item_add(), it will be already
27420     * displayed by the item.
27421     *
27422     * @see elm_segment_control_item_label_get()
27423     * @see elm_segment_control_item_add()
27424     *
27425     * @ingroup SegmentControl
27426     */
27427    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27428
27429    /**
27430     * Get the icon associated to the item.
27431     *
27432     * @param obj The segment control object.
27433     * @param index The index of the segment item.
27434     * @return The left side icon associated to the item at @p index.
27435     *
27436     * The return value is a pointer to the icon associated to the item when
27437     * it was created, with function elm_segment_control_item_add(), or later
27438     * with function elm_segment_control_item_icon_set(). If no icon
27439     * was passed as argument, it will return @c NULL.
27440     *
27441     * @see elm_segment_control_item_add()
27442     * @see elm_segment_control_item_icon_set()
27443     *
27444     * @ingroup SegmentControl
27445     */
27446    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27447
27448    /**
27449     * Set the icon associated to the item.
27450     *
27451     * @param it The segment control item.
27452     * @param icon The icon object to associate with @p it.
27453     *
27454     * The icon object to use at left side of the item. An
27455     * icon can be any Evas object, but usually it is an icon created
27456     * with elm_icon_add().
27457     *
27458     * Once the icon object is set, a previously set one will be deleted.
27459     * @warning Setting the same icon for two items will cause the icon to
27460     * dissapear from the first item.
27461     *
27462     * If an icon was passed as argument on item creation, with function
27463     * elm_segment_control_item_add(), it will be already
27464     * associated to the item.
27465     *
27466     * @see elm_segment_control_item_add()
27467     * @see elm_segment_control_item_icon_get()
27468     *
27469     * @ingroup SegmentControl
27470     */
27471    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27472
27473    /**
27474     * Get the index of an item.
27475     *
27476     * @param it The segment control item.
27477     * @return The position of item in segment control widget.
27478     *
27479     * Index is the position of an item in segment control widget. Its
27480     * range is from @c 0 to <tt> count - 1 </tt>.
27481     * Count is the number of items, that can be get with
27482     * elm_segment_control_item_count_get().
27483     *
27484     * @ingroup SegmentControl
27485     */
27486    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27487
27488    /**
27489     * Get the base object of the item.
27490     *
27491     * @param it The segment control item.
27492     * @return The base object associated with @p it.
27493     *
27494     * Base object is the @c Evas_Object that represents that item.
27495     *
27496     * @ingroup SegmentControl
27497     */
27498    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27499
27500    /**
27501     * Get the selected item.
27502     *
27503     * @param obj The segment control object.
27504     * @return The selected item or @c NULL if none of segment items is
27505     * selected.
27506     *
27507     * The selected item can be unselected with function
27508     * elm_segment_control_item_selected_set().
27509     *
27510     * The selected item always will be highlighted on segment control.
27511     *
27512     * @ingroup SegmentControl
27513     */
27514    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27515
27516    /**
27517     * Set the selected state of an item.
27518     *
27519     * @param it The segment control item
27520     * @param select The selected state
27521     *
27522     * This sets the selected state of the given item @p it.
27523     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27524     *
27525     * If a new item is selected the previosly selected will be unselected.
27526     * Previoulsy selected item can be get with function
27527     * elm_segment_control_item_selected_get().
27528     *
27529     * The selected item always will be highlighted on segment control.
27530     *
27531     * @see elm_segment_control_item_selected_get()
27532     *
27533     * @ingroup SegmentControl
27534     */
27535    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27536
27537    /**
27538     * @}
27539     */
27540
27541    /**
27542     * @defgroup Grid Grid
27543     *
27544     * The grid is a grid layout widget that lays out a series of children as a
27545     * fixed "grid" of widgets using a given percentage of the grid width and
27546     * height each using the child object.
27547     *
27548     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27549     * widgets size itself. The default is 100 x 100, so that means the
27550     * position and sizes of children will effectively be percentages (0 to 100)
27551     * of the width or height of the grid widget
27552     *
27553     * @{
27554     */
27555
27556    /**
27557     * Add a new grid to the parent
27558     *
27559     * @param parent The parent object
27560     * @return The new object or NULL if it cannot be created
27561     *
27562     * @ingroup Grid
27563     */
27564    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27565
27566    /**
27567     * Set the virtual size of the grid
27568     *
27569     * @param obj The grid object
27570     * @param w The virtual width of the grid
27571     * @param h The virtual height of the grid
27572     *
27573     * @ingroup Grid
27574     */
27575    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
27576
27577    /**
27578     * Get the virtual size of the grid
27579     *
27580     * @param obj The grid object
27581     * @param w Pointer to integer to store the virtual width of the grid
27582     * @param h Pointer to integer to store the virtual height of the grid
27583     *
27584     * @ingroup Grid
27585     */
27586    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27587
27588    /**
27589     * Pack child at given position and size
27590     *
27591     * @param obj The grid object
27592     * @param subobj The child to pack
27593     * @param x The virtual x coord at which to pack it
27594     * @param y The virtual y coord at which to pack it
27595     * @param w The virtual width at which to pack it
27596     * @param h The virtual height at which to pack it
27597     *
27598     * @ingroup Grid
27599     */
27600    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27601
27602    /**
27603     * Unpack a child from a grid object
27604     *
27605     * @param obj The grid object
27606     * @param subobj The child to unpack
27607     *
27608     * @ingroup Grid
27609     */
27610    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27611
27612    /**
27613     * Faster way to remove all child objects from a grid object.
27614     *
27615     * @param obj The grid object
27616     * @param clear If true, it will delete just removed children
27617     *
27618     * @ingroup Grid
27619     */
27620    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
27621
27622    /**
27623     * Set packing of an existing child at to position and size
27624     *
27625     * @param subobj The child to set packing of
27626     * @param x The virtual x coord at which to pack it
27627     * @param y The virtual y coord at which to pack it
27628     * @param w The virtual width at which to pack it
27629     * @param h The virtual height at which to pack it
27630     *
27631     * @ingroup Grid
27632     */
27633    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
27634
27635    /**
27636     * get packing of a child
27637     *
27638     * @param subobj The child to query
27639     * @param x Pointer to integer to store the virtual x coord
27640     * @param y Pointer to integer to store the virtual y coord
27641     * @param w Pointer to integer to store the virtual width
27642     * @param h Pointer to integer to store the virtual height
27643     *
27644     * @ingroup Grid
27645     */
27646    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
27647
27648    /**
27649     * @}
27650     */
27651
27652    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
27653    EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
27654    EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
27655    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
27656    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
27657    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
27658
27659    /**
27660     * @defgroup Video Video
27661     *
27662     * @addtogroup Video
27663     * @{
27664     *
27665     * Elementary comes with two object that help design application that need
27666     * to display video. The main one, Elm_Video, display a video by using Emotion.
27667     * It does embedded the video inside an Edje object, so you can do some
27668     * animation depending on the video state change. It does also implement a
27669     * ressource management policy to remove this burden from the application writer.
27670     *
27671     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
27672     * It take care of updating its content according to Emotion event and provide a
27673     * way to theme itself. It also does automatically raise the priority of the
27674     * linked Elm_Video so it will use the video decoder if available. It also does
27675     * activate the remember function on the linked Elm_Video object.
27676     *
27677     * Signals that you can add callback for are :
27678     *
27679     * "forward,clicked" - the user clicked the forward button.
27680     * "info,clicked" - the user clicked the info button.
27681     * "next,clicked" - the user clicked the next button.
27682     * "pause,clicked" - the user clicked the pause button.
27683     * "play,clicked" - the user clicked the play button.
27684     * "prev,clicked" - the user clicked the prev button.
27685     * "rewind,clicked" - the user clicked the rewind button.
27686     * "stop,clicked" - the user clicked the stop button.
27687     */
27688
27689    /**
27690     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
27691     *
27692     * @param parent The parent object
27693     * @return a new player widget handle or @c NULL, on errors.
27694     *
27695     * This function inserts a new player widget on the canvas.
27696     *
27697     * @see elm_player_video_set()
27698     *
27699     * @ingroup Video
27700     */
27701    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
27702
27703    /**
27704     * @brief Link a Elm_Payer with an Elm_Video object.
27705     *
27706     * @param player the Elm_Player object.
27707     * @param video The Elm_Video object.
27708     *
27709     * This mean that action on the player widget will affect the
27710     * video object and the state of the video will be reflected in
27711     * the player itself.
27712     *
27713     * @see elm_player_add()
27714     * @see elm_video_add()
27715     *
27716     * @ingroup Video
27717     */
27718    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
27719
27720    /**
27721     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
27722     *
27723     * @param parent The parent object
27724     * @return a new video widget handle or @c NULL, on errors.
27725     *
27726     * This function inserts a new video widget on the canvas.
27727     *
27728     * @seeelm_video_file_set()
27729     * @see elm_video_uri_set()
27730     *
27731     * @ingroup Video
27732     */
27733    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
27734
27735    /**
27736     * @brief Define the file that will be the video source.
27737     *
27738     * @param video The video object to define the file for.
27739     * @param filename The file to target.
27740     *
27741     * This function will explicitly define a filename as a source
27742     * for the video of the Elm_Video object.
27743     *
27744     * @see elm_video_uri_set()
27745     * @see elm_video_add()
27746     * @see elm_player_add()
27747     *
27748     * @ingroup Video
27749     */
27750    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
27751
27752    /**
27753     * @brief Define the uri that will be the video source.
27754     *
27755     * @param video The video object to define the file for.
27756     * @param uri The uri to target.
27757     *
27758     * This function will define an uri as a source for the video of the
27759     * Elm_Video object. URI could be remote source of video, like http:// or local source
27760     * like for example WebCam who are most of the time v4l2:// (but that depend and
27761     * you should use Emotion API to request and list the available Webcam on your system).
27762     *
27763     * @see elm_video_file_set()
27764     * @see elm_video_add()
27765     * @see elm_player_add()
27766     *
27767     * @ingroup Video
27768     */
27769    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
27770
27771    /**
27772     * @brief Get the underlying Emotion object.
27773     *
27774     * @param video The video object to proceed the request on.
27775     * @return the underlying Emotion object.
27776     *
27777     * @ingroup Video
27778     */
27779    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
27780
27781    /**
27782     * @brief Start to play the video
27783     *
27784     * @param video The video object to proceed the request on.
27785     *
27786     * Start to play the video and cancel all suspend state.
27787     *
27788     * @ingroup Video
27789     */
27790    EAPI void elm_video_play(Evas_Object *video);
27791
27792    /**
27793     * @brief Pause the video
27794     *
27795     * @param video The video object to proceed the request on.
27796     *
27797     * Pause the video and start a timer to trigger suspend mode.
27798     *
27799     * @ingroup Video
27800     */
27801    EAPI void elm_video_pause(Evas_Object *video);
27802
27803    /**
27804     * @brief Stop the video
27805     *
27806     * @param video The video object to proceed the request on.
27807     *
27808     * Stop the video and put the emotion in deep sleep mode.
27809     *
27810     * @ingroup Video
27811     */
27812    EAPI void elm_video_stop(Evas_Object *video);
27813
27814    /**
27815     * @brief Is the video actually playing.
27816     *
27817     * @param video The video object to proceed the request on.
27818     * @return EINA_TRUE if the video is actually playing.
27819     *
27820     * You should consider watching event on the object instead of polling
27821     * the object state.
27822     *
27823     * @ingroup Video
27824     */
27825    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
27826
27827    /**
27828     * @brief Is it possible to seek inside the video.
27829     *
27830     * @param video The video object to proceed the request on.
27831     * @return EINA_TRUE if is possible to seek inside the video.
27832     *
27833     * @ingroup Video
27834     */
27835    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
27836
27837    /**
27838     * @brief Is the audio muted.
27839     *
27840     * @param video The video object to proceed the request on.
27841     * @return EINA_TRUE if the audio is muted.
27842     *
27843     * @ingroup Video
27844     */
27845    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
27846
27847    /**
27848     * @brief Change the mute state of the Elm_Video object.
27849     *
27850     * @param video The video object to proceed the request on.
27851     * @param mute The new mute state.
27852     *
27853     * @ingroup Video
27854     */
27855    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
27856
27857    /**
27858     * @brief Get the audio level of the current video.
27859     *
27860     * @param video The video object to proceed the request on.
27861     * @return the current audio level.
27862     *
27863     * @ingroup Video
27864     */
27865    EAPI double elm_video_audio_level_get(Evas_Object *video);
27866
27867    /**
27868     * @brief Set the audio level of anElm_Video object.
27869     *
27870     * @param video The video object to proceed the request on.
27871     * @param volume The new audio volume.
27872     *
27873     * @ingroup Video
27874     */
27875    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
27876
27877    EAPI double elm_video_play_position_get(Evas_Object *video);
27878    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
27879    EAPI double elm_video_play_length_get(Evas_Object *video);
27880    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
27881    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
27882    EAPI const char *elm_video_title_get(Evas_Object *video);
27883    /**
27884     * @}
27885     */
27886
27887    /**
27888     * @defgroup Naviframe Naviframe
27889     * @ingroup Elementary
27890     *
27891     * @brief Naviframe is a kind of view manager for the applications.
27892     *
27893     * Naviframe provides functions to switch different pages with stack
27894     * mechanism. It means if one page(item) needs to be changed to the new one,
27895     * then naviframe would push the new page to it's internal stack. Of course,
27896     * it can be back to the previous page by popping the top page. Naviframe
27897     * provides some transition effect while the pages are switching (same as
27898     * pager).
27899     *
27900     * Since each item could keep the different styles, users could keep the
27901     * same look & feel for the pages or different styles for the items in it's
27902     * application.
27903     *
27904     * Signals that you can add callback for are:
27905     *
27906     * @li "transition,finished" - When the transition is finished in changing
27907     *     the item
27908     * @li "title,clicked" - User clicked title area
27909     *
27910     * Default contents parts for the naviframe items that you can use for are:
27911     *
27912     * @li "elm.swallow.content" - The main content of the page
27913     * @li "elm.swallow.prev_btn" - The button to go to the previous page
27914     * @li "elm.swallow.next_btn" - The button to go to the next page
27915     *
27916     * Default text parts of naviframe items that you can be used are:
27917     *
27918     * @li "elm.text.title" - The title label in the title area
27919     *
27920     * @ref tutorial_naviframe gives a good overview of the usage of the API.
27921     */
27922
27923    /**
27924     * @addtogroup Naviframe
27925     * @{
27926     */
27927
27928    /**
27929     * @brief Add a new Naviframe object to the parent.
27930     *
27931     * @param parent Parent object
27932     * @return New object or @c NULL, if it cannot be created
27933     *
27934     * @ingroup Naviframe
27935     */
27936    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27937    /**
27938     * @brief Push a new item to the top of the naviframe stack (and show it).
27939     *
27940     * @param obj The naviframe object
27941     * @param title_label The label in the title area. The name of the title
27942     *        label part is "elm.text.title"
27943     * @param prev_btn The button to go to the previous item. If it is NULL,
27944     *        then naviframe will create a back button automatically. The name of
27945     *        the prev_btn part is "elm.swallow.prev_btn"
27946     * @param next_btn The button to go to the next item. Or It could be just an
27947     *        extra function button. The name of the next_btn part is
27948     *        "elm.swallow.next_btn"
27949     * @param content The main content object. The name of content part is
27950     *        "elm.swallow.content"
27951     * @param item_style The current item style name. @c NULL would be default.
27952     * @return The created item or @c NULL upon failure.
27953     *
27954     * The item pushed becomes one page of the naviframe, this item will be
27955     * deleted when it is popped.
27956     *
27957     * @see also elm_naviframe_item_style_set()
27958     *
27959     * The following styles are available for this item:
27960     * @li @c "default"
27961     *
27962     * @ingroup Naviframe
27963     */
27964    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);
27965    /**
27966     * @brief Pop an item that is on top of the stack
27967     *
27968     * @param obj The naviframe object
27969     * @return @c NULL or the content object(if the
27970     *         elm_naviframe_content_preserve_on_pop_get is true).
27971     *
27972     * This pops an item that is on the top(visible) of the naviframe, makes it
27973     * disappear, then deletes the item. The item that was underneath it on the
27974     * stack will become visible.
27975     *
27976     * @see also elm_naviframe_content_preserve_on_pop_get()
27977     *
27978     * @ingroup Naviframe
27979     */
27980    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
27981    /**
27982     * @brief Pop the items between the top and the above one on the given item.
27983     *
27984     * @param it The naviframe item
27985     *
27986     * @ingroup Naviframe
27987     */
27988    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27989    /**
27990     * @brief Delete the given item instantly.
27991     *
27992     * @param it The naviframe item
27993     *
27994     * This just deletes the given item from the naviframe item list instantly.
27995     * So this would not emit any signals for view transitions but just change
27996     * the current view if the given item is a top one.
27997     *
27998     * @ingroup Naviframe
27999     */
28000    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28001    /**
28002     * @brief preserve the content objects when items are popped.
28003     *
28004     * @param obj The naviframe object
28005     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28006     *
28007     * @see also elm_naviframe_content_preserve_on_pop_get()
28008     *
28009     * @ingroup Naviframe
28010     */
28011    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28012    /**
28013     * @brief Get a value whether preserve mode is enabled or not.
28014     *
28015     * @param obj The naviframe object
28016     * @return If @c EINA_TRUE, preserve mode is enabled
28017     *
28018     * @see also elm_naviframe_content_preserve_on_pop_set()
28019     *
28020     * @ingroup Naviframe
28021     */
28022    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28023    /**
28024     * @brief Get a top item on the naviframe stack
28025     *
28026     * @param obj The naviframe object
28027     * @return The top item on the naviframe stack or @c NULL, if the stack is
28028     *         empty
28029     *
28030     * @ingroup Naviframe
28031     */
28032    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28033    /**
28034     * @brief Get a bottom item on the naviframe stack
28035     *
28036     * @param obj The naviframe object
28037     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28038     *         empty
28039     *
28040     * @ingroup Naviframe
28041     */
28042    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28043    /**
28044     * @brief Set an item style
28045     *
28046     * @param obj The naviframe item
28047     * @param item_style The current item style name. @c NULL would be default
28048     *
28049     * The following styles are available for this item:
28050     * @li @c "default"
28051     *
28052     * @see also elm_naviframe_item_style_get()
28053     *
28054     * @ingroup Naviframe
28055     */
28056    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28057    /**
28058     * @brief Get an item style
28059     *
28060     * @param obj The naviframe item
28061     * @return The current item style name
28062     *
28063     * @see also elm_naviframe_item_style_set()
28064     *
28065     * @ingroup Naviframe
28066     */
28067    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28068    /**
28069     * @brief Show/Hide the title area
28070     *
28071     * @param it The naviframe item
28072     * @param visible If @c EINA_TRUE, title area will be visible, hidden
28073     *        otherwise
28074     *
28075     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
28076     *
28077     * @see also elm_naviframe_item_title_visible_get()
28078     *
28079     * @ingroup Naviframe
28080     */
28081    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28082    /**
28083     * @brief Get a value whether title area is visible or not.
28084     *
28085     * @param it The naviframe item
28086     * @return If @c EINA_TRUE, title area is visible
28087     *
28088     * @see also elm_naviframe_item_title_visible_set()
28089     *
28090     * @ingroup Naviframe
28091     */
28092    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28093
28094    /**
28095     * @brief Set creating prev button automatically or not
28096     *
28097     * @param obj The naviframe object
28098     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28099     *        be created internally when you pass the @c NULL to the prev_btn
28100     *        parameter in elm_naviframe_item_push
28101     *
28102     * @see also elm_naviframe_item_push()
28103     */
28104    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28105    /**
28106     * @brief Get a value whether prev button(back button) will be auto pushed or
28107     *        not.
28108     *
28109     * @param obj The naviframe object
28110     * @return If @c EINA_TRUE, prev button will be auto pushed.
28111     *
28112     * @see also elm_naviframe_item_push()
28113     *           elm_naviframe_prev_btn_auto_pushed_set()
28114     */
28115    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
28116
28117    /**
28118     * @}
28119     */
28120
28121 #ifdef __cplusplus
28122 }
28123 #endif
28124
28125 #endif