MIN/MAX macros -> elm_priv.h
[framework/uifw/elementary.git] / src / lib / Elementary.h.in
1 /*
2  *
3  * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
4  */
5
6 /**
7 @file Elementary.h.in
8 @brief Elementary Widget Library
9 */
10
11 /**
12 @mainpage Elementary
13 @image html  elementary.png
14 @version 0.8.0
15 @date 2008-2011
16
17 @section intro What is Elementary?
18
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
21
22 It is meant to make the programmers work almost brainless but give them lots
23 of flexibility.
24
25 @li @ref Start - Go here to quickly get started with writing Apps
26
27 @section organization Organization
28
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
33
34 @section license License
35
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
38
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
44 */
45
46
47 /**
48  * @defgroup Start Getting Started
49  *
50  * To write an Elementary app, you can get started with the following:
51  *
52 @code
53 #include <Elementary.h>
54 EAPI_MAIN int
55 elm_main(int argc, char **argv)
56 {
57    // create window(s) here and do any application init
58    elm_run(); // run main loop
59    elm_shutdown(); // after mainloop finishes running, shutdown
60    return 0; // exit 0 for exit code
61 }
62 ELM_MAIN()
63 @endcode
64  *
65  * To use autotools (which helps in many ways in the long run, like being able
66  * to immediately create releases of your software directly from your tree
67  * and ensure everything needed to build it is there) you will need a
68  * configure.ac, Makefile.am and autogen.sh file.
69  *
70  * configure.ac:
71  *
72 @verbatim
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
74 AC_PREREQ(2.52)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
77 AC_PROG_CC
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
80 AC_OUTPUT(Makefile)
81 @endverbatim
82  *
83  * Makefile.am:
84  *
85 @verbatim
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
88
89 INCLUDES = -I$(top_srcdir)
90
91 bin_PROGRAMS = myapp
92
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
96 @endverbatim
97  *
98  * autogen.sh:
99  *
100 @verbatim
101 #!/bin/sh
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
106 ./configure "$@"
107 @endverbatim
108  *
109  * To generate all the things needed to bootstrap just run:
110  *
111 @verbatim
112 ./autogen.sh
113 @endverbatim
114  *
115  * This will generate Makefile.in's, the confgure script and everything else.
116  * After this it works like all normal autotools projects:
117 @verbatim
118 ./configure
119 make
120 sudo make install
121 @endverbatim
122  *
123  * Note sudo was assumed to get root permissions, as this would install in
124  * /usr/local which is system-owned. Use any way you like to gain root, or
125  * specify a different prefix with configure:
126  *
127 @verbatim
128 ./confiugre --prefix=$HOME/mysoftware
129 @endverbatim
130  *
131  * Also remember that autotools buys you some useful commands like:
132 @verbatim
133 make uninstall
134 @endverbatim
135  *
136  * This uninstalls the software after it was installed with "make install".
137  * It is very useful to clear up what you built if you wish to clean the
138  * system.
139  *
140 @verbatim
141 make distcheck
142 @endverbatim
143  *
144  * This firstly checks if your build tree is "clean" and ready for
145  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146  * ready to upload and distribute to the world, that contains the generated
147  * Makefile.in's and configure script. The users do not need to run
148  * autogen.sh - just configure and on. They don't need autotools installed.
149  * This tarball also builds cleanly, has all the sources it needs to build
150  * included (that is sources for your application, not libraries it depends
151  * on like Elementary). It builds cleanly in a buildroot and does not
152  * contain any files that are temporarily generated like binaries and other
153  * build-generated files, so the tarball is clean, and no need to worry
154  * about cleaning up your tree before packaging.
155  *
156 @verbatim
157 make clean
158 @endverbatim
159  *
160  * This cleans up all build files (binaries, objects etc.) from the tree.
161  *
162 @verbatim
163 make distclean
164 @endverbatim
165  *
166  * This cleans out all files from the build and from configure's output too.
167  *
168 @verbatim
169 make maintainer-clean
170 @endverbatim
171  *
172  * This deletes all the files autogen.sh will produce so the tree is clean
173  * to be put into a revision-control system (like CVS, SVN or GIT for example).
174  *
175  * There is a more advanced way of making use of the quicklaunch infrastructure
176  * in Elementary (which will not be covered here due to its more advanced
177  * nature).
178  *
179  * Now let's actually create an interactive "Hello World" gui that you can
180  * click the ok button to exit. It's more code because this now does something
181  * much more significant, but it's still very simple:
182  *
183 @code
184 #include <Elementary.h>
185
186 static void
187 on_done(void *data, Evas_Object *obj, void *event_info)
188 {
189    // quit the mainloop (elm_run function will return)
190    elm_exit();
191 }
192
193 EAPI_MAIN int
194 elm_main(int argc, char **argv)
195 {
196    Evas_Object *win, *bg, *box, *lab, *btn;
197
198    // new window - do the usual and give it a name (hello) and title (Hello)
199    win = elm_win_util_standard_add("hello", "Hello");
200    // when the user clicks "close" on a window there is a request to delete
201    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
202
203    // add a box object - default is vertical. a box holds children in a row,
204    // either horizontally or vertically. nothing more.
205    box = elm_box_add(win);
206    // make the box hotizontal
207    elm_box_horizontal_set(box, EINA_TRUE);
208    // add object as a resize object for the window (controls window minimum
209    // size as well as gets resized if window is resized)
210    elm_win_resize_object_add(win, box);
211    evas_object_show(box);
212
213    // add a label widget, set the text and put it in the pad frame
214    lab = elm_label_add(win);
215    // set default text of the label
216    elm_object_text_set(lab, "Hello out there world!");
217    // pack the label at the end of the box
218    elm_box_pack_end(box, lab);
219    evas_object_show(lab);
220
221    // add an ok button
222    btn = elm_button_add(win);
223    // set default text of button to "OK"
224    elm_object_text_set(btn, "OK");
225    // pack the button at the end of the box
226    elm_box_pack_end(box, btn);
227    evas_object_show(btn);
228    // call on_done when button is clicked
229    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
230
231    // now we are done, show the window
232    evas_object_show(win);
233
234    // run the mainloop and process events and callbacks
235    elm_run();
236    elm_shutdown();
237    return 0;
238 }
239 ELM_MAIN()
240 @endcode
241    *
242    */
243
244 /**
245 @page authors Authors
246 @author Carsten Haitzler <raster@@rasterman.com>
247 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
248 @author Cedric Bail <cedric.bail@@free.fr>
249 @author Vincent Torri <vtorri@@univ-evry.fr>
250 @author Daniel Kolesa <quaker66@@gmail.com>
251 @author Jaime Thomas <avi.thomas@@gmail.com>
252 @author Swisscom - http://www.swisscom.ch/
253 @author Christopher Michael <devilhorns@@comcast.net>
254 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
255 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
256 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
257 @author Brian Wang <brian.wang.0721@@gmail.com>
258 @author Mike Blumenkrantz (discomfitor/zmike) <michael.blumenkrantz@@gmail.com>
259 @author Samsung Electronics <tbd>
260 @author Samsung SAIT <tbd>
261 @author Brett Nash <nash@@nash.id.au>
262 @author Bruno Dilly <bdilly@@profusion.mobi>
263 @author Rafael Fonseca <rfonseca@@profusion.mobi>
264 @author Chuneon Park <hermet@@hermet.pe.kr>
265 @author Woohyun Jung <wh0705.jung@@samsung.com>
266 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
267 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
268 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
269 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
270 @author Gustavo Lima Chaves <glima@@profusion.mobi>
271 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
272 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
273 @author Otavio Pontes <otavio@@profusion.mobi>
274 @author Viktor Kojouharov <vkojouharov@@gmail.com>
275 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
276 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
277 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
278 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
279 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
280 @author Jihoon Kim <jihoon48.kim@@samsung.com>
281 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
282 @author Tom Hacohen <tom@@stosb.com>
283 @author Aharon Hillel <a.hillel@@partner.samsung.com>
284 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
285 @author Shinwoo Kim <kimcinoo@@gmail.com>
286 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
287 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
288 @author Sung W. Park <sungwoo@@gmail.com>
289 @author Thierry el Borgi <thierry@@substantiel.fr>
290 @author Shilpa Singh <shilpa.singh@@samsung.com> <shilpasingh.o@@gmail.com>
291 @author Chanwook Jung <joey.jung@@samsung.com>
292 @author Hyoyoung Chang <hyoyoung.chang@@samsung.com>
293 @author Guillaume "Kuri" Friloux <guillaume.friloux@@asp64.com>
294 @author Kim Yunhan <spbear@@gmail.com>
295 @author Bluezery <ohpowel@@gmail.com>
296 @author Nicolas Aguirre <aguirre.nicolas@@gmail.com>
297 @author Sanjeev BA <iamsanjeev@@gmail.com>
298
299 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
300 contact with the developers and maintainers.
301  */
302
303 #ifndef ELEMENTARY_H
304 #define ELEMENTARY_H
305
306 /**
307  * @file Elementary.h
308  * @brief Elementary's API
309  *
310  * Elementary API.
311  */
312
313 @ELM_UNIX_DEF@ ELM_UNIX
314 @ELM_WIN32_DEF@ ELM_WIN32
315 @ELM_WINCE_DEF@ ELM_WINCE
316 @ELM_EDBUS_DEF@ ELM_EDBUS
317 @ELM_EFREET_DEF@ ELM_EFREET
318 @ELM_ETHUMB_DEF@ ELM_ETHUMB
319 @ELM_WEB_DEF@ ELM_WEB
320 @ELM_EMAP_DEF@ ELM_EMAP
321 @ELM_DEBUG_DEF@ ELM_DEBUG
322 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
323 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
324 @ELM_DIRENT_H_DEF@ ELM_DIRENT_H
325
326 /* Standard headers for standard system calls etc. */
327 #include <stdio.h>
328 #include <stdlib.h>
329 #include <unistd.h>
330 #include <string.h>
331 #include <sys/types.h>
332 #include <sys/stat.h>
333 #include <sys/time.h>
334 #include <sys/param.h>
335 #include <math.h>
336 #include <fnmatch.h>
337 #include <limits.h>
338 #include <ctype.h>
339 #include <time.h>
340 #ifdef ELM_DIRENT_H
341 # include <dirent.h>
342 #endif
343 #include <pwd.h>
344 #include <errno.h>
345
346 #ifdef ELM_UNIX
347 # include <locale.h>
348 # ifdef ELM_LIBINTL_H
349 #  include <libintl.h>
350 # endif
351 # include <signal.h>
352 # include <grp.h>
353 # include <glob.h>
354 #endif
355
356 #ifdef ELM_ALLOCA_H
357 # include <alloca.h>
358 #endif
359
360 #if defined (ELM_WIN32) || defined (ELM_WINCE)
361 # include <malloc.h>
362 # ifndef alloca
363 #  define alloca _alloca
364 # endif
365 #endif
366
367
368 /* EFL headers */
369 #include <Eina.h>
370 #include <Eet.h>
371 #include <Evas.h>
372 #include <Evas_GL.h>
373 #include <Ecore.h>
374 #include <Ecore_Evas.h>
375 #include <Ecore_File.h>
376 @ELEMENTARY_ECORE_IMF_INC@
377 @ELEMENTARY_ECORE_CON_INC@
378 #include <Edje.h>
379
380 #ifdef ELM_EDBUS
381 # include <E_DBus.h>
382 #endif
383
384 #ifdef ELM_EFREET
385 # include <Efreet.h>
386 # include <Efreet_Mime.h>
387 # include <Efreet_Trash.h>
388 #endif
389
390 #ifdef ELM_ETHUMB
391 # include <Ethumb_Client.h>
392 #endif
393
394 #ifdef ELM_EMAP
395 # include <EMap.h>
396 #endif
397
398 #ifdef EAPI
399 # undef EAPI
400 #endif
401
402 #ifdef _WIN32
403 # ifdef ELEMENTARY_BUILD
404 #  ifdef DLL_EXPORT
405 #   define EAPI __declspec(dllexport)
406 #  else
407 #   define EAPI
408 #  endif /* ! DLL_EXPORT */
409 # else
410 #  define EAPI __declspec(dllimport)
411 # endif /* ! EFL_EVAS_BUILD */
412 #else
413 # ifdef __GNUC__
414 #  if __GNUC__ >= 4
415 #   define EAPI __attribute__ ((visibility("default")))
416 #  else
417 #   define EAPI
418 #  endif
419 # else
420 #  define EAPI
421 # endif
422 #endif /* ! _WIN32 */
423
424 #ifdef _WIN32
425 # define EAPI_MAIN
426 #else
427 # define EAPI_MAIN EAPI
428 #endif
429
430 /* allow usage from c++ */
431 #ifdef __cplusplus
432 extern "C" {
433 #endif
434
435 #define ELM_VERSION_MAJOR @VMAJ@
436 #define ELM_VERSION_MINOR @VMIN@
437
438    typedef struct _Elm_Version
439      {
440         int major;
441         int minor;
442         int micro;
443         int revision;
444      } Elm_Version;
445
446    EAPI extern Elm_Version *elm_version;
447
448 /* handy macros */
449 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
450 #define ELM_PI 3.14159265358979323846
451
452    /**
453     * @defgroup General General
454     *
455     * @brief General Elementary API. Functions that don't relate to
456     * Elementary objects specifically.
457     *
458     * Here are documented functions which init/shutdown the library,
459     * that apply to generic Elementary objects, that deal with
460     * configuration, et cetera.
461     *
462     * @ref general_functions_example_page "This" example contemplates
463     * some of these functions.
464     */
465
466    /**
467     * @addtogroup General
468     * @{
469     */
470
471   /**
472    * Defines couple of standard Evas_Object layers to be used
473    * with evas_object_layer_set().
474    *
475    * @note whenever extending with new values, try to keep some padding
476    *       to siblings so there is room for further extensions.
477    */
478   typedef enum _Elm_Object_Layer
479     {
480        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
481        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
482        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
483        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
484        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
485        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
486     } Elm_Object_Layer;
487
488 /**************************************************************************/
489    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
490
491    /**
492     * Emitted when the application has reconfigured elementary settings due
493     * to an external configuration tool asking it to.
494     */
495    EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
496
497    /**
498     * Emitted when any Elementary's policy value is changed.
499     */
500    EAPI extern int ELM_EVENT_POLICY_CHANGED;
501
502    /**
503     * @typedef Elm_Event_Policy_Changed
504     *
505     * Data on the event when an Elementary policy has changed
506     */
507     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
508
509    /**
510     * @struct _Elm_Event_Policy_Changed
511     *
512     * Data on the event when an Elementary policy has changed
513     */
514     struct _Elm_Event_Policy_Changed
515      {
516         unsigned int policy; /**< the policy identifier */
517         int          new_value; /**< value the policy had before the change */
518         int          old_value; /**< new value the policy got */
519     };
520
521    /**
522     * Policy identifiers.
523     */
524     typedef enum _Elm_Policy
525     {
526         ELM_POLICY_QUIT, /**< under which circumstances the application
527                           * should quit automatically. @see
528                           * Elm_Policy_Quit.
529                           */
530         ELM_POLICY_LAST
531     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
532  */
533
534    typedef enum _Elm_Policy_Quit
535      {
536         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
537                                    * automatically */
538         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
539                                             * application's last
540                                             * window is closed */
541      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
542
543    typedef enum _Elm_Focus_Direction
544      {
545         ELM_FOCUS_PREVIOUS,
546         ELM_FOCUS_NEXT
547      } Elm_Focus_Direction;
548
549    typedef enum _Elm_Text_Format
550      {
551         ELM_TEXT_FORMAT_PLAIN_UTF8,
552         ELM_TEXT_FORMAT_MARKUP_UTF8
553      } Elm_Text_Format;
554
555    /**
556     * Line wrapping types.
557     */
558    typedef enum _Elm_Wrap_Type
559      {
560         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
561         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
562         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
563         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
564         ELM_WRAP_LAST
565      } Elm_Wrap_Type;
566
567    typedef enum
568      {
569         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
570         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
571         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
572         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
573         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
574         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
575         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
576         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
577         ELM_INPUT_PANEL_LAYOUT_INVALID
578      } Elm_Input_Panel_Layout;
579
580    typedef enum
581      {
582         ELM_AUTOCAPITAL_TYPE_NONE,
583         ELM_AUTOCAPITAL_TYPE_WORD,
584         ELM_AUTOCAPITAL_TYPE_SENTENCE,
585         ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
586      } Elm_Autocapital_Type;
587
588    /**
589     * @typedef Elm_Object_Item
590     * An Elementary Object item handle.
591     * @ingroup General
592     */
593    typedef struct _Elm_Object_Item Elm_Object_Item;
594
595
596    /**
597     * Called back when a widget's tooltip is activated and needs content.
598     * @param data user-data given to elm_object_tooltip_content_cb_set()
599     * @param obj owner widget.
600     * @param tooltip The tooltip object (affix content to this!)
601     */
602    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
603
604    /**
605     * Called back when a widget's item tooltip is activated and needs content.
606     * @param data user-data given to elm_object_tooltip_content_cb_set()
607     * @param obj owner widget.
608     * @param tooltip The tooltip object (affix content to this!)
609     * @param item context dependent item. As an example, if tooltip was
610     *        set on Elm_List_Item, then it is of this type.
611     */
612    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
613
614    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. */
615
616 #ifndef ELM_LIB_QUICKLAUNCH
617 #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 */
618 #else
619 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
620 #endif
621
622 /**************************************************************************/
623    /* General calls */
624
625    /**
626     * Initialize Elementary
627     *
628     * @param[in] argc System's argument count value
629     * @param[in] argv System's pointer to array of argument strings
630     * @return The init counter value.
631     *
632     * This function initializes Elementary and increments a counter of
633     * the number of calls to it. It returns the new counter's value.
634     *
635     * @warning This call is exported only for use by the @c ELM_MAIN()
636     * macro. There is no need to use this if you use this macro (which
637     * is highly advisable). An elm_main() should contain the entry
638     * point code for your application, having the same prototype as
639     * elm_init(), and @b not being static (putting the @c EAPI symbol
640     * in front of its type declaration is advisable). The @c
641     * ELM_MAIN() call should be placed just after it.
642     *
643     * Example:
644     * @dontinclude bg_example_01.c
645     * @skip static void
646     * @until ELM_MAIN
647     *
648     * See the full @ref bg_example_01_c "example".
649     *
650     * @see elm_shutdown().
651     * @ingroup General
652     */
653    EAPI int          elm_init(int argc, char **argv);
654
655    /**
656     * Shut down Elementary
657     *
658     * @return The init counter value.
659     *
660     * This should be called at the end of your application, just
661     * before it ceases to do any more processing. This will clean up
662     * any permanent resources your application may have allocated via
663     * Elementary that would otherwise persist.
664     *
665     * @see elm_init() for an example
666     *
667     * @ingroup General
668     */
669    EAPI int          elm_shutdown(void);
670
671    /**
672     * Run Elementary's main loop
673     *
674     * This call should be issued just after all initialization is
675     * completed. This function will not return until elm_exit() is
676     * called. It will keep looping, running the main
677     * (event/processing) loop for Elementary.
678     *
679     * @see elm_init() for an example
680     *
681     * @ingroup General
682     */
683    EAPI void         elm_run(void);
684
685    /**
686     * Exit Elementary's main loop
687     *
688     * If this call is issued, it will flag the main loop to cease
689     * processing and return back to its parent function (usually your
690     * elm_main() function).
691     *
692     * @see elm_init() for an example. There, just after a request to
693     * close the window comes, the main loop will be left.
694     *
695     * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
696     * applications, you'll be able to get this function called automatically for you.
697     *
698     * @ingroup General
699     */
700    EAPI void         elm_exit(void);
701
702    /**
703     * Provide information in order to make Elementary determine the @b
704     * run time location of the software in question, so other data files
705     * such as images, sound files, executable utilities, libraries,
706     * modules and locale files can be found.
707     *
708     * @param mainfunc This is your application's main function name,
709     *        whose binary's location is to be found. Providing @c NULL
710     *        will make Elementary not to use it
711     * @param dom This will be used as the application's "domain", in the
712     *        form of a prefix to any environment variables that may
713     *        override prefix detection and the directory name, inside the
714     *        standard share or data directories, where the software's
715     *        data files will be looked for.
716     * @param checkfile This is an (optional) magic file's path to check
717     *        for existence (and it must be located in the data directory,
718     *        under the share directory provided above). Its presence will
719     *        help determine the prefix found was correct. Pass @c NULL if
720     *        the check is not to be done.
721     *
722     * This function allows one to re-locate the application somewhere
723     * else after compilation, if the developer wishes for easier
724     * distribution of pre-compiled binaries.
725     *
726     * The prefix system is designed to locate where the given software is
727     * installed (under a common path prefix) at run time and then report
728     * specific locations of this prefix and common directories inside
729     * this prefix like the binary, library, data and locale directories,
730     * through the @c elm_app_*_get() family of functions.
731     *
732     * Call elm_app_info_set() early on before you change working
733     * directory or anything about @c argv[0], so it gets accurate
734     * information.
735     *
736     * It will then try and trace back which file @p mainfunc comes from,
737     * if provided, to determine the application's prefix directory.
738     *
739     * The @p dom parameter provides a string prefix to prepend before
740     * environment variables, allowing a fallback to @b specific
741     * environment variables to locate the software. You would most
742     * probably provide a lowercase string there, because it will also
743     * serve as directory domain, explained next. For environment
744     * variables purposes, this string is made uppercase. For example if
745     * @c "myapp" is provided as the prefix, then the program would expect
746     * @c "MYAPP_PREFIX" as a master environment variable to specify the
747     * exact install prefix for the software, or more specific environment
748     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
749     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
750     * the user or scripts before launching. If not provided (@c NULL),
751     * environment variables will not be used to override compiled-in
752     * defaults or auto detections.
753     *
754     * The @p dom string also provides a subdirectory inside the system
755     * shared data directory for data files. For example, if the system
756     * directory is @c /usr/local/share, then this directory name is
757     * appended, creating @c /usr/local/share/myapp, if it @p was @c
758     * "myapp". It is expected that the application installs data files in
759     * this directory.
760     *
761     * The @p checkfile is a file name or path of something inside the
762     * share or data directory to be used to test that the prefix
763     * detection worked. For example, your app will install a wallpaper
764     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
765     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
766     * checkfile string.
767     *
768     * @see elm_app_compile_bin_dir_set()
769     * @see elm_app_compile_lib_dir_set()
770     * @see elm_app_compile_data_dir_set()
771     * @see elm_app_compile_locale_set()
772     * @see elm_app_prefix_dir_get()
773     * @see elm_app_bin_dir_get()
774     * @see elm_app_lib_dir_get()
775     * @see elm_app_data_dir_get()
776     * @see elm_app_locale_dir_get()
777     */
778    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
779
780    /**
781     * Provide information on the @b fallback application's binaries
782     * directory, in scenarios where they get overriden by
783     * elm_app_info_set().
784     *
785     * @param dir The path to the default binaries directory (compile time
786     * one)
787     *
788     * @note Elementary will as well use this path to determine actual
789     * names of binaries' directory paths, maybe changing it to be @c
790     * something/local/bin instead of @c something/bin, only, for
791     * example.
792     *
793     * @warning You should call this function @b before
794     * elm_app_info_set().
795     */
796    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
797
798    /**
799     * Provide information on the @b fallback application's libraries
800     * directory, on scenarios where they get overriden by
801     * elm_app_info_set().
802     *
803     * @param dir The path to the default libraries directory (compile
804     * time one)
805     *
806     * @note Elementary will as well use this path to determine actual
807     * names of libraries' directory paths, maybe changing it to be @c
808     * something/lib32 or @c something/lib64 instead of @c something/lib,
809     * only, for example.
810     *
811     * @warning You should call this function @b before
812     * elm_app_info_set().
813     */
814    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
815
816    /**
817     * Provide information on the @b fallback application's data
818     * directory, on scenarios where they get overriden by
819     * elm_app_info_set().
820     *
821     * @param dir The path to the default data directory (compile time
822     * one)
823     *
824     * @note Elementary will as well use this path to determine actual
825     * names of data directory paths, maybe changing it to be @c
826     * something/local/share instead of @c something/share, only, for
827     * example.
828     *
829     * @warning You should call this function @b before
830     * elm_app_info_set().
831     */
832    EAPI void         elm_app_compile_data_dir_set(const char *dir);
833
834    /**
835     * Provide information on the @b fallback application's locale
836     * directory, on scenarios where they get overriden by
837     * elm_app_info_set().
838     *
839     * @param dir The path to the default locale directory (compile time
840     * one)
841     *
842     * @warning You should call this function @b before
843     * elm_app_info_set().
844     */
845    EAPI void         elm_app_compile_locale_set(const char *dir);
846
847    /**
848     * Retrieve the application's run time prefix directory, as set by
849     * elm_app_info_set() and the way (environment) the application was
850     * run from.
851     *
852     * @return The directory prefix the application is actually using.
853     */
854    EAPI const char  *elm_app_prefix_dir_get(void);
855
856    /**
857     * Retrieve the application's run time binaries prefix directory, as
858     * set by elm_app_info_set() and the way (environment) the application
859     * was run from.
860     *
861     * @return The binaries directory prefix the application is actually
862     * using.
863     */
864    EAPI const char  *elm_app_bin_dir_get(void);
865
866    /**
867     * Retrieve the application's run time libraries prefix directory, as
868     * set by elm_app_info_set() and the way (environment) the application
869     * was run from.
870     *
871     * @return The libraries directory prefix the application is actually
872     * using.
873     */
874    EAPI const char  *elm_app_lib_dir_get(void);
875
876    /**
877     * Retrieve the application's run time data prefix directory, as
878     * set by elm_app_info_set() and the way (environment) the application
879     * was run from.
880     *
881     * @return The data directory prefix the application is actually
882     * using.
883     */
884    EAPI const char  *elm_app_data_dir_get(void);
885
886    /**
887     * Retrieve the application's run time locale prefix directory, as
888     * set by elm_app_info_set() and the way (environment) the application
889     * was run from.
890     *
891     * @return The locale directory prefix the application is actually
892     * using.
893     */
894    EAPI const char  *elm_app_locale_dir_get(void);
895
896    /**
897     * Exposed symbol used only by macros and should not be used by apps
898     */
899    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
900    
901    /**
902     * Exposed symbol used only by macros and should not be used by apps
903     */
904    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
905    
906    /**
907     * Exposed symbol used only by macros and should not be used by apps
908     */
909    EAPI int          elm_quicklaunch_init(int argc, char **argv);
910    
911    /**
912     * Exposed symbol used only by macros and should not be used by apps
913     */
914    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
915    
916    /**
917     * Exposed symbol used only by macros and should not be used by apps
918     */
919    EAPI int          elm_quicklaunch_sub_shutdown(void);
920    
921    /**
922     * Exposed symbol used only by macros and should not be used by apps
923     */
924    EAPI int          elm_quicklaunch_shutdown(void);
925    
926    /**
927     * Exposed symbol used only by macros and should not be used by apps
928     */
929    EAPI void         elm_quicklaunch_seed(void);
930    
931    /**
932     * Exposed symbol used only by macros and should not be used by apps
933     */
934    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
935    
936    /**
937     * Exposed symbol used only by macros and should not be used by apps
938     */
939    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
940    
941    /**
942     * Exposed symbol used only by macros and should not be used by apps
943     */
944    EAPI void         elm_quicklaunch_cleanup(void);
945    
946    /**
947     * Exposed symbol used only by macros and should not be used by apps
948     */
949    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
950    
951    /**
952     * Exposed symbol used only by macros and should not be used by apps
953     */
954    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
955
956    /**
957     * Request that your elementary application needs efreet
958     * 
959     * This initializes the Efreet library when called and if support exists
960     * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
961     * before any efreet calls.
962     * 
963     * @return EINA_TRUE if support exists and initialization succeeded.
964     * 
965     * @ingroup Efreet
966     */
967    EAPI Eina_Bool    elm_need_efreet(void);
968    
969    /**
970     * Request that your elementary application needs e_dbus
971     * 
972     * This initializes the E_dbus library when called and if support exists
973     * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
974     * before any e_dbus calls.
975     * 
976     * @return EINA_TRUE if support exists and initialization succeeded.
977     * 
978     * @ingroup E_dbus
979     */
980    EAPI Eina_Bool    elm_need_e_dbus(void);
981
982    /**
983     * Request that your elementary application needs ethumb
984     * 
985     * This initializes the Ethumb library when called and if support exists
986     * it returns EINA_TRUE, otherwise returns EINA_FALSE.
987     * This must be called before any other function that deals with
988     * elm_thumb objects or ethumb_client instances.
989     *
990     * @ingroup Thumb
991     */
992    EAPI Eina_Bool    elm_need_ethumb(void);
993
994    /**
995     * Request that your elementary application needs web support
996     * 
997     * This initializes the Ewebkit library when called and if support exists
998     * it returns EINA_TRUE, otherwise returns EINA_FALSE.
999     * This must be called before any other function that deals with
1000     * elm_web objects or ewk_view instances.
1001     *
1002     * @ingroup Web
1003     */
1004    EAPI Eina_Bool    elm_need_web(void);
1005
1006    /**
1007     * Set a new policy's value (for a given policy group/identifier).
1008     *
1009     * @param policy policy identifier, as in @ref Elm_Policy.
1010     * @param value policy value, which depends on the identifier
1011     *
1012     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
1013     *
1014     * Elementary policies define applications' behavior,
1015     * somehow. These behaviors are divided in policy groups (see
1016     * #Elm_Policy enumeration). This call will emit the Ecore event
1017     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
1018     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
1019     * then.
1020     *
1021     * @note Currently, we have only one policy identifier/group
1022     * (#ELM_POLICY_QUIT), which has two possible values.
1023     *
1024     * @ingroup General
1025     */
1026    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
1027
1028    /**
1029     * Gets the policy value for given policy identifier.
1030     *
1031     * @param policy policy identifier, as in #Elm_Policy.
1032     * @return The currently set policy value, for that
1033     * identifier. Will be @c 0 if @p policy passed is invalid.
1034     *
1035     * @ingroup General
1036     */
1037    EAPI int          elm_policy_get(unsigned int policy);
1038
1039    /**
1040     * Change the language of the current application
1041     *
1042     * The @p lang passed must be the full name of the locale to use, for
1043     * example "en_US.utf8" or "es_ES@euro".
1044     *
1045     * Changing language with this function will make Elementary run through
1046     * all its widgets, translating strings set with
1047     * elm_object_domain_translatable_text_part_set(). This way, an entire
1048     * UI can have its language changed without having to restart the program.
1049     *
1050     * For more complex cases, like having formatted strings that need
1051     * translation, widgets will also emit a "language,changed" signal that
1052     * the user can listen to to manually translate the text.
1053     *
1054     * @param lang Language to set, must be the full name of the locale
1055     *
1056     * @ingroup General
1057     */
1058    EAPI void         elm_language_set(const char *lang);
1059
1060    /**
1061     * Set a label of an object
1062     *
1063     * @param obj The Elementary object
1064     * @param part The text part name to set (NULL for the default label)
1065     * @param label The new text of the label
1066     *
1067     * @note Elementary objects may have many labels (e.g. Action Slider)
1068     * @deprecated Use elm_object_part_text_set() instead.
1069     * @ingroup General
1070     */
1071    EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
1072
1073    /**
1074     * Set a label of an object
1075     *
1076     * @param obj The Elementary object
1077     * @param part The text part name to set (NULL for the default label)
1078     * @param label The new text of the label
1079     *
1080     * @note Elementary objects may have many labels (e.g. Action Slider)
1081     *
1082     * @ingroup General
1083     */
1084    EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
1085
1086 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
1087
1088    /**
1089     * Get a label of an object
1090     *
1091     * @param obj The Elementary object
1092     * @param part The text part name to get (NULL for the default label)
1093     * @return text of the label or NULL for any error
1094     *
1095     * @note Elementary objects may have many labels (e.g. Action Slider)
1096     * @deprecated Use elm_object_part_text_get() instead.
1097     * @ingroup General
1098     */
1099    EINA_DEPRECATED EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1100
1101    /**
1102     * Get a label of an object
1103     *
1104     * @param obj The Elementary object
1105     * @param part The text part name to get (NULL for the default label)
1106     * @return text of the label or NULL for any error
1107     *
1108     * @note Elementary objects may have many labels (e.g. Action Slider)
1109     *
1110     * @ingroup General
1111     */
1112    EAPI const char  *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1113
1114 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1115
1116    /**
1117     * Set the text for an objects' part, marking it as translatable.
1118     *
1119     * The string to set as @p text must be the original one. Do not pass the
1120     * return of @c gettext() here. Elementary will translate the string
1121     * internally and set it on the object using elm_object_part_text_set(),
1122     * also storing the original string so that it can be automatically
1123     * translated when the language is changed with elm_language_set().
1124     *
1125     * The @p domain will be stored along to find the translation in the
1126     * correct catalog. It can be NULL, in which case it will use whatever
1127     * domain was set by the application with @c textdomain(). This is useful
1128     * in case you are building a library on top of Elementary that will have
1129     * its own translatable strings, that should not be mixed with those of
1130     * programs using the library.
1131     *
1132     * @param obj The object containing the text part
1133     * @param part The name of the part to set
1134     * @param domain The translation domain to use
1135     * @param text The original, non-translated text to set
1136     *
1137     * @ingroup General
1138     */
1139    EAPI void         elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1140
1141 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1142
1143 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1144
1145    /**
1146     * Gets the original string set as translatable for an object
1147     *
1148     * When setting translated strings, the function elm_object_part_text_get()
1149     * will return the translation returned by @c gettext(). To get the
1150     * original string use this function.
1151     *
1152     * @param obj The object
1153     * @param part The name of the part that was set
1154     *
1155     * @return The original, untranslated string
1156     *
1157     * @ingroup General
1158     */
1159    EAPI const char  *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1160
1161 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1162
1163    /**
1164     * Set a content of an object
1165     *
1166     * @param obj The Elementary object
1167     * @param part The content part name to set (NULL for the default content)
1168     * @param content The new content of the object
1169     *
1170     * @note Elementary objects may have many contents
1171     * @deprecated Use elm_object_part_content_set instead.
1172     * @ingroup General
1173     */
1174    EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1175
1176    /**
1177     * Set a content of an object
1178     *
1179     * @param obj The Elementary object
1180     * @param part The content part name to set (NULL for the default content)
1181     * @param content The new content of the object
1182     *
1183     * @note Elementary objects may have many contents
1184     *
1185     * @ingroup General
1186     */
1187    EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1188
1189 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1190
1191    /**
1192     * Get a content of an object
1193     *
1194     * @param obj The Elementary object
1195     * @param item The content part name to get (NULL for the default content)
1196     * @return content of the object or NULL for any error
1197     *
1198     * @note Elementary objects may have many contents
1199     * @deprecated Use elm_object_part_content_get instead.
1200     * @ingroup General
1201     */
1202    EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1203
1204    /**
1205     * Get a content of an object
1206     *
1207     * @param obj The Elementary object
1208     * @param item The content part name to get (NULL for the default content)
1209     * @return content of the object or NULL for any error
1210     *
1211     * @note Elementary objects may have many contents
1212     *
1213     * @ingroup General
1214     */
1215    EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1216
1217 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1218
1219    /**
1220     * Unset a content of an object
1221     *
1222     * @param obj The Elementary object
1223     * @param item The content part name to unset (NULL for the default content)
1224     *
1225     * @note Elementary objects may have many contents
1226     * @deprecated Use elm_object_part_content_unset instead.
1227     * @ingroup General
1228     */
1229    EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1230
1231    /**
1232     * Unset a content of an object
1233     *
1234     * @param obj The Elementary object
1235     * @param item The content part name to unset (NULL for the default content)
1236     *
1237     * @note Elementary objects may have many contents
1238     *
1239     * @ingroup General
1240     */
1241    EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1242
1243 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1244
1245    /**
1246     * Set the text to read out when in accessibility mode
1247     *
1248     * @param obj The object which is to be described
1249     * @param txt The text that describes the widget to people with poor or no vision
1250     *
1251     * @ingroup General
1252     */
1253    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1254
1255    /**
1256     * Get the widget object's handle which contains a given item
1257     *
1258     * @param item The Elementary object item
1259     * @return The widget object
1260     *
1261     * @note This returns the widget object itself that an item belongs to.
1262     *
1263     * @ingroup General
1264     */
1265    EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1266
1267    /**
1268     * Set a content of an object item
1269     *
1270     * @param it The Elementary object item
1271     * @param part The content part name to set (NULL for the default content)
1272     * @param content The new content of the object item
1273     *
1274     * @note Elementary object items may have many contents
1275     * @deprecated Use elm_object_item_part_content_set instead.
1276     * @ingroup General
1277     */
1278    EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1279
1280    /**
1281     * Set a content of an object item
1282     *
1283     * @param it The Elementary object item
1284     * @param part The content part name to set (NULL for the default content)
1285     * @param content The new content of the object item
1286     *
1287     * @note Elementary object items may have many contents
1288     *
1289     * @ingroup General
1290     */
1291    EAPI void elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1292
1293 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
1294
1295    /**
1296     * Get a content of an object item
1297     *
1298     * @param it The Elementary object item
1299     * @param part The content part name to unset (NULL for the default content)
1300     * @return content of the object item or NULL for any error
1301     *
1302     * @note Elementary object items may have many contents
1303     * @deprecated Use elm_object_item_part_content_get instead.
1304     * @ingroup General
1305     */
1306    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1307
1308    /**
1309     * Get a content of an object item
1310     *
1311     * @param it The Elementary object item
1312     * @param part The content part name to unset (NULL for the default content)
1313     * @return content of the object item or NULL for any error
1314     *
1315     * @note Elementary object items may have many contents
1316     *
1317     * @ingroup General
1318     */
1319    EAPI Evas_Object *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
1320
1321 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
1322
1323    /**
1324     * Unset a content of an object item
1325     *
1326     * @param it The Elementary object item
1327     * @param part The content part name to unset (NULL for the default content)
1328     *
1329     * @note Elementary object items may have many contents
1330     * @deprecated Use elm_object_item_part_content_unset instead.
1331     * @ingroup General
1332     */
1333    EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1334
1335    /**
1336     * Unset a content of an object item
1337     *
1338     * @param it The Elementary object item
1339     * @param part The content part name to unset (NULL for the default content)
1340     *
1341     * @note Elementary object items may have many contents
1342     *
1343     * @ingroup General
1344     */
1345    EAPI Evas_Object *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
1346
1347 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1348
1349    /**
1350     * Set a label of an object item
1351     *
1352     * @param it The Elementary object item
1353     * @param part The text part name to set (NULL for the default label)
1354     * @param label The new text of the label
1355     *
1356     * @note Elementary object items may have many labels
1357     * @deprecated Use elm_object_item_part_text_set instead.
1358     * @ingroup General
1359     */
1360    EINA_DEPRECATED EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1361
1362    /**
1363     * Set a label of an object item
1364     *
1365     * @param it The Elementary object item
1366     * @param part The text part name to set (NULL for the default label)
1367     * @param label The new text of the label
1368     *
1369     * @note Elementary object items may have many labels
1370     *
1371     * @ingroup General
1372     */
1373    EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1374
1375 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1376
1377    /**
1378     * Get a label of an object item
1379     *
1380     * @param it The Elementary object item
1381     * @param part The text part name to get (NULL for the default label)
1382     * @return text of the label or NULL for any error
1383     *
1384     * @note Elementary object items may have many labels
1385     * @deprecated Use elm_object_item_part_text_get instead.
1386     * @ingroup General
1387     */
1388    EINA_DEPRECATED EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1389    /**
1390     * Get a label of an object item
1391     *
1392     * @param it The Elementary object item
1393     * @param part The text part name to get (NULL for the default label)
1394     * @return text of the label or NULL for any error
1395     *
1396     * @note Elementary object items may have many labels
1397     *
1398     * @ingroup General
1399     */
1400    EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1401
1402 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1403
1404    /**
1405     * Set the text to read out when in accessibility mode
1406     *
1407     * @param it The object item which is to be described
1408     * @param txt The text that describes the widget to people with poor or no vision
1409     *
1410     * @ingroup General
1411     */
1412    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1413
1414    /**
1415     * Get the data associated with an object item
1416     * @param it The Elementary object item
1417     * @return The data associated with @p it
1418     *
1419     * @ingroup General
1420     */
1421    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1422
1423    /**
1424     * Set the data associated with an object item
1425     * @param it The Elementary object item
1426     * @param data The data to be associated with @p it
1427     *
1428     * @ingroup General
1429     */
1430    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1431
1432    /**
1433     * Send a signal to the edje object of the widget item.
1434     *
1435     * This function sends a signal to the edje object of the obj item. An
1436     * edje program can respond to a signal by specifying matching
1437     * 'signal' and 'source' fields.
1438     *
1439     * @param it The Elementary object item
1440     * @param emission The signal's name.
1441     * @param source The signal's source.
1442     * @ingroup General
1443     */
1444    EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1445
1446    /**
1447     * Set the disabled state of an widget item.
1448     *
1449     * @param obj The Elementary object item
1450     * @param disabled The state to put in in: @c EINA_TRUE for
1451     *        disabled, @c EINA_FALSE for enabled
1452     *
1453     * Elementary object item can be @b disabled, in which state they won't
1454     * receive input and, in general, will be themed differently from
1455     * their normal state, usually greyed out. Useful for contexts
1456     * where you don't want your users to interact with some of the
1457     * parts of you interface.
1458     *
1459     * This sets the state for the widget item, either disabling it or
1460     * enabling it back.
1461     *
1462     * @ingroup Styles
1463     */
1464    EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1465
1466    /**
1467     * Get the disabled state of an widget item.
1468     *
1469     * @param obj The Elementary object
1470     * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1471     *            if it's enabled (or on errors)
1472     *
1473     * This gets the state of the widget, which might be enabled or disabled.
1474     *
1475     * @ingroup Styles
1476     */
1477    EAPI Eina_Bool    elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1478
1479    /**
1480     * @}
1481     */
1482
1483    /**
1484     * @defgroup Caches Caches
1485     *
1486     * These are functions which let one fine-tune some cache values for
1487     * Elementary applications, thus allowing for performance adjustments.
1488     *
1489     * @{
1490     */
1491
1492    /**
1493     * @brief Flush all caches.
1494     *
1495     * Frees all data that was in cache and is not currently being used to reduce
1496     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1497     * to calling all of the following functions:
1498     * @li edje_file_cache_flush()
1499     * @li edje_collection_cache_flush()
1500     * @li eet_clearcache()
1501     * @li evas_image_cache_flush()
1502     * @li evas_font_cache_flush()
1503     * @li evas_render_dump()
1504     * @note Evas caches are flushed for every canvas associated with a window.
1505     *
1506     * @ingroup Caches
1507     */
1508    EAPI void         elm_all_flush(void);
1509
1510    /**
1511     * Get the configured cache flush interval time
1512     *
1513     * This gets the globally configured cache flush interval time, in
1514     * ticks
1515     *
1516     * @return The cache flush interval time
1517     * @ingroup Caches
1518     *
1519     * @see elm_all_flush()
1520     */
1521    EAPI int          elm_cache_flush_interval_get(void);
1522
1523    /**
1524     * Set the configured cache flush interval time
1525     *
1526     * This sets the globally configured cache flush interval time, in ticks
1527     *
1528     * @param size The cache flush interval time
1529     * @ingroup Caches
1530     *
1531     * @see elm_all_flush()
1532     */
1533    EAPI void         elm_cache_flush_interval_set(int size);
1534
1535    /**
1536     * Set the configured cache flush interval time for all applications on the
1537     * display
1538     *
1539     * This sets the globally configured cache flush interval time -- in ticks
1540     * -- for all applications on the display.
1541     *
1542     * @param size The cache flush interval time
1543     * @ingroup Caches
1544     */
1545    EAPI void         elm_cache_flush_interval_all_set(int size);
1546
1547    /**
1548     * Get the configured cache flush enabled state
1549     *
1550     * This gets the globally configured cache flush state - if it is enabled
1551     * or not. When cache flushing is enabled, elementary will regularly
1552     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1553     * memory and allow usage to re-seed caches and data in memory where it
1554     * can do so. An idle application will thus minimise its memory usage as
1555     * data will be freed from memory and not be re-loaded as it is idle and
1556     * not rendering or doing anything graphically right now.
1557     *
1558     * @return The cache flush state
1559     * @ingroup Caches
1560     *
1561     * @see elm_all_flush()
1562     */
1563    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1564
1565    /**
1566     * Set the configured cache flush enabled state
1567     *
1568     * This sets the globally configured cache flush enabled state.
1569     *
1570     * @param size The cache flush enabled state
1571     * @ingroup Caches
1572     *
1573     * @see elm_all_flush()
1574     */
1575    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1576
1577    /**
1578     * Set the configured cache flush enabled state for all applications on the
1579     * display
1580     *
1581     * This sets the globally configured cache flush enabled state for all
1582     * applications on the display.
1583     *
1584     * @param size The cache flush enabled state
1585     * @ingroup Caches
1586     */
1587    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1588
1589    /**
1590     * Get the configured font cache size
1591     *
1592     * This gets the globally configured font cache size, in bytes.
1593     *
1594     * @return The font cache size
1595     * @ingroup Caches
1596     */
1597    EAPI int          elm_font_cache_get(void);
1598
1599    /**
1600     * Set the configured font cache size
1601     *
1602     * This sets the globally configured font cache size, in bytes
1603     *
1604     * @param size The font cache size
1605     * @ingroup Caches
1606     */
1607    EAPI void         elm_font_cache_set(int size);
1608
1609    /**
1610     * Set the configured font cache size for all applications on the
1611     * display
1612     *
1613     * This sets the globally configured font cache size -- in bytes
1614     * -- for all applications on the display.
1615     *
1616     * @param size The font cache size
1617     * @ingroup Caches
1618     */
1619    EAPI void         elm_font_cache_all_set(int size);
1620
1621    /**
1622     * Get the configured image cache size
1623     *
1624     * This gets the globally configured image cache size, in bytes
1625     *
1626     * @return The image cache size
1627     * @ingroup Caches
1628     */
1629    EAPI int          elm_image_cache_get(void);
1630
1631    /**
1632     * Set the configured image cache size
1633     *
1634     * This sets the globally configured image cache size, in bytes
1635     *
1636     * @param size The image cache size
1637     * @ingroup Caches
1638     */
1639    EAPI void         elm_image_cache_set(int size);
1640
1641    /**
1642     * Set the configured image cache size for all applications on the
1643     * display
1644     *
1645     * This sets the globally configured image cache size -- in bytes
1646     * -- for all applications on the display.
1647     *
1648     * @param size The image cache size
1649     * @ingroup Caches
1650     */
1651    EAPI void         elm_image_cache_all_set(int size);
1652
1653    /**
1654     * Get the configured edje file cache size.
1655     *
1656     * This gets the globally configured edje file cache size, in number
1657     * of files.
1658     *
1659     * @return The edje file cache size
1660     * @ingroup Caches
1661     */
1662    EAPI int          elm_edje_file_cache_get(void);
1663
1664    /**
1665     * Set the configured edje file cache size
1666     *
1667     * This sets the globally configured edje file cache size, in number
1668     * of files.
1669     *
1670     * @param size The edje file cache size
1671     * @ingroup Caches
1672     */
1673    EAPI void         elm_edje_file_cache_set(int size);
1674
1675    /**
1676     * Set the configured edje file cache size for all applications on the
1677     * display
1678     *
1679     * This sets the globally configured edje file cache size -- in number
1680     * of files -- for all applications on the display.
1681     *
1682     * @param size The edje file cache size
1683     * @ingroup Caches
1684     */
1685    EAPI void         elm_edje_file_cache_all_set(int size);
1686
1687    /**
1688     * Get the configured edje collections (groups) cache size.
1689     *
1690     * This gets the globally configured edje collections cache size, in
1691     * number of collections.
1692     *
1693     * @return The edje collections cache size
1694     * @ingroup Caches
1695     */
1696    EAPI int          elm_edje_collection_cache_get(void);
1697
1698    /**
1699     * Set the configured edje collections (groups) cache size
1700     *
1701     * This sets the globally configured edje collections cache size, in
1702     * number of collections.
1703     *
1704     * @param size The edje collections cache size
1705     * @ingroup Caches
1706     */
1707    EAPI void         elm_edje_collection_cache_set(int size);
1708
1709    /**
1710     * Set the configured edje collections (groups) cache size for all
1711     * applications on the display
1712     *
1713     * This sets the globally configured edje collections cache size -- in
1714     * number of collections -- for all applications on the display.
1715     *
1716     * @param size The edje collections cache size
1717     * @ingroup Caches
1718     */
1719    EAPI void         elm_edje_collection_cache_all_set(int size);
1720
1721    /**
1722     * @}
1723     */
1724
1725    /**
1726     * @defgroup Scaling Widget Scaling
1727     *
1728     * Different widgets can be scaled independently. These functions
1729     * allow you to manipulate this scaling on a per-widget basis. The
1730     * object and all its children get their scaling factors multiplied
1731     * by the scale factor set. This is multiplicative, in that if a
1732     * child also has a scale size set it is in turn multiplied by its
1733     * parent's scale size. @c 1.0 means ā€œdon't scaleā€, @c 2.0 is
1734     * double size, @c 0.5 is half, etc.
1735     *
1736     * @ref general_functions_example_page "This" example contemplates
1737     * some of these functions.
1738     */
1739
1740    /**
1741     * Get the global scaling factor
1742     *
1743     * This gets the globally configured scaling factor that is applied to all
1744     * objects.
1745     *
1746     * @return The scaling factor
1747     * @ingroup Scaling
1748     */
1749    EAPI double       elm_scale_get(void);
1750
1751    /**
1752     * Set the global scaling factor
1753     *
1754     * This sets the globally configured scaling factor that is applied to all
1755     * objects.
1756     *
1757     * @param scale The scaling factor to set
1758     * @ingroup Scaling
1759     */
1760    EAPI void         elm_scale_set(double scale);
1761
1762    /**
1763     * Set the global scaling factor for all applications on the display
1764     *
1765     * This sets the globally configured scaling factor that is applied to all
1766     * objects for all applications.
1767     * @param scale The scaling factor to set
1768     * @ingroup Scaling
1769     */
1770    EAPI void         elm_scale_all_set(double scale);
1771
1772    /**
1773     * Set the scaling factor for a given Elementary object
1774     *
1775     * @param obj The Elementary to operate on
1776     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1777     * no scaling)
1778     *
1779     * @ingroup Scaling
1780     */
1781    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1782
1783    /**
1784     * Get the scaling factor for a given Elementary object
1785     *
1786     * @param obj The object
1787     * @return The scaling factor set by elm_object_scale_set()
1788     *
1789     * @ingroup Scaling
1790     */
1791    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1792
1793    /**
1794     * @defgroup Password_last_show Password last input show
1795     *
1796     * Last show feature of password mode enables user to view
1797     * the last input entered for few seconds before masking it.
1798     * These functions allow to set this feature in password mode
1799     * of entry widget and also allow to manipulate the duration
1800     * for which the input has to be visible.
1801     *
1802     * @{
1803     */
1804
1805    /**
1806     * Get show last setting of password mode.
1807     *
1808     * This gets the show last input setting of password mode which might be
1809     * enabled or disabled.
1810     *
1811     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1812     *            if it's disabled.
1813     * @ingroup Password_last_show
1814     */
1815    EAPI Eina_Bool elm_password_show_last_get(void);
1816
1817    /**
1818     * Set show last setting in password mode.
1819     *
1820     * This enables or disables show last setting of password mode.
1821     *
1822     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1823     * @see elm_password_show_last_timeout_set()
1824     * @ingroup Password_last_show
1825     */
1826    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1827
1828    /**
1829     * Get's the timeout value in last show password mode.
1830     *
1831     * This gets the time out value for which the last input entered in password
1832     * mode will be visible.
1833     *
1834     * @return The timeout value of last show password mode.
1835     * @ingroup Password_last_show
1836     */
1837    EAPI double elm_password_show_last_timeout_get(void);
1838
1839    /**
1840     * Set's the timeout value in last show password mode.
1841     *
1842     * This sets the time out value for which the last input entered in password
1843     * mode will be visible.
1844     *
1845     * @param password_show_last_timeout The timeout value.
1846     * @see elm_password_show_last_set()
1847     * @ingroup Password_last_show
1848     */
1849    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1850
1851    /**
1852     * @}
1853     */
1854
1855    /**
1856     * @defgroup UI-Mirroring Selective Widget mirroring
1857     *
1858     * These functions allow you to set ui-mirroring on specific
1859     * widgets or the whole interface. Widgets can be in one of two
1860     * modes, automatic and manual.  Automatic means they'll be changed
1861     * according to the system mirroring mode and manual means only
1862     * explicit changes will matter. You are not supposed to change
1863     * mirroring state of a widget set to automatic, will mostly work,
1864     * but the behavior is not really defined.
1865     *
1866     * @{
1867     */
1868
1869    EAPI Eina_Bool    elm_mirrored_get(void);
1870    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1871
1872    /**
1873     * Get the system mirrored mode. This determines the default mirrored mode
1874     * of widgets.
1875     *
1876     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1877     */
1878    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1879
1880    /**
1881     * Set the system mirrored mode. This determines the default mirrored mode
1882     * of widgets.
1883     *
1884     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1885     */
1886    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1887
1888    /**
1889     * Returns the widget's mirrored mode setting.
1890     *
1891     * @param obj The widget.
1892     * @return mirrored mode setting of the object.
1893     *
1894     **/
1895    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1896
1897    /**
1898     * Sets the widget's mirrored mode setting.
1899     * When widget in automatic mode, it follows the system mirrored mode set by
1900     * elm_mirrored_set().
1901     * @param obj The widget.
1902     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1903     */
1904    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1905
1906    /**
1907     * @}
1908     */
1909
1910    /**
1911     * Set the style to use by a widget
1912     *
1913     * Sets the style name that will define the appearance of a widget. Styles
1914     * vary from widget to widget and may also be defined by other themes
1915     * by means of extensions and overlays.
1916     *
1917     * @param obj The Elementary widget to style
1918     * @param style The style name to use
1919     *
1920     * @see elm_theme_extension_add()
1921     * @see elm_theme_extension_del()
1922     * @see elm_theme_overlay_add()
1923     * @see elm_theme_overlay_del()
1924     *
1925     * @ingroup Styles
1926     */
1927    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1928    /**
1929     * Get the style used by the widget
1930     *
1931     * This gets the style being used for that widget. Note that the string
1932     * pointer is only valid as longas the object is valid and the style doesn't
1933     * change.
1934     *
1935     * @param obj The Elementary widget to query for its style
1936     * @return The style name used
1937     *
1938     * @see elm_object_style_set()
1939     *
1940     * @ingroup Styles
1941     */
1942    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1943
1944    /**
1945     * @defgroup Styles Styles
1946     *
1947     * Widgets can have different styles of look. These generic API's
1948     * set styles of widgets, if they support them (and if the theme(s)
1949     * do).
1950     *
1951     * @ref general_functions_example_page "This" example contemplates
1952     * some of these functions.
1953     */
1954
1955    /**
1956     * Set the disabled state of an Elementary object.
1957     *
1958     * @param obj The Elementary object to operate on
1959     * @param disabled The state to put in in: @c EINA_TRUE for
1960     *        disabled, @c EINA_FALSE for enabled
1961     *
1962     * Elementary objects can be @b disabled, in which state they won't
1963     * receive input and, in general, will be themed differently from
1964     * their normal state, usually greyed out. Useful for contexts
1965     * where you don't want your users to interact with some of the
1966     * parts of you interface.
1967     *
1968     * This sets the state for the widget, either disabling it or
1969     * enabling it back.
1970     *
1971     * @ingroup Styles
1972     */
1973    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1974
1975    /**
1976     * Get the disabled state of an Elementary object.
1977     *
1978     * @param obj The Elementary object to operate on
1979     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1980     *            if it's enabled (or on errors)
1981     *
1982     * This gets the state of the widget, which might be enabled or disabled.
1983     *
1984     * @ingroup Styles
1985     */
1986    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1987
1988    /**
1989     * @defgroup WidgetNavigation Widget Tree Navigation.
1990     *
1991     * How to check if an Evas Object is an Elementary widget? How to
1992     * get the first elementary widget that is parent of the given
1993     * object?  These are all covered in widget tree navigation.
1994     *
1995     * @ref general_functions_example_page "This" example contemplates
1996     * some of these functions.
1997     */
1998
1999    /**
2000     * Check if the given Evas Object is an Elementary widget.
2001     *
2002     * @param obj the object to query.
2003     * @return @c EINA_TRUE if it is an elementary widget variant,
2004     *         @c EINA_FALSE otherwise
2005     * @ingroup WidgetNavigation
2006     */
2007    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2008
2009    /**
2010     * Get the first parent of the given object that is an Elementary
2011     * widget.
2012     *
2013     * @param obj the Elementary object to query parent from.
2014     * @return the parent object that is an Elementary widget, or @c
2015     *         NULL, if it was not found.
2016     *
2017     * Use this to query for an object's parent widget.
2018     *
2019     * @note Most of Elementary users wouldn't be mixing non-Elementary
2020     * smart objects in the objects tree of an application, as this is
2021     * an advanced usage of Elementary with Evas. So, except for the
2022     * application's window, which is the root of that tree, all other
2023     * objects would have valid Elementary widget parents.
2024     *
2025     * @ingroup WidgetNavigation
2026     */
2027    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2028
2029    /**
2030     * Get the top level parent of an Elementary widget.
2031     *
2032     * @param obj The object to query.
2033     * @return The top level Elementary widget, or @c NULL if parent cannot be
2034     * found.
2035     * @ingroup WidgetNavigation
2036     */
2037    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2038
2039    /**
2040     * Get the string that represents this Elementary widget.
2041     *
2042     * @note Elementary is weird and exposes itself as a single
2043     *       Evas_Object_Smart_Class of type "elm_widget", so
2044     *       evas_object_type_get() always return that, making debug and
2045     *       language bindings hard. This function tries to mitigate this
2046     *       problem, but the solution is to change Elementary to use
2047     *       proper inheritance.
2048     *
2049     * @param obj the object to query.
2050     * @return Elementary widget name, or @c NULL if not a valid widget.
2051     * @ingroup WidgetNavigation
2052     */
2053    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2054
2055    /**
2056     * @defgroup Config Elementary Config
2057     *
2058     * Elementary configuration is formed by a set options bounded to a
2059     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
2060     * "finger size", etc. These are functions with which one syncronizes
2061     * changes made to those values to the configuration storing files, de
2062     * facto. You most probably don't want to use the functions in this
2063     * group unlees you're writing an elementary configuration manager.
2064     *
2065     * @{
2066     */
2067
2068    /**
2069     * Save back Elementary's configuration, so that it will persist on
2070     * future sessions.
2071     *
2072     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2073     * @ingroup Config
2074     *
2075     * This function will take effect -- thus, do I/O -- immediately. Use
2076     * it when you want to apply all configuration changes at once. The
2077     * current configuration set will get saved onto the current profile
2078     * configuration file.
2079     *
2080     */
2081    EAPI Eina_Bool    elm_config_save(void);
2082
2083    /**
2084     * Reload Elementary's configuration, bounded to current selected
2085     * profile.
2086     *
2087     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2088     * @ingroup Config
2089     *
2090     * Useful when you want to force reloading of configuration values for
2091     * a profile. If one removes user custom configuration directories,
2092     * for example, it will force a reload with system values instead.
2093     *
2094     */
2095    EAPI void         elm_config_reload(void);
2096
2097    /**
2098     * @}
2099     */
2100
2101    /**
2102     * @defgroup Profile Elementary Profile
2103     *
2104     * Profiles are pre-set options that affect the whole look-and-feel of
2105     * Elementary-based applications. There are, for example, profiles
2106     * aimed at desktop computer applications and others aimed at mobile,
2107     * touchscreen-based ones. You most probably don't want to use the
2108     * functions in this group unlees you're writing an elementary
2109     * configuration manager.
2110     *
2111     * @{
2112     */
2113
2114    /**
2115     * Get Elementary's profile in use.
2116     *
2117     * This gets the global profile that is applied to all Elementary
2118     * applications.
2119     *
2120     * @return The profile's name
2121     * @ingroup Profile
2122     */
2123    EAPI const char  *elm_profile_current_get(void);
2124
2125    /**
2126     * Get an Elementary's profile directory path in the filesystem. One
2127     * may want to fetch a system profile's dir or an user one (fetched
2128     * inside $HOME).
2129     *
2130     * @param profile The profile's name
2131     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2132     *                or a system one (@c EINA_FALSE)
2133     * @return The profile's directory path.
2134     * @ingroup Profile
2135     *
2136     * @note You must free it with elm_profile_dir_free().
2137     */
2138    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2139
2140    /**
2141     * Free an Elementary's profile directory path, as returned by
2142     * elm_profile_dir_get().
2143     *
2144     * @param p_dir The profile's path
2145     * @ingroup Profile
2146     *
2147     */
2148    EAPI void         elm_profile_dir_free(const char *p_dir);
2149
2150    /**
2151     * Get Elementary's list of available profiles.
2152     *
2153     * @return The profiles list. List node data are the profile name
2154     *         strings.
2155     * @ingroup Profile
2156     *
2157     * @note One must free this list, after usage, with the function
2158     *       elm_profile_list_free().
2159     */
2160    EAPI Eina_List   *elm_profile_list_get(void);
2161
2162    /**
2163     * Free Elementary's list of available profiles.
2164     *
2165     * @param l The profiles list, as returned by elm_profile_list_get().
2166     * @ingroup Profile
2167     *
2168     */
2169    EAPI void         elm_profile_list_free(Eina_List *l);
2170
2171    /**
2172     * Set Elementary's profile.
2173     *
2174     * This sets the global profile that is applied to Elementary
2175     * applications. Just the process the call comes from will be
2176     * affected.
2177     *
2178     * @param profile The profile's name
2179     * @ingroup Profile
2180     *
2181     */
2182    EAPI void         elm_profile_set(const char *profile);
2183
2184    /**
2185     * Set Elementary's profile.
2186     *
2187     * This sets the global profile that is applied to all Elementary
2188     * applications. All running Elementary windows will be affected.
2189     *
2190     * @param profile The profile's name
2191     * @ingroup Profile
2192     *
2193     */
2194    EAPI void         elm_profile_all_set(const char *profile);
2195
2196    /**
2197     * @}
2198     */
2199
2200    /**
2201     * @defgroup Engine Elementary Engine
2202     *
2203     * These are functions setting and querying which rendering engine
2204     * Elementary will use for drawing its windows' pixels.
2205     *
2206     * The following are the available engines:
2207     * @li "software_x11"
2208     * @li "fb"
2209     * @li "directfb"
2210     * @li "software_16_x11"
2211     * @li "software_8_x11"
2212     * @li "xrender_x11"
2213     * @li "opengl_x11"
2214     * @li "software_gdi"
2215     * @li "software_16_wince_gdi"
2216     * @li "sdl"
2217     * @li "software_16_sdl"
2218     * @li "opengl_sdl"
2219     * @li "buffer"
2220     * @li "ews"
2221     * @li "opengl_cocoa"
2222     * @li "psl1ght"
2223     *
2224     * @{
2225     */
2226
2227    /**
2228     * @brief Get Elementary's rendering engine in use.
2229     *
2230     * @return The rendering engine's name
2231     * @note there's no need to free the returned string, here.
2232     *
2233     * This gets the global rendering engine that is applied to all Elementary
2234     * applications.
2235     *
2236     * @see elm_engine_set()
2237     */
2238    EAPI const char  *elm_engine_current_get(void);
2239
2240    /**
2241     * @brief Set Elementary's rendering engine for use.
2242     *
2243     * @param engine The rendering engine's name
2244     *
2245     * This sets global rendering engine that is applied to all Elementary
2246     * applications. Note that it will take effect only to Elementary windows
2247     * created after this is called.
2248     *
2249     * @see elm_win_add()
2250     */
2251    EAPI void         elm_engine_set(const char *engine);
2252
2253    /**
2254     * @}
2255     */
2256
2257    /**
2258     * @defgroup Fonts Elementary Fonts
2259     *
2260     * These are functions dealing with font rendering, selection and the
2261     * like for Elementary applications. One might fetch which system
2262     * fonts are there to use and set custom fonts for individual classes
2263     * of UI items containing text (text classes).
2264     *
2265     * @{
2266     */
2267
2268   typedef struct _Elm_Text_Class
2269     {
2270        const char *name;
2271        const char *desc;
2272     } Elm_Text_Class;
2273
2274   typedef struct _Elm_Font_Overlay
2275     {
2276        const char     *text_class;
2277        const char     *font;
2278        Evas_Font_Size  size;
2279     } Elm_Font_Overlay;
2280
2281   typedef struct _Elm_Font_Properties
2282     {
2283        const char *name;
2284        Eina_List  *styles;
2285     } Elm_Font_Properties;
2286
2287    /**
2288     * Get Elementary's list of supported text classes.
2289     *
2290     * @return The text classes list, with @c Elm_Text_Class blobs as data.
2291     * @ingroup Fonts
2292     *
2293     * Release the list with elm_text_classes_list_free().
2294     */
2295    EAPI const Eina_List     *elm_text_classes_list_get(void);
2296
2297    /**
2298     * Free Elementary's list of supported text classes.
2299     *
2300     * @ingroup Fonts
2301     *
2302     * @see elm_text_classes_list_get().
2303     */
2304    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
2305
2306    /**
2307     * Get Elementary's list of font overlays, set with
2308     * elm_font_overlay_set().
2309     *
2310     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2311     * data.
2312     *
2313     * @ingroup Fonts
2314     *
2315     * For each text class, one can set a <b>font overlay</b> for it,
2316     * overriding the default font properties for that class coming from
2317     * the theme in use. There is no need to free this list.
2318     *
2319     * @see elm_font_overlay_set() and elm_font_overlay_unset().
2320     */
2321    EAPI const Eina_List     *elm_font_overlay_list_get(void);
2322
2323    /**
2324     * Set a font overlay for a given Elementary text class.
2325     *
2326     * @param text_class Text class name
2327     * @param font Font name and style string
2328     * @param size Font size
2329     *
2330     * @ingroup Fonts
2331     *
2332     * @p font has to be in the format returned by
2333     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2334     * and elm_font_overlay_unset().
2335     */
2336    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2337
2338    /**
2339     * Unset a font overlay for a given Elementary text class.
2340     *
2341     * @param text_class Text class name
2342     *
2343     * @ingroup Fonts
2344     *
2345     * This will bring back text elements belonging to text class
2346     * @p text_class back to their default font settings.
2347     */
2348    EAPI void                 elm_font_overlay_unset(const char *text_class);
2349
2350    /**
2351     * Apply the changes made with elm_font_overlay_set() and
2352     * elm_font_overlay_unset() on the current Elementary window.
2353     *
2354     * @ingroup Fonts
2355     *
2356     * This applies all font overlays set to all objects in the UI.
2357     */
2358    EAPI void                 elm_font_overlay_apply(void);
2359
2360    /**
2361     * Apply the changes made with elm_font_overlay_set() and
2362     * elm_font_overlay_unset() on all Elementary application windows.
2363     *
2364     * @ingroup Fonts
2365     *
2366     * This applies all font overlays set to all objects in the UI.
2367     */
2368    EAPI void                 elm_font_overlay_all_apply(void);
2369
2370    /**
2371     * Translate a font (family) name string in fontconfig's font names
2372     * syntax into an @c Elm_Font_Properties struct.
2373     *
2374     * @param font The font name and styles string
2375     * @return the font properties struct
2376     *
2377     * @ingroup Fonts
2378     *
2379     * @note The reverse translation can be achived with
2380     * elm_font_fontconfig_name_get(), for one style only (single font
2381     * instance, not family).
2382     */
2383    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2384
2385    /**
2386     * Free font properties return by elm_font_properties_get().
2387     *
2388     * @param efp the font properties struct
2389     *
2390     * @ingroup Fonts
2391     */
2392    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2393
2394    /**
2395     * Translate a font name, bound to a style, into fontconfig's font names
2396     * syntax.
2397     *
2398     * @param name The font (family) name
2399     * @param style The given style (may be @c NULL)
2400     *
2401     * @return the font name and style string
2402     *
2403     * @ingroup Fonts
2404     *
2405     * @note The reverse translation can be achived with
2406     * elm_font_properties_get(), for one style only (single font
2407     * instance, not family).
2408     */
2409    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2410
2411    /**
2412     * Free the font string return by elm_font_fontconfig_name_get().
2413     *
2414     * @param efp the font properties struct
2415     *
2416     * @ingroup Fonts
2417     */
2418    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2419
2420    /**
2421     * Create a font hash table of available system fonts.
2422     *
2423     * One must call it with @p list being the return value of
2424     * evas_font_available_list(). The hash will be indexed by font
2425     * (family) names, being its values @c Elm_Font_Properties blobs.
2426     *
2427     * @param list The list of available system fonts, as returned by
2428     * evas_font_available_list().
2429     * @return the font hash.
2430     *
2431     * @ingroup Fonts
2432     *
2433     * @note The user is supposed to get it populated at least with 3
2434     * default font families (Sans, Serif, Monospace), which should be
2435     * present on most systems.
2436     */
2437    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2438
2439    /**
2440     * Free the hash return by elm_font_available_hash_add().
2441     *
2442     * @param hash the hash to be freed.
2443     *
2444     * @ingroup Fonts
2445     */
2446    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2447
2448    /**
2449     * @}
2450     */
2451
2452    /**
2453     * @defgroup Fingers Fingers
2454     *
2455     * Elementary is designed to be finger-friendly for touchscreens,
2456     * and so in addition to scaling for display resolution, it can
2457     * also scale based on finger "resolution" (or size). You can then
2458     * customize the granularity of the areas meant to receive clicks
2459     * on touchscreens.
2460     *
2461     * Different profiles may have pre-set values for finger sizes.
2462     *
2463     * @ref general_functions_example_page "This" example contemplates
2464     * some of these functions.
2465     *
2466     * @{
2467     */
2468
2469    /**
2470     * Get the configured "finger size"
2471     *
2472     * @return The finger size
2473     *
2474     * This gets the globally configured finger size, <b>in pixels</b>
2475     *
2476     * @ingroup Fingers
2477     */
2478    EAPI Evas_Coord       elm_finger_size_get(void);
2479
2480    /**
2481     * Set the configured finger size
2482     *
2483     * This sets the globally configured finger size in pixels
2484     *
2485     * @param size The finger size
2486     * @ingroup Fingers
2487     */
2488    EAPI void             elm_finger_size_set(Evas_Coord size);
2489
2490    /**
2491     * Set the configured finger size for all applications on the display
2492     *
2493     * This sets the globally configured finger size in pixels for all
2494     * applications on the display
2495     *
2496     * @param size The finger size
2497     * @ingroup Fingers
2498     */
2499    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2500
2501    /**
2502     * @}
2503     */
2504
2505    /**
2506     * @defgroup Focus Focus
2507     *
2508     * An Elementary application has, at all times, one (and only one)
2509     * @b focused object. This is what determines where the input
2510     * events go to within the application's window. Also, focused
2511     * objects can be decorated differently, in order to signal to the
2512     * user where the input is, at a given moment.
2513     *
2514     * Elementary applications also have the concept of <b>focus
2515     * chain</b>: one can cycle through all the windows' focusable
2516     * objects by input (tab key) or programmatically. The default
2517     * focus chain for an application is the one define by the order in
2518     * which the widgets where added in code. One will cycle through
2519     * top level widgets, and, for each one containg sub-objects, cycle
2520     * through them all, before returning to the level
2521     * above. Elementary also allows one to set @b custom focus chains
2522     * for their applications.
2523     *
2524     * Besides the focused decoration a widget may exhibit, when it
2525     * gets focus, Elementary has a @b global focus highlight object
2526     * that can be enabled for a window. If one chooses to do so, this
2527     * extra highlight effect will surround the current focused object,
2528     * too.
2529     *
2530     * @note Some Elementary widgets are @b unfocusable, after
2531     * creation, by their very nature: they are not meant to be
2532     * interacted with input events, but are there just for visual
2533     * purposes.
2534     *
2535     * @ref general_functions_example_page "This" example contemplates
2536     * some of these functions.
2537     */
2538
2539    /**
2540     * Get the enable status of the focus highlight
2541     *
2542     * This gets whether the highlight on focused objects is enabled or not
2543     * @ingroup Focus
2544     */
2545    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2546
2547    /**
2548     * Set the enable status of the focus highlight
2549     *
2550     * Set whether to show or not the highlight on focused objects
2551     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2552     * @ingroup Focus
2553     */
2554    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2555
2556    /**
2557     * Get the enable status of the highlight animation
2558     *
2559     * Get whether the focus highlight, if enabled, will animate its switch from
2560     * one object to the next
2561     * @ingroup Focus
2562     */
2563    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2564
2565    /**
2566     * Set the enable status of the highlight animation
2567     *
2568     * Set whether the focus highlight, if enabled, will animate its switch from
2569     * one object to the next
2570     * @param animate Enable animation if EINA_TRUE, disable otherwise
2571     * @ingroup Focus
2572     */
2573    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2574
2575    /**
2576     * Get the whether an Elementary object has the focus or not.
2577     *
2578     * @param obj The Elementary object to get the information from
2579     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2580     *            not (and on errors).
2581     *
2582     * @see elm_object_focus_set()
2583     *
2584     * @ingroup Focus
2585     */
2586    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2587
2588    /**
2589     * Set/unset focus to a given Elementary object.
2590     *
2591     * @param obj The Elementary object to operate on.
2592     * @param enable @c EINA_TRUE Set focus to a given object,
2593     *               @c EINA_FALSE Unset focus to a given object.
2594     *
2595     * @note When you set focus to this object, if it can handle focus, will
2596     * take the focus away from the one who had it previously and will, for
2597     * now on, be the one receiving input events. Unsetting focus will remove
2598     * the focus from @p obj, passing it back to the previous element in the
2599     * focus chain list.
2600     *
2601     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2602     *
2603     * @ingroup Focus
2604     */
2605    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2606
2607    /**
2608     * Make a given Elementary object the focused one.
2609     *
2610     * @param obj The Elementary object to make focused.
2611     *
2612     * @note This object, if it can handle focus, will take the focus
2613     * away from the one who had it previously and will, for now on, be
2614     * the one receiving input events.
2615     *
2616     * @see elm_object_focus_get()
2617     * @deprecated use elm_object_focus_set() instead.
2618     *
2619     * @ingroup Focus
2620     */
2621    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2622
2623    /**
2624     * Remove the focus from an Elementary object
2625     *
2626     * @param obj The Elementary to take focus from
2627     *
2628     * This removes the focus from @p obj, passing it back to the
2629     * previous element in the focus chain list.
2630     *
2631     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2632     * @deprecated use elm_object_focus_set() instead.
2633     *
2634     * @ingroup Focus
2635     */
2636    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2637
2638    /**
2639     * Set the ability for an Element object to be focused
2640     *
2641     * @param obj The Elementary object to operate on
2642     * @param enable @c EINA_TRUE if the object can be focused, @c
2643     *        EINA_FALSE if not (and on errors)
2644     *
2645     * This sets whether the object @p obj is able to take focus or
2646     * not. Unfocusable objects do nothing when programmatically
2647     * focused, being the nearest focusable parent object the one
2648     * really getting focus. Also, when they receive mouse input, they
2649     * will get the event, but not take away the focus from where it
2650     * was previously.
2651     *
2652     * @ingroup Focus
2653     */
2654    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2655
2656    /**
2657     * Get whether an Elementary object is focusable or not
2658     *
2659     * @param obj The Elementary object to operate on
2660     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2661     *             EINA_FALSE if not (and on errors)
2662     *
2663     * @note Objects which are meant to be interacted with by input
2664     * events are created able to be focused, by default. All the
2665     * others are not.
2666     *
2667     * @ingroup Focus
2668     */
2669    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2670
2671    /**
2672     * Set custom focus chain.
2673     *
2674     * This function overwrites any previous custom focus chain within
2675     * the list of objects. The previous list will be deleted and this list
2676     * will be managed by elementary. After it is set, don't modify it.
2677     *
2678     * @note On focus cycle, only will be evaluated children of this container.
2679     *
2680     * @param obj The container object
2681     * @param objs Chain of objects to pass focus
2682     * @ingroup Focus
2683     */
2684    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2685
2686    /**
2687     * Unset a custom focus chain on a given Elementary widget
2688     *
2689     * @param obj The container object to remove focus chain from
2690     *
2691     * Any focus chain previously set on @p obj (for its child objects)
2692     * is removed entirely after this call.
2693     *
2694     * @ingroup Focus
2695     */
2696    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2697
2698    /**
2699     * Get custom focus chain
2700     *
2701     * @param obj The container object
2702     * @ingroup Focus
2703     */
2704    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2705
2706    /**
2707     * Append object to custom focus chain.
2708     *
2709     * @note If relative_child equal to NULL or not in custom chain, the object
2710     * will be added in end.
2711     *
2712     * @note On focus cycle, only will be evaluated children of this container.
2713     *
2714     * @param obj The container object
2715     * @param child The child to be added in custom chain
2716     * @param relative_child The relative object to position the child
2717     * @ingroup Focus
2718     */
2719    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2720
2721    /**
2722     * Prepend object to custom focus chain.
2723     *
2724     * @note If relative_child equal to NULL or not in custom chain, the object
2725     * will be added in begin.
2726     *
2727     * @note On focus cycle, only will be evaluated children of this container.
2728     *
2729     * @param obj The container object
2730     * @param child The child to be added in custom chain
2731     * @param relative_child The relative object to position the child
2732     * @ingroup Focus
2733     */
2734    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2735
2736    /**
2737     * Give focus to next object in object tree.
2738     *
2739     * Give focus to next object in focus chain of one object sub-tree.
2740     * If the last object of chain already have focus, the focus will go to the
2741     * first object of chain.
2742     *
2743     * @param obj The object root of sub-tree
2744     * @param dir Direction to cycle the focus
2745     *
2746     * @ingroup Focus
2747     */
2748    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2749
2750    /**
2751     * Give focus to near object in one direction.
2752     *
2753     * Give focus to near object in direction of one object.
2754     * If none focusable object in given direction, the focus will not change.
2755     *
2756     * @param obj The reference object
2757     * @param x Horizontal component of direction to focus
2758     * @param y Vertical component of direction to focus
2759     *
2760     * @ingroup Focus
2761     */
2762    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2763
2764    /**
2765     * Make the elementary object and its children to be unfocusable
2766     * (or focusable).
2767     *
2768     * @param obj The Elementary object to operate on
2769     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2770     *        @c EINA_FALSE for focusable.
2771     *
2772     * This sets whether the object @p obj and its children objects
2773     * are able to take focus or not. If the tree is set as unfocusable,
2774     * newest focused object which is not in this tree will get focus.
2775     * This API can be helpful for an object to be deleted.
2776     * When an object will be deleted soon, it and its children may not
2777     * want to get focus (by focus reverting or by other focus controls).
2778     * Then, just use this API before deleting.
2779     *
2780     * @see elm_object_tree_unfocusable_get()
2781     *
2782     * @ingroup Focus
2783     */
2784    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2785
2786    /**
2787     * Get whether an Elementary object and its children are unfocusable or not.
2788     *
2789     * @param obj The Elementary object to get the information from
2790     * @return @c EINA_TRUE, if the tree is unfocussable,
2791     *         @c EINA_FALSE if not (and on errors).
2792     *
2793     * @see elm_object_tree_unfocusable_set()
2794     *
2795     * @ingroup Focus
2796     */
2797    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2798
2799    /**
2800     * @defgroup Scrolling Scrolling
2801     *
2802     * These are functions setting how scrollable views in Elementary
2803     * widgets should behave on user interaction.
2804     *
2805     * @{
2806     */
2807
2808    /**
2809     * Get whether scrollers should bounce when they reach their
2810     * viewport's edge during a scroll.
2811     *
2812     * @return the thumb scroll bouncing state
2813     *
2814     * This is the default behavior for touch screens, in general.
2815     * @ingroup Scrolling
2816     */
2817    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2818
2819    /**
2820     * Set whether scrollers should bounce when they reach their
2821     * viewport's edge during a scroll.
2822     *
2823     * @param enabled the thumb scroll bouncing state
2824     *
2825     * @see elm_thumbscroll_bounce_enabled_get()
2826     * @ingroup Scrolling
2827     */
2828    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2829
2830    /**
2831     * Set whether scrollers should bounce when they reach their
2832     * viewport's edge during a scroll, for all Elementary application
2833     * windows.
2834     *
2835     * @param enabled the thumb scroll bouncing state
2836     *
2837     * @see elm_thumbscroll_bounce_enabled_get()
2838     * @ingroup Scrolling
2839     */
2840    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2841
2842    /**
2843     * Get the amount of inertia a scroller will impose at bounce
2844     * animations.
2845     *
2846     * @return the thumb scroll bounce friction
2847     *
2848     * @ingroup Scrolling
2849     */
2850    EAPI double           elm_scroll_bounce_friction_get(void);
2851
2852    /**
2853     * Set the amount of inertia a scroller will impose at bounce
2854     * animations.
2855     *
2856     * @param friction the thumb scroll bounce friction
2857     *
2858     * @see elm_thumbscroll_bounce_friction_get()
2859     * @ingroup Scrolling
2860     */
2861    EAPI void             elm_scroll_bounce_friction_set(double friction);
2862
2863    /**
2864     * Set the amount of inertia a scroller will impose at bounce
2865     * animations, for all Elementary application windows.
2866     *
2867     * @param friction the thumb scroll bounce friction
2868     *
2869     * @see elm_thumbscroll_bounce_friction_get()
2870     * @ingroup Scrolling
2871     */
2872    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2873
2874    /**
2875     * Get the amount of inertia a <b>paged</b> scroller will impose at
2876     * page fitting animations.
2877     *
2878     * @return the page scroll friction
2879     *
2880     * @ingroup Scrolling
2881     */
2882    EAPI double           elm_scroll_page_scroll_friction_get(void);
2883
2884    /**
2885     * Set the amount of inertia a <b>paged</b> scroller will impose at
2886     * page fitting animations.
2887     *
2888     * @param friction the page scroll friction
2889     *
2890     * @see elm_thumbscroll_page_scroll_friction_get()
2891     * @ingroup Scrolling
2892     */
2893    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2894
2895    /**
2896     * Set the amount of inertia a <b>paged</b> scroller will impose at
2897     * page fitting animations, for all Elementary application windows.
2898     *
2899     * @param friction the page scroll friction
2900     *
2901     * @see elm_thumbscroll_page_scroll_friction_get()
2902     * @ingroup Scrolling
2903     */
2904    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2905
2906    /**
2907     * Get the amount of inertia a scroller will impose at region bring
2908     * animations.
2909     *
2910     * @return the bring in scroll friction
2911     *
2912     * @ingroup Scrolling
2913     */
2914    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2915
2916    /**
2917     * Set the amount of inertia a scroller will impose at region bring
2918     * animations.
2919     *
2920     * @param friction the bring in scroll friction
2921     *
2922     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2923     * @ingroup Scrolling
2924     */
2925    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2926
2927    /**
2928     * Set the amount of inertia a scroller will impose at region bring
2929     * animations, for all Elementary application windows.
2930     *
2931     * @param friction the bring in scroll friction
2932     *
2933     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2934     * @ingroup Scrolling
2935     */
2936    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2937
2938    /**
2939     * Get the amount of inertia scrollers will impose at animations
2940     * triggered by Elementary widgets' zooming API.
2941     *
2942     * @return the zoom friction
2943     *
2944     * @ingroup Scrolling
2945     */
2946    EAPI double           elm_scroll_zoom_friction_get(void);
2947
2948    /**
2949     * Set the amount of inertia scrollers will impose at animations
2950     * triggered by Elementary widgets' zooming API.
2951     *
2952     * @param friction the zoom friction
2953     *
2954     * @see elm_thumbscroll_zoom_friction_get()
2955     * @ingroup Scrolling
2956     */
2957    EAPI void             elm_scroll_zoom_friction_set(double friction);
2958
2959    /**
2960     * Set the amount of inertia scrollers will impose at animations
2961     * triggered by Elementary widgets' zooming API, for all Elementary
2962     * application windows.
2963     *
2964     * @param friction the zoom friction
2965     *
2966     * @see elm_thumbscroll_zoom_friction_get()
2967     * @ingroup Scrolling
2968     */
2969    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2970
2971    /**
2972     * Get whether scrollers should be draggable from any point in their
2973     * views.
2974     *
2975     * @return the thumb scroll state
2976     *
2977     * @note This is the default behavior for touch screens, in general.
2978     * @note All other functions namespaced with "thumbscroll" will only
2979     *       have effect if this mode is enabled.
2980     *
2981     * @ingroup Scrolling
2982     */
2983    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2984
2985    /**
2986     * Set whether scrollers should be draggable from any point in their
2987     * views.
2988     *
2989     * @param enabled the thumb scroll state
2990     *
2991     * @see elm_thumbscroll_enabled_get()
2992     * @ingroup Scrolling
2993     */
2994    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2995
2996    /**
2997     * Set whether scrollers should be draggable from any point in their
2998     * views, for all Elementary application windows.
2999     *
3000     * @param enabled the thumb scroll state
3001     *
3002     * @see elm_thumbscroll_enabled_get()
3003     * @ingroup Scrolling
3004     */
3005    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
3006
3007    /**
3008     * Get the number of pixels one should travel while dragging a
3009     * scroller's view to actually trigger scrolling.
3010     *
3011     * @return the thumb scroll threshould
3012     *
3013     * One would use higher values for touch screens, in general, because
3014     * of their inherent imprecision.
3015     * @ingroup Scrolling
3016     */
3017    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
3018
3019    /**
3020     * Set the number of pixels one should travel while dragging a
3021     * scroller's view to actually trigger scrolling.
3022     *
3023     * @param threshold the thumb scroll threshould
3024     *
3025     * @see elm_thumbscroll_threshould_get()
3026     * @ingroup Scrolling
3027     */
3028    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
3029
3030    /**
3031     * Set the number of pixels one should travel while dragging a
3032     * scroller's view to actually trigger scrolling, for all Elementary
3033     * application windows.
3034     *
3035     * @param threshold the thumb scroll threshould
3036     *
3037     * @see elm_thumbscroll_threshould_get()
3038     * @ingroup Scrolling
3039     */
3040    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
3041
3042    /**
3043     * Get the minimum speed of mouse cursor movement which will trigger
3044     * list self scrolling animation after a mouse up event
3045     * (pixels/second).
3046     *
3047     * @return the thumb scroll momentum threshould
3048     *
3049     * @ingroup Scrolling
3050     */
3051    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
3052
3053    /**
3054     * Set the minimum speed of mouse cursor movement which will trigger
3055     * list self scrolling animation after a mouse up event
3056     * (pixels/second).
3057     *
3058     * @param threshold the thumb scroll momentum threshould
3059     *
3060     * @see elm_thumbscroll_momentum_threshould_get()
3061     * @ingroup Scrolling
3062     */
3063    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
3064
3065    /**
3066     * Set the minimum speed of mouse cursor movement which will trigger
3067     * list self scrolling animation after a mouse up event
3068     * (pixels/second), for all Elementary application windows.
3069     *
3070     * @param threshold the thumb scroll momentum threshould
3071     *
3072     * @see elm_thumbscroll_momentum_threshould_get()
3073     * @ingroup Scrolling
3074     */
3075    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
3076
3077    /**
3078     * Get the amount of inertia a scroller will impose at self scrolling
3079     * animations.
3080     *
3081     * @return the thumb scroll friction
3082     *
3083     * @ingroup Scrolling
3084     */
3085    EAPI double           elm_scroll_thumbscroll_friction_get(void);
3086
3087    /**
3088     * Set the amount of inertia a scroller will impose at self scrolling
3089     * animations.
3090     *
3091     * @param friction the thumb scroll friction
3092     *
3093     * @see elm_thumbscroll_friction_get()
3094     * @ingroup Scrolling
3095     */
3096    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
3097
3098    /**
3099     * Set the amount of inertia a scroller will impose at self scrolling
3100     * animations, for all Elementary application windows.
3101     *
3102     * @param friction the thumb scroll friction
3103     *
3104     * @see elm_thumbscroll_friction_get()
3105     * @ingroup Scrolling
3106     */
3107    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
3108
3109    /**
3110     * Get the amount of lag between your actual mouse cursor dragging
3111     * movement and a scroller's view movement itself, while pushing it
3112     * into bounce state manually.
3113     *
3114     * @return the thumb scroll border friction
3115     *
3116     * @ingroup Scrolling
3117     */
3118    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
3119
3120    /**
3121     * Set the amount of lag between your actual mouse cursor dragging
3122     * movement and a scroller's view movement itself, while pushing it
3123     * into bounce state manually.
3124     *
3125     * @param friction the thumb scroll border friction. @c 0.0 for
3126     *        perfect synchrony between two movements, @c 1.0 for maximum
3127     *        lag.
3128     *
3129     * @see elm_thumbscroll_border_friction_get()
3130     * @note parameter value will get bound to 0.0 - 1.0 interval, always
3131     *
3132     * @ingroup Scrolling
3133     */
3134    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
3135
3136    /**
3137     * Set the amount of lag between your actual mouse cursor dragging
3138     * movement and a scroller's view movement itself, while pushing it
3139     * into bounce state manually, for all Elementary application windows.
3140     *
3141     * @param friction the thumb scroll border friction. @c 0.0 for
3142     *        perfect synchrony between two movements, @c 1.0 for maximum
3143     *        lag.
3144     *
3145     * @see elm_thumbscroll_border_friction_get()
3146     * @note parameter value will get bound to 0.0 - 1.0 interval, always
3147     *
3148     * @ingroup Scrolling
3149     */
3150    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
3151
3152    /**
3153     * Get the sensitivity amount which is be multiplied by the length of
3154     * mouse dragging.
3155     *
3156     * @return the thumb scroll sensitivity friction
3157     *
3158     * @ingroup Scrolling
3159     */
3160    EAPI double           elm_scroll_thumbscroll_sensitivity_friction_get(void);
3161
3162    /**
3163     * Set the sensitivity amount which is be multiplied by the length of
3164     * mouse dragging.
3165     *
3166     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3167     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3168     *        is proper.
3169     *
3170     * @see elm_thumbscroll_sensitivity_friction_get()
3171     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3172     *
3173     * @ingroup Scrolling
3174     */
3175    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3176
3177    /**
3178     * Set the sensitivity amount which is be multiplied by the length of
3179     * mouse dragging, for all Elementary application windows.
3180     *
3181     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3182     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3183     *        is proper.
3184     *
3185     * @see elm_thumbscroll_sensitivity_friction_get()
3186     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3187     *
3188     * @ingroup Scrolling
3189     */
3190    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3191
3192    /**
3193     * @}
3194     */
3195
3196    /**
3197     * @defgroup Scrollhints Scrollhints
3198     *
3199     * Objects when inside a scroller can scroll, but this may not always be
3200     * desirable in certain situations. This allows an object to hint to itself
3201     * and parents to "not scroll" in one of 2 ways. If any child object of a
3202     * scroller has pushed a scroll freeze or hold then it affects all parent
3203     * scrollers until all children have released them.
3204     *
3205     * 1. To hold on scrolling. This means just flicking and dragging may no
3206     * longer scroll, but pressing/dragging near an edge of the scroller will
3207     * still scroll. This is automatically used by the entry object when
3208     * selecting text.
3209     *
3210     * 2. To totally freeze scrolling. This means it stops. until
3211     * popped/released.
3212     *
3213     * @{
3214     */
3215
3216    /**
3217     * Push the scroll hold by 1
3218     *
3219     * This increments the scroll hold count by one. If it is more than 0 it will
3220     * take effect on the parents of the indicated object.
3221     *
3222     * @param obj The object
3223     * @ingroup Scrollhints
3224     */
3225    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3226
3227    /**
3228     * Pop the scroll hold by 1
3229     *
3230     * This decrements the scroll hold count by one. If it is more than 0 it will
3231     * take effect on the parents of the indicated object.
3232     *
3233     * @param obj The object
3234     * @ingroup Scrollhints
3235     */
3236    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3237
3238    /**
3239     * Push the scroll freeze by 1
3240     *
3241     * This increments the scroll freeze count by one. If it is more
3242     * than 0 it will take effect on the parents of the indicated
3243     * object.
3244     *
3245     * @param obj The object
3246     * @ingroup Scrollhints
3247     */
3248    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3249
3250    /**
3251     * Pop the scroll freeze by 1
3252     *
3253     * This decrements the scroll freeze count by one. If it is more
3254     * than 0 it will take effect on the parents of the indicated
3255     * object.
3256     *
3257     * @param obj The object
3258     * @ingroup Scrollhints
3259     */
3260    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3261
3262    /**
3263     * Lock the scrolling of the given widget (and thus all parents)
3264     *
3265     * This locks the given object from scrolling in the X axis (and implicitly
3266     * also locks all parent scrollers too from doing the same).
3267     *
3268     * @param obj The object
3269     * @param lock The lock state (1 == locked, 0 == unlocked)
3270     * @ingroup Scrollhints
3271     */
3272    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3273
3274    /**
3275     * Lock the scrolling of the given widget (and thus all parents)
3276     *
3277     * This locks the given object from scrolling in the Y axis (and implicitly
3278     * also locks all parent scrollers too from doing the same).
3279     *
3280     * @param obj The object
3281     * @param lock The lock state (1 == locked, 0 == unlocked)
3282     * @ingroup Scrollhints
3283     */
3284    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3285
3286    /**
3287     * Get the scrolling lock of the given widget
3288     *
3289     * This gets the lock for X axis scrolling.
3290     *
3291     * @param obj The object
3292     * @ingroup Scrollhints
3293     */
3294    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3295
3296    /**
3297     * Get the scrolling lock of the given widget
3298     *
3299     * This gets the lock for X axis scrolling.
3300     *
3301     * @param obj The object
3302     * @ingroup Scrollhints
3303     */
3304    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3305
3306    /**
3307     * @}
3308     */
3309
3310    /**
3311     * Send a signal to the widget edje object.
3312     *
3313     * This function sends a signal to the edje object of the obj. An
3314     * edje program can respond to a signal by specifying matching
3315     * 'signal' and 'source' fields.
3316     *
3317     * @param obj The object
3318     * @param emission The signal's name.
3319     * @param source The signal's source.
3320     * @ingroup General
3321     */
3322    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3323
3324    /**
3325     * Add a callback for a signal emitted by widget edje object.
3326     *
3327     * This function connects a callback function to a signal emitted by the
3328     * edje object of the obj.
3329     * Globs can occur in either the emission or source name.
3330     *
3331     * @param obj The object
3332     * @param emission The signal's name.
3333     * @param source The signal's source.
3334     * @param func The callback function to be executed when the signal is
3335     * emitted.
3336     * @param data A pointer to data to pass in to the callback function.
3337     * @ingroup General
3338     */
3339    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);
3340
3341    /**
3342     * Remove a signal-triggered callback from a widget edje object.
3343     *
3344     * This function removes a callback, previoulsy attached to a
3345     * signal emitted by the edje object of the obj.  The parameters
3346     * emission, source and func must match exactly those passed to a
3347     * previous call to elm_object_signal_callback_add(). The data
3348     * pointer that was passed to this call will be returned.
3349     *
3350     * @param obj The object
3351     * @param emission The signal's name.
3352     * @param source The signal's source.
3353     * @param func The callback function to be executed when the signal is
3354     * emitted.
3355     * @return The data pointer
3356     * @ingroup General
3357     */
3358    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);
3359
3360    /**
3361     * Add a callback for input events (key up, key down, mouse wheel)
3362     * on a given Elementary widget
3363     *
3364     * @param obj The widget to add an event callback on
3365     * @param func The callback function to be executed when the event
3366     * happens
3367     * @param data Data to pass in to @p func
3368     *
3369     * Every widget in an Elementary interface set to receive focus,
3370     * with elm_object_focus_allow_set(), will propagate @b all of its
3371     * key up, key down and mouse wheel input events up to its parent
3372     * object, and so on. All of the focusable ones in this chain which
3373     * had an event callback set, with this call, will be able to treat
3374     * those events. There are two ways of making the propagation of
3375     * these event upwards in the tree of widgets to @b cease:
3376     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3377     *   the event was @b not processed, so the propagation will go on.
3378     * - The @c event_info pointer passed to @p func will contain the
3379     *   event's structure and, if you OR its @c event_flags inner
3380     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3381     *   one has already handled it, thus killing the event's
3382     *   propagation, too.
3383     *
3384     * @note Your event callback will be issued on those events taking
3385     * place only if no other child widget of @obj has consumed the
3386     * event already.
3387     *
3388     * @note Not to be confused with @c
3389     * evas_object_event_callback_add(), which will add event callbacks
3390     * per type on general Evas objects (no event propagation
3391     * infrastructure taken in account).
3392     *
3393     * @note Not to be confused with @c
3394     * elm_object_signal_callback_add(), which will add callbacks to @b
3395     * signals coming from a widget's theme, not input events.
3396     *
3397     * @note Not to be confused with @c
3398     * edje_object_signal_callback_add(), which does the same as
3399     * elm_object_signal_callback_add(), but directly on an Edje
3400     * object.
3401     *
3402     * @note Not to be confused with @c
3403     * evas_object_smart_callback_add(), which adds callbacks to smart
3404     * objects' <b>smart events</b>, and not input events.
3405     *
3406     * @see elm_object_event_callback_del()
3407     *
3408     * @ingroup General
3409     */
3410    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3411
3412    /**
3413     * Remove an event callback from a widget.
3414     *
3415     * This function removes a callback, previoulsy attached to event emission
3416     * by the @p obj.
3417     * The parameters func and data must match exactly those passed to
3418     * a previous call to elm_object_event_callback_add(). The data pointer that
3419     * was passed to this call will be returned.
3420     *
3421     * @param obj The object
3422     * @param func The callback function to be executed when the event is
3423     * emitted.
3424     * @param data Data to pass in to the callback function.
3425     * @return The data pointer
3426     * @ingroup General
3427     */
3428    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3429
3430    /**
3431     * Adjust size of an element for finger usage.
3432     *
3433     * @param times_w How many fingers should fit horizontally
3434     * @param w Pointer to the width size to adjust
3435     * @param times_h How many fingers should fit vertically
3436     * @param h Pointer to the height size to adjust
3437     *
3438     * This takes width and height sizes (in pixels) as input and a
3439     * size multiple (which is how many fingers you want to place
3440     * within the area, being "finger" the size set by
3441     * elm_finger_size_set()), and adjusts the size to be large enough
3442     * to accommodate the resulting size -- if it doesn't already
3443     * accommodate it. On return the @p w and @p h sizes pointed to by
3444     * these parameters will be modified, on those conditions.
3445     *
3446     * @note This is kind of a low level Elementary call, most useful
3447     * on size evaluation times for widgets. An external user wouldn't
3448     * be calling, most of the time.
3449     *
3450     * @ingroup Fingers
3451     */
3452    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3453
3454    /**
3455     * Get the duration for occuring long press event.
3456     *
3457     * @return Timeout for long press event
3458     * @ingroup Longpress
3459     */
3460    EAPI double           elm_longpress_timeout_get(void);
3461
3462    /**
3463     * Set the duration for occuring long press event.
3464     *
3465     * @param lonpress_timeout Timeout for long press event
3466     * @ingroup Longpress
3467     */
3468    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3469
3470    /**
3471     * @defgroup Debug Debug
3472     * don't use it unless you are sure
3473     *
3474     * @{
3475     */
3476
3477    /**
3478     * Print Tree object hierarchy in stdout
3479     *
3480     * @param obj The root object
3481     * @ingroup Debug
3482     */
3483    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3484
3485    /**
3486     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3487     *
3488     * @param obj The root object
3489     * @param file The path of output file
3490     * @ingroup Debug
3491     */
3492    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3493
3494    /**
3495     * @}
3496     */
3497
3498    /**
3499     * @defgroup Theme Theme
3500     *
3501     * Elementary uses Edje to theme its widgets, naturally. But for the most
3502     * part this is hidden behind a simpler interface that lets the user set
3503     * extensions and choose the style of widgets in a much easier way.
3504     *
3505     * Instead of thinking in terms of paths to Edje files and their groups
3506     * each time you want to change the appearance of a widget, Elementary
3507     * works so you can add any theme file with extensions or replace the
3508     * main theme at one point in the application, and then just set the style
3509     * of widgets with elm_object_style_set() and related functions. Elementary
3510     * will then look in its list of themes for a matching group and apply it,
3511     * and when the theme changes midway through the application, all widgets
3512     * will be updated accordingly.
3513     *
3514     * There are three concepts you need to know to understand how Elementary
3515     * theming works: default theme, extensions and overlays.
3516     *
3517     * Default theme, obviously enough, is the one that provides the default
3518     * look of all widgets. End users can change the theme used by Elementary
3519     * by setting the @c ELM_THEME environment variable before running an
3520     * application, or globally for all programs using the @c elementary_config
3521     * utility. Applications can change the default theme using elm_theme_set(),
3522     * but this can go against the user wishes, so it's not an adviced practice.
3523     *
3524     * Ideally, applications should find everything they need in the already
3525     * provided theme, but there may be occasions when that's not enough and
3526     * custom styles are required to correctly express the idea. For this
3527     * cases, Elementary has extensions.
3528     *
3529     * Extensions allow the application developer to write styles of its own
3530     * to apply to some widgets. This requires knowledge of how each widget
3531     * is themed, as extensions will always replace the entire group used by
3532     * the widget, so important signals and parts need to be there for the
3533     * object to behave properly (see documentation of Edje for details).
3534     * Once the theme for the extension is done, the application needs to add
3535     * it to the list of themes Elementary will look into, using
3536     * elm_theme_extension_add(), and set the style of the desired widgets as
3537     * he would normally with elm_object_style_set().
3538     *
3539     * Overlays, on the other hand, can replace the look of all widgets by
3540     * overriding the default style. Like extensions, it's up to the application
3541     * developer to write the theme for the widgets it wants, the difference
3542     * being that when looking for the theme, Elementary will check first the
3543     * list of overlays, then the set theme and lastly the list of extensions,
3544     * so with overlays it's possible to replace the default view and every
3545     * widget will be affected. This is very much alike to setting the whole
3546     * theme for the application and will probably clash with the end user
3547     * options, not to mention the risk of ending up with not matching styles
3548     * across the program. Unless there's a very special reason to use them,
3549     * overlays should be avoided for the resons exposed before.
3550     *
3551     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3552     * keeps one default internally and every function that receives one of
3553     * these can be called with NULL to refer to this default (except for
3554     * elm_theme_free()). It's possible to create a new instance of a
3555     * ::Elm_Theme to set other theme for a specific widget (and all of its
3556     * children), but this is as discouraged, if not even more so, than using
3557     * overlays. Don't use this unless you really know what you are doing.
3558     *
3559     * But to be less negative about things, you can look at the following
3560     * examples:
3561     * @li @ref theme_example_01 "Using extensions"
3562     * @li @ref theme_example_02 "Using overlays"
3563     *
3564     * @{
3565     */
3566    /**
3567     * @typedef Elm_Theme
3568     *
3569     * Opaque handler for the list of themes Elementary looks for when
3570     * rendering widgets.
3571     *
3572     * Stay out of this unless you really know what you are doing. For most
3573     * cases, sticking to the default is all a developer needs.
3574     */
3575    typedef struct _Elm_Theme Elm_Theme;
3576
3577    /**
3578     * Create a new specific theme
3579     *
3580     * This creates an empty specific theme that only uses the default theme. A
3581     * specific theme has its own private set of extensions and overlays too
3582     * (which are empty by default). Specific themes do not fall back to themes
3583     * of parent objects. They are not intended for this use. Use styles, overlays
3584     * and extensions when needed, but avoid specific themes unless there is no
3585     * other way (example: you want to have a preview of a new theme you are
3586     * selecting in a "theme selector" window. The preview is inside a scroller
3587     * and should display what the theme you selected will look like, but not
3588     * actually apply it yet. The child of the scroller will have a specific
3589     * theme set to show this preview before the user decides to apply it to all
3590     * applications).
3591     */
3592    EAPI Elm_Theme       *elm_theme_new(void);
3593    /**
3594     * Free a specific theme
3595     *
3596     * @param th The theme to free
3597     *
3598     * This frees a theme created with elm_theme_new().
3599     */
3600    EAPI void             elm_theme_free(Elm_Theme *th);
3601    /**
3602     * Copy the theme fom the source to the destination theme
3603     *
3604     * @param th The source theme to copy from
3605     * @param thdst The destination theme to copy data to
3606     *
3607     * This makes a one-time static copy of all the theme config, extensions
3608     * and overlays from @p th to @p thdst. If @p th references a theme, then
3609     * @p thdst is also set to reference it, with all the theme settings,
3610     * overlays and extensions that @p th had.
3611     */
3612    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3613    /**
3614     * Tell the source theme to reference the ref theme
3615     *
3616     * @param th The theme that will do the referencing
3617     * @param thref The theme that is the reference source
3618     *
3619     * This clears @p th to be empty and then sets it to refer to @p thref
3620     * so @p th acts as an override to @p thref, but where its overrides
3621     * don't apply, it will fall through to @p thref for configuration.
3622     */
3623    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3624    /**
3625     * Return the theme referred to
3626     *
3627     * @param th The theme to get the reference from
3628     * @return The referenced theme handle
3629     *
3630     * This gets the theme set as the reference theme by elm_theme_ref_set().
3631     * If no theme is set as a reference, NULL is returned.
3632     */
3633    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3634    /**
3635     * Return the default theme
3636     *
3637     * @return The default theme handle
3638     *
3639     * This returns the internal default theme setup handle that all widgets
3640     * use implicitly unless a specific theme is set. This is also often use
3641     * as a shorthand of NULL.
3642     */
3643    EAPI Elm_Theme       *elm_theme_default_get(void);
3644    /**
3645     * Prepends a theme overlay to the list of overlays
3646     *
3647     * @param th The theme to add to, or if NULL, the default theme
3648     * @param item The Edje file path to be used
3649     *
3650     * Use this if your application needs to provide some custom overlay theme
3651     * (An Edje file that replaces some default styles of widgets) where adding
3652     * new styles, or changing system theme configuration is not possible. Do
3653     * NOT use this instead of a proper system theme configuration. Use proper
3654     * configuration files, profiles, environment variables etc. to set a theme
3655     * so that the theme can be altered by simple confiugration by a user. Using
3656     * this call to achieve that effect is abusing the API and will create lots
3657     * of trouble.
3658     *
3659     * @see elm_theme_extension_add()
3660     */
3661    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3662    /**
3663     * Delete a theme overlay from the list of overlays
3664     *
3665     * @param th The theme to delete from, or if NULL, the default theme
3666     * @param item The name of the theme overlay
3667     *
3668     * @see elm_theme_overlay_add()
3669     */
3670    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3671    /**
3672     * Appends a theme extension to the list of extensions.
3673     *
3674     * @param th The theme to add to, or if NULL, the default theme
3675     * @param item The Edje file path to be used
3676     *
3677     * This is intended when an application needs more styles of widgets or new
3678     * widget themes that the default does not provide (or may not provide). The
3679     * application has "extended" usage by coming up with new custom style names
3680     * for widgets for specific uses, but as these are not "standard", they are
3681     * not guaranteed to be provided by a default theme. This means the
3682     * application is required to provide these extra elements itself in specific
3683     * Edje files. This call adds one of those Edje files to the theme search
3684     * path to be search after the default theme. The use of this call is
3685     * encouraged when default styles do not meet the needs of the application.
3686     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3687     *
3688     * @see elm_object_style_set()
3689     */
3690    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3691    /**
3692     * Deletes a theme extension from the list of extensions.
3693     *
3694     * @param th The theme to delete from, or if NULL, the default theme
3695     * @param item The name of the theme extension
3696     *
3697     * @see elm_theme_extension_add()
3698     */
3699    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3700    /**
3701     * Set the theme search order for the given theme
3702     *
3703     * @param th The theme to set the search order, or if NULL, the default theme
3704     * @param theme Theme search string
3705     *
3706     * This sets the search string for the theme in path-notation from first
3707     * theme to search, to last, delimited by the : character. Example:
3708     *
3709     * "shiny:/path/to/file.edj:default"
3710     *
3711     * See the ELM_THEME environment variable for more information.
3712     *
3713     * @see elm_theme_get()
3714     * @see elm_theme_list_get()
3715     */
3716    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3717    /**
3718     * Return the theme search order
3719     *
3720     * @param th The theme to get the search order, or if NULL, the default theme
3721     * @return The internal search order path
3722     *
3723     * This function returns a colon separated string of theme elements as
3724     * returned by elm_theme_list_get().
3725     *
3726     * @see elm_theme_set()
3727     * @see elm_theme_list_get()
3728     */
3729    EAPI const char      *elm_theme_get(Elm_Theme *th);
3730    /**
3731     * Return a list of theme elements to be used in a theme.
3732     *
3733     * @param th Theme to get the list of theme elements from.
3734     * @return The internal list of theme elements
3735     *
3736     * This returns the internal list of theme elements (will only be valid as
3737     * long as the theme is not modified by elm_theme_set() or theme is not
3738     * freed by elm_theme_free(). This is a list of strings which must not be
3739     * altered as they are also internal. If @p th is NULL, then the default
3740     * theme element list is returned.
3741     *
3742     * A theme element can consist of a full or relative path to a .edj file,
3743     * or a name, without extension, for a theme to be searched in the known
3744     * theme paths for Elemementary.
3745     *
3746     * @see elm_theme_set()
3747     * @see elm_theme_get()
3748     */
3749    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3750    /**
3751     * Return the full patrh for a theme element
3752     *
3753     * @param f The theme element name
3754     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3755     * @return The full path to the file found.
3756     *
3757     * This returns a string you should free with free() on success, NULL on
3758     * failure. This will search for the given theme element, and if it is a
3759     * full or relative path element or a simple searchable name. The returned
3760     * path is the full path to the file, if searched, and the file exists, or it
3761     * is simply the full path given in the element or a resolved path if
3762     * relative to home. The @p in_search_path boolean pointed to is set to
3763     * EINA_TRUE if the file was a searchable file andis in the search path,
3764     * and EINA_FALSE otherwise.
3765     */
3766    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3767    /**
3768     * Flush the current theme.
3769     *
3770     * @param th Theme to flush
3771     *
3772     * This flushes caches that let elementary know where to find theme elements
3773     * in the given theme. If @p th is NULL, then the default theme is flushed.
3774     * Call this function if source theme data has changed in such a way as to
3775     * make any caches Elementary kept invalid.
3776     */
3777    EAPI void             elm_theme_flush(Elm_Theme *th);
3778    /**
3779     * This flushes all themes (default and specific ones).
3780     *
3781     * This will flush all themes in the current application context, by calling
3782     * elm_theme_flush() on each of them.
3783     */
3784    EAPI void             elm_theme_full_flush(void);
3785    /**
3786     * Set the theme for all elementary using applications on the current display
3787     *
3788     * @param theme The name of the theme to use. Format same as the ELM_THEME
3789     * environment variable.
3790     */
3791    EAPI void             elm_theme_all_set(const char *theme);
3792    /**
3793     * Return a list of theme elements in the theme search path
3794     *
3795     * @return A list of strings that are the theme element names.
3796     *
3797     * This lists all available theme files in the standard Elementary search path
3798     * for theme elements, and returns them in alphabetical order as theme
3799     * element names in a list of strings. Free this with
3800     * elm_theme_name_available_list_free() when you are done with the list.
3801     */
3802    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3803    /**
3804     * Free the list returned by elm_theme_name_available_list_new()
3805     *
3806     * This frees the list of themes returned by
3807     * elm_theme_name_available_list_new(). Once freed the list should no longer
3808     * be used. a new list mys be created.
3809     */
3810    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3811    /**
3812     * Set a specific theme to be used for this object and its children
3813     *
3814     * @param obj The object to set the theme on
3815     * @param th The theme to set
3816     *
3817     * This sets a specific theme that will be used for the given object and any
3818     * child objects it has. If @p th is NULL then the theme to be used is
3819     * cleared and the object will inherit its theme from its parent (which
3820     * ultimately will use the default theme if no specific themes are set).
3821     *
3822     * Use special themes with great care as this will annoy users and make
3823     * configuration difficult. Avoid any custom themes at all if it can be
3824     * helped.
3825     */
3826    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3827    /**
3828     * Get the specific theme to be used
3829     *
3830     * @param obj The object to get the specific theme from
3831     * @return The specifc theme set.
3832     *
3833     * This will return a specific theme set, or NULL if no specific theme is
3834     * set on that object. It will not return inherited themes from parents, only
3835     * the specific theme set for that specific object. See elm_object_theme_set()
3836     * for more information.
3837     */
3838    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3839
3840    /**
3841     * Get a data item from a theme
3842     *
3843     * @param th The theme, or NULL for default theme
3844     * @param key The data key to search with
3845     * @return The data value, or NULL on failure
3846     *
3847     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3848     * It works the same way as edje_file_data_get() except that the return is stringshared.
3849     */
3850    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3851    /**
3852     * @}
3853     */
3854
3855    /* win */
3856    /** @defgroup Win Win
3857     *
3858     * @image html img/widget/win/preview-00.png
3859     * @image latex img/widget/win/preview-00.eps
3860     *
3861     * The window class of Elementary.  Contains functions to manipulate
3862     * windows. The Evas engine used to render the window contents is specified
3863     * in the system or user elementary config files (whichever is found last),
3864     * and can be overridden with the ELM_ENGINE environment variable for
3865     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3866     * compilation setup and modules actually installed at runtime) are (listed
3867     * in order of best supported and most likely to be complete and work to
3868     * lowest quality).
3869     *
3870     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3871     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3872     * rendering in X11)
3873     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3874     * exits)
3875     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3876     * rendering)
3877     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3878     * buffer)
3879     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3880     * rendering using SDL as the buffer)
3881     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3882     * GDI with software)
3883     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3884     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3885     * grayscale using dedicated 8bit software engine in X11)
3886     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3887     * X11 using 16bit software engine)
3888     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3889     * (Windows CE rendering via GDI with 16bit software renderer)
3890     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3891     * buffer with 16bit software renderer)
3892     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3893     * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3894     * @li "psl1ght" (PS3 rendering using PSL1GHT)
3895     *
3896     * All engines use a simple string to select the engine to render, EXCEPT
3897     * the "shot" engine. This actually encodes the output of the virtual
3898     * screenshot and how long to delay in the engine string. The engine string
3899     * is encoded in the following way:
3900     *
3901     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3902     *
3903     * Where options are separated by a ":" char if more than one option is
3904     * given, with delay, if provided being the first option and file the last
3905     * (order is important). The delay specifies how long to wait after the
3906     * window is shown before doing the virtual "in memory" rendering and then
3907     * save the output to the file specified by the file option (and then exit).
3908     * If no delay is given, the default is 0.5 seconds. If no file is given the
3909     * default output file is "out.png". Repeat option is for continous
3910     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3911     * fixed to "out001.png" Some examples of using the shot engine:
3912     *
3913     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3914     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3915     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3916     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3917     *   ELM_ENGINE="shot:" elementary_test
3918     *
3919     * Signals that you can add callbacks for are:
3920     *
3921     * @li "delete,request": the user requested to close the window. See
3922     * elm_win_autodel_set().
3923     * @li "focus,in": window got focus
3924     * @li "focus,out": window lost focus
3925     * @li "moved": window that holds the canvas was moved
3926     *
3927     * Examples:
3928     * @li @ref win_example_01
3929     *
3930     * @{
3931     */
3932    /**
3933     * Defines the types of window that can be created
3934     *
3935     * These are hints set on the window so that a running Window Manager knows
3936     * how the window should be handled and/or what kind of decorations it
3937     * should have.
3938     *
3939     * Currently, only the X11 backed engines use them.
3940     */
3941    typedef enum _Elm_Win_Type
3942      {
3943         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3944                          window. Almost every window will be created with this
3945                          type. */
3946         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3947         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3948                            window holding desktop icons. */
3949         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3950                         be kept on top of any other window by the Window
3951                         Manager. */
3952         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3953                            similar. */
3954         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3955         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3956                            pallete. */
3957         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3958         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3959                                  entry in a menubar is clicked. Typically used
3960                                  with elm_win_override_set(). This hint exists
3961                                  for completion only, as the EFL way of
3962                                  implementing a menu would not normally use a
3963                                  separate window for its contents. */
3964         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3965                               triggered by right-clicking an object. */
3966         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3967                            explanatory text that typically appear after the
3968                            mouse cursor hovers over an object for a while.
3969                            Typically used with elm_win_override_set() and also
3970                            not very commonly used in the EFL. */
3971         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3972                                 battery life or a new E-Mail received. */
3973         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3974                          usually used in the EFL. */
3975         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3976                        object being dragged across different windows, or even
3977                        applications. Typically used with
3978                        elm_win_override_set(). */
3979         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3980                                  buffer. No actual window is created for this
3981                                  type, instead the window and all of its
3982                                  contents will be rendered to an image buffer.
3983                                  This allows to have children window inside a
3984                                  parent one just like any other object would
3985                                  be, and do other things like applying @c
3986                                  Evas_Map effects to it. This is the only type
3987                                  of window that requires the @c parent
3988                                  parameter of elm_win_add() to be a valid @c
3989                                  Evas_Object. */
3990      } Elm_Win_Type;
3991
3992    /**
3993     * The differents layouts that can be requested for the virtual keyboard.
3994     *
3995     * When the application window is being managed by Illume, it may request
3996     * any of the following layouts for the virtual keyboard.
3997     */
3998    typedef enum _Elm_Win_Keyboard_Mode
3999      {
4000         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
4001         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
4002         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
4003         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
4004         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
4005         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
4006         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
4007         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
4008         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
4009         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
4010         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
4011         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
4012         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
4013         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
4014         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
4015         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
4016      } Elm_Win_Keyboard_Mode;
4017
4018    /**
4019     * Available commands that can be sent to the Illume manager.
4020     *
4021     * When running under an Illume session, a window may send commands to the
4022     * Illume manager to perform different actions.
4023     */
4024    typedef enum _Elm_Illume_Command
4025      {
4026         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
4027                                          window */
4028         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
4029                                             in the list */
4030         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
4031                                          screen */
4032         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
4033      } Elm_Illume_Command;
4034
4035    /**
4036     * Adds a window object. If this is the first window created, pass NULL as
4037     * @p parent.
4038     *
4039     * @param parent Parent object to add the window to, or NULL
4040     * @param name The name of the window
4041     * @param type The window type, one of #Elm_Win_Type.
4042     *
4043     * The @p parent paramter can be @c NULL for every window @p type except
4044     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
4045     * which the image object will be created.
4046     *
4047     * @return The created object, or NULL on failure
4048     */
4049    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
4050    /**
4051     * Adds a window object with standard setup
4052     *
4053     * @param name The name of the window
4054     * @param title The title for the window
4055     *
4056     * This creates a window like elm_win_add() but also puts in a standard
4057     * background with elm_bg_add(), as well as setting the window title to
4058     * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
4059     * as the parent widget.
4060     *
4061     * @return The created object, or NULL on failure
4062     *
4063     * @see elm_win_add()
4064     */
4065    EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
4066    /**
4067     * Add @p subobj as a resize object of window @p obj.
4068     *
4069     *
4070     * Setting an object as a resize object of the window means that the
4071     * @p subobj child's size and position will be controlled by the window
4072     * directly. That is, the object will be resized to match the window size
4073     * and should never be moved or resized manually by the developer.
4074     *
4075     * In addition, resize objects of the window control what the minimum size
4076     * of it will be, as well as whether it can or not be resized by the user.
4077     *
4078     * For the end user to be able to resize a window by dragging the handles
4079     * or borders provided by the Window Manager, or using any other similar
4080     * mechanism, all of the resize objects in the window should have their
4081     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4082     *
4083     * Also notice that the window can get resized to the current size of the
4084     * object if the EVAS_HINT_EXPAND is set @b after the call to
4085     * elm_win_resize_object_add(). So if the object should get resized to the
4086     * size of the window, set this hint @b before adding it as a resize object
4087     * (this happens because the size of the window and the object are evaluated
4088     * as soon as the object is added to the window).
4089     *
4090     * @param obj The window object
4091     * @param subobj The resize object to add
4092     */
4093    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4094    /**
4095     * Delete @p subobj as a resize object of window @p obj.
4096     *
4097     * This function removes the object @p subobj from the resize objects of
4098     * the window @p obj. It will not delete the object itself, which will be
4099     * left unmanaged and should be deleted by the developer, manually handled
4100     * or set as child of some other container.
4101     *
4102     * @param obj The window object
4103     * @param subobj The resize object to add
4104     */
4105    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4106    /**
4107     * Set the title of the window
4108     *
4109     * @param obj The window object
4110     * @param title The title to set
4111     */
4112    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4113    /**
4114     * Get the title of the window
4115     *
4116     * The returned string is an internal one and should not be freed or
4117     * modified. It will also be rendered invalid if a new title is set or if
4118     * the window is destroyed.
4119     *
4120     * @param obj The window object
4121     * @return The title
4122     */
4123    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4124    /**
4125     * Set the window's autodel state.
4126     *
4127     * When closing the window in any way outside of the program control, like
4128     * pressing the X button in the titlebar or using a command from the
4129     * Window Manager, a "delete,request" signal is emitted to indicate that
4130     * this event occurred and the developer can take any action, which may
4131     * include, or not, destroying the window object.
4132     *
4133     * When the @p autodel parameter is set, the window will be automatically
4134     * destroyed when this event occurs, after the signal is emitted.
4135     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4136     * and is up to the program to do so when it's required.
4137     *
4138     * @param obj The window object
4139     * @param autodel If true, the window will automatically delete itself when
4140     * closed
4141     */
4142    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4143    /**
4144     * Get the window's autodel state.
4145     *
4146     * @param obj The window object
4147     * @return If the window will automatically delete itself when closed
4148     *
4149     * @see elm_win_autodel_set()
4150     */
4151    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4152    /**
4153     * Activate a window object.
4154     *
4155     * This function sends a request to the Window Manager to activate the
4156     * window pointed by @p obj. If honored by the WM, the window will receive
4157     * the keyboard focus.
4158     *
4159     * @note This is just a request that a Window Manager may ignore, so calling
4160     * this function does not ensure in any way that the window will be the
4161     * active one after it.
4162     *
4163     * @param obj The window object
4164     */
4165    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4166    /**
4167     * Lower a window object.
4168     *
4169     * Places the window pointed by @p obj at the bottom of the stack, so that
4170     * no other window is covered by it.
4171     *
4172     * If elm_win_override_set() is not set, the Window Manager may ignore this
4173     * request.
4174     *
4175     * @param obj The window object
4176     */
4177    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4178    /**
4179     * Raise a window object.
4180     *
4181     * Places the window pointed by @p obj at the top of the stack, so that it's
4182     * not covered by any other window.
4183     *
4184     * If elm_win_override_set() is not set, the Window Manager may ignore this
4185     * request.
4186     *
4187     * @param obj The window object
4188     */
4189    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4190    /**
4191     * Set the borderless state of a window.
4192     *
4193     * This function requests the Window Manager to not draw any decoration
4194     * around the window.
4195     *
4196     * @param obj The window object
4197     * @param borderless If true, the window is borderless
4198     */
4199    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4200    /**
4201     * Get the borderless state of a window.
4202     *
4203     * @param obj The window object
4204     * @return If true, the window is borderless
4205     */
4206    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4207    /**
4208     * Set the shaped state of a window.
4209     *
4210     * Shaped windows, when supported, will render the parts of the window that
4211     * has no content, transparent.
4212     *
4213     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4214     * background object or cover the entire window in any other way, or the
4215     * parts of the canvas that have no data will show framebuffer artifacts.
4216     *
4217     * @param obj The window object
4218     * @param shaped If true, the window is shaped
4219     *
4220     * @see elm_win_alpha_set()
4221     */
4222    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4223    /**
4224     * Get the shaped state of a window.
4225     *
4226     * @param obj The window object
4227     * @return If true, the window is shaped
4228     *
4229     * @see elm_win_shaped_set()
4230     */
4231    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4232    /**
4233     * Set the alpha channel state of a window.
4234     *
4235     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4236     * possibly making parts of the window completely or partially transparent.
4237     * This is also subject to the underlying system supporting it, like for
4238     * example, running under a compositing manager. If no compositing is
4239     * available, enabling this option will instead fallback to using shaped
4240     * windows, with elm_win_shaped_set().
4241     *
4242     * @param obj The window object
4243     * @param alpha If true, the window has an alpha channel
4244     *
4245     * @see elm_win_alpha_set()
4246     */
4247    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4248    /**
4249     * Get the transparency state of a window.
4250     *
4251     * @param obj The window object
4252     * @return If true, the window is transparent
4253     *
4254     * @see elm_win_transparent_set()
4255     */
4256    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4257    /**
4258     * Set the transparency state of a window.
4259     *
4260     * Use elm_win_alpha_set() instead.
4261     *
4262     * @param obj The window object
4263     * @param transparent If true, the window is transparent
4264     *
4265     * @see elm_win_alpha_set()
4266     */
4267    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4268    /**
4269     * Get the alpha channel state of a window.
4270     *
4271     * @param obj The window object
4272     * @return If true, the window has an alpha channel
4273     */
4274    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4275    /**
4276     * Set the override state of a window.
4277     *
4278     * A window with @p override set to EINA_TRUE will not be managed by the
4279     * Window Manager. This means that no decorations of any kind will be shown
4280     * for it, moving and resizing must be handled by the application, as well
4281     * as the window visibility.
4282     *
4283     * This should not be used for normal windows, and even for not so normal
4284     * ones, it should only be used when there's a good reason and with a lot
4285     * of care. Mishandling override windows may result situations that
4286     * disrupt the normal workflow of the end user.
4287     *
4288     * @param obj The window object
4289     * @param override If true, the window is overridden
4290     */
4291    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4292    /**
4293     * Get the override state of a window.
4294     *
4295     * @param obj The window object
4296     * @return If true, the window is overridden
4297     *
4298     * @see elm_win_override_set()
4299     */
4300    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4301    /**
4302     * Set the fullscreen state of a window.
4303     *
4304     * @param obj The window object
4305     * @param fullscreen If true, the window is fullscreen
4306     */
4307    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4308    /**
4309     * Get the fullscreen state of a window.
4310     *
4311     * @param obj The window object
4312     * @return If true, the window is fullscreen
4313     */
4314    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4315    /**
4316     * Set the maximized state of a window.
4317     *
4318     * @param obj The window object
4319     * @param maximized If true, the window is maximized
4320     */
4321    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4322    /**
4323     * Get the maximized state of a window.
4324     *
4325     * @param obj The window object
4326     * @return If true, the window is maximized
4327     */
4328    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4329    /**
4330     * Set the iconified state of a window.
4331     *
4332     * @param obj The window object
4333     * @param iconified If true, the window is iconified
4334     */
4335    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4336    /**
4337     * Get the iconified state of a window.
4338     *
4339     * @param obj The window object
4340     * @return If true, the window is iconified
4341     */
4342    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4343    /**
4344     * Set the layer of the window.
4345     *
4346     * What this means exactly will depend on the underlying engine used.
4347     *
4348     * In the case of X11 backed engines, the value in @p layer has the
4349     * following meanings:
4350     * @li < 3: The window will be placed below all others.
4351     * @li > 5: The window will be placed above all others.
4352     * @li other: The window will be placed in the default layer.
4353     *
4354     * @param obj The window object
4355     * @param layer The layer of the window
4356     */
4357    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4358    /**
4359     * Get the layer of the window.
4360     *
4361     * @param obj The window object
4362     * @return The layer of the window
4363     *
4364     * @see elm_win_layer_set()
4365     */
4366    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4367    /**
4368     * Set the rotation of the window.
4369     *
4370     * Most engines only work with multiples of 90.
4371     *
4372     * This function is used to set the orientation of the window @p obj to
4373     * match that of the screen. The window itself will be resized to adjust
4374     * to the new geometry of its contents. If you want to keep the window size,
4375     * see elm_win_rotation_with_resize_set().
4376     *
4377     * @param obj The window object
4378     * @param rotation The rotation of the window, in degrees (0-360),
4379     * counter-clockwise.
4380     */
4381    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4382    /**
4383     * Rotates the window and resizes it.
4384     *
4385     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4386     * that they fit inside the current window geometry.
4387     *
4388     * @param obj The window object
4389     * @param layer The rotation of the window in degrees (0-360),
4390     * counter-clockwise.
4391     */
4392    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4393    /**
4394     * Get the rotation of the window.
4395     *
4396     * @param obj The window object
4397     * @return The rotation of the window in degrees (0-360)
4398     *
4399     * @see elm_win_rotation_set()
4400     * @see elm_win_rotation_with_resize_set()
4401     */
4402    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4403    /**
4404     * Set the sticky state of the window.
4405     *
4406     * Hints the Window Manager that the window in @p obj should be left fixed
4407     * at its position even when the virtual desktop it's on moves or changes.
4408     *
4409     * @param obj The window object
4410     * @param sticky If true, the window's sticky state is enabled
4411     */
4412    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4413    /**
4414     * Get the sticky state of the window.
4415     *
4416     * @param obj The window object
4417     * @return If true, the window's sticky state is enabled
4418     *
4419     * @see elm_win_sticky_set()
4420     */
4421    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4422    /**
4423     * Set if this window is an illume conformant window
4424     *
4425     * @param obj The window object
4426     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4427     */
4428    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4429    /**
4430     * Get if this window is an illume conformant window
4431     *
4432     * @param obj The window object
4433     * @return A boolean if this window is illume conformant or not
4434     */
4435    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4436    /**
4437     * Set a window to be an illume quickpanel window
4438     *
4439     * By default window objects are not quickpanel windows.
4440     *
4441     * @param obj The window object
4442     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4443     */
4444    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4445    /**
4446     * Get if this window is a quickpanel or not
4447     *
4448     * @param obj The window object
4449     * @return A boolean if this window is a quickpanel or not
4450     */
4451    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4452    /**
4453     * Set the major priority of a quickpanel window
4454     *
4455     * @param obj The window object
4456     * @param priority The major priority for this quickpanel
4457     */
4458    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4459    /**
4460     * Get the major priority of a quickpanel window
4461     *
4462     * @param obj The window object
4463     * @return The major priority of this quickpanel
4464     */
4465    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4466    /**
4467     * Set the minor priority of a quickpanel window
4468     *
4469     * @param obj The window object
4470     * @param priority The minor priority for this quickpanel
4471     */
4472    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4473    /**
4474     * Get the minor priority of a quickpanel window
4475     *
4476     * @param obj The window object
4477     * @return The minor priority of this quickpanel
4478     */
4479    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4480    /**
4481     * Set which zone this quickpanel should appear in
4482     *
4483     * @param obj The window object
4484     * @param zone The requested zone for this quickpanel
4485     */
4486    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4487    /**
4488     * Get which zone this quickpanel should appear in
4489     *
4490     * @param obj The window object
4491     * @return The requested zone for this quickpanel
4492     */
4493    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4494    /**
4495     * Set the window to be skipped by keyboard focus
4496     *
4497     * This sets the window to be skipped by normal keyboard input. This means
4498     * a window manager will be asked to not focus this window as well as omit
4499     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4500     *
4501     * Call this and enable it on a window BEFORE you show it for the first time,
4502     * otherwise it may have no effect.
4503     *
4504     * Use this for windows that have only output information or might only be
4505     * interacted with by the mouse or fingers, and never for typing input.
4506     * Be careful that this may have side-effects like making the window
4507     * non-accessible in some cases unless the window is specially handled. Use
4508     * this with care.
4509     *
4510     * @param obj The window object
4511     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4512     */
4513    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4514    /**
4515     * Send a command to the windowing environment
4516     *
4517     * This is intended to work in touchscreen or small screen device
4518     * environments where there is a more simplistic window management policy in
4519     * place. This uses the window object indicated to select which part of the
4520     * environment to control (the part that this window lives in), and provides
4521     * a command and an optional parameter structure (use NULL for this if not
4522     * needed).
4523     *
4524     * @param obj The window object that lives in the environment to control
4525     * @param command The command to send
4526     * @param params Optional parameters for the command
4527     */
4528    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4529    /**
4530     * Get the inlined image object handle
4531     *
4532     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4533     * then the window is in fact an evas image object inlined in the parent
4534     * canvas. You can get this object (be careful to not manipulate it as it
4535     * is under control of elementary), and use it to do things like get pixel
4536     * data, save the image to a file, etc.
4537     *
4538     * @param obj The window object to get the inlined image from
4539     * @return The inlined image object, or NULL if none exists
4540     */
4541    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4542    /**
4543     * Determine whether a window has focus
4544     * @param obj The window to query
4545     * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4546     */
4547    EAPI Eina_Bool    elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4548    /**
4549     * Constrain the maximum width and height of a window to the width and height of its screen
4550     *
4551     * When @p constrain is true, @p obj will never resize larger than the screen.
4552     * @param obj The window object
4553     * @param constrain EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
4554     */
4555    EAPI void         elm_win_screen_constrain_set(Evas_Object *obj, Eina_Bool constrain) EINA_ARG_NONNULL(1);
4556    /**
4557     * Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen
4558     *
4559     * When this function returns true, @p obj will never resize larger than the screen.
4560     * @param obj The window object
4561     * @return EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
4562     */
4563    EAPI Eina_Bool    elm_win_screen_constrain_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4564    /**
4565     * Get screen geometry details for the screen that a window is on
4566     * @param obj The window to query
4567     * @param x where to return the horizontal offset value. May be NULL.
4568     * @param y  where to return the vertical offset value. May be NULL.
4569     * @param w  where to return the width value. May be NULL.
4570     * @param h  where to return the height value. May be NULL.
4571     */
4572    EAPI void         elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4573    /**
4574     * Set the enabled status for the focus highlight in a window
4575     *
4576     * This function will enable or disable the focus highlight only for the
4577     * given window, regardless of the global setting for it
4578     *
4579     * @param obj The window where to enable the highlight
4580     * @param enabled The enabled value for the highlight
4581     */
4582    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4583    /**
4584     * Get the enabled value of the focus highlight for this window
4585     *
4586     * @param obj The window in which to check if the focus highlight is enabled
4587     *
4588     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4589     */
4590    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4591    /**
4592     * Set the style for the focus highlight on this window
4593     *
4594     * Sets the style to use for theming the highlight of focused objects on
4595     * the given window. If @p style is NULL, the default will be used.
4596     *
4597     * @param obj The window where to set the style
4598     * @param style The style to set
4599     */
4600    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4601    /**
4602     * Get the style set for the focus highlight object
4603     *
4604     * Gets the style set for this windows highilght object, or NULL if none
4605     * is set.
4606     *
4607     * @param obj The window to retrieve the highlights style from
4608     *
4609     * @return The style set or NULL if none was. Default is used in that case.
4610     */
4611    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4612    /*...
4613     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4614     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4615     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4616     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4617     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4618     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4619     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4620     *
4621     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4622     * (blank mouse, private mouse obj, defaultmouse)
4623     *
4624     */
4625    /**
4626     * Sets the keyboard mode of the window.
4627     *
4628     * @param obj The window object
4629     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4630     */
4631    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4632    /**
4633     * Gets the keyboard mode of the window.
4634     *
4635     * @param obj The window object
4636     * @return The mode, one of #Elm_Win_Keyboard_Mode
4637     */
4638    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4639    /**
4640     * Sets whether the window is a keyboard.
4641     *
4642     * @param obj The window object
4643     * @param is_keyboard If true, the window is a virtual keyboard
4644     */
4645    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4646    /**
4647     * Gets whether the window is a keyboard.
4648     *
4649     * @param obj The window object
4650     * @return If the window is a virtual keyboard
4651     */
4652    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4653
4654    /**
4655     * Get the screen position of a window.
4656     *
4657     * @param obj The window object
4658     * @param x The int to store the x coordinate to
4659     * @param y The int to store the y coordinate to
4660     */
4661    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4662    /**
4663     * @}
4664     */
4665
4666    /**
4667     * @defgroup Inwin Inwin
4668     *
4669     * @image html img/widget/inwin/preview-00.png
4670     * @image latex img/widget/inwin/preview-00.eps
4671     * @image html img/widget/inwin/preview-01.png
4672     * @image latex img/widget/inwin/preview-01.eps
4673     * @image html img/widget/inwin/preview-02.png
4674     * @image latex img/widget/inwin/preview-02.eps
4675     *
4676     * An inwin is a window inside a window that is useful for a quick popup.
4677     * It does not hover.
4678     *
4679     * It works by creating an object that will occupy the entire window, so it
4680     * must be created using an @ref Win "elm_win" as parent only. The inwin
4681     * object can be hidden or restacked below every other object if it's
4682     * needed to show what's behind it without destroying it. If this is done,
4683     * the elm_win_inwin_activate() function can be used to bring it back to
4684     * full visibility again.
4685     *
4686     * There are three styles available in the default theme. These are:
4687     * @li default: The inwin is sized to take over most of the window it's
4688     * placed in.
4689     * @li minimal: The size of the inwin will be the minimum necessary to show
4690     * its contents.
4691     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4692     * possible, but it's sized vertically the most it needs to fit its\
4693     * contents.
4694     *
4695     * Some examples of Inwin can be found in the following:
4696     * @li @ref inwin_example_01
4697     *
4698     * @{
4699     */
4700    /**
4701     * Adds an inwin to the current window
4702     *
4703     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4704     * Never call this function with anything other than the top-most window
4705     * as its parameter, unless you are fond of undefined behavior.
4706     *
4707     * After creating the object, the widget will set itself as resize object
4708     * for the window with elm_win_resize_object_add(), so when shown it will
4709     * appear to cover almost the entire window (how much of it depends on its
4710     * content and the style used). It must not be added into other container
4711     * objects and it needs not be moved or resized manually.
4712     *
4713     * @param parent The parent object
4714     * @return The new object or NULL if it cannot be created
4715     */
4716    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4717    /**
4718     * Activates an inwin object, ensuring its visibility
4719     *
4720     * This function will make sure that the inwin @p obj is completely visible
4721     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4722     * to the front. It also sets the keyboard focus to it, which will be passed
4723     * onto its content.
4724     *
4725     * The object's theme will also receive the signal "elm,action,show" with
4726     * source "elm".
4727     *
4728     * @param obj The inwin to activate
4729     */
4730    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4731    /**
4732     * Set the content of an inwin object.
4733     *
4734     * Once the content object is set, a previously set one will be deleted.
4735     * If you want to keep that old content object, use the
4736     * elm_win_inwin_content_unset() function.
4737     *
4738     * @param obj The inwin object
4739     * @param content The object to set as content
4740     */
4741    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4742    /**
4743     * Get the content of an inwin object.
4744     *
4745     * Return the content object which is set for this widget.
4746     *
4747     * The returned object is valid as long as the inwin is still alive and no
4748     * other content is set on it. Deleting the object will notify the inwin
4749     * about it and this one will be left empty.
4750     *
4751     * If you need to remove an inwin's content to be reused somewhere else,
4752     * see elm_win_inwin_content_unset().
4753     *
4754     * @param obj The inwin object
4755     * @return The content that is being used
4756     */
4757    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4758    /**
4759     * Unset the content of an inwin object.
4760     *
4761     * Unparent and return the content object which was set for this widget.
4762     *
4763     * @param obj The inwin object
4764     * @return The content that was being used
4765     */
4766    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4767    /**
4768     * @}
4769     */
4770    /* X specific calls - won't work on non-x engines (return 0) */
4771
4772    /**
4773     * Get the Ecore_X_Window of an Evas_Object
4774     *
4775     * @param obj The object
4776     *
4777     * @return The Ecore_X_Window of @p obj
4778     *
4779     * @ingroup Win
4780     */
4781    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4782
4783    /* smart callbacks called:
4784     * "delete,request" - the user requested to delete the window
4785     * "focus,in" - window got focus
4786     * "focus,out" - window lost focus
4787     * "moved" - window that holds the canvas was moved
4788     */
4789
4790    /**
4791     * @defgroup Bg Bg
4792     *
4793     * @image html img/widget/bg/preview-00.png
4794     * @image latex img/widget/bg/preview-00.eps
4795     *
4796     * @brief Background object, used for setting a solid color, image or Edje
4797     * group as background to a window or any container object.
4798     *
4799     * The bg object is used for setting a solid background to a window or
4800     * packing into any container object. It works just like an image, but has
4801     * some properties useful to a background, like setting it to tiled,
4802     * centered, scaled or stretched.
4803     *
4804     * Default contents parts of the bg widget that you can use for are:
4805     * @li "overlay" - overlay of the bg
4806     *
4807     * Here is some sample code using it:
4808     * @li @ref bg_01_example_page
4809     * @li @ref bg_02_example_page
4810     * @li @ref bg_03_example_page
4811     */
4812
4813    /* bg */
4814    typedef enum _Elm_Bg_Option
4815      {
4816         ELM_BG_OPTION_CENTER,  /**< center the background */
4817         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4818         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4819         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4820      } Elm_Bg_Option;
4821
4822    /**
4823     * Add a new background to the parent
4824     *
4825     * @param parent The parent object
4826     * @return The new object or NULL if it cannot be created
4827     *
4828     * @ingroup Bg
4829     */
4830    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4831
4832    /**
4833     * Set the file (image or edje) used for the background
4834     *
4835     * @param obj The bg object
4836     * @param file The file path
4837     * @param group Optional key (group in Edje) within the file
4838     *
4839     * This sets the image file used in the background object. The image (or edje)
4840     * will be stretched (retaining aspect if its an image file) to completely fill
4841     * the bg object. This may mean some parts are not visible.
4842     *
4843     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4844     * even if @p file is NULL.
4845     *
4846     * @ingroup Bg
4847     */
4848    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4849
4850    /**
4851     * Get the file (image or edje) used for the background
4852     *
4853     * @param obj The bg object
4854     * @param file The file path
4855     * @param group Optional key (group in Edje) within the file
4856     *
4857     * @ingroup Bg
4858     */
4859    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4860
4861    /**
4862     * Set the option used for the background image
4863     *
4864     * @param obj The bg object
4865     * @param option The desired background option (TILE, SCALE)
4866     *
4867     * This sets the option used for manipulating the display of the background
4868     * image. The image can be tiled or scaled.
4869     *
4870     * @ingroup Bg
4871     */
4872    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4873
4874    /**
4875     * Get the option used for the background image
4876     *
4877     * @param obj The bg object
4878     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4879     *
4880     * @ingroup Bg
4881     */
4882    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4883    /**
4884     * Set the option used for the background color
4885     *
4886     * @param obj The bg object
4887     * @param r
4888     * @param g
4889     * @param b
4890     *
4891     * This sets the color used for the background rectangle. Its range goes
4892     * from 0 to 255.
4893     *
4894     * @ingroup Bg
4895     */
4896    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4897    /**
4898     * Get the option used for the background color
4899     *
4900     * @param obj The bg object
4901     * @param r
4902     * @param g
4903     * @param b
4904     *
4905     * @ingroup Bg
4906     */
4907    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4908
4909    /**
4910     * Set the overlay object used for the background object.
4911     *
4912     * @param obj The bg object
4913     * @param overlay The overlay object
4914     *
4915     * This provides a way for elm_bg to have an 'overlay' that will be on top
4916     * of the bg. Once the over object is set, a previously set one will be
4917     * deleted, even if you set the new one to NULL. If you want to keep that
4918     * old content object, use the elm_bg_overlay_unset() function.
4919     *
4920     * @deprecated use elm_object_part_content_set() instead
4921     *
4922     * @ingroup Bg
4923     */
4924
4925    EINA_DEPRECATED EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4926
4927    /**
4928     * Get the overlay object used for the background object.
4929     *
4930     * @param obj The bg object
4931     * @return The content that is being used
4932     *
4933     * Return the content object which is set for this widget
4934     *
4935     * @deprecated use elm_object_part_content_get() instead
4936     *
4937     * @ingroup Bg
4938     */
4939    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4940
4941    /**
4942     * Get the overlay object used for the background object.
4943     *
4944     * @param obj The bg object
4945     * @return The content that was being used
4946     *
4947     * Unparent and return the overlay object which was set for this widget
4948     *
4949     * @deprecated use elm_object_part_content_unset() instead
4950     *
4951     * @ingroup Bg
4952     */
4953    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4954
4955    /**
4956     * Set the size of the pixmap representation of the image.
4957     *
4958     * This option just makes sense if an image is going to be set in the bg.
4959     *
4960     * @param obj The bg object
4961     * @param w The new width of the image pixmap representation.
4962     * @param h The new height of the image pixmap representation.
4963     *
4964     * This function sets a new size for pixmap representation of the given bg
4965     * image. It allows the image to be loaded already in the specified size,
4966     * reducing the memory usage and load time when loading a big image with load
4967     * size set to a smaller size.
4968     *
4969     * NOTE: this is just a hint, the real size of the pixmap may differ
4970     * depending on the type of image being loaded, being bigger than requested.
4971     *
4972     * @ingroup Bg
4973     */
4974    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4975    /* smart callbacks called:
4976     */
4977
4978    /**
4979     * @defgroup Icon Icon
4980     *
4981     * @image html img/widget/icon/preview-00.png
4982     * @image latex img/widget/icon/preview-00.eps
4983     *
4984     * An object that provides standard icon images (delete, edit, arrows, etc.)
4985     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4986     *
4987     * The icon image requested can be in the elementary theme, or in the
4988     * freedesktop.org paths. It's possible to set the order of preference from
4989     * where the image will be used.
4990     *
4991     * This API is very similar to @ref Image, but with ready to use images.
4992     *
4993     * Default images provided by the theme are described below.
4994     *
4995     * The first list contains icons that were first intended to be used in
4996     * toolbars, but can be used in many other places too:
4997     * @li home
4998     * @li close
4999     * @li apps
5000     * @li arrow_up
5001     * @li arrow_down
5002     * @li arrow_left
5003     * @li arrow_right
5004     * @li chat
5005     * @li clock
5006     * @li delete
5007     * @li edit
5008     * @li refresh
5009     * @li folder
5010     * @li file
5011     *
5012     * Now some icons that were designed to be used in menus (but again, you can
5013     * use them anywhere else):
5014     * @li menu/home
5015     * @li menu/close
5016     * @li menu/apps
5017     * @li menu/arrow_up
5018     * @li menu/arrow_down
5019     * @li menu/arrow_left
5020     * @li menu/arrow_right
5021     * @li menu/chat
5022     * @li menu/clock
5023     * @li menu/delete
5024     * @li menu/edit
5025     * @li menu/refresh
5026     * @li menu/folder
5027     * @li menu/file
5028     *
5029     * And here we have some media player specific icons:
5030     * @li media_player/forward
5031     * @li media_player/info
5032     * @li media_player/next
5033     * @li media_player/pause
5034     * @li media_player/play
5035     * @li media_player/prev
5036     * @li media_player/rewind
5037     * @li media_player/stop
5038     *
5039     * Signals that you can add callbacks for are:
5040     *
5041     * "clicked" - This is called when a user has clicked the icon
5042     *
5043     * An example of usage for this API follows:
5044     * @li @ref tutorial_icon
5045     */
5046
5047    /**
5048     * @addtogroup Icon
5049     * @{
5050     */
5051
5052    typedef enum _Elm_Icon_Type
5053      {
5054         ELM_ICON_NONE,
5055         ELM_ICON_FILE,
5056         ELM_ICON_STANDARD
5057      } Elm_Icon_Type;
5058    /**
5059     * @enum _Elm_Icon_Lookup_Order
5060     * @typedef Elm_Icon_Lookup_Order
5061     *
5062     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
5063     * theme, FDO paths, or both?
5064     *
5065     * @ingroup Icon
5066     */
5067    typedef enum _Elm_Icon_Lookup_Order
5068      {
5069         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
5070         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
5071         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
5072         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
5073      } Elm_Icon_Lookup_Order;
5074
5075    /**
5076     * Add a new icon object to the parent.
5077     *
5078     * @param parent The parent object
5079     * @return The new object or NULL if it cannot be created
5080     *
5081     * @see elm_icon_file_set()
5082     *
5083     * @ingroup Icon
5084     */
5085    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5086    /**
5087     * Set the file that will be used as icon.
5088     *
5089     * @param obj The icon object
5090     * @param file The path to file that will be used as icon image
5091     * @param group The group that the icon belongs to an edje file
5092     *
5093     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5094     *
5095     * @note The icon image set by this function can be changed by
5096     * elm_icon_standard_set().
5097     *
5098     * @see elm_icon_file_get()
5099     *
5100     * @ingroup Icon
5101     */
5102    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5103    /**
5104     * Set a location in memory to be used as an icon
5105     *
5106     * @param obj The icon object
5107     * @param img The binary data that will be used as an image
5108     * @param size The size of binary data @p img
5109     * @param format Optional format of @p img to pass to the image loader
5110     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5111     *
5112     * The @p format string should be something like "png", "jpg", "tga",
5113     * "tiff", "bmp" etc. if it is provided (NULL if not). This improves
5114     * the loader performance as it tries the "correct" loader first before
5115     * trying a range of other possible loaders until one succeeds.
5116     * 
5117     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5118     *
5119     * @note The icon image set by this function can be changed by
5120     * elm_icon_standard_set().
5121     *
5122     * @ingroup Icon
5123     */
5124    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);
5125    /**
5126     * Get the file that will be used as icon.
5127     *
5128     * @param obj The icon object
5129     * @param file The path to file that will be used as the icon image
5130     * @param group The group that the icon belongs to, in edje file
5131     *
5132     * @see elm_icon_file_set()
5133     *
5134     * @ingroup Icon
5135     */
5136    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5137    /**
5138     * Set the file that will be used, but use a generated thumbnail.
5139     *
5140     * @param obj The icon object
5141     * @param file The path to file that will be used as icon image
5142     * @param group The group that the icon belongs to an edje file
5143     *
5144     * This functions like elm_icon_file_set() but requires the Ethumb library
5145     * support to be enabled successfully with elm_need_ethumb(). When set
5146     * the file indicated has a thumbnail generated and cached on disk for
5147     * future use or will directly use an existing cached thumbnail if it
5148     * is valid.
5149     * 
5150     * @see elm_icon_file_set()
5151     *
5152     * @ingroup Icon
5153     */
5154    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5155    /**
5156     * Set the icon by icon standards names.
5157     *
5158     * @param obj The icon object
5159     * @param name The icon name
5160     *
5161     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5162     *
5163     * For example, freedesktop.org defines standard icon names such as "home",
5164     * "network", etc. There can be different icon sets to match those icon
5165     * keys. The @p name given as parameter is one of these "keys", and will be
5166     * used to look in the freedesktop.org paths and elementary theme. One can
5167     * change the lookup order with elm_icon_order_lookup_set().
5168     *
5169     * If name is not found in any of the expected locations and it is the
5170     * absolute path of an image file, this image will be used.
5171     *
5172     * @note The icon image set by this function can be changed by
5173     * elm_icon_file_set().
5174     *
5175     * @see elm_icon_standard_get()
5176     * @see elm_icon_file_set()
5177     *
5178     * @ingroup Icon
5179     */
5180    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5181    /**
5182     * Get the icon name set by icon standard names.
5183     *
5184     * @param obj The icon object
5185     * @return The icon name
5186     *
5187     * If the icon image was set using elm_icon_file_set() instead of
5188     * elm_icon_standard_set(), then this function will return @c NULL.
5189     *
5190     * @see elm_icon_standard_set()
5191     *
5192     * @ingroup Icon
5193     */
5194    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5195    /**
5196     * Set the smooth scaling for an icon object.
5197     *
5198     * @param obj The icon object
5199     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5200     * otherwise. Default is @c EINA_TRUE.
5201     *
5202     * Set the scaling algorithm to be used when scaling the icon image. Smooth
5203     * scaling provides a better resulting image, but is slower.
5204     *
5205     * The smooth scaling should be disabled when making animations that change
5206     * the icon size, since they will be faster. Animations that don't require
5207     * resizing of the icon can keep the smooth scaling enabled (even if the icon
5208     * is already scaled, since the scaled icon image will be cached).
5209     *
5210     * @see elm_icon_smooth_get()
5211     *
5212     * @ingroup Icon
5213     */
5214    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5215    /**
5216     * Get whether smooth scaling is enabled for an icon object.
5217     *
5218     * @param obj The icon object
5219     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5220     *
5221     * @see elm_icon_smooth_set()
5222     *
5223     * @ingroup Icon
5224     */
5225    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5226    /**
5227     * Disable scaling of this object.
5228     *
5229     * @param obj The icon object.
5230     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5231     * otherwise. Default is @c EINA_FALSE.
5232     *
5233     * This function disables scaling of the icon object through the function
5234     * elm_object_scale_set(). However, this does not affect the object
5235     * size/resize in any way. For that effect, take a look at
5236     * elm_icon_scale_set().
5237     *
5238     * @see elm_icon_no_scale_get()
5239     * @see elm_icon_scale_set()
5240     * @see elm_object_scale_set()
5241     *
5242     * @ingroup Icon
5243     */
5244    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5245    /**
5246     * Get whether scaling is disabled on the object.
5247     *
5248     * @param obj The icon object
5249     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5250     *
5251     * @see elm_icon_no_scale_set()
5252     *
5253     * @ingroup Icon
5254     */
5255    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5256    /**
5257     * Set if the object is (up/down) resizable.
5258     *
5259     * @param obj The icon object
5260     * @param scale_up A bool to set if the object is resizable up. Default is
5261     * @c EINA_TRUE.
5262     * @param scale_down A bool to set if the object is resizable down. Default
5263     * is @c EINA_TRUE.
5264     *
5265     * This function limits the icon object resize ability. If @p scale_up is set to
5266     * @c EINA_FALSE, the object can't have its height or width resized to a value
5267     * higher than the original icon size. Same is valid for @p scale_down.
5268     *
5269     * @see elm_icon_scale_get()
5270     *
5271     * @ingroup Icon
5272     */
5273    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5274    /**
5275     * Get if the object is (up/down) resizable.
5276     *
5277     * @param obj The icon object
5278     * @param scale_up A bool to set if the object is resizable up
5279     * @param scale_down A bool to set if the object is resizable down
5280     *
5281     * @see elm_icon_scale_set()
5282     *
5283     * @ingroup Icon
5284     */
5285    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5286    /**
5287     * Get the object's image size
5288     *
5289     * @param obj The icon object
5290     * @param w A pointer to store the width in
5291     * @param h A pointer to store the height in
5292     *
5293     * @ingroup Icon
5294     */
5295    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5296    /**
5297     * Set if the icon fill the entire object area.
5298     *
5299     * @param obj The icon object
5300     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5301     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5302     *
5303     * When the icon object is resized to a different aspect ratio from the
5304     * original icon image, the icon image will still keep its aspect. This flag
5305     * tells how the image should fill the object's area. They are: keep the
5306     * entire icon inside the limits of height and width of the object (@p
5307     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5308     * of the object, and the icon will fill the entire object (@p fill_outside
5309     * is @c EINA_TRUE).
5310     *
5311     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5312     * retain property to false. Thus, the icon image will always keep its
5313     * original aspect ratio.
5314     *
5315     * @see elm_icon_fill_outside_get()
5316     * @see elm_image_fill_outside_set()
5317     *
5318     * @ingroup Icon
5319     */
5320    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5321    /**
5322     * Get if the object is filled outside.
5323     *
5324     * @param obj The icon object
5325     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5326     *
5327     * @see elm_icon_fill_outside_set()
5328     *
5329     * @ingroup Icon
5330     */
5331    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5332    /**
5333     * Set the prescale size for the icon.
5334     *
5335     * @param obj The icon object
5336     * @param size The prescale size. This value is used for both width and
5337     * height.
5338     *
5339     * This function sets a new size for pixmap representation of the given
5340     * icon. It allows the icon to be loaded already in the specified size,
5341     * reducing the memory usage and load time when loading a big icon with load
5342     * size set to a smaller size.
5343     *
5344     * It's equivalent to the elm_bg_load_size_set() function for bg.
5345     *
5346     * @note this is just a hint, the real size of the pixmap may differ
5347     * depending on the type of icon being loaded, being bigger than requested.
5348     *
5349     * @see elm_icon_prescale_get()
5350     * @see elm_bg_load_size_set()
5351     *
5352     * @ingroup Icon
5353     */
5354    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5355    /**
5356     * Get the prescale size for the icon.
5357     *
5358     * @param obj The icon object
5359     * @return The prescale size
5360     *
5361     * @see elm_icon_prescale_set()
5362     *
5363     * @ingroup Icon
5364     */
5365    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5366    /**
5367     * Gets the image object of the icon. DO NOT MODIFY THIS.
5368     *
5369     * @param obj The icon object
5370     * @return The internal icon object
5371     *
5372     * @ingroup Icon
5373     */
5374    EAPI Evas_Object          *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5375    /**
5376     * Sets the icon lookup order used by elm_icon_standard_set().
5377     *
5378     * @param obj The icon object
5379     * @param order The icon lookup order (can be one of
5380     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5381     * or ELM_ICON_LOOKUP_THEME)
5382     *
5383     * @see elm_icon_order_lookup_get()
5384     * @see Elm_Icon_Lookup_Order
5385     *
5386     * @ingroup Icon
5387     */
5388    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5389    /**
5390     * Gets the icon lookup order.
5391     *
5392     * @param obj The icon object
5393     * @return The icon lookup order
5394     *
5395     * @see elm_icon_order_lookup_set()
5396     * @see Elm_Icon_Lookup_Order
5397     *
5398     * @ingroup Icon
5399     */
5400    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5401    /**
5402     * Enable or disable preloading of the icon
5403     *
5404     * @param obj The icon object
5405     * @param disable If EINA_TRUE, preloading will be disabled
5406     * @ingroup Icon
5407     */
5408    EAPI void                  elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5409    /**
5410     * Get if the icon supports animation or not.
5411     *
5412     * @param obj The icon object
5413     * @return @c EINA_TRUE if the icon supports animation,
5414     *         @c EINA_FALSE otherwise.
5415     *
5416     * Return if this elm icon's image can be animated. Currently Evas only
5417     * supports gif animation. If the return value is EINA_FALSE, other
5418     * elm_icon_animated_XXX APIs won't work.
5419     * @ingroup Icon
5420     */
5421    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5422    /**
5423     * Set animation mode of the icon.
5424     *
5425     * @param obj The icon object
5426     * @param anim @c EINA_TRUE if the object do animation job,
5427     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5428     *
5429     * Since the default animation mode is set to EINA_FALSE,
5430     * the icon is shown without animation. Files like animated GIF files
5431     * can animate, and this is supported if you enable animated support
5432     * on the icon.
5433     * Set it to EINA_TRUE when the icon needs to be animated.
5434     * @ingroup Icon
5435     */
5436    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5437    /**
5438     * Get animation mode of the icon.
5439     *
5440     * @param obj The icon object
5441     * @return The animation mode of the icon object
5442     * @see elm_icon_animated_set
5443     * @ingroup Icon
5444     */
5445    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5446    /**
5447     * Set animation play mode of the icon.
5448     *
5449     * @param obj The icon object
5450     * @param play @c EINA_TRUE the object play animation images,
5451     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5452     *
5453     * To play elm icon's animation, set play to EINA_TURE.
5454     * For example, you make gif player using this set/get API and click event.
5455     * This literally lets you control current play or paused state. To have
5456     * this work with animated GIF files for example, you first, before
5457     * setting the file have to use elm_icon_animated_set() to enable animation
5458     * at all on the icon.
5459     *
5460     * 1. Click event occurs
5461     * 2. Check play flag using elm_icon_animaged_play_get
5462     * 3. If elm icon was playing, set play to EINA_FALSE.
5463     *    Then animation will be stopped and vice versa
5464     * @ingroup Icon
5465     */
5466    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5467    /**
5468     * Get animation play mode of the icon.
5469     *
5470     * @param obj The icon object
5471     * @return The play mode of the icon object
5472     *
5473     * @see elm_icon_animated_play_get
5474     * @ingroup Icon
5475     */
5476    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5477
5478    /**
5479     * @}
5480     */
5481
5482    /**
5483     * @defgroup Image Image
5484     *
5485     * @image html img/widget/image/preview-00.png
5486     * @image latex img/widget/image/preview-00.eps
5487
5488     *
5489     * An object that allows one to load an image file to it. It can be used
5490     * anywhere like any other elementary widget.
5491     *
5492     * This widget provides most of the functionality provided from @ref Bg or @ref
5493     * Icon, but with a slightly different API (use the one that fits better your
5494     * needs).
5495     *
5496     * The features not provided by those two other image widgets are:
5497     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5498     * @li change the object orientation with elm_image_orient_set();
5499     * @li and turning the image editable with elm_image_editable_set().
5500     *
5501     * Signals that you can add callbacks for are:
5502     *
5503     * @li @c "clicked" - This is called when a user has clicked the image
5504     *
5505     * An example of usage for this API follows:
5506     * @li @ref tutorial_image
5507     */
5508
5509    /**
5510     * @addtogroup Image
5511     * @{
5512     */
5513
5514    /**
5515     * @enum _Elm_Image_Orient
5516     * @typedef Elm_Image_Orient
5517     *
5518     * Possible orientation options for elm_image_orient_set().
5519     *
5520     * @image html elm_image_orient_set.png
5521     * @image latex elm_image_orient_set.eps width=\textwidth
5522     *
5523     * @ingroup Image
5524     */
5525    typedef enum _Elm_Image_Orient
5526      {
5527         ELM_IMAGE_ORIENT_NONE = 0, /**< no orientation change */
5528         ELM_IMAGE_ORIENT_0 = 0, /**< no orientation change */
5529         ELM_IMAGE_ROTATE_90 = 1, /**< rotate 90 degrees clockwise */
5530         ELM_IMAGE_ROTATE_180 = 2, /**< rotate 180 degrees clockwise */
5531         ELM_IMAGE_ROTATE_270 = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5532         /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CW = 1, /**< rotate 90 degrees clockwise */
5533         /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_180_CW = 2, /**< rotate 180 degrees clockwise */
5534         /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CCW = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5535         ELM_IMAGE_FLIP_HORIZONTAL = 4, /**< flip image horizontally */
5536         ELM_IMAGE_FLIP_VERTICAL = 5, /**< flip image vertically */
5537         ELM_IMAGE_FLIP_TRANSPOSE = 6, /**< flip the image along the y = (width - x) line (bottom-left to top-right) */
5538         ELM_IMAGE_FLIP_TRANSVERSE = 7 /**< flip the image along the y = x line (top-left to bottom-right) */
5539      } Elm_Image_Orient;
5540
5541    /**
5542     * Add a new image to the parent.
5543     *
5544     * @param parent The parent object
5545     * @return The new object or NULL if it cannot be created
5546     *
5547     * @see elm_image_file_set()
5548     *
5549     * @ingroup Image
5550     */
5551    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5552    /**
5553     * Set the file that will be used as image.
5554     *
5555     * @param obj The image object
5556     * @param file The path to file that will be used as image
5557     * @param group The group that the image belongs in edje file (if it's an
5558     * edje image)
5559     *
5560     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5561     *
5562     * @see elm_image_file_get()
5563     *
5564     * @ingroup Image
5565     */
5566    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5567    /**
5568     * Get the file that will be used as image.
5569     *
5570     * @param obj The image object
5571     * @param file The path to file
5572     * @param group The group that the image belongs in edje file
5573     *
5574     * @see elm_image_file_set()
5575     *
5576     * @ingroup Image
5577     */
5578    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5579    /**
5580     * Set the smooth effect for an image.
5581     *
5582     * @param obj The image object
5583     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5584     * otherwise. Default is @c EINA_TRUE.
5585     *
5586     * Set the scaling algorithm to be used when scaling the image. Smooth
5587     * scaling provides a better resulting image, but is slower.
5588     *
5589     * The smooth scaling should be disabled when making animations that change
5590     * the image size, since it will be faster. Animations that don't require
5591     * resizing of the image can keep the smooth scaling enabled (even if the
5592     * image is already scaled, since the scaled image will be cached).
5593     *
5594     * @see elm_image_smooth_get()
5595     *
5596     * @ingroup Image
5597     */
5598    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5599    /**
5600     * Get the smooth effect for an image.
5601     *
5602     * @param obj The image object
5603     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5604     *
5605     * @see elm_image_smooth_get()
5606     *
5607     * @ingroup Image
5608     */
5609    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5610
5611    /**
5612     * Gets the current size of the image.
5613     *
5614     * @param obj The image object.
5615     * @param w Pointer to store width, or NULL.
5616     * @param h Pointer to store height, or NULL.
5617     *
5618     * This is the real size of the image, not the size of the object.
5619     *
5620     * On error, neither w and h will be fileld with 0.
5621     *
5622     * @ingroup Image
5623     */
5624    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5625    /**
5626     * Disable scaling of this object.
5627     *
5628     * @param obj The image object.
5629     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5630     * otherwise. Default is @c EINA_FALSE.
5631     *
5632     * This function disables scaling of the elm_image widget through the
5633     * function elm_object_scale_set(). However, this does not affect the widget
5634     * size/resize in any way. For that effect, take a look at
5635     * elm_image_scale_set().
5636     *
5637     * @see elm_image_no_scale_get()
5638     * @see elm_image_scale_set()
5639     * @see elm_object_scale_set()
5640     *
5641     * @ingroup Image
5642     */
5643    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5644    /**
5645     * Get whether scaling is disabled on the object.
5646     *
5647     * @param obj The image object
5648     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5649     *
5650     * @see elm_image_no_scale_set()
5651     *
5652     * @ingroup Image
5653     */
5654    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5655    /**
5656     * Set if the object is (up/down) resizable.
5657     *
5658     * @param obj The image object
5659     * @param scale_up A bool to set if the object is resizable up. Default is
5660     * @c EINA_TRUE.
5661     * @param scale_down A bool to set if the object is resizable down. Default
5662     * is @c EINA_TRUE.
5663     *
5664     * This function limits the image resize ability. If @p scale_up is set to
5665     * @c EINA_FALSE, the object can't have its height or width resized to a value
5666     * higher than the original image size. Same is valid for @p scale_down.
5667     *
5668     * @see elm_image_scale_get()
5669     *
5670     * @ingroup Image
5671     */
5672    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5673    /**
5674     * Get if the object is (up/down) resizable.
5675     *
5676     * @param obj The image object
5677     * @param scale_up A bool to set if the object is resizable up
5678     * @param scale_down A bool to set if the object is resizable down
5679     *
5680     * @see elm_image_scale_set()
5681     *
5682     * @ingroup Image
5683     */
5684    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5685    /**
5686     * Set if the image fills the entire object area, when keeping the aspect ratio.
5687     *
5688     * @param obj The image object
5689     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5690     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5691     *
5692     * When the image should keep its aspect ratio even if resized to another
5693     * aspect ratio, there are two possibilities to resize it: keep the entire
5694     * image inside the limits of height and width of the object (@p fill_outside
5695     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5696     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5697     *
5698     * @note This option will have no effect if
5699     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5700     *
5701     * @see elm_image_fill_outside_get()
5702     * @see elm_image_aspect_ratio_retained_set()
5703     *
5704     * @ingroup Image
5705     */
5706    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5707    /**
5708     * Get if the object is filled outside
5709     *
5710     * @param obj The image object
5711     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5712     *
5713     * @see elm_image_fill_outside_set()
5714     *
5715     * @ingroup Image
5716     */
5717    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5718    /**
5719     * Set the prescale size for the image
5720     *
5721     * @param obj The image object
5722     * @param size The prescale size. This value is used for both width and
5723     * height.
5724     *
5725     * This function sets a new size for pixmap representation of the given
5726     * image. It allows the image to be loaded already in the specified size,
5727     * reducing the memory usage and load time when loading a big image with load
5728     * size set to a smaller size.
5729     *
5730     * It's equivalent to the elm_bg_load_size_set() function for bg.
5731     *
5732     * @note this is just a hint, the real size of the pixmap may differ
5733     * depending on the type of image being loaded, being bigger than requested.
5734     *
5735     * @see elm_image_prescale_get()
5736     * @see elm_bg_load_size_set()
5737     *
5738     * @ingroup Image
5739     */
5740    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5741    /**
5742     * Get the prescale size for the image
5743     *
5744     * @param obj The image object
5745     * @return The prescale size
5746     *
5747     * @see elm_image_prescale_set()
5748     *
5749     * @ingroup Image
5750     */
5751    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5752    /**
5753     * Set the image orientation.
5754     *
5755     * @param obj The image object
5756     * @param orient The image orientation @ref Elm_Image_Orient
5757     *  Default is #ELM_IMAGE_ORIENT_NONE.
5758     *
5759     * This function allows to rotate or flip the given image.
5760     *
5761     * @see elm_image_orient_get()
5762     * @see @ref Elm_Image_Orient
5763     *
5764     * @ingroup Image
5765     */
5766    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5767    /**
5768     * Get the image orientation.
5769     *
5770     * @param obj The image object
5771     * @return The image orientation @ref Elm_Image_Orient
5772     *
5773     * @see elm_image_orient_set()
5774     * @see @ref Elm_Image_Orient
5775     *
5776     * @ingroup Image
5777     */
5778    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5779    /**
5780     * Make the image 'editable'.
5781     *
5782     * @param obj Image object.
5783     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5784     *
5785     * This means the image is a valid drag target for drag and drop, and can be
5786     * cut or pasted too.
5787     *
5788     * @ingroup Image
5789     */
5790    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5791    /**
5792     * Check if the image 'editable'.
5793     *
5794     * @param obj Image object.
5795     * @return Editability.
5796     *
5797     * A return value of EINA_TRUE means the image is a valid drag target
5798     * for drag and drop, and can be cut or pasted too.
5799     *
5800     * @ingroup Image
5801     */
5802    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5803    /**
5804     * Get the basic Evas_Image object from this object (widget).
5805     *
5806     * @param obj The image object to get the inlined image from
5807     * @return The inlined image object, or NULL if none exists
5808     *
5809     * This function allows one to get the underlying @c Evas_Object of type
5810     * Image from this elementary widget. It can be useful to do things like get
5811     * the pixel data, save the image to a file, etc.
5812     *
5813     * @note Be careful to not manipulate it, as it is under control of
5814     * elementary.
5815     *
5816     * @ingroup Image
5817     */
5818    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5819    /**
5820     * Set whether the original aspect ratio of the image should be kept on resize.
5821     *
5822     * @param obj The image object.
5823     * @param retained @c EINA_TRUE if the image should retain the aspect,
5824     * @c EINA_FALSE otherwise.
5825     *
5826     * The original aspect ratio (width / height) of the image is usually
5827     * distorted to match the object's size. Enabling this option will retain
5828     * this original aspect, and the way that the image is fit into the object's
5829     * area depends on the option set by elm_image_fill_outside_set().
5830     *
5831     * @see elm_image_aspect_ratio_retained_get()
5832     * @see elm_image_fill_outside_set()
5833     *
5834     * @ingroup Image
5835     */
5836    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5837    /**
5838     * Get if the object retains the original aspect ratio.
5839     *
5840     * @param obj The image object.
5841     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5842     * otherwise.
5843     *
5844     * @ingroup Image
5845     */
5846    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5847
5848    /**
5849     * @}
5850     */
5851
5852    /* glview */
5853    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5854
5855    typedef enum _Elm_GLView_Mode
5856      {
5857         ELM_GLVIEW_ALPHA   = 1,
5858         ELM_GLVIEW_DEPTH   = 2,
5859         ELM_GLVIEW_STENCIL = 4
5860      } Elm_GLView_Mode;
5861
5862    /**
5863     * Defines a policy for the glview resizing.
5864     *
5865     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5866     */
5867    typedef enum _Elm_GLView_Resize_Policy
5868      {
5869         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5870         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5871      } Elm_GLView_Resize_Policy;
5872
5873    typedef enum _Elm_GLView_Render_Policy
5874      {
5875         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5876         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5877      } Elm_GLView_Render_Policy;
5878
5879    /**
5880     * @defgroup GLView
5881     *
5882     * A simple GLView widget that allows GL rendering.
5883     *
5884     * Signals that you can add callbacks for are:
5885     *
5886     * @{
5887     */
5888
5889    /**
5890     * Add a new glview to the parent
5891     *
5892     * @param parent The parent object
5893     * @return The new object or NULL if it cannot be created
5894     *
5895     * @ingroup GLView
5896     */
5897    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5898
5899    /**
5900     * Sets the size of the glview
5901     *
5902     * @param obj The glview object
5903     * @param width width of the glview object
5904     * @param height height of the glview object
5905     *
5906     * @ingroup GLView
5907     */
5908    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5909
5910    /**
5911     * Gets the size of the glview.
5912     *
5913     * @param obj The glview object
5914     * @param width width of the glview object
5915     * @param height height of the glview object
5916     *
5917     * Note that this function returns the actual image size of the
5918     * glview.  This means that when the scale policy is set to
5919     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5920     * size.
5921     *
5922     * @ingroup GLView
5923     */
5924    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5925
5926    /**
5927     * Gets the gl api struct for gl rendering
5928     *
5929     * @param obj The glview object
5930     * @return The api object or NULL if it cannot be created
5931     *
5932     * @ingroup GLView
5933     */
5934    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5935
5936    /**
5937     * Set the mode of the GLView. Supports Three simple modes.
5938     *
5939     * @param obj The glview object
5940     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5941     * @return True if set properly.
5942     *
5943     * @ingroup GLView
5944     */
5945    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5946
5947    /**
5948     * Set the resize policy for the glview object.
5949     *
5950     * @param obj The glview object.
5951     * @param policy The scaling policy.
5952     *
5953     * By default, the resize policy is set to
5954     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5955     * destroys the previous surface and recreates the newly specified
5956     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5957     * however, glview only scales the image object and not the underlying
5958     * GL Surface.
5959     *
5960     * @ingroup GLView
5961     */
5962    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5963
5964    /**
5965     * Set the render policy for the glview object.
5966     *
5967     * @param obj The glview object.
5968     * @param policy The render policy.
5969     *
5970     * By default, the render policy is set to
5971     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5972     * that during the render loop, glview is only redrawn if it needs
5973     * to be redrawn. (i.e. When it is visible) If the policy is set to
5974     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5975     * whether it is visible/need redrawing or not.
5976     *
5977     * @ingroup GLView
5978     */
5979    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5980
5981    /**
5982     * Set the init function that runs once in the main loop.
5983     *
5984     * @param obj The glview object.
5985     * @param func The init function to be registered.
5986     *
5987     * The registered init function gets called once during the render loop.
5988     *
5989     * @ingroup GLView
5990     */
5991    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5992
5993    /**
5994     * Set the render function that runs in the main loop.
5995     *
5996     * @param obj The glview object.
5997     * @param func The delete function to be registered.
5998     *
5999     * The registered del function gets called when GLView object is deleted.
6000     *
6001     * @ingroup GLView
6002     */
6003    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6004
6005    /**
6006     * Set the resize function that gets called when resize happens.
6007     *
6008     * @param obj The glview object.
6009     * @param func The resize function to be registered.
6010     *
6011     * @ingroup GLView
6012     */
6013    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6014
6015    /**
6016     * Set the render function that runs in the main loop.
6017     *
6018     * @param obj The glview object.
6019     * @param func The render function to be registered.
6020     *
6021     * @ingroup GLView
6022     */
6023    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6024
6025    /**
6026     * Notifies that there has been changes in the GLView.
6027     *
6028     * @param obj The glview object.
6029     *
6030     * @ingroup GLView
6031     */
6032    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6033
6034    /**
6035     * @}
6036     */
6037
6038    /* box */
6039    /**
6040     * @defgroup Box Box
6041     *
6042     * @image html img/widget/box/preview-00.png
6043     * @image latex img/widget/box/preview-00.eps width=\textwidth
6044     *
6045     * @image html img/box.png
6046     * @image latex img/box.eps width=\textwidth
6047     *
6048     * A box arranges objects in a linear fashion, governed by a layout function
6049     * that defines the details of this arrangement.
6050     *
6051     * By default, the box will use an internal function to set the layout to
6052     * a single row, either vertical or horizontal. This layout is affected
6053     * by a number of parameters, such as the homogeneous flag set by
6054     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
6055     * elm_box_align_set() and the hints set to each object in the box.
6056     *
6057     * For this default layout, it's possible to change the orientation with
6058     * elm_box_horizontal_set(). The box will start in the vertical orientation,
6059     * placing its elements ordered from top to bottom. When horizontal is set,
6060     * the order will go from left to right. If the box is set to be
6061     * homogeneous, every object in it will be assigned the same space, that
6062     * of the largest object. Padding can be used to set some spacing between
6063     * the cell given to each object. The alignment of the box, set with
6064     * elm_box_align_set(), determines how the bounding box of all the elements
6065     * will be placed within the space given to the box widget itself.
6066     *
6067     * The size hints of each object also affect how they are placed and sized
6068     * within the box. evas_object_size_hint_min_set() will give the minimum
6069     * size the object can have, and the box will use it as the basis for all
6070     * latter calculations. Elementary widgets set their own minimum size as
6071     * needed, so there's rarely any need to use it manually.
6072     *
6073     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
6074     * used to tell whether the object will be allocated the minimum size it
6075     * needs or if the space given to it should be expanded. It's important
6076     * to realize that expanding the size given to the object is not the same
6077     * thing as resizing the object. It could very well end being a small
6078     * widget floating in a much larger empty space. If not set, the weight
6079     * for objects will normally be 0.0 for both axis, meaning the widget will
6080     * not be expanded. To take as much space possible, set the weight to
6081     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
6082     *
6083     * Besides how much space each object is allocated, it's possible to control
6084     * how the widget will be placed within that space using
6085     * evas_object_size_hint_align_set(). By default, this value will be 0.5
6086     * for both axis, meaning the object will be centered, but any value from
6087     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
6088     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
6089     * is -1.0, means the object will be resized to fill the entire space it
6090     * was allocated.
6091     *
6092     * In addition, customized functions to define the layout can be set, which
6093     * allow the application developer to organize the objects within the box
6094     * in any number of ways.
6095     *
6096     * The special elm_box_layout_transition() function can be used
6097     * to switch from one layout to another, animating the motion of the
6098     * children of the box.
6099     *
6100     * @note Objects should not be added to box objects using _add() calls.
6101     *
6102     * Some examples on how to use boxes follow:
6103     * @li @ref box_example_01
6104     * @li @ref box_example_02
6105     *
6106     * @{
6107     */
6108    /**
6109     * @typedef Elm_Box_Transition
6110     *
6111     * Opaque handler containing the parameters to perform an animated
6112     * transition of the layout the box uses.
6113     *
6114     * @see elm_box_transition_new()
6115     * @see elm_box_layout_set()
6116     * @see elm_box_layout_transition()
6117     */
6118    typedef struct _Elm_Box_Transition Elm_Box_Transition;
6119
6120    /**
6121     * Add a new box to the parent
6122     *
6123     * By default, the box will be in vertical mode and non-homogeneous.
6124     *
6125     * @param parent The parent object
6126     * @return The new object or NULL if it cannot be created
6127     */
6128    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6129    /**
6130     * Set the horizontal orientation
6131     *
6132     * By default, box object arranges their contents vertically from top to
6133     * bottom.
6134     * By calling this function with @p horizontal as EINA_TRUE, the box will
6135     * become horizontal, arranging contents from left to right.
6136     *
6137     * @note This flag is ignored if a custom layout function is set.
6138     *
6139     * @param obj The box object
6140     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
6141     * EINA_FALSE = vertical)
6142     */
6143    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6144    /**
6145     * Get the horizontal orientation
6146     *
6147     * @param obj The box object
6148     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
6149     */
6150    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6151    /**
6152     * Set the box to arrange its children homogeneously
6153     *
6154     * If enabled, homogeneous layout makes all items the same size, according
6155     * to the size of the largest of its children.
6156     *
6157     * @note This flag is ignored if a custom layout function is set.
6158     *
6159     * @param obj The box object
6160     * @param homogeneous The homogeneous flag
6161     */
6162    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6163    /**
6164     * Get whether the box is using homogeneous mode or not
6165     *
6166     * @param obj The box object
6167     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
6168     */
6169    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6170    /**
6171     * Add an object to the beginning of the pack list
6172     *
6173     * Pack @p subobj into the box @p obj, placing it first in the list of
6174     * children objects. The actual position the object will get on screen
6175     * depends on the layout used. If no custom layout is set, it will be at
6176     * the top or left, depending if the box is vertical or horizontal,
6177     * respectively.
6178     *
6179     * @param obj The box object
6180     * @param subobj The object to add to the box
6181     *
6182     * @see elm_box_pack_end()
6183     * @see elm_box_pack_before()
6184     * @see elm_box_pack_after()
6185     * @see elm_box_unpack()
6186     * @see elm_box_unpack_all()
6187     * @see elm_box_clear()
6188     */
6189    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6190    /**
6191     * Add an object at the end of the pack list
6192     *
6193     * Pack @p subobj into the box @p obj, placing it last in the list of
6194     * children objects. The actual position the object will get on screen
6195     * depends on the layout used. If no custom layout is set, it will be at
6196     * the bottom or right, depending if the box is vertical or horizontal,
6197     * respectively.
6198     *
6199     * @param obj The box object
6200     * @param subobj The object to add to the box
6201     *
6202     * @see elm_box_pack_start()
6203     * @see elm_box_pack_before()
6204     * @see elm_box_pack_after()
6205     * @see elm_box_unpack()
6206     * @see elm_box_unpack_all()
6207     * @see elm_box_clear()
6208     */
6209    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6210    /**
6211     * Adds an object to the box before the indicated object
6212     *
6213     * This will add the @p subobj to the box indicated before the object
6214     * indicated with @p before. If @p before is not already in the box, results
6215     * are undefined. Before means either to the left of the indicated object or
6216     * above it depending on orientation.
6217     *
6218     * @param obj The box object
6219     * @param subobj The object to add to the box
6220     * @param before The object before which to add it
6221     *
6222     * @see elm_box_pack_start()
6223     * @see elm_box_pack_end()
6224     * @see elm_box_pack_after()
6225     * @see elm_box_unpack()
6226     * @see elm_box_unpack_all()
6227     * @see elm_box_clear()
6228     */
6229    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6230    /**
6231     * Adds an object to the box after the indicated object
6232     *
6233     * This will add the @p subobj to the box indicated after the object
6234     * indicated with @p after. If @p after is not already in the box, results
6235     * are undefined. After means either to the right of the indicated object or
6236     * below it depending on orientation.
6237     *
6238     * @param obj The box object
6239     * @param subobj The object to add to the box
6240     * @param after The object after which to add it
6241     *
6242     * @see elm_box_pack_start()
6243     * @see elm_box_pack_end()
6244     * @see elm_box_pack_before()
6245     * @see elm_box_unpack()
6246     * @see elm_box_unpack_all()
6247     * @see elm_box_clear()
6248     */
6249    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6250    /**
6251     * Clear the box of all children
6252     *
6253     * Remove all the elements contained by the box, deleting the respective
6254     * objects.
6255     *
6256     * @param obj The box object
6257     *
6258     * @see elm_box_unpack()
6259     * @see elm_box_unpack_all()
6260     */
6261    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6262    /**
6263     * Unpack a box item
6264     *
6265     * Remove the object given by @p subobj from the box @p obj without
6266     * deleting it.
6267     *
6268     * @param obj The box object
6269     *
6270     * @see elm_box_unpack_all()
6271     * @see elm_box_clear()
6272     */
6273    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6274    /**
6275     * Remove all items from the box, without deleting them
6276     *
6277     * Clear the box from all children, but don't delete the respective objects.
6278     * If no other references of the box children exist, the objects will never
6279     * be deleted, and thus the application will leak the memory. Make sure
6280     * when using this function that you hold a reference to all the objects
6281     * in the box @p obj.
6282     *
6283     * @param obj The box object
6284     *
6285     * @see elm_box_clear()
6286     * @see elm_box_unpack()
6287     */
6288    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6289    /**
6290     * Retrieve a list of the objects packed into the box
6291     *
6292     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6293     * The order of the list corresponds to the packing order the box uses.
6294     *
6295     * You must free this list with eina_list_free() once you are done with it.
6296     *
6297     * @param obj The box object
6298     */
6299    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6300    /**
6301     * Set the space (padding) between the box's elements.
6302     *
6303     * Extra space in pixels that will be added between a box child and its
6304     * neighbors after its containing cell has been calculated. This padding
6305     * is set for all elements in the box, besides any possible padding that
6306     * individual elements may have through their size hints.
6307     *
6308     * @param obj The box object
6309     * @param horizontal The horizontal space between elements
6310     * @param vertical The vertical space between elements
6311     */
6312    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6313    /**
6314     * Get the space (padding) between the box's elements.
6315     *
6316     * @param obj The box object
6317     * @param horizontal The horizontal space between elements
6318     * @param vertical The vertical space between elements
6319     *
6320     * @see elm_box_padding_set()
6321     */
6322    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6323    /**
6324     * Set the alignment of the whole bouding box of contents.
6325     *
6326     * Sets how the bounding box containing all the elements of the box, after
6327     * their sizes and position has been calculated, will be aligned within
6328     * the space given for the whole box widget.
6329     *
6330     * @param obj The box object
6331     * @param horizontal The horizontal alignment of elements
6332     * @param vertical The vertical alignment of elements
6333     */
6334    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6335    /**
6336     * Get the alignment of the whole bouding box of contents.
6337     *
6338     * @param obj The box object
6339     * @param horizontal The horizontal alignment of elements
6340     * @param vertical The vertical alignment of elements
6341     *
6342     * @see elm_box_align_set()
6343     */
6344    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6345
6346    /**
6347     * Force the box to recalculate its children packing.
6348     *
6349     * If any children was added or removed, box will not calculate the
6350     * values immediately rather leaving it to the next main loop
6351     * iteration. While this is great as it would save lots of
6352     * recalculation, whenever you need to get the position of a just
6353     * added item you must force recalculate before doing so.
6354     *
6355     * @param obj The box object.
6356     */
6357    EAPI void                 elm_box_recalculate(Evas_Object *obj);
6358
6359    /**
6360     * Set the layout defining function to be used by the box
6361     *
6362     * Whenever anything changes that requires the box in @p obj to recalculate
6363     * the size and position of its elements, the function @p cb will be called
6364     * to determine what the layout of the children will be.
6365     *
6366     * Once a custom function is set, everything about the children layout
6367     * is defined by it. The flags set by elm_box_horizontal_set() and
6368     * elm_box_homogeneous_set() no longer have any meaning, and the values
6369     * given by elm_box_padding_set() and elm_box_align_set() are up to this
6370     * layout function to decide if they are used and how. These last two
6371     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6372     * passed to @p cb. The @c Evas_Object the function receives is not the
6373     * Elementary widget, but the internal Evas Box it uses, so none of the
6374     * functions described here can be used on it.
6375     *
6376     * Any of the layout functions in @c Evas can be used here, as well as the
6377     * special elm_box_layout_transition().
6378     *
6379     * The final @p data argument received by @p cb is the same @p data passed
6380     * here, and the @p free_data function will be called to free it
6381     * whenever the box is destroyed or another layout function is set.
6382     *
6383     * Setting @p cb to NULL will revert back to the default layout function.
6384     *
6385     * @param obj The box object
6386     * @param cb The callback function used for layout
6387     * @param data Data that will be passed to layout function
6388     * @param free_data Function called to free @p data
6389     *
6390     * @see elm_box_layout_transition()
6391     */
6392    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);
6393    /**
6394     * Special layout function that animates the transition from one layout to another
6395     *
6396     * Normally, when switching the layout function for a box, this will be
6397     * reflected immediately on screen on the next render, but it's also
6398     * possible to do this through an animated transition.
6399     *
6400     * This is done by creating an ::Elm_Box_Transition and setting the box
6401     * layout to this function.
6402     *
6403     * For example:
6404     * @code
6405     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6406     *                            evas_object_box_layout_vertical, // start
6407     *                            NULL, // data for initial layout
6408     *                            NULL, // free function for initial data
6409     *                            evas_object_box_layout_horizontal, // end
6410     *                            NULL, // data for final layout
6411     *                            NULL, // free function for final data
6412     *                            anim_end, // will be called when animation ends
6413     *                            NULL); // data for anim_end function\
6414     * elm_box_layout_set(box, elm_box_layout_transition, t,
6415     *                    elm_box_transition_free);
6416     * @endcode
6417     *
6418     * @note This function can only be used with elm_box_layout_set(). Calling
6419     * it directly will not have the expected results.
6420     *
6421     * @see elm_box_transition_new
6422     * @see elm_box_transition_free
6423     * @see elm_box_layout_set
6424     */
6425    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6426    /**
6427     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6428     *
6429     * If you want to animate the change from one layout to another, you need
6430     * to set the layout function of the box to elm_box_layout_transition(),
6431     * passing as user data to it an instance of ::Elm_Box_Transition with the
6432     * necessary information to perform this animation. The free function to
6433     * set for the layout is elm_box_transition_free().
6434     *
6435     * The parameters to create an ::Elm_Box_Transition sum up to how long
6436     * will it be, in seconds, a layout function to describe the initial point,
6437     * another for the final position of the children and one function to be
6438     * called when the whole animation ends. This last function is useful to
6439     * set the definitive layout for the box, usually the same as the end
6440     * layout for the animation, but could be used to start another transition.
6441     *
6442     * @param start_layout The layout function that will be used to start the animation
6443     * @param start_layout_data The data to be passed the @p start_layout function
6444     * @param start_layout_free_data Function to free @p start_layout_data
6445     * @param end_layout The layout function that will be used to end the animation
6446     * @param end_layout_free_data The data to be passed the @p end_layout function
6447     * @param end_layout_free_data Function to free @p end_layout_data
6448     * @param transition_end_cb Callback function called when animation ends
6449     * @param transition_end_data Data to be passed to @p transition_end_cb
6450     * @return An instance of ::Elm_Box_Transition
6451     *
6452     * @see elm_box_transition_new
6453     * @see elm_box_layout_transition
6454     */
6455    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);
6456    /**
6457     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6458     *
6459     * This function is mostly useful as the @c free_data parameter in
6460     * elm_box_layout_set() when elm_box_layout_transition().
6461     *
6462     * @param data The Elm_Box_Transition instance to be freed.
6463     *
6464     * @see elm_box_transition_new
6465     * @see elm_box_layout_transition
6466     */
6467    EAPI void                elm_box_transition_free(void *data);
6468    /**
6469     * @}
6470     */
6471
6472    /* button */
6473    /**
6474     * @defgroup Button Button
6475     *
6476     * @image html img/widget/button/preview-00.png
6477     * @image latex img/widget/button/preview-00.eps
6478     * @image html img/widget/button/preview-01.png
6479     * @image latex img/widget/button/preview-01.eps
6480     * @image html img/widget/button/preview-02.png
6481     * @image latex img/widget/button/preview-02.eps
6482     *
6483     * This is a push-button. Press it and run some function. It can contain
6484     * a simple label and icon object and it also has an autorepeat feature.
6485     *
6486     * This widgets emits the following signals:
6487     * @li "clicked": the user clicked the button (press/release).
6488     * @li "repeated": the user pressed the button without releasing it.
6489     * @li "pressed": button was pressed.
6490     * @li "unpressed": button was released after being pressed.
6491     * In all three cases, the @c event parameter of the callback will be
6492     * @c NULL.
6493     *
6494     * Also, defined in the default theme, the button has the following styles
6495     * available:
6496     * @li default: a normal button.
6497     * @li anchor: Like default, but the button fades away when the mouse is not
6498     * over it, leaving only the text or icon.
6499     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6500     * continuous look across its options.
6501     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6502     *
6503     * Default contents parts of the button widget that you can use for are:
6504     * @li "icon" - An icon of the button
6505     *
6506     * Default text parts of the button widget that you can use for are:
6507     * @li "default" - Label of the button
6508     *
6509     * Follow through a complete example @ref button_example_01 "here".
6510     * @{
6511     */
6512    /**
6513     * Add a new button to the parent's canvas
6514     *
6515     * @param parent The parent object
6516     * @return The new object or NULL if it cannot be created
6517     */
6518    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6519    /**
6520     * Set the label used in the button
6521     *
6522     * The passed @p label can be NULL to clean any existing text in it and
6523     * leave the button as an icon only object.
6524     *
6525     * @param obj The button object
6526     * @param label The text will be written on the button
6527     * @deprecated use elm_object_text_set() instead.
6528     */
6529    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6530    /**
6531     * Get the label set for the button
6532     *
6533     * The string returned is an internal pointer and should not be freed or
6534     * altered. It will also become invalid when the button is destroyed.
6535     * The string returned, if not NULL, is a stringshare, so if you need to
6536     * keep it around even after the button is destroyed, you can use
6537     * eina_stringshare_ref().
6538     *
6539     * @param obj The button object
6540     * @return The text set to the label, or NULL if nothing is set
6541     * @deprecated use elm_object_text_set() instead.
6542     */
6543    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6544    /**
6545     * Set the icon used for the button
6546     *
6547     * Setting a new icon will delete any other that was previously set, making
6548     * any reference to them invalid. If you need to maintain the previous
6549     * object alive, unset it first with elm_button_icon_unset().
6550     *
6551     * @param obj The button object
6552     * @param icon The icon object for the button
6553     * @deprecated use elm_object_part_content_set() instead.
6554     */
6555    EINA_DEPRECATED EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6556    /**
6557     * Get the icon used for the button
6558     *
6559     * Return the icon object which is set for this widget. If the button is
6560     * destroyed or another icon is set, the returned object will be deleted
6561     * and any reference to it will be invalid.
6562     *
6563     * @param obj The button object
6564     * @return The icon object that is being used
6565     *
6566     * @deprecated use elm_object_part_content_get() instead
6567     */
6568    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6569    /**
6570     * Remove the icon set without deleting it and return the object
6571     *
6572     * This function drops the reference the button holds of the icon object
6573     * and returns this last object. It is used in case you want to remove any
6574     * icon, or set another one, without deleting the actual object. The button
6575     * will be left without an icon set.
6576     *
6577     * @param obj The button object
6578     * @return The icon object that was being used
6579     * @deprecated use elm_object_part_content_unset() instead.
6580     */
6581    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6582    /**
6583     * Turn on/off the autorepeat event generated when the button is kept pressed
6584     *
6585     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6586     * signal when they are clicked.
6587     *
6588     * When on, keeping a button pressed will continuously emit a @c repeated
6589     * signal until the button is released. The time it takes until it starts
6590     * emitting the signal is given by
6591     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6592     * new emission by elm_button_autorepeat_gap_timeout_set().
6593     *
6594     * @param obj The button object
6595     * @param on  A bool to turn on/off the event
6596     */
6597    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6598    /**
6599     * Get whether the autorepeat feature is enabled
6600     *
6601     * @param obj The button object
6602     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6603     *
6604     * @see elm_button_autorepeat_set()
6605     */
6606    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6607    /**
6608     * Set the initial timeout before the autorepeat event is generated
6609     *
6610     * Sets the timeout, in seconds, since the button is pressed until the
6611     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6612     * won't be any delay and the even will be fired the moment the button is
6613     * pressed.
6614     *
6615     * @param obj The button object
6616     * @param t   Timeout in seconds
6617     *
6618     * @see elm_button_autorepeat_set()
6619     * @see elm_button_autorepeat_gap_timeout_set()
6620     */
6621    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6622    /**
6623     * Get the initial timeout before the autorepeat event is generated
6624     *
6625     * @param obj The button object
6626     * @return Timeout in seconds
6627     *
6628     * @see elm_button_autorepeat_initial_timeout_set()
6629     */
6630    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6631    /**
6632     * Set the interval between each generated autorepeat event
6633     *
6634     * After the first @c repeated event is fired, all subsequent ones will
6635     * follow after a delay of @p t seconds for each.
6636     *
6637     * @param obj The button object
6638     * @param t   Interval in seconds
6639     *
6640     * @see elm_button_autorepeat_initial_timeout_set()
6641     */
6642    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6643    /**
6644     * Get the interval between each generated autorepeat event
6645     *
6646     * @param obj The button object
6647     * @return Interval in seconds
6648     */
6649    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6650    /**
6651     * @}
6652     */
6653
6654    /**
6655     * @defgroup File_Selector_Button File Selector Button
6656     *
6657     * @image html img/widget/fileselector_button/preview-00.png
6658     * @image latex img/widget/fileselector_button/preview-00.eps
6659     * @image html img/widget/fileselector_button/preview-01.png
6660     * @image latex img/widget/fileselector_button/preview-01.eps
6661     * @image html img/widget/fileselector_button/preview-02.png
6662     * @image latex img/widget/fileselector_button/preview-02.eps
6663     *
6664     * This is a button that, when clicked, creates an Elementary
6665     * window (or inner window) <b> with a @ref Fileselector "file
6666     * selector widget" within</b>. When a file is chosen, the (inner)
6667     * window is closed and the button emits a signal having the
6668     * selected file as it's @c event_info.
6669     *
6670     * This widget encapsulates operations on its internal file
6671     * selector on its own API. There is less control over its file
6672     * selector than that one would have instatiating one directly.
6673     *
6674     * The following styles are available for this button:
6675     * @li @c "default"
6676     * @li @c "anchor"
6677     * @li @c "hoversel_vertical"
6678     * @li @c "hoversel_vertical_entry"
6679     *
6680     * Smart callbacks one can register to:
6681     * - @c "file,chosen" - the user has selected a path, whose string
6682     *   pointer comes as the @c event_info data (a stringshared
6683     *   string)
6684     *
6685     * Here is an example on its usage:
6686     * @li @ref fileselector_button_example
6687     *
6688     * @see @ref File_Selector_Entry for a similar widget.
6689     * @{
6690     */
6691
6692    /**
6693     * Add a new file selector button widget to the given parent
6694     * Elementary (container) object
6695     *
6696     * @param parent The parent object
6697     * @return a new file selector button widget handle or @c NULL, on
6698     * errors
6699     */
6700    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6701
6702    /**
6703     * Set the label for a given file selector button widget
6704     *
6705     * @param obj The file selector button widget
6706     * @param label The text label to be displayed on @p obj
6707     *
6708     * @deprecated use elm_object_text_set() instead.
6709     */
6710    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6711
6712    /**
6713     * Get the label set for a given file selector button widget
6714     *
6715     * @param obj The file selector button widget
6716     * @return The button label
6717     *
6718     * @deprecated use elm_object_text_set() instead.
6719     */
6720    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6721
6722    /**
6723     * Set the icon on a given file selector button widget
6724     *
6725     * @param obj The file selector button widget
6726     * @param icon The icon object for the button
6727     *
6728     * Once the icon object is set, a previously set one will be
6729     * deleted. If you want to keep the latter, use the
6730     * elm_fileselector_button_icon_unset() function.
6731     *
6732     * @see elm_fileselector_button_icon_get()
6733     */
6734    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6735
6736    /**
6737     * Get the icon set for a given file selector button widget
6738     *
6739     * @param obj The file selector button widget
6740     * @return The icon object currently set on @p obj or @c NULL, if
6741     * none is
6742     *
6743     * @see elm_fileselector_button_icon_set()
6744     */
6745    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6746
6747    /**
6748     * Unset the icon used in a given file selector button widget
6749     *
6750     * @param obj The file selector button widget
6751     * @return The icon object that was being used on @p obj or @c
6752     * NULL, on errors
6753     *
6754     * Unparent and return the icon object which was set for this
6755     * widget.
6756     *
6757     * @see elm_fileselector_button_icon_set()
6758     */
6759    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6760
6761    /**
6762     * Set the title for a given file selector button widget's window
6763     *
6764     * @param obj The file selector button widget
6765     * @param title The title string
6766     *
6767     * This will change the window's title, when the file selector pops
6768     * out after a click on the button. Those windows have the default
6769     * (unlocalized) value of @c "Select a file" as titles.
6770     *
6771     * @note It will only take any effect if the file selector
6772     * button widget is @b not under "inwin mode".
6773     *
6774     * @see elm_fileselector_button_window_title_get()
6775     */
6776    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6777
6778    /**
6779     * Get the title set for a given file selector button widget's
6780     * window
6781     *
6782     * @param obj The file selector button widget
6783     * @return Title of the file selector button's window
6784     *
6785     * @see elm_fileselector_button_window_title_get() for more details
6786     */
6787    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6788
6789    /**
6790     * Set the size of a given file selector button widget's window,
6791     * holding the file selector itself.
6792     *
6793     * @param obj The file selector button widget
6794     * @param width The window's width
6795     * @param height The window's height
6796     *
6797     * @note it will only take any effect if the file selector button
6798     * widget is @b not under "inwin mode". The default size for the
6799     * window (when applicable) is 400x400 pixels.
6800     *
6801     * @see elm_fileselector_button_window_size_get()
6802     */
6803    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6804
6805    /**
6806     * Get the size of a given file selector button widget's window,
6807     * holding the file selector itself.
6808     *
6809     * @param obj The file selector button widget
6810     * @param width Pointer into which to store the width value
6811     * @param height Pointer into which to store the height value
6812     *
6813     * @note Use @c NULL pointers on the size values you're not
6814     * interested in: they'll be ignored by the function.
6815     *
6816     * @see elm_fileselector_button_window_size_set(), for more details
6817     */
6818    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6819
6820    /**
6821     * Set the initial file system path for a given file selector
6822     * button widget
6823     *
6824     * @param obj The file selector button widget
6825     * @param path The path string
6826     *
6827     * It must be a <b>directory</b> path, which will have the contents
6828     * displayed initially in the file selector's view, when invoked
6829     * from @p obj. The default initial path is the @c "HOME"
6830     * environment variable's value.
6831     *
6832     * @see elm_fileselector_button_path_get()
6833     */
6834    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6835
6836    /**
6837     * Get the initial file system path set for a given file selector
6838     * button widget
6839     *
6840     * @param obj The file selector button widget
6841     * @return path The path string
6842     *
6843     * @see elm_fileselector_button_path_set() for more details
6844     */
6845    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6846
6847    /**
6848     * Enable/disable a tree view in the given file selector button
6849     * widget's internal file selector
6850     *
6851     * @param obj The file selector button widget
6852     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6853     * disable
6854     *
6855     * This has the same effect as elm_fileselector_expandable_set(),
6856     * but now applied to a file selector button's internal file
6857     * selector.
6858     *
6859     * @note There's no way to put a file selector button's internal
6860     * file selector in "grid mode", as one may do with "pure" file
6861     * selectors.
6862     *
6863     * @see elm_fileselector_expandable_get()
6864     */
6865    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6866
6867    /**
6868     * Get whether tree view is enabled for the given file selector
6869     * button widget's internal file selector
6870     *
6871     * @param obj The file selector button widget
6872     * @return @c EINA_TRUE if @p obj widget's internal file selector
6873     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6874     *
6875     * @see elm_fileselector_expandable_set() for more details
6876     */
6877    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6878
6879    /**
6880     * Set whether a given file selector button widget's internal file
6881     * selector is to display folders only or the directory contents,
6882     * as well.
6883     *
6884     * @param obj The file selector button widget
6885     * @param only @c EINA_TRUE to make @p obj widget's internal file
6886     * selector only display directories, @c EINA_FALSE to make files
6887     * to be displayed in it too
6888     *
6889     * This has the same effect as elm_fileselector_folder_only_set(),
6890     * but now applied to a file selector button's internal file
6891     * selector.
6892     *
6893     * @see elm_fileselector_folder_only_get()
6894     */
6895    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6896
6897    /**
6898     * Get whether a given file selector button widget's internal file
6899     * selector is displaying folders only or the directory contents,
6900     * as well.
6901     *
6902     * @param obj The file selector button widget
6903     * @return @c EINA_TRUE if @p obj widget's internal file
6904     * selector is only displaying directories, @c EINA_FALSE if files
6905     * are being displayed in it too (and on errors)
6906     *
6907     * @see elm_fileselector_button_folder_only_set() for more details
6908     */
6909    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6910
6911    /**
6912     * Enable/disable the file name entry box where the user can type
6913     * in a name for a file, in a given file selector button widget's
6914     * internal file selector.
6915     *
6916     * @param obj The file selector button widget
6917     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6918     * file selector a "saving dialog", @c EINA_FALSE otherwise
6919     *
6920     * This has the same effect as elm_fileselector_is_save_set(),
6921     * but now applied to a file selector button's internal file
6922     * selector.
6923     *
6924     * @see elm_fileselector_is_save_get()
6925     */
6926    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6927
6928    /**
6929     * Get whether the given file selector button widget's internal
6930     * file selector is in "saving dialog" mode
6931     *
6932     * @param obj The file selector button widget
6933     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6934     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6935     * errors)
6936     *
6937     * @see elm_fileselector_button_is_save_set() for more details
6938     */
6939    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6940
6941    /**
6942     * Set whether a given file selector button widget's internal file
6943     * selector will raise an Elementary "inner window", instead of a
6944     * dedicated Elementary window. By default, it won't.
6945     *
6946     * @param obj The file selector button widget
6947     * @param value @c EINA_TRUE to make it use an inner window, @c
6948     * EINA_TRUE to make it use a dedicated window
6949     *
6950     * @see elm_win_inwin_add() for more information on inner windows
6951     * @see elm_fileselector_button_inwin_mode_get()
6952     */
6953    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6954
6955    /**
6956     * Get whether a given file selector button widget's internal file
6957     * selector will raise an Elementary "inner window", instead of a
6958     * dedicated Elementary window.
6959     *
6960     * @param obj The file selector button widget
6961     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6962     * if it will use a dedicated window
6963     *
6964     * @see elm_fileselector_button_inwin_mode_set() for more details
6965     */
6966    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6967
6968    /**
6969     * @}
6970     */
6971
6972     /**
6973     * @defgroup File_Selector_Entry File Selector Entry
6974     *
6975     * @image html img/widget/fileselector_entry/preview-00.png
6976     * @image latex img/widget/fileselector_entry/preview-00.eps
6977     *
6978     * This is an entry made to be filled with or display a <b>file
6979     * system path string</b>. Besides the entry itself, the widget has
6980     * a @ref File_Selector_Button "file selector button" on its side,
6981     * which will raise an internal @ref Fileselector "file selector widget",
6982     * when clicked, for path selection aided by file system
6983     * navigation.
6984     *
6985     * This file selector may appear in an Elementary window or in an
6986     * inner window. When a file is chosen from it, the (inner) window
6987     * is closed and the selected file's path string is exposed both as
6988     * an smart event and as the new text on the entry.
6989     *
6990     * This widget encapsulates operations on its internal file
6991     * selector on its own API. There is less control over its file
6992     * selector than that one would have instatiating one directly.
6993     *
6994     * Smart callbacks one can register to:
6995     * - @c "changed" - The text within the entry was changed
6996     * - @c "activated" - The entry has had editing finished and
6997     *   changes are to be "committed"
6998     * - @c "press" - The entry has been clicked
6999     * - @c "longpressed" - The entry has been clicked (and held) for a
7000     *   couple seconds
7001     * - @c "clicked" - The entry has been clicked
7002     * - @c "clicked,double" - The entry has been double clicked
7003     * - @c "focused" - The entry has received focus
7004     * - @c "unfocused" - The entry has lost focus
7005     * - @c "selection,paste" - A paste action has occurred on the
7006     *   entry
7007     * - @c "selection,copy" - A copy action has occurred on the entry
7008     * - @c "selection,cut" - A cut action has occurred on the entry
7009     * - @c "unpressed" - The file selector entry's button was released
7010     *   after being pressed.
7011     * - @c "file,chosen" - The user has selected a path via the file
7012     *   selector entry's internal file selector, whose string pointer
7013     *   comes as the @c event_info data (a stringshared string)
7014     *
7015     * Here is an example on its usage:
7016     * @li @ref fileselector_entry_example
7017     *
7018     * @see @ref File_Selector_Button for a similar widget.
7019     * @{
7020     */
7021
7022    /**
7023     * Add a new file selector entry widget to the given parent
7024     * Elementary (container) object
7025     *
7026     * @param parent The parent object
7027     * @return a new file selector entry widget handle or @c NULL, on
7028     * errors
7029     */
7030    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7031
7032    /**
7033     * Set the label for a given file selector entry widget's button
7034     *
7035     * @param obj The file selector entry widget
7036     * @param label The text label to be displayed on @p obj widget's
7037     * button
7038     *
7039     * @deprecated use elm_object_text_set() instead.
7040     */
7041    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7042
7043    /**
7044     * Get the label set for a given file selector entry widget's button
7045     *
7046     * @param obj The file selector entry widget
7047     * @return The widget button's label
7048     *
7049     * @deprecated use elm_object_text_set() instead.
7050     */
7051    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7052
7053    /**
7054     * Set the icon on a given file selector entry widget's button
7055     *
7056     * @param obj The file selector entry widget
7057     * @param icon The icon object for the entry's button
7058     *
7059     * Once the icon object is set, a previously set one will be
7060     * deleted. If you want to keep the latter, use the
7061     * elm_fileselector_entry_button_icon_unset() function.
7062     *
7063     * @see elm_fileselector_entry_button_icon_get()
7064     */
7065    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7066
7067    /**
7068     * Get the icon set for a given file selector entry widget's button
7069     *
7070     * @param obj The file selector entry widget
7071     * @return The icon object currently set on @p obj widget's button
7072     * or @c NULL, if none is
7073     *
7074     * @see elm_fileselector_entry_button_icon_set()
7075     */
7076    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7077
7078    /**
7079     * Unset the icon used in a given file selector entry widget's
7080     * button
7081     *
7082     * @param obj The file selector entry widget
7083     * @return The icon object that was being used on @p obj widget's
7084     * button or @c NULL, on errors
7085     *
7086     * Unparent and return the icon object which was set for this
7087     * widget's button.
7088     *
7089     * @see elm_fileselector_entry_button_icon_set()
7090     */
7091    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7092
7093    /**
7094     * Set the title for a given file selector entry widget's window
7095     *
7096     * @param obj The file selector entry widget
7097     * @param title The title string
7098     *
7099     * This will change the window's title, when the file selector pops
7100     * out after a click on the entry's button. Those windows have the
7101     * default (unlocalized) value of @c "Select a file" as titles.
7102     *
7103     * @note It will only take any effect if the file selector
7104     * entry widget is @b not under "inwin mode".
7105     *
7106     * @see elm_fileselector_entry_window_title_get()
7107     */
7108    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
7109
7110    /**
7111     * Get the title set for a given file selector entry widget's
7112     * window
7113     *
7114     * @param obj The file selector entry widget
7115     * @return Title of the file selector entry's window
7116     *
7117     * @see elm_fileselector_entry_window_title_get() for more details
7118     */
7119    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7120
7121    /**
7122     * Set the size of a given file selector entry widget's window,
7123     * holding the file selector itself.
7124     *
7125     * @param obj The file selector entry widget
7126     * @param width The window's width
7127     * @param height The window's height
7128     *
7129     * @note it will only take any effect if the file selector entry
7130     * widget is @b not under "inwin mode". The default size for the
7131     * window (when applicable) is 400x400 pixels.
7132     *
7133     * @see elm_fileselector_entry_window_size_get()
7134     */
7135    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7136
7137    /**
7138     * Get the size of a given file selector entry widget's window,
7139     * holding the file selector itself.
7140     *
7141     * @param obj The file selector entry widget
7142     * @param width Pointer into which to store the width value
7143     * @param height Pointer into which to store the height value
7144     *
7145     * @note Use @c NULL pointers on the size values you're not
7146     * interested in: they'll be ignored by the function.
7147     *
7148     * @see elm_fileselector_entry_window_size_set(), for more details
7149     */
7150    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7151
7152    /**
7153     * Set the initial file system path and the entry's path string for
7154     * a given file selector entry widget
7155     *
7156     * @param obj The file selector entry widget
7157     * @param path The path string
7158     *
7159     * It must be a <b>directory</b> path, which will have the contents
7160     * displayed initially in the file selector's view, when invoked
7161     * from @p obj. The default initial path is the @c "HOME"
7162     * environment variable's value.
7163     *
7164     * @see elm_fileselector_entry_path_get()
7165     */
7166    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7167
7168    /**
7169     * Get the entry's path string for a given file selector entry
7170     * widget
7171     *
7172     * @param obj The file selector entry widget
7173     * @return path The path string
7174     *
7175     * @see elm_fileselector_entry_path_set() for more details
7176     */
7177    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7178
7179    /**
7180     * Enable/disable a tree view in the given file selector entry
7181     * widget's internal file selector
7182     *
7183     * @param obj The file selector entry widget
7184     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7185     * disable
7186     *
7187     * This has the same effect as elm_fileselector_expandable_set(),
7188     * but now applied to a file selector entry's internal file
7189     * selector.
7190     *
7191     * @note There's no way to put a file selector entry's internal
7192     * file selector in "grid mode", as one may do with "pure" file
7193     * selectors.
7194     *
7195     * @see elm_fileselector_expandable_get()
7196     */
7197    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7198
7199    /**
7200     * Get whether tree view is enabled for the given file selector
7201     * entry widget's internal file selector
7202     *
7203     * @param obj The file selector entry widget
7204     * @return @c EINA_TRUE if @p obj widget's internal file selector
7205     * is in tree view, @c EINA_FALSE otherwise (and or errors)
7206     *
7207     * @see elm_fileselector_expandable_set() for more details
7208     */
7209    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7210
7211    /**
7212     * Set whether a given file selector entry widget's internal file
7213     * selector is to display folders only or the directory contents,
7214     * as well.
7215     *
7216     * @param obj The file selector entry widget
7217     * @param only @c EINA_TRUE to make @p obj widget's internal file
7218     * selector only display directories, @c EINA_FALSE to make files
7219     * to be displayed in it too
7220     *
7221     * This has the same effect as elm_fileselector_folder_only_set(),
7222     * but now applied to a file selector entry's internal file
7223     * selector.
7224     *
7225     * @see elm_fileselector_folder_only_get()
7226     */
7227    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7228
7229    /**
7230     * Get whether a given file selector entry widget's internal file
7231     * selector is displaying folders only or the directory contents,
7232     * as well.
7233     *
7234     * @param obj The file selector entry widget
7235     * @return @c EINA_TRUE if @p obj widget's internal file
7236     * selector is only displaying directories, @c EINA_FALSE if files
7237     * are being displayed in it too (and on errors)
7238     *
7239     * @see elm_fileselector_entry_folder_only_set() for more details
7240     */
7241    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7242
7243    /**
7244     * Enable/disable the file name entry box where the user can type
7245     * in a name for a file, in a given file selector entry widget's
7246     * internal file selector.
7247     *
7248     * @param obj The file selector entry widget
7249     * @param is_save @c EINA_TRUE to make @p obj widget's internal
7250     * file selector a "saving dialog", @c EINA_FALSE otherwise
7251     *
7252     * This has the same effect as elm_fileselector_is_save_set(),
7253     * but now applied to a file selector entry's internal file
7254     * selector.
7255     *
7256     * @see elm_fileselector_is_save_get()
7257     */
7258    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7259
7260    /**
7261     * Get whether the given file selector entry widget's internal
7262     * file selector is in "saving dialog" mode
7263     *
7264     * @param obj The file selector entry widget
7265     * @return @c EINA_TRUE, if @p obj widget's internal file selector
7266     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7267     * errors)
7268     *
7269     * @see elm_fileselector_entry_is_save_set() for more details
7270     */
7271    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7272
7273    /**
7274     * Set whether a given file selector entry widget's internal file
7275     * selector will raise an Elementary "inner window", instead of a
7276     * dedicated Elementary window. By default, it won't.
7277     *
7278     * @param obj The file selector entry widget
7279     * @param value @c EINA_TRUE to make it use an inner window, @c
7280     * EINA_TRUE to make it use a dedicated window
7281     *
7282     * @see elm_win_inwin_add() for more information on inner windows
7283     * @see elm_fileselector_entry_inwin_mode_get()
7284     */
7285    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7286
7287    /**
7288     * Get whether a given file selector entry widget's internal file
7289     * selector will raise an Elementary "inner window", instead of a
7290     * dedicated Elementary window.
7291     *
7292     * @param obj The file selector entry widget
7293     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7294     * if it will use a dedicated window
7295     *
7296     * @see elm_fileselector_entry_inwin_mode_set() for more details
7297     */
7298    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7299
7300    /**
7301     * Set the initial file system path for a given file selector entry
7302     * widget
7303     *
7304     * @param obj The file selector entry widget
7305     * @param path The path string
7306     *
7307     * It must be a <b>directory</b> path, which will have the contents
7308     * displayed initially in the file selector's view, when invoked
7309     * from @p obj. The default initial path is the @c "HOME"
7310     * environment variable's value.
7311     *
7312     * @see elm_fileselector_entry_path_get()
7313     */
7314    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7315
7316    /**
7317     * Get the parent directory's path to the latest file selection on
7318     * a given filer selector entry widget
7319     *
7320     * @param obj The file selector object
7321     * @return The (full) path of the directory of the last selection
7322     * on @p obj widget, a @b stringshared string
7323     *
7324     * @see elm_fileselector_entry_path_set()
7325     */
7326    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7327
7328    /**
7329     * @}
7330     */
7331
7332    /**
7333     * @defgroup Scroller Scroller
7334     *
7335     * A scroller holds a single object and "scrolls it around". This means that
7336     * it allows the user to use a scrollbar (or a finger) to drag the viewable
7337     * region around, allowing to move through a much larger object that is
7338     * contained in the scroller. The scroller will always have a small minimum
7339     * size by default as it won't be limited by the contents of the scroller.
7340     *
7341     * Signals that you can add callbacks for are:
7342     * @li "edge,left" - the left edge of the content has been reached
7343     * @li "edge,right" - the right edge of the content has been reached
7344     * @li "edge,top" - the top edge of the content has been reached
7345     * @li "edge,bottom" - the bottom edge of the content has been reached
7346     * @li "scroll" - the content has been scrolled (moved)
7347     * @li "scroll,anim,start" - scrolling animation has started
7348     * @li "scroll,anim,stop" - scrolling animation has stopped
7349     * @li "scroll,drag,start" - dragging the contents around has started
7350     * @li "scroll,drag,stop" - dragging the contents around has stopped
7351     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7352     * user intervetion.
7353     *
7354     * @note When Elemementary is in embedded mode the scrollbars will not be
7355     * dragable, they appear merely as indicators of how much has been scrolled.
7356     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7357     * fingerscroll) won't work.
7358     *
7359     * Default contents parts of the scroller widget that you can use for are:
7360     * @li "default" - A content of the scroller
7361     *
7362     * In @ref tutorial_scroller you'll find an example of how to use most of
7363     * this API.
7364     * @{
7365     */
7366    /**
7367     * @brief Type that controls when scrollbars should appear.
7368     *
7369     * @see elm_scroller_policy_set()
7370     */
7371    typedef enum _Elm_Scroller_Policy
7372      {
7373         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7374         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7375         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7376         ELM_SCROLLER_POLICY_LAST
7377      } Elm_Scroller_Policy;
7378    /**
7379     * @brief Add a new scroller to the parent
7380     *
7381     * @param parent The parent object
7382     * @return The new object or NULL if it cannot be created
7383     */
7384    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7385    /**
7386     * @brief Set the content of the scroller widget (the object to be scrolled around).
7387     *
7388     * @param obj The scroller object
7389     * @param content The new content object
7390     *
7391     * Once the content object is set, a previously set one will be deleted.
7392     * If you want to keep that old content object, use the
7393     * elm_scroller_content_unset() function.
7394     * @deprecated use elm_object_content_set() instead
7395     */
7396    EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7397    /**
7398     * @brief Get the content of the scroller widget
7399     *
7400     * @param obj The slider object
7401     * @return The content that is being used
7402     *
7403     * Return the content object which is set for this widget
7404     *
7405     * @see elm_scroller_content_set()
7406     * @deprecated use elm_object_content_get() instead.
7407     */
7408    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7409    /**
7410     * @brief Unset the content of the scroller widget
7411     *
7412     * @param obj The slider object
7413     * @return The content that was being used
7414     *
7415     * Unparent and return the content object which was set for this widget
7416     *
7417     * @see elm_scroller_content_set()
7418     * @deprecated use elm_object_content_unset() instead.
7419     */
7420    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7421    /**
7422     * @brief Set custom theme elements for the scroller
7423     *
7424     * @param obj The scroller object
7425     * @param widget The widget name to use (default is "scroller")
7426     * @param base The base name to use (default is "base")
7427     */
7428    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7429    /**
7430     * @brief Make the scroller minimum size limited to the minimum size of the content
7431     *
7432     * @param obj The scroller object
7433     * @param w Enable limiting minimum size horizontally
7434     * @param h Enable limiting minimum size vertically
7435     *
7436     * By default the scroller will be as small as its design allows,
7437     * irrespective of its content. This will make the scroller minimum size the
7438     * right size horizontally and/or vertically to perfectly fit its content in
7439     * that direction.
7440     */
7441    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7442    /**
7443     * @brief Show a specific virtual region within the scroller content object
7444     *
7445     * @param obj The scroller object
7446     * @param x X coordinate of the region
7447     * @param y Y coordinate of the region
7448     * @param w Width of the region
7449     * @param h Height of the region
7450     *
7451     * This will ensure all (or part if it does not fit) of the designated
7452     * region in the virtual content object (0, 0 starting at the top-left of the
7453     * virtual content object) is shown within the scroller.
7454     */
7455    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);
7456    /**
7457     * @brief Set the scrollbar visibility policy
7458     *
7459     * @param obj The scroller object
7460     * @param policy_h Horizontal scrollbar policy
7461     * @param policy_v Vertical scrollbar policy
7462     *
7463     * This sets the scrollbar visibility policy for the given scroller.
7464     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7465     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7466     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7467     * respectively for the horizontal and vertical scrollbars.
7468     */
7469    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7470    /**
7471     * @brief Gets scrollbar visibility policy
7472     *
7473     * @param obj The scroller object
7474     * @param policy_h Horizontal scrollbar policy
7475     * @param policy_v Vertical scrollbar policy
7476     *
7477     * @see elm_scroller_policy_set()
7478     */
7479    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7480    /**
7481     * @brief Get the currently visible content region
7482     *
7483     * @param obj The scroller object
7484     * @param x X coordinate of the region
7485     * @param y Y coordinate of the region
7486     * @param w Width of the region
7487     * @param h Height of the region
7488     *
7489     * This gets the current region in the content object that is visible through
7490     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7491     * w, @p h values pointed to.
7492     *
7493     * @note All coordinates are relative to the content.
7494     *
7495     * @see elm_scroller_region_show()
7496     */
7497    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);
7498    /**
7499     * @brief Get the size of the content object
7500     *
7501     * @param obj The scroller object
7502     * @param w Width of the content object.
7503     * @param h Height of the content object.
7504     *
7505     * This gets the size of the content object of the scroller.
7506     */
7507    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7508    /**
7509     * @brief Set bouncing behavior
7510     *
7511     * @param obj The scroller object
7512     * @param h_bounce Allow bounce horizontally
7513     * @param v_bounce Allow bounce vertically
7514     *
7515     * When scrolling, the scroller may "bounce" when reaching an edge of the
7516     * content object. This is a visual way to indicate the end has been reached.
7517     * This is enabled by default for both axis. This API will set if it is enabled
7518     * for the given axis with the boolean parameters for each axis.
7519     */
7520    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7521    /**
7522     * @brief Get the bounce behaviour
7523     *
7524     * @param obj The Scroller object
7525     * @param h_bounce Will the scroller bounce horizontally or not
7526     * @param v_bounce Will the scroller bounce vertically or not
7527     *
7528     * @see elm_scroller_bounce_set()
7529     */
7530    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7531    /**
7532     * @brief Set scroll page size relative to viewport size.
7533     *
7534     * @param obj The scroller object
7535     * @param h_pagerel The horizontal page relative size
7536     * @param v_pagerel The vertical page relative size
7537     *
7538     * The scroller is capable of limiting scrolling by the user to "pages". That
7539     * is to jump by and only show a "whole page" at a time as if the continuous
7540     * area of the scroller content is split into page sized pieces. This sets
7541     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7542     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7543     * axis. This is mutually exclusive with page size
7544     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7545     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7546     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7547     * the other axis.
7548     */
7549    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7550    /**
7551     * @brief Set scroll page size.
7552     *
7553     * @param obj The scroller object
7554     * @param h_pagesize The horizontal page size
7555     * @param v_pagesize The vertical page size
7556     *
7557     * This sets the page size to an absolute fixed value, with 0 turning it off
7558     * for that axis.
7559     *
7560     * @see elm_scroller_page_relative_set()
7561     */
7562    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7563    /**
7564     * @brief Get scroll current page number.
7565     *
7566     * @param obj The scroller object
7567     * @param h_pagenumber The horizontal page number
7568     * @param v_pagenumber The vertical page number
7569     *
7570     * The page number starts from 0. 0 is the first page.
7571     * Current page means the page which meets the top-left of the viewport.
7572     * If there are two or more pages in the viewport, it returns the number of the page
7573     * which meets the top-left of the viewport.
7574     *
7575     * @see elm_scroller_last_page_get()
7576     * @see elm_scroller_page_show()
7577     * @see elm_scroller_page_brint_in()
7578     */
7579    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7580    /**
7581     * @brief Get scroll last page number.
7582     *
7583     * @param obj The scroller object
7584     * @param h_pagenumber The horizontal page number
7585     * @param v_pagenumber The vertical page number
7586     *
7587     * The page number starts from 0. 0 is the first page.
7588     * This returns the last page number among the pages.
7589     *
7590     * @see elm_scroller_current_page_get()
7591     * @see elm_scroller_page_show()
7592     * @see elm_scroller_page_brint_in()
7593     */
7594    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7595    /**
7596     * Show a specific virtual region within the scroller content object by page number.
7597     *
7598     * @param obj The scroller object
7599     * @param h_pagenumber The horizontal page number
7600     * @param v_pagenumber The vertical page number
7601     *
7602     * 0, 0 of the indicated page is located at the top-left of the viewport.
7603     * This will jump to the page directly without animation.
7604     *
7605     * Example of usage:
7606     *
7607     * @code
7608     * sc = elm_scroller_add(win);
7609     * elm_scroller_content_set(sc, content);
7610     * elm_scroller_page_relative_set(sc, 1, 0);
7611     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7612     * elm_scroller_page_show(sc, h_page + 1, v_page);
7613     * @endcode
7614     *
7615     * @see elm_scroller_page_bring_in()
7616     */
7617    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7618    /**
7619     * Show a specific virtual region within the scroller content object by page number.
7620     *
7621     * @param obj The scroller object
7622     * @param h_pagenumber The horizontal page number
7623     * @param v_pagenumber The vertical page number
7624     *
7625     * 0, 0 of the indicated page is located at the top-left of the viewport.
7626     * This will slide to the page with animation.
7627     *
7628     * Example of usage:
7629     *
7630     * @code
7631     * sc = elm_scroller_add(win);
7632     * elm_scroller_content_set(sc, content);
7633     * elm_scroller_page_relative_set(sc, 1, 0);
7634     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7635     * elm_scroller_page_bring_in(sc, h_page, v_page);
7636     * @endcode
7637     *
7638     * @see elm_scroller_page_show()
7639     */
7640    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7641    /**
7642     * @brief Show a specific virtual region within the scroller content object.
7643     *
7644     * @param obj The scroller object
7645     * @param x X coordinate of the region
7646     * @param y Y coordinate of the region
7647     * @param w Width of the region
7648     * @param h Height of the region
7649     *
7650     * This will ensure all (or part if it does not fit) of the designated
7651     * region in the virtual content object (0, 0 starting at the top-left of the
7652     * virtual content object) is shown within the scroller. Unlike
7653     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7654     * to this location (if configuration in general calls for transitions). It
7655     * may not jump immediately to the new location and make take a while and
7656     * show other content along the way.
7657     *
7658     * @see elm_scroller_region_show()
7659     */
7660    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);
7661    /**
7662     * @brief Set event propagation on a scroller
7663     *
7664     * @param obj The scroller object
7665     * @param propagation If propagation is enabled or not
7666     *
7667     * This enables or disabled event propagation from the scroller content to
7668     * the scroller and its parent. By default event propagation is disabled.
7669     */
7670    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7671    /**
7672     * @brief Get event propagation for a scroller
7673     *
7674     * @param obj The scroller object
7675     * @return The propagation state
7676     *
7677     * This gets the event propagation for a scroller.
7678     *
7679     * @see elm_scroller_propagate_events_set()
7680     */
7681    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7682    /**
7683     * @brief Set scrolling gravity on a scroller
7684     *
7685     * @param obj The scroller object
7686     * @param x The scrolling horizontal gravity
7687     * @param y The scrolling vertical gravity
7688     *
7689     * The gravity, defines how the scroller will adjust its view
7690     * when the size of the scroller contents increase.
7691     *
7692     * The scroller will adjust the view to glue itself as follows.
7693     *
7694     *  x=0.0, for showing the left most region of the content.
7695     *  x=1.0, for showing the right most region of the content.
7696     *  y=0.0, for showing the bottom most region of the content.
7697     *  y=1.0, for showing the top most region of the content.
7698     *
7699     * Default values for x and y are 0.0
7700     */
7701    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7702    /**
7703     * @brief Get scrolling gravity values for a scroller
7704     *
7705     * @param obj The scroller object
7706     * @param x The scrolling horizontal gravity
7707     * @param y The scrolling vertical gravity
7708     *
7709     * This gets gravity values for a scroller.
7710     *
7711     * @see elm_scroller_gravity_set()
7712     *
7713     */
7714    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7715    /**
7716     * @}
7717     */
7718
7719    /**
7720     * @defgroup Label Label
7721     *
7722     * @image html img/widget/label/preview-00.png
7723     * @image latex img/widget/label/preview-00.eps
7724     *
7725     * @brief Widget to display text, with simple html-like markup.
7726     *
7727     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7728     * text doesn't fit the geometry of the label it will be ellipsized or be
7729     * cut. Elementary provides several styles for this widget:
7730     * @li default - No animation
7731     * @li marker - Centers the text in the label and make it bold by default
7732     * @li slide_long - The entire text appears from the right of the screen and
7733     * slides until it disappears in the left of the screen(reappering on the
7734     * right again).
7735     * @li slide_short - The text appears in the left of the label and slides to
7736     * the right to show the overflow. When all of the text has been shown the
7737     * position is reset.
7738     * @li slide_bounce - The text appears in the left of the label and slides to
7739     * the right to show the overflow. When all of the text has been shown the
7740     * animation reverses, moving the text to the left.
7741     *
7742     * Custom themes can of course invent new markup tags and style them any way
7743     * they like.
7744     *
7745     * The following signals may be emitted by the label widget:
7746     * @li "language,changed": The program's language changed.
7747     *
7748     * See @ref tutorial_label for a demonstration of how to use a label widget.
7749     * @{
7750     */
7751    /**
7752     * @brief Add a new label to the parent
7753     *
7754     * @param parent The parent object
7755     * @return The new object or NULL if it cannot be created
7756     */
7757    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7758    /**
7759     * @brief Set the label on the label object
7760     *
7761     * @param obj The label object
7762     * @param label The label will be used on the label object
7763     * @deprecated See elm_object_text_set()
7764     */
7765    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 */
7766    /**
7767     * @brief Get the label used on the label object
7768     *
7769     * @param obj The label object
7770     * @return The string inside the label
7771     * @deprecated See elm_object_text_get()
7772     */
7773    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7774    /**
7775     * @brief Set the wrapping behavior of the label
7776     *
7777     * @param obj The label object
7778     * @param wrap To wrap text or not
7779     *
7780     * By default no wrapping is done. Possible values for @p wrap are:
7781     * @li ELM_WRAP_NONE - No wrapping
7782     * @li ELM_WRAP_CHAR - wrap between characters
7783     * @li ELM_WRAP_WORD - wrap between words
7784     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7785     */
7786    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7787    /**
7788     * @brief Get the wrapping behavior of the label
7789     *
7790     * @param obj The label object
7791     * @return Wrap type
7792     *
7793     * @see elm_label_line_wrap_set()
7794     */
7795    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7796    /**
7797     * @brief Set wrap width of the label
7798     *
7799     * @param obj The label object
7800     * @param w The wrap width in pixels at a minimum where words need to wrap
7801     *
7802     * This function sets the maximum width size hint of the label.
7803     *
7804     * @warning This is only relevant if the label is inside a container.
7805     */
7806    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7807    /**
7808     * @brief Get wrap width of the label
7809     *
7810     * @param obj The label object
7811     * @return The wrap width in pixels at a minimum where words need to wrap
7812     *
7813     * @see elm_label_wrap_width_set()
7814     */
7815    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7816    /**
7817     * @brief Set wrap height of the label
7818     *
7819     * @param obj The label object
7820     * @param h The wrap height in pixels at a minimum where words need to wrap
7821     *
7822     * This function sets the maximum height size hint of the label.
7823     *
7824     * @warning This is only relevant if the label is inside a container.
7825     */
7826    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7827    /**
7828     * @brief get wrap width of the label
7829     *
7830     * @param obj The label object
7831     * @return The wrap height in pixels at a minimum where words need to wrap
7832     */
7833    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7834    /**
7835     * @brief Set the font size on the label object.
7836     *
7837     * @param obj The label object
7838     * @param size font size
7839     *
7840     * @warning NEVER use this. It is for hyper-special cases only. use styles
7841     * instead. e.g. "default", "marker", "slide_long" etc.
7842     */
7843    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7844    /**
7845     * @brief Set the text color on the label object
7846     *
7847     * @param obj The label object
7848     * @param r Red property background color of The label object
7849     * @param g Green property background color of The label object
7850     * @param b Blue property background color of The label object
7851     * @param a Alpha property background color of The label object
7852     *
7853     * @warning NEVER use this. It is for hyper-special cases only. use styles
7854     * instead. e.g. "default", "marker", "slide_long" etc.
7855     */
7856    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);
7857    /**
7858     * @brief Set the text align on the label object
7859     *
7860     * @param obj The label object
7861     * @param align align mode ("left", "center", "right")
7862     *
7863     * @warning NEVER use this. It is for hyper-special cases only. use styles
7864     * instead. e.g. "default", "marker", "slide_long" etc.
7865     */
7866    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7867    /**
7868     * @brief Set background color of the label
7869     *
7870     * @param obj The label object
7871     * @param r Red property background color of The label object
7872     * @param g Green property background color of The label object
7873     * @param b Blue property background color of The label object
7874     * @param a Alpha property background alpha of The label object
7875     *
7876     * @warning NEVER use this. It is for hyper-special cases only. use styles
7877     * instead. e.g. "default", "marker", "slide_long" etc.
7878     */
7879    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);
7880    /**
7881     * @brief Set the ellipsis behavior of the label
7882     *
7883     * @param obj The label object
7884     * @param ellipsis To ellipsis text or not
7885     *
7886     * If set to true and the text doesn't fit in the label an ellipsis("...")
7887     * will be shown at the end of the widget.
7888     *
7889     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7890     * choosen wrap method was ELM_WRAP_WORD.
7891     */
7892    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7893    /**
7894     * @brief Set the text slide of the label
7895     *
7896     * @param obj The label object
7897     * @param slide To start slide or stop
7898     *
7899     * If set to true, the text of the label will slide/scroll through the length of
7900     * label.
7901     *
7902     * @warning This only works with the themes "slide_short", "slide_long" and
7903     * "slide_bounce".
7904     */
7905    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7906    /**
7907     * @brief Get the text slide mode of the label
7908     *
7909     * @param obj The label object
7910     * @return slide slide mode value
7911     *
7912     * @see elm_label_slide_set()
7913     */
7914    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7915    /**
7916     * @brief Set the slide duration(speed) of the label
7917     *
7918     * @param obj The label object
7919     * @return The duration in seconds in moving text from slide begin position
7920     * to slide end position
7921     */
7922    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7923    /**
7924     * @brief Get the slide duration(speed) of the label
7925     *
7926     * @param obj The label object
7927     * @return The duration time in moving text from slide begin position to slide end position
7928     *
7929     * @see elm_label_slide_duration_set()
7930     */
7931    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7932    /**
7933     * @}
7934     */
7935
7936    /**
7937     * @defgroup Toggle Toggle
7938     *
7939     * @image html img/widget/toggle/preview-00.png
7940     * @image latex img/widget/toggle/preview-00.eps
7941     *
7942     * @brief A toggle is a slider which can be used to toggle between
7943     * two values.  It has two states: on and off.
7944     *
7945     * This widget is deprecated. Please use elm_check_add() instead using the
7946     * toggle style like:
7947     *
7948     * @code
7949     * obj = elm_check_add(parent);
7950     * elm_object_style_set(obj, "toggle");
7951     * elm_object_part_text_set(obj, "on", "ON");
7952     * elm_object_part_text_set(obj, "off", "OFF");
7953     * @endcode
7954     *
7955     * Signals that you can add callbacks for are:
7956     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7957     *                 until the toggle is released by the cursor (assuming it
7958     *                 has been triggered by the cursor in the first place).
7959     *
7960     * Default contents parts of the toggle widget that you can use for are:
7961     * @li "icon" - An icon of the toggle
7962     *
7963     * Default text parts of the toggle widget that you can use for are:
7964     * @li "elm.text" - Label of the toggle
7965     *
7966     * @ref tutorial_toggle show how to use a toggle.
7967     * @{
7968     */
7969    /**
7970     * @brief Add a toggle to @p parent.
7971     *
7972     * @param parent The parent object
7973     *
7974     * @return The toggle object
7975     */
7976    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7977    /**
7978     * @brief Sets the label to be displayed with the toggle.
7979     *
7980     * @param obj The toggle object
7981     * @param label The label to be displayed
7982     *
7983     * @deprecated use elm_object_text_set() instead.
7984     */
7985    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7986    /**
7987     * @brief Gets the label of the toggle
7988     *
7989     * @param obj  toggle object
7990     * @return The label of the toggle
7991     *
7992     * @deprecated use elm_object_text_get() instead.
7993     */
7994    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7995    /**
7996     * @brief Set the icon used for the toggle
7997     *
7998     * @param obj The toggle object
7999     * @param icon The icon object for the button
8000     *
8001     * Once the icon object is set, a previously set one will be deleted
8002     * If you want to keep that old content object, use the
8003     * elm_toggle_icon_unset() function.
8004     *
8005     * @deprecated use elm_object_part_content_set() instead.
8006     */
8007    EINA_DEPRECATED EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8008    /**
8009     * @brief Get the icon used for the toggle
8010     *
8011     * @param obj The toggle object
8012     * @return The icon object that is being used
8013     *
8014     * Return the icon object which is set for this widget.
8015     *
8016     * @see elm_toggle_icon_set()
8017     *
8018     * @deprecated use elm_object_part_content_get() instead.
8019     */
8020    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8021    /**
8022     * @brief Unset the icon used for the toggle
8023     *
8024     * @param obj The toggle object
8025     * @return The icon object that was being used
8026     *
8027     * Unparent and return the icon object which was set for this widget.
8028     *
8029     * @see elm_toggle_icon_set()
8030     *
8031     * @deprecated use elm_object_part_content_unset() instead.
8032     */
8033    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8034    /**
8035     * @brief Sets the labels to be associated with the on and off states of the toggle.
8036     *
8037     * @param obj The toggle object
8038     * @param onlabel The label displayed when the toggle is in the "on" state
8039     * @param offlabel The label displayed when the toggle is in the "off" state
8040     *
8041     * @deprecated use elm_object_part_text_set() for "on" and "off" parts
8042     * instead.
8043     */
8044    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
8045    /**
8046     * @brief Gets the labels associated with the on and off states of the
8047     * toggle.
8048     *
8049     * @param obj The toggle object
8050     * @param onlabel A char** to place the onlabel of @p obj into
8051     * @param offlabel A char** to place the offlabel of @p obj into
8052     *
8053     * @deprecated use elm_object_part_text_get() for "on" and "off" parts
8054     * instead.
8055     */
8056    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
8057    /**
8058     * @brief Sets the state of the toggle to @p state.
8059     *
8060     * @param obj The toggle object
8061     * @param state The state of @p obj
8062     *
8063     * @deprecated use elm_check_state_set() instead.
8064     */
8065    EINA_DEPRECATED EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
8066    /**
8067     * @brief Gets the state of the toggle to @p state.
8068     *
8069     * @param obj The toggle object
8070     * @return The state of @p obj
8071     *
8072     * @deprecated use elm_check_state_get() instead.
8073     */
8074    EINA_DEPRECATED EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8075    /**
8076     * @brief Sets the state pointer of the toggle to @p statep.
8077     *
8078     * @param obj The toggle object
8079     * @param statep The state pointer of @p obj
8080     *
8081     * @deprecated use elm_check_state_pointer_set() instead.
8082     */
8083    EINA_DEPRECATED EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
8084    /**
8085     * @}
8086     */
8087
8088    /**
8089     * @defgroup Frame Frame
8090     *
8091     * @image html img/widget/frame/preview-00.png
8092     * @image latex img/widget/frame/preview-00.eps
8093     *
8094     * @brief Frame is a widget that holds some content and has a title.
8095     *
8096     * The default look is a frame with a title, but Frame supports multple
8097     * styles:
8098     * @li default
8099     * @li pad_small
8100     * @li pad_medium
8101     * @li pad_large
8102     * @li pad_huge
8103     * @li outdent_top
8104     * @li outdent_bottom
8105     *
8106     * Of all this styles only default shows the title. Frame emits no signals.
8107     *
8108     * Default contents parts of the frame widget that you can use for are:
8109     * @li "default" - A content of the frame
8110     *
8111     * Default text parts of the frame widget that you can use for are:
8112     * @li "elm.text" - Label of the frame
8113     *
8114     * For a detailed example see the @ref tutorial_frame.
8115     *
8116     * @{
8117     */
8118    /**
8119     * @brief Add a new frame to the parent
8120     *
8121     * @param parent The parent object
8122     * @return The new object or NULL if it cannot be created
8123     */
8124    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8125    /**
8126     * @brief Set the frame label
8127     *
8128     * @param obj The frame object
8129     * @param label The label of this frame object
8130     *
8131     * @deprecated use elm_object_text_set() instead.
8132     */
8133    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8134    /**
8135     * @brief Get the frame label
8136     *
8137     * @param obj The frame object
8138     *
8139     * @return The label of this frame objet or NULL if unable to get frame
8140     *
8141     * @deprecated use elm_object_text_get() instead.
8142     */
8143    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8144    /**
8145     * @brief Set the content of the frame widget
8146     *
8147     * Once the content object is set, a previously set one will be deleted.
8148     * If you want to keep that old content object, use the
8149     * elm_frame_content_unset() function.
8150     *
8151     * @param obj The frame object
8152     * @param content The content will be filled in this frame object
8153     *
8154     * @deprecated use elm_object_content_set() instead.
8155     */
8156    EINA_DEPRECATED EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8157    /**
8158     * @brief Get the content of the frame widget
8159     *
8160     * Return the content object which is set for this widget
8161     *
8162     * @param obj The frame object
8163     * @return The content that is being used
8164     *
8165     * @deprecated use elm_object_content_get() instead.
8166     */
8167    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8168    /**
8169     * @brief Unset the content of the frame widget
8170     *
8171     * Unparent and return the content object which was set for this widget
8172     *
8173     * @param obj The frame object
8174     * @return The content that was being used
8175     *
8176     * @deprecated use elm_object_content_unset() instead.
8177     */
8178    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8179    /**
8180     * @}
8181     */
8182
8183    /**
8184     * @defgroup Table Table
8185     *
8186     * A container widget to arrange other widgets in a table where items can
8187     * also span multiple columns or rows - even overlap (and then be raised or
8188     * lowered accordingly to adjust stacking if they do overlap).
8189     *
8190     * For a Table widget the row/column count is not fixed.
8191     * The table widget adjusts itself when subobjects are added to it dynamically.
8192     *
8193     * The followin are examples of how to use a table:
8194     * @li @ref tutorial_table_01
8195     * @li @ref tutorial_table_02
8196     *
8197     * @{
8198     */
8199    /**
8200     * @brief Add a new table to the parent
8201     *
8202     * @param parent The parent object
8203     * @return The new object or NULL if it cannot be created
8204     */
8205    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8206    /**
8207     * @brief Set the homogeneous layout in the table
8208     *
8209     * @param obj The layout object
8210     * @param homogeneous A boolean to set if the layout is homogeneous in the
8211     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
8212     */
8213    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
8214    /**
8215     * @brief Get the current table homogeneous mode.
8216     *
8217     * @param obj The table object
8218     * @return A boolean to indicating if the layout is homogeneous in the table
8219     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
8220     */
8221    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8222    /**
8223     * @brief Set padding between cells.
8224     *
8225     * @param obj The layout object.
8226     * @param horizontal set the horizontal padding.
8227     * @param vertical set the vertical padding.
8228     *
8229     * Default value is 0.
8230     */
8231    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
8232    /**
8233     * @brief Get padding between cells.
8234     *
8235     * @param obj The layout object.
8236     * @param horizontal set the horizontal padding.
8237     * @param vertical set the vertical padding.
8238     */
8239    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
8240    /**
8241     * @brief Add a subobject on the table with the coordinates passed
8242     *
8243     * @param obj The table object
8244     * @param subobj The subobject to be added to the table
8245     * @param x Row number
8246     * @param y Column number
8247     * @param w rowspan
8248     * @param h colspan
8249     *
8250     * @note All positioning inside the table is relative to rows and columns, so
8251     * a value of 0 for x and y, means the top left cell of the table, and a
8252     * value of 1 for w and h means @p subobj only takes that 1 cell.
8253     */
8254    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8255    /**
8256     * @brief Remove child from table.
8257     *
8258     * @param obj The table object
8259     * @param subobj The subobject
8260     */
8261    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8262    /**
8263     * @brief Faster way to remove all child objects from a table object.
8264     *
8265     * @param obj The table object
8266     * @param clear If true, will delete children, else just remove from table.
8267     */
8268    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8269    /**
8270     * @brief Set the packing location of an existing child of the table
8271     *
8272     * @param subobj The subobject to be modified in the table
8273     * @param x Row number
8274     * @param y Column number
8275     * @param w rowspan
8276     * @param h colspan
8277     *
8278     * Modifies the position of an object already in the table.
8279     *
8280     * @note All positioning inside the table is relative to rows and columns, so
8281     * a value of 0 for x and y, means the top left cell of the table, and a
8282     * value of 1 for w and h means @p subobj only takes that 1 cell.
8283     */
8284    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8285    /**
8286     * @brief Get the packing location of an existing child of the table
8287     *
8288     * @param subobj The subobject to be modified in the table
8289     * @param x Row number
8290     * @param y Column number
8291     * @param w rowspan
8292     * @param h colspan
8293     *
8294     * @see elm_table_pack_set()
8295     */
8296    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8297    /**
8298     * @}
8299     */
8300
8301    /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
8302    typedef struct Elm_Gen_Item Elm_Gen_Item;
8303    typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
8304    typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
8305    typedef char        *(*Elm_Gen_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
8306    typedef Evas_Object *(*Elm_Gen_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Content(swallowed object) fetching class function for gen item classes. */
8307    typedef Eina_Bool    (*Elm_Gen_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gen item classes. */
8308    typedef void         (*Elm_Gen_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
8309    struct _Elm_Gen_Item_Class
8310      {
8311         const char             *item_style;
8312         struct _Elm_Gen_Item_Class_Func
8313           {
8314              Elm_Gen_Item_Text_Get_Cb  text_get;
8315              Elm_Gen_Item_Content_Get_Cb  content_get;
8316              Elm_Gen_Item_State_Get_Cb state_get;
8317              Elm_Gen_Item_Del_Cb       del;
8318           } func;
8319      };
8320    EINA_DEPRECATED EAPI void elm_gen_clear(Evas_Object *obj);
8321    EINA_DEPRECATED EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8322    EINA_DEPRECATED EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8323    EINA_DEPRECATED EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8324    EINA_DEPRECATED EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8325    EINA_DEPRECATED EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8326    EINA_DEPRECATED EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8327    EINA_DEPRECATED EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8328    EINA_DEPRECATED EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8329    EINA_DEPRECATED EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8330    EINA_DEPRECATED EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8331
8332    EINA_DEPRECATED EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8333    EINA_DEPRECATED EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8334    EINA_DEPRECATED EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8335    EINA_DEPRECATED EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8336    EINA_DEPRECATED EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8337    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8338    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8339    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8340    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8341    EINA_DEPRECATED EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8342
8343    /**
8344     * @defgroup Gengrid Gengrid (Generic grid)
8345     *
8346     * This widget aims to position objects in a grid layout while
8347     * actually creating and rendering only the visible ones, using the
8348     * same idea as the @ref Genlist "genlist": the user defines a @b
8349     * class for each item, specifying functions that will be called at
8350     * object creation, deletion, etc. When those items are selected by
8351     * the user, a callback function is issued. Users may interact with
8352     * a gengrid via the mouse (by clicking on items to select them and
8353     * clicking on the grid's viewport and swiping to pan the whole
8354     * view) or via the keyboard, navigating through item with the
8355     * arrow keys.
8356     *
8357     * @section Gengrid_Layouts Gengrid layouts
8358     *
8359     * Gengrid may layout its items in one of two possible layouts:
8360     * - horizontal or
8361     * - vertical.
8362     *
8363     * When in "horizontal mode", items will be placed in @b columns,
8364     * from top to bottom and, when the space for a column is filled,
8365     * another one is started on the right, thus expanding the grid
8366     * horizontally, making for horizontal scrolling. When in "vertical
8367     * mode" , though, items will be placed in @b rows, from left to
8368     * right and, when the space for a row is filled, another one is
8369     * started below, thus expanding the grid vertically (and making
8370     * for vertical scrolling).
8371     *
8372     * @section Gengrid_Items Gengrid items
8373     *
8374     * An item in a gengrid can have 0 or more texts (they can be
8375     * regular text or textblock Evas objects - that's up to the style
8376     * to determine), 0 or more contents (which are simply objects
8377     * swallowed into the gengrid item's theming Edje object) and 0 or
8378     * more <b>boolean states</b>, which have the behavior left to the
8379     * user to define. The Edje part names for each of these properties
8380     * will be looked up, in the theme file for the gengrid, under the
8381     * Edje (string) data items named @c "texts", @c "contents" and @c
8382     * "states", respectively. For each of those properties, if more
8383     * than one part is provided, they must have names listed separated
8384     * by spaces in the data fields. For the default gengrid item
8385     * theme, we have @b one text part (@c "elm.text"), @b two content 
8386     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8387     * no state parts.
8388     *
8389     * A gengrid item may be at one of several styles. Elementary
8390     * provides one by default - "default", but this can be extended by
8391     * system or application custom themes/overlays/extensions (see
8392     * @ref Theme "themes" for more details).
8393     *
8394     * @section Gengrid_Item_Class Gengrid item classes
8395     *
8396     * In order to have the ability to add and delete items on the fly,
8397     * gengrid implements a class (callback) system where the
8398     * application provides a structure with information about that
8399     * type of item (gengrid may contain multiple different items with
8400     * different classes, states and styles). Gengrid will call the
8401     * functions in this struct (methods) when an item is "realized"
8402     * (i.e., created dynamically, while the user is scrolling the
8403     * grid). All objects will simply be deleted when no longer needed
8404     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8405     * contains the following members:
8406     * - @c item_style - This is a constant string and simply defines
8407     * the name of the item style. It @b must be specified and the
8408     * default should be @c "default".
8409     * - @c func.text_get - This function is called when an item
8410     * object is actually created. The @c data parameter will point to
8411     * the same data passed to elm_gengrid_item_append() and related
8412     * item creation functions. The @c obj parameter is the gengrid
8413     * object itself, while the @c part one is the name string of one
8414     * of the existing text parts in the Edje group implementing the
8415     * item's theme. This function @b must return a strdup'()ed string,
8416     * as the caller will free() it when done. See
8417     * #Elm_Gengrid_Item_Text_Get_Cb.
8418     * - @c func.content_get - This function is called when an item object
8419     * is actually created. The @c data parameter will point to the
8420     * same data passed to elm_gengrid_item_append() and related item
8421     * creation functions. The @c obj parameter is the gengrid object
8422     * itself, while the @c part one is the name string of one of the
8423     * existing (content) swallow parts in the Edje group implementing the
8424     * item's theme. It must return @c NULL, when no content is desired,
8425     * or a valid object handle, otherwise. The object will be deleted
8426     * by the gengrid on its deletion or when the item is "unrealized".
8427     * See #Elm_Gengrid_Item_Content_Get_Cb.
8428     * - @c func.state_get - This function is called when an item
8429     * object is actually created. The @c data parameter will point to
8430     * the same data passed to elm_gengrid_item_append() and related
8431     * item creation functions. The @c obj parameter is the gengrid
8432     * object itself, while the @c part one is the name string of one
8433     * of the state parts in the Edje group implementing the item's
8434     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8435     * true/on. Gengrids will emit a signal to its theming Edje object
8436     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8437     * "source" arguments, respectively, when the state is true (the
8438     * default is false), where @c XXX is the name of the (state) part.
8439     * See #Elm_Gengrid_Item_State_Get_Cb.
8440     * - @c func.del - This is called when elm_gengrid_item_del() is
8441     * called on an item or elm_gengrid_clear() is called on the
8442     * gengrid. This is intended for use when gengrid items are
8443     * deleted, so any data attached to the item (e.g. its data
8444     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8445     *
8446     * @section Gengrid_Usage_Hints Usage hints
8447     *
8448     * If the user wants to have multiple items selected at the same
8449     * time, elm_gengrid_multi_select_set() will permit it. If the
8450     * gengrid is single-selection only (the default), then
8451     * elm_gengrid_select_item_get() will return the selected item or
8452     * @c NULL, if none is selected. If the gengrid is under
8453     * multi-selection, then elm_gengrid_selected_items_get() will
8454     * return a list (that is only valid as long as no items are
8455     * modified (added, deleted, selected or unselected) of child items
8456     * on a gengrid.
8457     *
8458     * If an item changes (internal (boolean) state, text or content
8459     * changes), then use elm_gengrid_item_update() to have gengrid
8460     * update the item with the new state. A gengrid will re-"realize"
8461     * the item, thus calling the functions in the
8462     * #Elm_Gengrid_Item_Class set for that item.
8463     *
8464     * To programmatically (un)select an item, use
8465     * elm_gengrid_item_selected_set(). To get its selected state use
8466     * elm_gengrid_item_selected_get(). To make an item disabled
8467     * (unable to be selected and appear differently) use
8468     * elm_gengrid_item_disabled_set() to set this and
8469     * elm_gengrid_item_disabled_get() to get the disabled state.
8470     *
8471     * Grid cells will only have their selection smart callbacks called
8472     * when firstly getting selected. Any further clicks will do
8473     * nothing, unless you enable the "always select mode", with
8474     * elm_gengrid_always_select_mode_set(), thus making every click to
8475     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8476     * turn off the ability to select items entirely in the widget and
8477     * they will neither appear selected nor call the selection smart
8478     * callbacks.
8479     *
8480     * Remember that you can create new styles and add your own theme
8481     * augmentation per application with elm_theme_extension_add(). If
8482     * you absolutely must have a specific style that overrides any
8483     * theme the user or system sets up you can use
8484     * elm_theme_overlay_add() to add such a file.
8485     *
8486     * @section Gengrid_Smart_Events Gengrid smart events
8487     *
8488     * Smart events that you can add callbacks for are:
8489     * - @c "activated" - The user has double-clicked or pressed
8490     *   (enter|return|spacebar) on an item. The @c event_info parameter
8491     *   is the gengrid item that was activated.
8492     * - @c "clicked,double" - The user has double-clicked an item.
8493     *   The @c event_info parameter is the gengrid item that was double-clicked.
8494     * - @c "longpressed" - This is called when the item is pressed for a certain
8495     *   amount of time. By default it's 1 second.
8496     * - @c "selected" - The user has made an item selected. The
8497     *   @c event_info parameter is the gengrid item that was selected.
8498     * - @c "unselected" - The user has made an item unselected. The
8499     *   @c event_info parameter is the gengrid item that was unselected.
8500     * - @c "realized" - This is called when the item in the gengrid
8501     *   has its implementing Evas object instantiated, de facto. @c
8502     *   event_info is the gengrid item that was created. The object
8503     *   may be deleted at any time, so it is highly advised to the
8504     *   caller @b not to use the object pointer returned from
8505     *   elm_gengrid_item_object_get(), because it may point to freed
8506     *   objects.
8507     * - @c "unrealized" - This is called when the implementing Evas
8508     *   object for this item is deleted. @c event_info is the gengrid
8509     *   item that was deleted.
8510     * - @c "changed" - Called when an item is added, removed, resized
8511     *   or moved and when the gengrid is resized or gets "horizontal"
8512     *   property changes.
8513     * - @c "scroll,anim,start" - This is called when scrolling animation has
8514     *   started.
8515     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8516     *   stopped.
8517     * - @c "drag,start,up" - Called when the item in the gengrid has
8518     *   been dragged (not scrolled) up.
8519     * - @c "drag,start,down" - Called when the item in the gengrid has
8520     *   been dragged (not scrolled) down.
8521     * - @c "drag,start,left" - Called when the item in the gengrid has
8522     *   been dragged (not scrolled) left.
8523     * - @c "drag,start,right" - Called when the item in the gengrid has
8524     *   been dragged (not scrolled) right.
8525     * - @c "drag,stop" - Called when the item in the gengrid has
8526     *   stopped being dragged.
8527     * - @c "drag" - Called when the item in the gengrid is being
8528     *   dragged.
8529     * - @c "scroll" - called when the content has been scrolled
8530     *   (moved).
8531     * - @c "scroll,drag,start" - called when dragging the content has
8532     *   started.
8533     * - @c "scroll,drag,stop" - called when dragging the content has
8534     *   stopped.
8535     * - @c "edge,top" - This is called when the gengrid is scrolled until
8536     *   the top edge.
8537     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8538     *   until the bottom edge.
8539     * - @c "edge,left" - This is called when the gengrid is scrolled
8540     *   until the left edge.
8541     * - @c "edge,right" - This is called when the gengrid is scrolled
8542     *   until the right edge.
8543     *
8544     * List of gengrid examples:
8545     * @li @ref gengrid_example
8546     */
8547
8548    /**
8549     * @addtogroup Gengrid
8550     * @{
8551     */
8552
8553    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8554    #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8555    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8556    #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8557    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8558    /**
8559     * Text fetching class function for Elm_Gen_Item_Class.
8560     * @param data The data passed in the item creation function
8561     * @param obj The base widget object
8562     * @param part The part name of the swallow
8563     * @return The allocated (NOT stringshared) string to set as the text 
8564     */
8565    typedef char        *(*Elm_Gengrid_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8566    /**
8567     * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8568     * @param data The data passed in the item creation function
8569     * @param obj The base widget object
8570     * @param part The part name of the swallow
8571     * @return The content object to swallow
8572     */
8573    typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part);
8574    /**
8575     * State fetching class function for Elm_Gen_Item_Class.
8576     * @param data The data passed in the item creation function
8577     * @param obj The base widget object
8578     * @param part The part name of the swallow
8579     * @return The hell if I know
8580     */
8581    typedef Eina_Bool    (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8582    /**
8583     * Deletion class function for Elm_Gen_Item_Class.
8584     * @param data The data passed in the item creation function
8585     * @param obj The base widget object
8586     */
8587    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj);
8588
8589    /**
8590     * @struct _Elm_Gengrid_Item_Class
8591     *
8592     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8593     * field details.
8594     */
8595    struct _Elm_Gengrid_Item_Class
8596      {
8597         const char             *item_style;
8598         struct _Elm_Gengrid_Item_Class_Func
8599           {
8600              Elm_Gengrid_Item_Text_Get_Cb    text_get; /**< Text fetching class function for gengrid item classes.*/
8601              Elm_Gengrid_Item_Content_Get_Cb content_get; /**< Content fetching class function for gengrid item classes. */
8602              Elm_Gengrid_Item_State_Get_Cb   state_get; /**< State fetching class function for gengrid item classes. */
8603              Elm_Gengrid_Item_Del_Cb         del; /**< Deletion class function for gengrid item classes. */
8604           } func;
8605      }; /**< #Elm_Gengrid_Item_Class member definitions */
8606    #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8607    /**
8608     * Add a new gengrid widget to the given parent Elementary
8609     * (container) object
8610     *
8611     * @param parent The parent object
8612     * @return a new gengrid widget handle or @c NULL, on errors
8613     *
8614     * This function inserts a new gengrid widget on the canvas.
8615     *
8616     * @see elm_gengrid_item_size_set()
8617     * @see elm_gengrid_group_item_size_set()
8618     * @see elm_gengrid_horizontal_set()
8619     * @see elm_gengrid_item_append()
8620     * @see elm_gengrid_item_del()
8621     * @see elm_gengrid_clear()
8622     *
8623     * @ingroup Gengrid
8624     */
8625    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8626
8627    /**
8628     * Set the size for the items of a given gengrid widget
8629     *
8630     * @param obj The gengrid object.
8631     * @param w The items' width.
8632     * @param h The items' height;
8633     *
8634     * A gengrid, after creation, has still no information on the size
8635     * to give to each of its cells. So, you most probably will end up
8636     * with squares one @ref Fingers "finger" wide, the default
8637     * size. Use this function to force a custom size for you items,
8638     * making them as big as you wish.
8639     *
8640     * @see elm_gengrid_item_size_get()
8641     *
8642     * @ingroup Gengrid
8643     */
8644    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8645
8646    /**
8647     * Get the size set for the items of a given gengrid widget
8648     *
8649     * @param obj The gengrid object.
8650     * @param w Pointer to a variable where to store the items' width.
8651     * @param h Pointer to a variable where to store the items' height.
8652     *
8653     * @note Use @c NULL pointers on the size values you're not
8654     * interested in: they'll be ignored by the function.
8655     *
8656     * @see elm_gengrid_item_size_get() for more details
8657     *
8658     * @ingroup Gengrid
8659     */
8660    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8661
8662    /**
8663     * Set the size for the group items of a given gengrid widget
8664     *
8665     * @param obj The gengrid object.
8666     * @param w The group items' width.
8667     * @param h The group items' height;
8668     *
8669     * A gengrid, after creation, has still no information on the size
8670     * to give to each of its cells. So, you most probably will end up
8671     * with squares one @ref Fingers "finger" wide, the default
8672     * size. Use this function to force a custom size for you group items,
8673     * making them as big as you wish.
8674     *
8675     * @see elm_gengrid_group_item_size_get()
8676     *
8677     * @ingroup Gengrid
8678     */
8679    EAPI void               elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8680
8681    /**
8682     * Get the size set for the group items of a given gengrid widget
8683     *
8684     * @param obj The gengrid object.
8685     * @param w Pointer to a variable where to store the group items' width.
8686     * @param h Pointer to a variable where to store the group items' height.
8687     *
8688     * @note Use @c NULL pointers on the size values you're not
8689     * interested in: they'll be ignored by the function.
8690     *
8691     * @see elm_gengrid_group_item_size_get() for more details
8692     *
8693     * @ingroup Gengrid
8694     */
8695    EAPI void               elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8696
8697    /**
8698     * Set the items grid's alignment within a given gengrid widget
8699     *
8700     * @param obj The gengrid object.
8701     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8702     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8703     *
8704     * This sets the alignment of the whole grid of items of a gengrid
8705     * within its given viewport. By default, those values are both
8706     * 0.5, meaning that the gengrid will have its items grid placed
8707     * exactly in the middle of its viewport.
8708     *
8709     * @note If given alignment values are out of the cited ranges,
8710     * they'll be changed to the nearest boundary values on the valid
8711     * ranges.
8712     *
8713     * @see elm_gengrid_align_get()
8714     *
8715     * @ingroup Gengrid
8716     */
8717    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8718
8719    /**
8720     * Get the items grid's alignment values within a given gengrid
8721     * widget
8722     *
8723     * @param obj The gengrid object.
8724     * @param align_x Pointer to a variable where to store the
8725     * horizontal alignment.
8726     * @param align_y Pointer to a variable where to store the vertical
8727     * alignment.
8728     *
8729     * @note Use @c NULL pointers on the alignment values you're not
8730     * interested in: they'll be ignored by the function.
8731     *
8732     * @see elm_gengrid_align_set() for more details
8733     *
8734     * @ingroup Gengrid
8735     */
8736    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8737
8738    /**
8739     * Set whether a given gengrid widget is or not able have items
8740     * @b reordered
8741     *
8742     * @param obj The gengrid object
8743     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8744     * @c EINA_FALSE to turn it off
8745     *
8746     * If a gengrid is set to allow reordering, a click held for more
8747     * than 0.5 over a given item will highlight it specially,
8748     * signalling the gengrid has entered the reordering state. From
8749     * that time on, the user will be able to, while still holding the
8750     * mouse button down, move the item freely in the gengrid's
8751     * viewport, replacing to said item to the locations it goes to.
8752     * The replacements will be animated and, whenever the user
8753     * releases the mouse button, the item being replaced gets a new
8754     * definitive place in the grid.
8755     *
8756     * @see elm_gengrid_reorder_mode_get()
8757     *
8758     * @ingroup Gengrid
8759     */
8760    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8761
8762    /**
8763     * Get whether a given gengrid widget is or not able have items
8764     * @b reordered
8765     *
8766     * @param obj The gengrid object
8767     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8768     * off
8769     *
8770     * @see elm_gengrid_reorder_mode_set() for more details
8771     *
8772     * @ingroup Gengrid
8773     */
8774    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8775
8776    /**
8777     * Append a new item in a given gengrid widget.
8778     *
8779     * @param obj The gengrid object.
8780     * @param gic The item class for the item.
8781     * @param data The item data.
8782     * @param func Convenience function called when the item is
8783     * selected.
8784     * @param func_data Data to be passed to @p func.
8785     * @return A handle to the item added or @c NULL, on errors.
8786     *
8787     * This adds an item to the beginning of the gengrid.
8788     *
8789     * @see elm_gengrid_item_prepend()
8790     * @see elm_gengrid_item_insert_before()
8791     * @see elm_gengrid_item_insert_after()
8792     * @see elm_gengrid_item_del()
8793     *
8794     * @ingroup Gengrid
8795     */
8796    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);
8797
8798    /**
8799     * Prepend a new item in a given gengrid widget.
8800     *
8801     * @param obj The gengrid object.
8802     * @param gic The item class for the item.
8803     * @param data The item data.
8804     * @param func Convenience function called when the item is
8805     * selected.
8806     * @param func_data Data to be passed to @p func.
8807     * @return A handle to the item added or @c NULL, on errors.
8808     *
8809     * This adds an item to the end of the gengrid.
8810     *
8811     * @see elm_gengrid_item_append()
8812     * @see elm_gengrid_item_insert_before()
8813     * @see elm_gengrid_item_insert_after()
8814     * @see elm_gengrid_item_del()
8815     *
8816     * @ingroup Gengrid
8817     */
8818    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);
8819
8820    /**
8821     * Insert an item before another in a gengrid widget
8822     *
8823     * @param obj The gengrid object.
8824     * @param gic The item class for the item.
8825     * @param data The item data.
8826     * @param relative The item to place this new one before.
8827     * @param func Convenience function called when the item is
8828     * selected.
8829     * @param func_data Data to be passed to @p func.
8830     * @return A handle to the item added or @c NULL, on errors.
8831     *
8832     * This inserts an item before another in the gengrid.
8833     *
8834     * @see elm_gengrid_item_append()
8835     * @see elm_gengrid_item_prepend()
8836     * @see elm_gengrid_item_insert_after()
8837     * @see elm_gengrid_item_del()
8838     *
8839     * @ingroup Gengrid
8840     */
8841    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);
8842
8843    /**
8844     * Insert an item after another in a gengrid widget
8845     *
8846     * @param obj The gengrid object.
8847     * @param gic The item class for the item.
8848     * @param data The item data.
8849     * @param relative The item to place this new one after.
8850     * @param func Convenience function called when the item is
8851     * selected.
8852     * @param func_data Data to be passed to @p func.
8853     * @return A handle to the item added or @c NULL, on errors.
8854     *
8855     * This inserts an item after another in the gengrid.
8856     *
8857     * @see elm_gengrid_item_append()
8858     * @see elm_gengrid_item_prepend()
8859     * @see elm_gengrid_item_insert_after()
8860     * @see elm_gengrid_item_del()
8861     *
8862     * @ingroup Gengrid
8863     */
8864    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);
8865
8866    /**
8867     * Insert an item in a gengrid widget using a user-defined sort function.
8868     *
8869     * @param obj The gengrid object.
8870     * @param gic The item class for the item.
8871     * @param data The item data.
8872     * @param comp User defined comparison function that defines the sort order based on
8873     * Elm_Gen_Item and its data param.
8874     * @param func Convenience function called when the item is selected.
8875     * @param func_data Data to be passed to @p func.
8876     * @return A handle to the item added or @c NULL, on errors.
8877     *
8878     * This inserts an item in the gengrid based on user defined comparison function.
8879     *
8880     * @see elm_gengrid_item_append()
8881     * @see elm_gengrid_item_prepend()
8882     * @see elm_gengrid_item_insert_after()
8883     * @see elm_gengrid_item_del()
8884     * @see elm_gengrid_item_direct_sorted_insert()
8885     *
8886     * @ingroup Gengrid
8887     */
8888    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);
8889
8890    /**
8891     * Insert an item in a gengrid widget using a user-defined sort function.
8892     *
8893     * @param obj The gengrid object.
8894     * @param gic The item class for the item.
8895     * @param data The item data.
8896     * @param comp User defined comparison function that defines the sort order based on
8897     * Elm_Gen_Item.
8898     * @param func Convenience function called when the item is selected.
8899     * @param func_data Data to be passed to @p func.
8900     * @return A handle to the item added or @c NULL, on errors.
8901     *
8902     * This inserts an item in the gengrid based on user defined comparison function.
8903     *
8904     * @see elm_gengrid_item_append()
8905     * @see elm_gengrid_item_prepend()
8906     * @see elm_gengrid_item_insert_after()
8907     * @see elm_gengrid_item_del()
8908     * @see elm_gengrid_item_sorted_insert()
8909     *
8910     * @ingroup Gengrid
8911     */
8912    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);
8913
8914    /**
8915     * Set whether items on a given gengrid widget are to get their
8916     * selection callbacks issued for @b every subsequent selection
8917     * click on them or just for the first click.
8918     *
8919     * @param obj The gengrid object
8920     * @param always_select @c EINA_TRUE to make items "always
8921     * selected", @c EINA_FALSE, otherwise
8922     *
8923     * By default, grid items will only call their selection callback
8924     * function when firstly getting selected, any subsequent further
8925     * clicks will do nothing. With this call, you make those
8926     * subsequent clicks also to issue the selection callbacks.
8927     *
8928     * @note <b>Double clicks</b> will @b always be reported on items.
8929     *
8930     * @see elm_gengrid_always_select_mode_get()
8931     *
8932     * @ingroup Gengrid
8933     */
8934    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8935
8936    /**
8937     * Get whether items on a given gengrid widget have their selection
8938     * callbacks issued for @b every subsequent selection click on them
8939     * or just for the first click.
8940     *
8941     * @param obj The gengrid object.
8942     * @return @c EINA_TRUE if the gengrid items are "always selected",
8943     * @c EINA_FALSE, otherwise
8944     *
8945     * @see elm_gengrid_always_select_mode_set() for more details
8946     *
8947     * @ingroup Gengrid
8948     */
8949    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8950
8951    /**
8952     * Set whether items on a given gengrid widget can be selected or not.
8953     *
8954     * @param obj The gengrid object
8955     * @param no_select @c EINA_TRUE to make items selectable,
8956     * @c EINA_FALSE otherwise
8957     *
8958     * This will make items in @p obj selectable or not. In the latter
8959     * case, any user interaction on the gengrid items will neither make
8960     * them appear selected nor them call their selection callback
8961     * functions.
8962     *
8963     * @see elm_gengrid_no_select_mode_get()
8964     *
8965     * @ingroup Gengrid
8966     */
8967    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8968
8969    /**
8970     * Get whether items on a given gengrid widget can be selected or
8971     * not.
8972     *
8973     * @param obj The gengrid object
8974     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8975     * otherwise
8976     *
8977     * @see elm_gengrid_no_select_mode_set() for more details
8978     *
8979     * @ingroup Gengrid
8980     */
8981    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8982
8983    /**
8984     * Enable or disable multi-selection in a given gengrid widget
8985     *
8986     * @param obj The gengrid object.
8987     * @param multi @c EINA_TRUE, to enable multi-selection,
8988     * @c EINA_FALSE to disable it.
8989     *
8990     * Multi-selection is the ability to have @b more than one
8991     * item selected, on a given gengrid, simultaneously. When it is
8992     * enabled, a sequence of clicks on different items will make them
8993     * all selected, progressively. A click on an already selected item
8994     * will unselect it. If interacting via the keyboard,
8995     * multi-selection is enabled while holding the "Shift" key.
8996     *
8997     * @note By default, multi-selection is @b disabled on gengrids
8998     *
8999     * @see elm_gengrid_multi_select_get()
9000     *
9001     * @ingroup Gengrid
9002     */
9003    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
9004
9005    /**
9006     * Get whether multi-selection is enabled or disabled for a given
9007     * gengrid widget
9008     *
9009     * @param obj The gengrid object.
9010     * @return @c EINA_TRUE, if multi-selection is enabled, @c
9011     * EINA_FALSE otherwise
9012     *
9013     * @see elm_gengrid_multi_select_set() for more details
9014     *
9015     * @ingroup Gengrid
9016     */
9017    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9018
9019    /**
9020     * Enable or disable bouncing effect for a given gengrid widget
9021     *
9022     * @param obj The gengrid object
9023     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
9024     * @c EINA_FALSE to disable it
9025     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
9026     * @c EINA_FALSE to disable it
9027     *
9028     * The bouncing effect occurs whenever one reaches the gengrid's
9029     * edge's while panning it -- it will scroll past its limits a
9030     * little bit and return to the edge again, in a animated for,
9031     * automatically.
9032     *
9033     * @note By default, gengrids have bouncing enabled on both axis
9034     *
9035     * @see elm_gengrid_bounce_get()
9036     *
9037     * @ingroup Gengrid
9038     */
9039    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9040
9041    /**
9042     * Get whether bouncing effects are enabled or disabled, for a
9043     * given gengrid widget, on each axis
9044     *
9045     * @param obj The gengrid object
9046     * @param h_bounce Pointer to a variable where to store the
9047     * horizontal bouncing flag.
9048     * @param v_bounce Pointer to a variable where to store the
9049     * vertical bouncing flag.
9050     *
9051     * @see elm_gengrid_bounce_set() for more details
9052     *
9053     * @ingroup Gengrid
9054     */
9055    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9056
9057    /**
9058     * Set a given gengrid widget's scrolling page size, relative to
9059     * its viewport size.
9060     *
9061     * @param obj The gengrid object
9062     * @param h_pagerel The horizontal page (relative) size
9063     * @param v_pagerel The vertical page (relative) size
9064     *
9065     * The gengrid's scroller is capable of binding scrolling by the
9066     * user to "pages". It means that, while scrolling and, specially
9067     * after releasing the mouse button, the grid will @b snap to the
9068     * nearest displaying page's area. When page sizes are set, the
9069     * grid's continuous content area is split into (equal) page sized
9070     * pieces.
9071     *
9072     * This function sets the size of a page <b>relatively to the
9073     * viewport dimensions</b> of the gengrid, for each axis. A value
9074     * @c 1.0 means "the exact viewport's size", in that axis, while @c
9075     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
9076     * a viewport". Sane usable values are, than, between @c 0.0 and @c
9077     * 1.0. Values beyond those will make it behave behave
9078     * inconsistently. If you only want one axis to snap to pages, use
9079     * the value @c 0.0 for the other one.
9080     *
9081     * There is a function setting page size values in @b absolute
9082     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
9083     * is mutually exclusive to this one.
9084     *
9085     * @see elm_gengrid_page_relative_get()
9086     *
9087     * @ingroup Gengrid
9088     */
9089    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
9090
9091    /**
9092     * Get a given gengrid widget's scrolling page size, relative to
9093     * its viewport size.
9094     *
9095     * @param obj The gengrid object
9096     * @param h_pagerel Pointer to a variable where to store the
9097     * horizontal page (relative) size
9098     * @param v_pagerel Pointer to a variable where to store the
9099     * vertical page (relative) size
9100     *
9101     * @see elm_gengrid_page_relative_set() for more details
9102     *
9103     * @ingroup Gengrid
9104     */
9105    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
9106
9107    /**
9108     * Set a given gengrid widget's scrolling page size
9109     *
9110     * @param obj The gengrid object
9111     * @param h_pagerel The horizontal page size, in pixels
9112     * @param v_pagerel The vertical page size, in pixels
9113     *
9114     * The gengrid's scroller is capable of binding scrolling by the
9115     * user to "pages". It means that, while scrolling and, specially
9116     * after releasing the mouse button, the grid will @b snap to the
9117     * nearest displaying page's area. When page sizes are set, the
9118     * grid's continuous content area is split into (equal) page sized
9119     * pieces.
9120     *
9121     * This function sets the size of a page of the gengrid, in pixels,
9122     * for each axis. Sane usable values are, between @c 0 and the
9123     * dimensions of @p obj, for each axis. Values beyond those will
9124     * make it behave behave inconsistently. If you only want one axis
9125     * to snap to pages, use the value @c 0 for the other one.
9126     *
9127     * There is a function setting page size values in @b relative
9128     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
9129     * use is mutually exclusive to this one.
9130     *
9131     * @ingroup Gengrid
9132     */
9133    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
9134
9135    /**
9136     * @brief Get gengrid current page number.
9137     *
9138     * @param obj The gengrid object
9139     * @param h_pagenumber The horizontal page number
9140     * @param v_pagenumber The vertical page number
9141     *
9142     * The page number starts from 0. 0 is the first page.
9143     * Current page means the page which meet the top-left of the viewport.
9144     * If there are two or more pages in the viewport, it returns the number of page
9145     * which meet the top-left of the viewport.
9146     *
9147     * @see elm_gengrid_last_page_get()
9148     * @see elm_gengrid_page_show()
9149     * @see elm_gengrid_page_brint_in()
9150     */
9151    EAPI void         elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
9152
9153    /**
9154     * @brief Get scroll last page number.
9155     *
9156     * @param obj The gengrid object
9157     * @param h_pagenumber The horizontal page number
9158     * @param v_pagenumber The vertical page number
9159     *
9160     * The page number starts from 0. 0 is the first page.
9161     * This returns the last page number among the pages.
9162     *
9163     * @see elm_gengrid_current_page_get()
9164     * @see elm_gengrid_page_show()
9165     * @see elm_gengrid_page_brint_in()
9166     */
9167    EAPI void         elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
9168
9169    /**
9170     * Show a specific virtual region within the gengrid content object by page number.
9171     *
9172     * @param obj The gengrid object
9173     * @param h_pagenumber The horizontal page number
9174     * @param v_pagenumber The vertical page number
9175     *
9176     * 0, 0 of the indicated page is located at the top-left of the viewport.
9177     * This will jump to the page directly without animation.
9178     *
9179     * Example of usage:
9180     *
9181     * @code
9182     * sc = elm_gengrid_add(win);
9183     * elm_gengrid_content_set(sc, content);
9184     * elm_gengrid_page_relative_set(sc, 1, 0);
9185     * elm_gengrid_current_page_get(sc, &h_page, &v_page);
9186     * elm_gengrid_page_show(sc, h_page + 1, v_page);
9187     * @endcode
9188     *
9189     * @see elm_gengrid_page_bring_in()
9190     */
9191    EAPI void         elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9192
9193    /**
9194     * Show a specific virtual region within the gengrid content object by page number.
9195     *
9196     * @param obj The gengrid object
9197     * @param h_pagenumber The horizontal page number
9198     * @param v_pagenumber The vertical page number
9199     *
9200     * 0, 0 of the indicated page is located at the top-left of the viewport.
9201     * This will slide to the page with animation.
9202     *
9203     * Example of usage:
9204     *
9205     * @code
9206     * sc = elm_gengrid_add(win);
9207     * elm_gengrid_content_set(sc, content);
9208     * elm_gengrid_page_relative_set(sc, 1, 0);
9209     * elm_gengrid_last_page_get(sc, &h_page, &v_page);
9210     * elm_gengrid_page_bring_in(sc, h_page, v_page);
9211     * @endcode
9212     *
9213     * @see elm_gengrid_page_show()
9214     */
9215     EAPI void         elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9216
9217    /**
9218     * Set the direction in which a given gengrid widget will expand while
9219     * placing its items.
9220     *
9221     * @param obj The gengrid object.
9222     * @param setting @c EINA_TRUE to make the gengrid expand
9223     * horizontally, @c EINA_FALSE to expand vertically.
9224     *
9225     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
9226     * in @b columns, from top to bottom and, when the space for a
9227     * column is filled, another one is started on the right, thus
9228     * expanding the grid horizontally. When in "vertical mode"
9229     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
9230     * to right and, when the space for a row is filled, another one is
9231     * started below, thus expanding the grid vertically.
9232     *
9233     * @see elm_gengrid_horizontal_get()
9234     *
9235     * @ingroup Gengrid
9236     */
9237    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
9238
9239    /**
9240     * Get for what direction a given gengrid widget will expand while
9241     * placing its items.
9242     *
9243     * @param obj The gengrid object.
9244     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
9245     * @c EINA_FALSE if it's set to expand vertically.
9246     *
9247     * @see elm_gengrid_horizontal_set() for more detais
9248     *
9249     * @ingroup Gengrid
9250     */
9251    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9252
9253    /**
9254     * Get the first item in a given gengrid widget
9255     *
9256     * @param obj The gengrid object
9257     * @return The first item's handle or @c NULL, if there are no
9258     * items in @p obj (and on errors)
9259     *
9260     * This returns the first item in the @p obj's internal list of
9261     * items.
9262     *
9263     * @see elm_gengrid_last_item_get()
9264     *
9265     * @ingroup Gengrid
9266     */
9267    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9268
9269    /**
9270     * Get the last item in a given gengrid widget
9271     *
9272     * @param obj The gengrid object
9273     * @return The last item's handle or @c NULL, if there are no
9274     * items in @p obj (and on errors)
9275     *
9276     * This returns the last item in the @p obj's internal list of
9277     * items.
9278     *
9279     * @see elm_gengrid_first_item_get()
9280     *
9281     * @ingroup Gengrid
9282     */
9283    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9284
9285    /**
9286     * Get the @b next item in a gengrid widget's internal list of items,
9287     * given a handle to one of those items.
9288     *
9289     * @param item The gengrid item to fetch next from
9290     * @return The item after @p item, or @c NULL if there's none (and
9291     * on errors)
9292     *
9293     * This returns the item placed after the @p item, on the container
9294     * gengrid.
9295     *
9296     * @see elm_gengrid_item_prev_get()
9297     *
9298     * @ingroup Gengrid
9299     */
9300    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9301
9302    /**
9303     * Get the @b previous item in a gengrid widget's internal list of items,
9304     * given a handle to one of those items.
9305     *
9306     * @param item The gengrid item to fetch previous from
9307     * @return The item before @p item, or @c NULL if there's none (and
9308     * on errors)
9309     *
9310     * This returns the item placed before the @p item, on the container
9311     * gengrid.
9312     *
9313     * @see elm_gengrid_item_next_get()
9314     *
9315     * @ingroup Gengrid
9316     */
9317    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9318
9319    /**
9320     * Get the gengrid object's handle which contains a given gengrid
9321     * item
9322     *
9323     * @param item The item to fetch the container from
9324     * @return The gengrid (parent) object
9325     *
9326     * This returns the gengrid object itself that an item belongs to.
9327     *
9328     * @ingroup Gengrid
9329     */
9330    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9331
9332    /**
9333     * Remove a gengrid item from its parent, deleting it.
9334     *
9335     * @param item The item to be removed.
9336     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
9337     *
9338     * @see elm_gengrid_clear(), to remove all items in a gengrid at
9339     * once.
9340     *
9341     * @ingroup Gengrid
9342     */
9343    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9344
9345    /**
9346     * Update the contents of a given gengrid item
9347     *
9348     * @param item The gengrid item
9349     *
9350     * This updates an item by calling all the item class functions
9351     * again to get the contents, texts and states. Use this when the
9352     * original item data has changed and you want the changes to be
9353     * reflected.
9354     *
9355     * @ingroup Gengrid
9356     */
9357    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9358
9359    /**
9360     * Get the Gengrid Item class for the given Gengrid Item.
9361     *
9362     * @param item The gengrid item
9363     *
9364     * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9365     * the function pointers and item_style.
9366     *
9367     * @ingroup Gengrid
9368     */
9369    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9370
9371    /**
9372     * Get the Gengrid Item class for the given Gengrid Item.
9373     *
9374     * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9375     * the function pointers and item_style.
9376     *
9377     * @param item The gengrid item
9378     * @param gic The gengrid item class describing the function pointers and the item style.
9379     *
9380     * @ingroup Gengrid
9381     */
9382    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9383
9384    /**
9385     * Return the data associated to a given gengrid item
9386     *
9387     * @param item The gengrid item.
9388     * @return the data associated with this item.
9389     *
9390     * This returns the @c data value passed on the
9391     * elm_gengrid_item_append() and related item addition calls.
9392     *
9393     * @see elm_gengrid_item_append()
9394     * @see elm_gengrid_item_data_set()
9395     *
9396     * @ingroup Gengrid
9397     */
9398    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9399
9400    /**
9401     * Set the data associated with a given gengrid item
9402     *
9403     * @param item The gengrid item
9404     * @param data The data pointer to set on it
9405     *
9406     * This @b overrides the @c data value passed on the
9407     * elm_gengrid_item_append() and related item addition calls. This
9408     * function @b won't call elm_gengrid_item_update() automatically,
9409     * so you'd issue it afterwards if you want to have the item
9410     * updated to reflect the new data.
9411     *
9412     * @see elm_gengrid_item_data_get()
9413     * @see elm_gengrid_item_update()
9414     *
9415     * @ingroup Gengrid
9416     */
9417    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9418
9419    /**
9420     * Get a given gengrid item's position, relative to the whole
9421     * gengrid's grid area.
9422     *
9423     * @param item The Gengrid item.
9424     * @param x Pointer to variable to store the item's <b>row number</b>.
9425     * @param y Pointer to variable to store the item's <b>column number</b>.
9426     *
9427     * This returns the "logical" position of the item within the
9428     * gengrid. For example, @c (0, 1) would stand for first row,
9429     * second column.
9430     *
9431     * @ingroup Gengrid
9432     */
9433    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9434
9435    /**
9436     * Set whether a given gengrid item is selected or not
9437     *
9438     * @param item The gengrid item
9439     * @param selected Use @c EINA_TRUE, to make it selected, @c
9440     * EINA_FALSE to make it unselected
9441     *
9442     * This sets the selected state of an item. If multi-selection is
9443     * not enabled on the containing gengrid and @p selected is @c
9444     * EINA_TRUE, any other previously selected items will get
9445     * unselected in favor of this new one.
9446     *
9447     * @see elm_gengrid_item_selected_get()
9448     *
9449     * @ingroup Gengrid
9450     */
9451    EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9452
9453    /**
9454     * Get whether a given gengrid item is selected or not
9455     *
9456     * @param item The gengrid item
9457     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9458     *
9459     * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9460     *
9461     * @see elm_gengrid_item_selected_set() for more details
9462     *
9463     * @ingroup Gengrid
9464     */
9465    EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9466
9467    /**
9468     * Get the real Evas object created to implement the view of a
9469     * given gengrid item
9470     *
9471     * @param item The gengrid item.
9472     * @return the Evas object implementing this item's view.
9473     *
9474     * This returns the actual Evas object used to implement the
9475     * specified gengrid item's view. This may be @c NULL, as it may
9476     * not have been created or may have been deleted, at any time, by
9477     * the gengrid. <b>Do not modify this object</b> (move, resize,
9478     * show, hide, etc.), as the gengrid is controlling it. This
9479     * function is for querying, emitting custom signals or hooking
9480     * lower level callbacks for events on that object. Do not delete
9481     * this object under any circumstances.
9482     *
9483     * @see elm_gengrid_item_data_get()
9484     *
9485     * @ingroup Gengrid
9486     */
9487    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9488
9489    /**
9490     * Show the portion of a gengrid's internal grid containing a given
9491     * item, @b immediately.
9492     *
9493     * @param item The item to display
9494     *
9495     * This causes gengrid to @b redraw its viewport's contents to the
9496     * region contining the given @p item item, if it is not fully
9497     * visible.
9498     *
9499     * @see elm_gengrid_item_bring_in()
9500     *
9501     * @ingroup Gengrid
9502     */
9503    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9504
9505    /**
9506     * Animatedly bring in, to the visible area of a gengrid, a given
9507     * item on it.
9508     *
9509     * @param item The gengrid item to display
9510     *
9511     * This causes gengrid to jump to the given @p item and show
9512     * it (by scrolling), if it is not fully visible. This will use
9513     * animation to do so and take a period of time to complete.
9514     *
9515     * @see elm_gengrid_item_show()
9516     *
9517     * @ingroup Gengrid
9518     */
9519    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9520
9521    /**
9522     * Set whether a given gengrid item is disabled or not.
9523     *
9524     * @param item The gengrid item
9525     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9526     * to enable it back.
9527     *
9528     * A disabled item cannot be selected or unselected. It will also
9529     * change its appearance, to signal the user it's disabled.
9530     *
9531     * @see elm_gengrid_item_disabled_get()
9532     *
9533     * @ingroup Gengrid
9534     */
9535    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9536
9537    /**
9538     * Get whether a given gengrid item is disabled or not.
9539     *
9540     * @param item The gengrid item
9541     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9542     * (and on errors).
9543     *
9544     * @see elm_gengrid_item_disabled_set() for more details
9545     *
9546     * @ingroup Gengrid
9547     */
9548    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9549
9550    /**
9551     * Set the text to be shown in a given gengrid item's tooltips.
9552     *
9553     * @param item The gengrid item
9554     * @param text The text to set in the content
9555     *
9556     * This call will setup the text to be used as tooltip to that item
9557     * (analogous to elm_object_tooltip_text_set(), but being item
9558     * tooltips with higher precedence than object tooltips). It can
9559     * have only one tooltip at a time, so any previous tooltip data
9560     * will get removed.
9561     *
9562     * @ingroup Gengrid
9563     */
9564    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9565
9566    /**
9567     * Set the content to be shown in a given gengrid item's tooltip
9568     *
9569     * @param item The gengrid item.
9570     * @param func The function returning the tooltip contents.
9571     * @param data What to provide to @a func as callback data/context.
9572     * @param del_cb Called when data is not needed anymore, either when
9573     *        another callback replaces @p func, the tooltip is unset with
9574     *        elm_gengrid_item_tooltip_unset() or the owner @p item
9575     *        dies. This callback receives as its first parameter the
9576     *        given @p data, being @c event_info the item handle.
9577     *
9578     * This call will setup the tooltip's contents to @p item
9579     * (analogous to elm_object_tooltip_content_cb_set(), but being
9580     * item tooltips with higher precedence than object tooltips). It
9581     * can have only one tooltip at a time, so any previous tooltip
9582     * content will get removed. @p func (with @p data) will be called
9583     * every time Elementary needs to show the tooltip and it should
9584     * return a valid Evas object, which will be fully managed by the
9585     * tooltip system, getting deleted when the tooltip is gone.
9586     *
9587     * @ingroup Gengrid
9588     */
9589    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);
9590
9591    /**
9592     * Unset a tooltip from a given gengrid item
9593     *
9594     * @param item gengrid item to remove a previously set tooltip from.
9595     *
9596     * This call removes any tooltip set on @p item. The callback
9597     * provided as @c del_cb to
9598     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9599     * notify it is not used anymore (and have resources cleaned, if
9600     * need be).
9601     *
9602     * @see elm_gengrid_item_tooltip_content_cb_set()
9603     *
9604     * @ingroup Gengrid
9605     */
9606    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9607
9608    /**
9609     * Set a different @b style for a given gengrid item's tooltip.
9610     *
9611     * @param item gengrid item with tooltip set
9612     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9613     * "default", @c "transparent", etc)
9614     *
9615     * Tooltips can have <b>alternate styles</b> to be displayed on,
9616     * which are defined by the theme set on Elementary. This function
9617     * works analogously as elm_object_tooltip_style_set(), but here
9618     * applied only to gengrid item objects. The default style for
9619     * tooltips is @c "default".
9620     *
9621     * @note before you set a style you should define a tooltip with
9622     *       elm_gengrid_item_tooltip_content_cb_set() or
9623     *       elm_gengrid_item_tooltip_text_set()
9624     *
9625     * @see elm_gengrid_item_tooltip_style_get()
9626     *
9627     * @ingroup Gengrid
9628     */
9629    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9630
9631    /**
9632     * Get the style set a given gengrid item's tooltip.
9633     *
9634     * @param item gengrid item with tooltip already set on.
9635     * @return style the theme style in use, which defaults to
9636     *         "default". If the object does not have a tooltip set,
9637     *         then @c NULL is returned.
9638     *
9639     * @see elm_gengrid_item_tooltip_style_set() for more details
9640     *
9641     * @ingroup Gengrid
9642     */
9643    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9644    /**
9645     * @brief Disable size restrictions on an object's tooltip
9646     * @param item The tooltip's anchor object
9647     * @param disable If EINA_TRUE, size restrictions are disabled
9648     * @return EINA_FALSE on failure, EINA_TRUE on success
9649     *
9650     * This function allows a tooltip to expand beyond its parant window's canvas.
9651     * It will instead be limited only by the size of the display.
9652     */
9653    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9654    /**
9655     * @brief Retrieve size restriction state of an object's tooltip
9656     * @param item The tooltip's anchor object
9657     * @return If EINA_TRUE, size restrictions are disabled
9658     *
9659     * This function returns whether a tooltip is allowed to expand beyond
9660     * its parant window's canvas.
9661     * It will instead be limited only by the size of the display.
9662     */
9663    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9664    /**
9665     * Set the type of mouse pointer/cursor decoration to be shown,
9666     * when the mouse pointer is over the given gengrid widget item
9667     *
9668     * @param item gengrid item to customize cursor on
9669     * @param cursor the cursor type's name
9670     *
9671     * This function works analogously as elm_object_cursor_set(), but
9672     * here the cursor's changing area is restricted to the item's
9673     * area, and not the whole widget's. Note that that item cursors
9674     * have precedence over widget cursors, so that a mouse over @p
9675     * item will always show cursor @p type.
9676     *
9677     * If this function is called twice for an object, a previously set
9678     * cursor will be unset on the second call.
9679     *
9680     * @see elm_object_cursor_set()
9681     * @see elm_gengrid_item_cursor_get()
9682     * @see elm_gengrid_item_cursor_unset()
9683     *
9684     * @ingroup Gengrid
9685     */
9686    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9687
9688    /**
9689     * Get the type of mouse pointer/cursor decoration set to be shown,
9690     * when the mouse pointer is over the given gengrid widget item
9691     *
9692     * @param item gengrid item with custom cursor set
9693     * @return the cursor type's name or @c NULL, if no custom cursors
9694     * were set to @p item (and on errors)
9695     *
9696     * @see elm_object_cursor_get()
9697     * @see elm_gengrid_item_cursor_set() for more details
9698     * @see elm_gengrid_item_cursor_unset()
9699     *
9700     * @ingroup Gengrid
9701     */
9702    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9703
9704    /**
9705     * Unset any custom mouse pointer/cursor decoration set to be
9706     * shown, when the mouse pointer is over the given gengrid widget
9707     * item, thus making it show the @b default cursor again.
9708     *
9709     * @param item a gengrid item
9710     *
9711     * Use this call to undo any custom settings on this item's cursor
9712     * decoration, bringing it back to defaults (no custom style set).
9713     *
9714     * @see elm_object_cursor_unset()
9715     * @see elm_gengrid_item_cursor_set() for more details
9716     *
9717     * @ingroup Gengrid
9718     */
9719    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9720
9721    /**
9722     * Set a different @b style for a given custom cursor set for a
9723     * gengrid item.
9724     *
9725     * @param item gengrid item with custom cursor set
9726     * @param style the <b>theme style</b> to use (e.g. @c "default",
9727     * @c "transparent", etc)
9728     *
9729     * This function only makes sense when one is using custom mouse
9730     * cursor decorations <b>defined in a theme file</b> , which can
9731     * have, given a cursor name/type, <b>alternate styles</b> on
9732     * it. It works analogously as elm_object_cursor_style_set(), but
9733     * here applied only to gengrid item objects.
9734     *
9735     * @warning Before you set a cursor style you should have defined a
9736     *       custom cursor previously on the item, with
9737     *       elm_gengrid_item_cursor_set()
9738     *
9739     * @see elm_gengrid_item_cursor_engine_only_set()
9740     * @see elm_gengrid_item_cursor_style_get()
9741     *
9742     * @ingroup Gengrid
9743     */
9744    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9745
9746    /**
9747     * Get the current @b style set for a given gengrid item's custom
9748     * cursor
9749     *
9750     * @param item gengrid item with custom cursor set.
9751     * @return style the cursor style in use. If the object does not
9752     *         have a cursor set, then @c NULL is returned.
9753     *
9754     * @see elm_gengrid_item_cursor_style_set() for more details
9755     *
9756     * @ingroup Gengrid
9757     */
9758    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9759
9760    /**
9761     * Set if the (custom) cursor for a given gengrid item should be
9762     * searched in its theme, also, or should only rely on the
9763     * rendering engine.
9764     *
9765     * @param item item with custom (custom) cursor already set on
9766     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9767     * only on those provided by the rendering engine, @c EINA_FALSE to
9768     * have them searched on the widget's theme, as well.
9769     *
9770     * @note This call is of use only if you've set a custom cursor
9771     * for gengrid items, with elm_gengrid_item_cursor_set().
9772     *
9773     * @note By default, cursors will only be looked for between those
9774     * provided by the rendering engine.
9775     *
9776     * @ingroup Gengrid
9777     */
9778    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9779
9780    /**
9781     * Get if the (custom) cursor for a given gengrid item is being
9782     * searched in its theme, also, or is only relying on the rendering
9783     * engine.
9784     *
9785     * @param item a gengrid item
9786     * @return @c EINA_TRUE, if cursors are being looked for only on
9787     * those provided by the rendering engine, @c EINA_FALSE if they
9788     * are being searched on the widget's theme, as well.
9789     *
9790     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9791     *
9792     * @ingroup Gengrid
9793     */
9794    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9795
9796    /**
9797     * Remove all items from a given gengrid widget
9798     *
9799     * @param obj The gengrid object.
9800     *
9801     * This removes (and deletes) all items in @p obj, leaving it
9802     * empty.
9803     *
9804     * @see elm_gengrid_item_del(), to remove just one item.
9805     *
9806     * @ingroup Gengrid
9807     */
9808    EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9809
9810    /**
9811     * Get the selected item in a given gengrid widget
9812     *
9813     * @param obj The gengrid object.
9814     * @return The selected item's handleor @c NULL, if none is
9815     * selected at the moment (and on errors)
9816     *
9817     * This returns the selected item in @p obj. If multi selection is
9818     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9819     * the first item in the list is selected, which might not be very
9820     * useful. For that case, see elm_gengrid_selected_items_get().
9821     *
9822     * @ingroup Gengrid
9823     */
9824    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9825
9826    /**
9827     * Get <b>a list</b> of selected items in a given gengrid
9828     *
9829     * @param obj The gengrid object.
9830     * @return The list of selected items or @c NULL, if none is
9831     * selected at the moment (and on errors)
9832     *
9833     * This returns a list of the selected items, in the order that
9834     * they appear in the grid. This list is only valid as long as no
9835     * more items are selected or unselected (or unselected implictly
9836     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9837     * data, naturally.
9838     *
9839     * @see elm_gengrid_selected_item_get()
9840     *
9841     * @ingroup Gengrid
9842     */
9843    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9844
9845    /**
9846     * @}
9847     */
9848
9849    /**
9850     * @defgroup Clock Clock
9851     *
9852     * @image html img/widget/clock/preview-00.png
9853     * @image latex img/widget/clock/preview-00.eps
9854     *
9855     * This is a @b digital clock widget. In its default theme, it has a
9856     * vintage "flipping numbers clock" appearance, which will animate
9857     * sheets of individual algarisms individually as time goes by.
9858     *
9859     * A newly created clock will fetch system's time (already
9860     * considering local time adjustments) to start with, and will tick
9861     * accondingly. It may or may not show seconds.
9862     *
9863     * Clocks have an @b edition mode. When in it, the sheets will
9864     * display extra arrow indications on the top and bottom and the
9865     * user may click on them to raise or lower the time values. After
9866     * it's told to exit edition mode, it will keep ticking with that
9867     * new time set (it keeps the difference from local time).
9868     *
9869     * Also, when under edition mode, user clicks on the cited arrows
9870     * which are @b held for some time will make the clock to flip the
9871     * sheet, thus editing the time, continuosly and automatically for
9872     * the user. The interval between sheet flips will keep growing in
9873     * time, so that it helps the user to reach a time which is distant
9874     * from the one set.
9875     *
9876     * The time display is, by default, in military mode (24h), but an
9877     * am/pm indicator may be optionally shown, too, when it will
9878     * switch to 12h.
9879     *
9880     * Smart callbacks one can register to:
9881     * - "changed" - the clock's user changed the time
9882     *
9883     * Here is an example on its usage:
9884     * @li @ref clock_example
9885     */
9886
9887    /**
9888     * @addtogroup Clock
9889     * @{
9890     */
9891
9892    /**
9893     * Identifiers for which clock digits should be editable, when a
9894     * clock widget is in edition mode. Values may be ORed together to
9895     * make a mask, naturally.
9896     *
9897     * @see elm_clock_edit_set()
9898     * @see elm_clock_digit_edit_set()
9899     */
9900    typedef enum _Elm_Clock_Digedit
9901      {
9902         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9903         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9904         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9905         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9906         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9907         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9908         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9909         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9910      } Elm_Clock_Digedit;
9911
9912    /**
9913     * Add a new clock widget to the given parent Elementary
9914     * (container) object
9915     *
9916     * @param parent The parent object
9917     * @return a new clock widget handle or @c NULL, on errors
9918     *
9919     * This function inserts a new clock widget on the canvas.
9920     *
9921     * @ingroup Clock
9922     */
9923    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9924
9925    /**
9926     * Set a clock widget's time, programmatically
9927     *
9928     * @param obj The clock widget object
9929     * @param hrs The hours to set
9930     * @param min The minutes to set
9931     * @param sec The secondes to set
9932     *
9933     * This function updates the time that is showed by the clock
9934     * widget.
9935     *
9936     *  Values @b must be set within the following ranges:
9937     * - 0 - 23, for hours
9938     * - 0 - 59, for minutes
9939     * - 0 - 59, for seconds,
9940     *
9941     * even if the clock is not in "military" mode.
9942     *
9943     * @warning The behavior for values set out of those ranges is @b
9944     * undefined.
9945     *
9946     * @ingroup Clock
9947     */
9948    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9949
9950    /**
9951     * Get a clock widget's time values
9952     *
9953     * @param obj The clock object
9954     * @param[out] hrs Pointer to the variable to get the hours value
9955     * @param[out] min Pointer to the variable to get the minutes value
9956     * @param[out] sec Pointer to the variable to get the seconds value
9957     *
9958     * This function gets the time set for @p obj, returning
9959     * it on the variables passed as the arguments to function
9960     *
9961     * @note Use @c NULL pointers on the time values you're not
9962     * interested in: they'll be ignored by the function.
9963     *
9964     * @ingroup Clock
9965     */
9966    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9967
9968    /**
9969     * Set whether a given clock widget is under <b>edition mode</b> or
9970     * under (default) displaying-only mode.
9971     *
9972     * @param obj The clock object
9973     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9974     * put it back to "displaying only" mode
9975     *
9976     * This function makes a clock's time to be editable or not <b>by
9977     * user interaction</b>. When in edition mode, clocks @b stop
9978     * ticking, until one brings them back to canonical mode. The
9979     * elm_clock_digit_edit_set() function will influence which digits
9980     * of the clock will be editable. By default, all of them will be
9981     * (#ELM_CLOCK_NONE).
9982     *
9983     * @note am/pm sheets, if being shown, will @b always be editable
9984     * under edition mode.
9985     *
9986     * @see elm_clock_edit_get()
9987     *
9988     * @ingroup Clock
9989     */
9990    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9991
9992    /**
9993     * Retrieve whether a given clock widget is under <b>edition
9994     * mode</b> or under (default) displaying-only mode.
9995     *
9996     * @param obj The clock object
9997     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9998     * otherwise
9999     *
10000     * This function retrieves whether the clock's time can be edited
10001     * or not by user interaction.
10002     *
10003     * @see elm_clock_edit_set() for more details
10004     *
10005     * @ingroup Clock
10006     */
10007    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10008
10009    /**
10010     * Set what digits of the given clock widget should be editable
10011     * when in edition mode.
10012     *
10013     * @param obj The clock object
10014     * @param digedit Bit mask indicating the digits to be editable
10015     * (values in #Elm_Clock_Digedit).
10016     *
10017     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
10018     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
10019     * EINA_FALSE).
10020     *
10021     * @see elm_clock_digit_edit_get()
10022     *
10023     * @ingroup Clock
10024     */
10025    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
10026
10027    /**
10028     * Retrieve what digits of the given clock widget should be
10029     * editable when in edition mode.
10030     *
10031     * @param obj The clock object
10032     * @return Bit mask indicating the digits to be editable
10033     * (values in #Elm_Clock_Digedit).
10034     *
10035     * @see elm_clock_digit_edit_set() for more details
10036     *
10037     * @ingroup Clock
10038     */
10039    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10040
10041    /**
10042     * Set if the given clock widget must show hours in military or
10043     * am/pm mode
10044     *
10045     * @param obj The clock object
10046     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
10047     * to military mode
10048     *
10049     * This function sets if the clock must show hours in military or
10050     * am/pm mode. In some countries like Brazil the military mode
10051     * (00-24h-format) is used, in opposition to the USA, where the
10052     * am/pm mode is more commonly used.
10053     *
10054     * @see elm_clock_show_am_pm_get()
10055     *
10056     * @ingroup Clock
10057     */
10058    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
10059
10060    /**
10061     * Get if the given clock widget shows hours in military or am/pm
10062     * mode
10063     *
10064     * @param obj The clock object
10065     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
10066     * military
10067     *
10068     * This function gets if the clock shows hours in military or am/pm
10069     * mode.
10070     *
10071     * @see elm_clock_show_am_pm_set() for more details
10072     *
10073     * @ingroup Clock
10074     */
10075    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10076
10077    /**
10078     * Set if the given clock widget must show time with seconds or not
10079     *
10080     * @param obj The clock object
10081     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
10082     *
10083     * This function sets if the given clock must show or not elapsed
10084     * seconds. By default, they are @b not shown.
10085     *
10086     * @see elm_clock_show_seconds_get()
10087     *
10088     * @ingroup Clock
10089     */
10090    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
10091
10092    /**
10093     * Get whether the given clock widget is showing time with seconds
10094     * or not
10095     *
10096     * @param obj The clock object
10097     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
10098     *
10099     * This function gets whether @p obj is showing or not the elapsed
10100     * seconds.
10101     *
10102     * @see elm_clock_show_seconds_set()
10103     *
10104     * @ingroup Clock
10105     */
10106    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10107
10108    /**
10109     * Set the interval on time updates for an user mouse button hold
10110     * on clock widgets' time edition.
10111     *
10112     * @param obj The clock object
10113     * @param interval The (first) interval value in seconds
10114     *
10115     * This interval value is @b decreased while the user holds the
10116     * mouse pointer either incrementing or decrementing a given the
10117     * clock digit's value.
10118     *
10119     * This helps the user to get to a given time distant from the
10120     * current one easier/faster, as it will start to flip quicker and
10121     * quicker on mouse button holds.
10122     *
10123     * The calculation for the next flip interval value, starting from
10124     * the one set with this call, is the previous interval divided by
10125     * 1.05, so it decreases a little bit.
10126     *
10127     * The default starting interval value for automatic flips is
10128     * @b 0.85 seconds.
10129     *
10130     * @see elm_clock_interval_get()
10131     *
10132     * @ingroup Clock
10133     */
10134    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
10135
10136    /**
10137     * Get the interval on time updates for an user mouse button hold
10138     * on clock widgets' time edition.
10139     *
10140     * @param obj The clock object
10141     * @return The (first) interval value, in seconds, set on it
10142     *
10143     * @see elm_clock_interval_set() for more details
10144     *
10145     * @ingroup Clock
10146     */
10147    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10148
10149    /**
10150     * @}
10151     */
10152
10153    /**
10154     * @defgroup Layout Layout
10155     *
10156     * @image html img/widget/layout/preview-00.png
10157     * @image latex img/widget/layout/preview-00.eps width=\textwidth
10158     *
10159     * @image html img/layout-predefined.png
10160     * @image latex img/layout-predefined.eps width=\textwidth
10161     *
10162     * This is a container widget that takes a standard Edje design file and
10163     * wraps it very thinly in a widget.
10164     *
10165     * An Edje design (theme) file has a very wide range of possibilities to
10166     * describe the behavior of elements added to the Layout. Check out the Edje
10167     * documentation and the EDC reference to get more information about what can
10168     * be done with Edje.
10169     *
10170     * Just like @ref List, @ref Box, and other container widgets, any
10171     * object added to the Layout will become its child, meaning that it will be
10172     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
10173     *
10174     * The Layout widget can contain as many Contents, Boxes or Tables as
10175     * described in its theme file. For instance, objects can be added to
10176     * different Tables by specifying the respective Table part names. The same
10177     * is valid for Content and Box.
10178     *
10179     * The objects added as child of the Layout will behave as described in the
10180     * part description where they were added. There are 3 possible types of
10181     * parts where a child can be added:
10182     *
10183     * @section secContent Content (SWALLOW part)
10184     *
10185     * Only one object can be added to the @c SWALLOW part (but you still can
10186     * have many @c SWALLOW parts and one object on each of them). Use the @c
10187     * elm_object_content_set/get/unset functions to set, retrieve and unset
10188     * objects as content of the @c SWALLOW. After being set to this part, the
10189     * object size, position, visibility, clipping and other description
10190     * properties will be totally controlled by the description of the given part
10191     * (inside the Edje theme file).
10192     *
10193     * One can use @c evas_object_size_hint_* functions on the child to have some
10194     * kind of control over its behavior, but the resulting behavior will still
10195     * depend heavily on the @c SWALLOW part description.
10196     *
10197     * The Edje theme also can change the part description, based on signals or
10198     * scripts running inside the theme. This change can also be animated. All of
10199     * this will affect the child object set as content accordingly. The object
10200     * size will be changed if the part size is changed, it will animate move if
10201     * the part is moving, and so on.
10202     *
10203     * The following picture demonstrates a Layout widget with a child object
10204     * added to its @c SWALLOW:
10205     *
10206     * @image html layout_swallow.png
10207     * @image latex layout_swallow.eps width=\textwidth
10208     *
10209     * @section secBox Box (BOX part)
10210     *
10211     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
10212     * allows one to add objects to the box and have them distributed along its
10213     * area, accordingly to the specified @a layout property (now by @a layout we
10214     * mean the chosen layouting design of the Box, not the Layout widget
10215     * itself).
10216     *
10217     * A similar effect for having a box with its position, size and other things
10218     * controlled by the Layout theme would be to create an Elementary @ref Box
10219     * widget and add it as a Content in the @c SWALLOW part.
10220     *
10221     * The main difference of using the Layout Box is that its behavior, the box
10222     * properties like layouting format, padding, align, etc. will be all
10223     * controlled by the theme. This means, for example, that a signal could be
10224     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
10225     * handled the signal by changing the box padding, or align, or both. Using
10226     * the Elementary @ref Box widget is not necessarily harder or easier, it
10227     * just depends on the circunstances and requirements.
10228     *
10229     * The Layout Box can be used through the @c elm_layout_box_* set of
10230     * functions.
10231     *
10232     * The following picture demonstrates a Layout widget with many child objects
10233     * added to its @c BOX part:
10234     *
10235     * @image html layout_box.png
10236     * @image latex layout_box.eps width=\textwidth
10237     *
10238     * @section secTable Table (TABLE part)
10239     *
10240     * Just like the @ref secBox, the Layout Table is very similar to the
10241     * Elementary @ref Table widget. It allows one to add objects to the Table
10242     * specifying the row and column where the object should be added, and any
10243     * column or row span if necessary.
10244     *
10245     * Again, we could have this design by adding a @ref Table widget to the @c
10246     * SWALLOW part using elm_object_part_content_set(). The same difference happens
10247     * here when choosing to use the Layout Table (a @c TABLE part) instead of
10248     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
10249     *
10250     * The Layout Table can be used through the @c elm_layout_table_* set of
10251     * functions.
10252     *
10253     * The following picture demonstrates a Layout widget with many child objects
10254     * added to its @c TABLE part:
10255     *
10256     * @image html layout_table.png
10257     * @image latex layout_table.eps width=\textwidth
10258     *
10259     * @section secPredef Predefined Layouts
10260     *
10261     * Another interesting thing about the Layout widget is that it offers some
10262     * predefined themes that come with the default Elementary theme. These
10263     * themes can be set by the call elm_layout_theme_set(), and provide some
10264     * basic functionality depending on the theme used.
10265     *
10266     * Most of them already send some signals, some already provide a toolbar or
10267     * back and next buttons.
10268     *
10269     * These are available predefined theme layouts. All of them have class = @c
10270     * layout, group = @c application, and style = one of the following options:
10271     *
10272     * @li @c toolbar-content - application with toolbar and main content area
10273     * @li @c toolbar-content-back - application with toolbar and main content
10274     * area with a back button and title area
10275     * @li @c toolbar-content-back-next - application with toolbar and main
10276     * content area with a back and next buttons and title area
10277     * @li @c content-back - application with a main content area with a back
10278     * button and title area
10279     * @li @c content-back-next - application with a main content area with a
10280     * back and next buttons and title area
10281     * @li @c toolbar-vbox - application with toolbar and main content area as a
10282     * vertical box
10283     * @li @c toolbar-table - application with toolbar and main content area as a
10284     * table
10285     *
10286     * @section secExamples Examples
10287     *
10288     * Some examples of the Layout widget can be found here:
10289     * @li @ref layout_example_01
10290     * @li @ref layout_example_02
10291     * @li @ref layout_example_03
10292     * @li @ref layout_example_edc
10293     *
10294     */
10295
10296    /**
10297     * Add a new layout to the parent
10298     *
10299     * @param parent The parent object
10300     * @return The new object or NULL if it cannot be created
10301     *
10302     * @see elm_layout_file_set()
10303     * @see elm_layout_theme_set()
10304     *
10305     * @ingroup Layout
10306     */
10307    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10308    /**
10309     * Set the file that will be used as layout
10310     *
10311     * @param obj The layout object
10312     * @param file The path to file (edj) that will be used as layout
10313     * @param group The group that the layout belongs in edje file
10314     *
10315     * @return (1 = success, 0 = error)
10316     *
10317     * @ingroup Layout
10318     */
10319    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
10320    /**
10321     * Set the edje group from the elementary theme that will be used as layout
10322     *
10323     * @param obj The layout object
10324     * @param clas the clas of the group
10325     * @param group the group
10326     * @param style the style to used
10327     *
10328     * @return (1 = success, 0 = error)
10329     *
10330     * @ingroup Layout
10331     */
10332    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
10333    /**
10334     * Set the layout content.
10335     *
10336     * @param obj The layout object
10337     * @param swallow The swallow part name in the edje file
10338     * @param content The child that will be added in this layout object
10339     *
10340     * Once the content object is set, a previously set one will be deleted.
10341     * If you want to keep that old content object, use the
10342     * elm_object_part_content_unset() function.
10343     *
10344     * @note In an Edje theme, the part used as a content container is called @c
10345     * SWALLOW. This is why the parameter name is called @p swallow, but it is
10346     * expected to be a part name just like the second parameter of
10347     * elm_layout_box_append().
10348     *
10349     * @see elm_layout_box_append()
10350     * @see elm_object_part_content_get()
10351     * @see elm_object_part_content_unset()
10352     * @see @ref secBox
10353     * @deprecated use elm_object_part_content_set() instead
10354     *
10355     * @ingroup Layout
10356     */
10357    EINA_DEPRECATED EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10358    /**
10359     * Get the child object in the given content part.
10360     *
10361     * @param obj The layout object
10362     * @param swallow The SWALLOW part to get its content
10363     *
10364     * @return The swallowed object or NULL if none or an error occurred
10365     *
10366     * @deprecated use elm_object_part_content_get() instead
10367     *
10368     * @ingroup Layout
10369     */
10370    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10371    /**
10372     * Unset the layout content.
10373     *
10374     * @param obj The layout object
10375     * @param swallow The swallow part name in the edje file
10376     * @return The content that was being used
10377     *
10378     * Unparent and return the content object which was set for this part.
10379     *
10380     * @deprecated use elm_object_part_content_unset() instead
10381     *
10382     * @ingroup Layout
10383     */
10384    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10385    /**
10386     * Set the text of the given part
10387     *
10388     * @param obj The layout object
10389     * @param part The TEXT part where to set the text
10390     * @param text The text to set
10391     *
10392     * @ingroup Layout
10393     * @deprecated use elm_object_part_text_set() instead.
10394     */
10395    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10396    /**
10397     * Get the text set in the given part
10398     *
10399     * @param obj The layout object
10400     * @param part The TEXT part to retrieve the text off
10401     *
10402     * @return The text set in @p part
10403     *
10404     * @ingroup Layout
10405     * @deprecated use elm_object_part_text_get() instead.
10406     */
10407    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10408    /**
10409     * Append child to layout box part.
10410     *
10411     * @param obj the layout object
10412     * @param part the box part to which the object will be appended.
10413     * @param child the child object to append to box.
10414     *
10415     * Once the object is appended, it will become child of the layout. Its
10416     * lifetime will be bound to the layout, whenever the layout dies the child
10417     * will be deleted automatically. One should use elm_layout_box_remove() to
10418     * make this layout forget about the object.
10419     *
10420     * @see elm_layout_box_prepend()
10421     * @see elm_layout_box_insert_before()
10422     * @see elm_layout_box_insert_at()
10423     * @see elm_layout_box_remove()
10424     *
10425     * @ingroup Layout
10426     */
10427    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10428    /**
10429     * Prepend child to layout box part.
10430     *
10431     * @param obj the layout object
10432     * @param part the box part to prepend.
10433     * @param child the child object to prepend to box.
10434     *
10435     * Once the object is prepended, it will become child of the layout. Its
10436     * lifetime will be bound to the layout, whenever the layout dies the child
10437     * will be deleted automatically. One should use elm_layout_box_remove() to
10438     * make this layout forget about the object.
10439     *
10440     * @see elm_layout_box_append()
10441     * @see elm_layout_box_insert_before()
10442     * @see elm_layout_box_insert_at()
10443     * @see elm_layout_box_remove()
10444     *
10445     * @ingroup Layout
10446     */
10447    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10448    /**
10449     * Insert child to layout box part before a reference object.
10450     *
10451     * @param obj the layout object
10452     * @param part the box part to insert.
10453     * @param child the child object to insert into box.
10454     * @param reference another reference object to insert before in box.
10455     *
10456     * Once the object is inserted, it will become child of the layout. Its
10457     * lifetime will be bound to the layout, whenever the layout dies the child
10458     * will be deleted automatically. One should use elm_layout_box_remove() to
10459     * make this layout forget about the object.
10460     *
10461     * @see elm_layout_box_append()
10462     * @see elm_layout_box_prepend()
10463     * @see elm_layout_box_insert_before()
10464     * @see elm_layout_box_remove()
10465     *
10466     * @ingroup Layout
10467     */
10468    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10469    /**
10470     * Insert child to layout box part at a given position.
10471     *
10472     * @param obj the layout object
10473     * @param part the box part to insert.
10474     * @param child the child object to insert into box.
10475     * @param pos the numeric position >=0 to insert the child.
10476     *
10477     * Once the object is inserted, it will become child of the layout. Its
10478     * lifetime will be bound to the layout, whenever the layout dies the child
10479     * will be deleted automatically. One should use elm_layout_box_remove() to
10480     * make this layout forget about the object.
10481     *
10482     * @see elm_layout_box_append()
10483     * @see elm_layout_box_prepend()
10484     * @see elm_layout_box_insert_before()
10485     * @see elm_layout_box_remove()
10486     *
10487     * @ingroup Layout
10488     */
10489    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10490    /**
10491     * Remove a child of the given part box.
10492     *
10493     * @param obj The layout object
10494     * @param part The box part name to remove child.
10495     * @param child The object to remove from box.
10496     * @return The object that was being used, or NULL if not found.
10497     *
10498     * The object will be removed from the box part and its lifetime will
10499     * not be handled by the layout anymore. This is equivalent to
10500     * elm_object_part_content_unset() for box.
10501     *
10502     * @see elm_layout_box_append()
10503     * @see elm_layout_box_remove_all()
10504     *
10505     * @ingroup Layout
10506     */
10507    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10508    /**
10509     * Remove all children of the given part box.
10510     *
10511     * @param obj The layout object
10512     * @param part The box part name to remove child.
10513     * @param clear If EINA_TRUE, then all objects will be deleted as
10514     *        well, otherwise they will just be removed and will be
10515     *        dangling on the canvas.
10516     *
10517     * The objects will be removed from the box part and their lifetime will
10518     * not be handled by the layout anymore. This is equivalent to
10519     * elm_layout_box_remove() for all box children.
10520     *
10521     * @see elm_layout_box_append()
10522     * @see elm_layout_box_remove()
10523     *
10524     * @ingroup Layout
10525     */
10526    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10527    /**
10528     * Insert child to layout table part.
10529     *
10530     * @param obj the layout object
10531     * @param part the box part to pack child.
10532     * @param child_obj the child object to pack into table.
10533     * @param col the column to which the child should be added. (>= 0)
10534     * @param row the row to which the child should be added. (>= 0)
10535     * @param colspan how many columns should be used to store this object. (>=
10536     *        1)
10537     * @param rowspan how many rows should be used to store this object. (>= 1)
10538     *
10539     * Once the object is inserted, it will become child of the table. Its
10540     * lifetime will be bound to the layout, and whenever the layout dies the
10541     * child will be deleted automatically. One should use
10542     * elm_layout_table_remove() to make this layout forget about the object.
10543     *
10544     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10545     * more space than a single cell. For instance, the following code:
10546     * @code
10547     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10548     * @endcode
10549     *
10550     * Would result in an object being added like the following picture:
10551     *
10552     * @image html layout_colspan.png
10553     * @image latex layout_colspan.eps width=\textwidth
10554     *
10555     * @see elm_layout_table_unpack()
10556     * @see elm_layout_table_clear()
10557     *
10558     * @ingroup Layout
10559     */
10560    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);
10561    /**
10562     * Unpack (remove) a child of the given part table.
10563     *
10564     * @param obj The layout object
10565     * @param part The table part name to remove child.
10566     * @param child_obj The object to remove from table.
10567     * @return The object that was being used, or NULL if not found.
10568     *
10569     * The object will be unpacked from the table part and its lifetime
10570     * will not be handled by the layout anymore. This is equivalent to
10571     * elm_object_part_content_unset() for table.
10572     *
10573     * @see elm_layout_table_pack()
10574     * @see elm_layout_table_clear()
10575     *
10576     * @ingroup Layout
10577     */
10578    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10579    /**
10580     * Remove all the child objects of the given part table.
10581     *
10582     * @param obj The layout object
10583     * @param part The table part name to remove child.
10584     * @param clear If EINA_TRUE, then all objects will be deleted as
10585     *        well, otherwise they will just be removed and will be
10586     *        dangling on the canvas.
10587     *
10588     * The objects will be removed from the table part and their lifetime will
10589     * not be handled by the layout anymore. This is equivalent to
10590     * elm_layout_table_unpack() for all table children.
10591     *
10592     * @see elm_layout_table_pack()
10593     * @see elm_layout_table_unpack()
10594     *
10595     * @ingroup Layout
10596     */
10597    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10598    /**
10599     * Get the edje layout
10600     *
10601     * @param obj The layout object
10602     *
10603     * @return A Evas_Object with the edje layout settings loaded
10604     * with function elm_layout_file_set
10605     *
10606     * This returns the edje object. It is not expected to be used to then
10607     * swallow objects via edje_object_part_swallow() for example. Use
10608     * elm_object_part_content_set() instead so child object handling and sizing is
10609     * done properly.
10610     *
10611     * @note This function should only be used if you really need to call some
10612     * low level Edje function on this edje object. All the common stuff (setting
10613     * text, emitting signals, hooking callbacks to signals, etc.) can be done
10614     * with proper elementary functions.
10615     *
10616     * @see elm_object_signal_callback_add()
10617     * @see elm_object_signal_emit()
10618     * @see elm_object_part_text_set()
10619     * @see elm_object_part_content_set()
10620     * @see elm_layout_box_append()
10621     * @see elm_layout_table_pack()
10622     * @see elm_layout_data_get()
10623     *
10624     * @ingroup Layout
10625     */
10626    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10627    /**
10628     * Get the edje data from the given layout
10629     *
10630     * @param obj The layout object
10631     * @param key The data key
10632     *
10633     * @return The edje data string
10634     *
10635     * This function fetches data specified inside the edje theme of this layout.
10636     * This function return NULL if data is not found.
10637     *
10638     * In EDC this comes from a data block within the group block that @p
10639     * obj was loaded from. E.g.
10640     *
10641     * @code
10642     * collections {
10643     *   group {
10644     *     name: "a_group";
10645     *     data {
10646     *       item: "key1" "value1";
10647     *       item: "key2" "value2";
10648     *     }
10649     *   }
10650     * }
10651     * @endcode
10652     *
10653     * @ingroup Layout
10654     */
10655    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10656    /**
10657     * Eval sizing
10658     *
10659     * @param obj The layout object
10660     *
10661     * Manually forces a sizing re-evaluation. This is useful when the minimum
10662     * size required by the edje theme of this layout has changed. The change on
10663     * the minimum size required by the edje theme is not immediately reported to
10664     * the elementary layout, so one needs to call this function in order to tell
10665     * the widget (layout) that it needs to reevaluate its own size.
10666     *
10667     * The minimum size of the theme is calculated based on minimum size of
10668     * parts, the size of elements inside containers like box and table, etc. All
10669     * of this can change due to state changes, and that's when this function
10670     * should be called.
10671     *
10672     * Also note that a standard signal of "size,eval" "elm" emitted from the
10673     * edje object will cause this to happen too.
10674     *
10675     * @ingroup Layout
10676     */
10677    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10678
10679    /**
10680     * Sets a specific cursor for an edje part.
10681     *
10682     * @param obj The layout object.
10683     * @param part_name a part from loaded edje group.
10684     * @param cursor cursor name to use, see Elementary_Cursor.h
10685     *
10686     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10687     *         part not exists or it has "mouse_events: 0".
10688     *
10689     * @ingroup Layout
10690     */
10691    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10692
10693    /**
10694     * Get the cursor to be shown when mouse is over an edje part
10695     *
10696     * @param obj The layout object.
10697     * @param part_name a part from loaded edje group.
10698     * @return the cursor name.
10699     *
10700     * @ingroup Layout
10701     */
10702    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10703
10704    /**
10705     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10706     *
10707     * @param obj The layout object.
10708     * @param part_name a part from loaded edje group, that had a cursor set
10709     *        with elm_layout_part_cursor_set().
10710     *
10711     * @ingroup Layout
10712     */
10713    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10714
10715    /**
10716     * Sets a specific cursor style for an edje part.
10717     *
10718     * @param obj The layout object.
10719     * @param part_name a part from loaded edje group.
10720     * @param style the theme style to use (default, transparent, ...)
10721     *
10722     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10723     *         part not exists or it did not had a cursor set.
10724     *
10725     * @ingroup Layout
10726     */
10727    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10728
10729    /**
10730     * Gets a specific cursor style for an edje part.
10731     *
10732     * @param obj The layout object.
10733     * @param part_name a part from loaded edje group.
10734     *
10735     * @return the theme style in use, defaults to "default". If the
10736     *         object does not have a cursor set, then NULL is returned.
10737     *
10738     * @ingroup Layout
10739     */
10740    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10741
10742    /**
10743     * Sets if the cursor set should be searched on the theme or should use
10744     * the provided by the engine, only.
10745     *
10746     * @note before you set if should look on theme you should define a
10747     * cursor with elm_layout_part_cursor_set(). By default it will only
10748     * look for cursors provided by the engine.
10749     *
10750     * @param obj The layout object.
10751     * @param part_name a part from loaded edje group.
10752     * @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
10753     *        or should also search on widget's theme as well (EINA_FALSE)
10754     *
10755     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10756     *         part not exists or it did not had a cursor set.
10757     *
10758     * @ingroup Layout
10759     */
10760    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);
10761
10762    /**
10763     * Gets a specific cursor engine_only for an edje part.
10764     *
10765     * @param obj The layout object.
10766     * @param part_name a part from loaded edje group.
10767     *
10768     * @return whenever the cursor is just provided by engine or also from theme.
10769     *
10770     * @ingroup Layout
10771     */
10772    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10773
10774 /**
10775  * @def elm_layout_icon_set
10776  * Convenience macro to set the icon object in a layout that follows the
10777  * Elementary naming convention for its parts.
10778  *
10779  * @ingroup Layout
10780  */
10781 #define elm_layout_icon_set(_ly, _obj) \
10782   do { \
10783     const char *sig; \
10784     elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10785     if ((_obj)) sig = "elm,state,icon,visible"; \
10786     else sig = "elm,state,icon,hidden"; \
10787     elm_object_signal_emit((_ly), sig, "elm"); \
10788   } while (0)
10789
10790 /**
10791  * @def elm_layout_icon_get
10792  * Convienience macro to get the icon object from a layout that follows the
10793  * Elementary naming convention for its parts.
10794  *
10795  * @ingroup Layout
10796  */
10797 #define elm_layout_icon_get(_ly) \
10798   elm_object_part_content_get((_ly), "elm.swallow.icon")
10799
10800 /**
10801  * @def elm_layout_end_set
10802  * Convienience macro to set the end object in a layout that follows the
10803  * Elementary naming convention for its parts.
10804  *
10805  * @ingroup Layout
10806  */
10807 #define elm_layout_end_set(_ly, _obj) \
10808   do { \
10809     const char *sig; \
10810     elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10811     if ((_obj)) sig = "elm,state,end,visible"; \
10812     else sig = "elm,state,end,hidden"; \
10813     elm_object_signal_emit((_ly), sig, "elm"); \
10814   } while (0)
10815
10816 /**
10817  * @def elm_layout_end_get
10818  * Convienience macro to get the end object in a layout that follows the
10819  * Elementary naming convention for its parts.
10820  *
10821  * @ingroup Layout
10822  */
10823 #define elm_layout_end_get(_ly) \
10824   elm_object_part_content_get((_ly), "elm.swallow.end")
10825
10826 /**
10827  * @def elm_layout_label_set
10828  * Convienience macro to set the label in a layout that follows the
10829  * Elementary naming convention for its parts.
10830  *
10831  * @ingroup Layout
10832  * @deprecated use elm_object_text_set() instead.
10833  */
10834 #define elm_layout_label_set(_ly, _txt) \
10835   elm_layout_text_set((_ly), "elm.text", (_txt))
10836
10837 /**
10838  * @def elm_layout_label_get
10839  * Convenience macro to get the label in a layout that follows the
10840  * Elementary naming convention for its parts.
10841  *
10842  * @ingroup Layout
10843  * @deprecated use elm_object_text_set() instead.
10844  */
10845 #define elm_layout_label_get(_ly) \
10846   elm_layout_text_get((_ly), "elm.text")
10847
10848    /* smart callbacks called:
10849     * "theme,changed" - when elm theme is changed.
10850     */
10851
10852    /**
10853     * @defgroup Notify Notify
10854     *
10855     * @image html img/widget/notify/preview-00.png
10856     * @image latex img/widget/notify/preview-00.eps
10857     *
10858     * Display a container in a particular region of the parent(top, bottom,
10859     * etc).  A timeout can be set to automatically hide the notify. This is so
10860     * that, after an evas_object_show() on a notify object, if a timeout was set
10861     * on it, it will @b automatically get hidden after that time.
10862     *
10863     * Signals that you can add callbacks for are:
10864     * @li "timeout" - when timeout happens on notify and it's hidden
10865     * @li "block,clicked" - when a click outside of the notify happens
10866     *
10867     * Default contents parts of the notify widget that you can use for are:
10868     * @li "default" - A content of the notify
10869     *
10870     * @ref tutorial_notify show usage of the API.
10871     *
10872     * @{
10873     */
10874    /**
10875     * @brief Possible orient values for notify.
10876     *
10877     * This values should be used in conjunction to elm_notify_orient_set() to
10878     * set the position in which the notify should appear(relative to its parent)
10879     * and in conjunction with elm_notify_orient_get() to know where the notify
10880     * is appearing.
10881     */
10882    typedef enum _Elm_Notify_Orient
10883      {
10884         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10885         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10886         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10887         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10888         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10889         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10890         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10891         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10892         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10893         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10894      } Elm_Notify_Orient;
10895    /**
10896     * @brief Add a new notify to the parent
10897     *
10898     * @param parent The parent object
10899     * @return The new object or NULL if it cannot be created
10900     */
10901    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10902    /**
10903     * @brief Set the content of the notify widget
10904     *
10905     * @param obj The notify object
10906     * @param content The content will be filled in this notify object
10907     *
10908     * Once the content object is set, a previously set one will be deleted. If
10909     * you want to keep that old content object, use the
10910     * elm_notify_content_unset() function.
10911     *
10912     * @deprecated use elm_object_content_set() instead
10913     *
10914     */
10915    EINA_DEPRECATED EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10916    /**
10917     * @brief Unset the content of the notify widget
10918     *
10919     * @param obj The notify object
10920     * @return The content that was being used
10921     *
10922     * Unparent and return the content object which was set for this widget
10923     *
10924     * @see elm_notify_content_set()
10925     * @deprecated use elm_object_content_unset() instead
10926     *
10927     */
10928    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10929    /**
10930     * @brief Return the content of the notify widget
10931     *
10932     * @param obj The notify object
10933     * @return The content that is being used
10934     *
10935     * @see elm_notify_content_set()
10936     * @deprecated use elm_object_content_get() instead
10937     *
10938     */
10939    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10940    /**
10941     * @brief Set the notify parent
10942     *
10943     * @param obj The notify object
10944     * @param content The new parent
10945     *
10946     * Once the parent object is set, a previously set one will be disconnected
10947     * and replaced.
10948     */
10949    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10950    /**
10951     * @brief Get the notify parent
10952     *
10953     * @param obj The notify object
10954     * @return The parent
10955     *
10956     * @see elm_notify_parent_set()
10957     */
10958    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10959    /**
10960     * @brief Set the orientation
10961     *
10962     * @param obj The notify object
10963     * @param orient The new orientation
10964     *
10965     * Sets the position in which the notify will appear in its parent.
10966     *
10967     * @see @ref Elm_Notify_Orient for possible values.
10968     */
10969    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10970    /**
10971     * @brief Return the orientation
10972     * @param obj The notify object
10973     * @return The orientation of the notification
10974     *
10975     * @see elm_notify_orient_set()
10976     * @see Elm_Notify_Orient
10977     */
10978    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10979    /**
10980     * @brief Set the time interval after which the notify window is going to be
10981     * hidden.
10982     *
10983     * @param obj The notify object
10984     * @param time The timeout in seconds
10985     *
10986     * This function sets a timeout and starts the timer controlling when the
10987     * notify is hidden. Since calling evas_object_show() on a notify restarts
10988     * the timer controlling when the notify is hidden, setting this before the
10989     * notify is shown will in effect mean starting the timer when the notify is
10990     * shown.
10991     *
10992     * @note Set a value <= 0.0 to disable a running timer.
10993     *
10994     * @note If the value > 0.0 and the notify is previously visible, the
10995     * timer will be started with this value, canceling any running timer.
10996     */
10997    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10998    /**
10999     * @brief Return the timeout value (in seconds)
11000     * @param obj the notify object
11001     *
11002     * @see elm_notify_timeout_set()
11003     */
11004    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11005    /**
11006     * @brief Sets whether events should be passed to by a click outside
11007     * its area.
11008     *
11009     * @param obj The notify object
11010     * @param repeats EINA_TRUE Events are repeats, else no
11011     *
11012     * When true if the user clicks outside the window the events will be caught
11013     * by the others widgets, else the events are blocked.
11014     *
11015     * @note The default value is EINA_TRUE.
11016     */
11017    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
11018    /**
11019     * @brief Return true if events are repeat below the notify object
11020     * @param obj the notify object
11021     *
11022     * @see elm_notify_repeat_events_set()
11023     */
11024    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11025    /**
11026     * @}
11027     */
11028
11029    /**
11030     * @defgroup Hover Hover
11031     *
11032     * @image html img/widget/hover/preview-00.png
11033     * @image latex img/widget/hover/preview-00.eps
11034     *
11035     * A Hover object will hover over its @p parent object at the @p target
11036     * location. Anything in the background will be given a darker coloring to
11037     * indicate that the hover object is on top (at the default theme). When the
11038     * hover is clicked it is dismissed(hidden), if the contents of the hover are
11039     * clicked that @b doesn't cause the hover to be dismissed.
11040     *
11041     * A Hover object has two parents. One parent that owns it during creation
11042     * and the other parent being the one over which the hover object spans.
11043     *
11044     *
11045     * @note The hover object will take up the entire space of @p target
11046     * object.
11047     *
11048     * Elementary has the following styles for the hover widget:
11049     * @li default
11050     * @li popout
11051     * @li menu
11052     * @li hoversel_vertical
11053     *
11054     * The following are the available position for content:
11055     * @li left
11056     * @li top-left
11057     * @li top
11058     * @li top-right
11059     * @li right
11060     * @li bottom-right
11061     * @li bottom
11062     * @li bottom-left
11063     * @li middle
11064     * @li smart
11065     *
11066     * Signals that you can add callbacks for are:
11067     * @li "clicked" - the user clicked the empty space in the hover to dismiss
11068     * @li "smart,changed" - a content object placed under the "smart"
11069     *                   policy was replaced to a new slot direction.
11070     *
11071     * See @ref tutorial_hover for more information.
11072     *
11073     * @{
11074     */
11075    typedef enum _Elm_Hover_Axis
11076      {
11077         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
11078         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
11079         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
11080         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
11081      } Elm_Hover_Axis;
11082    /**
11083     * @brief Adds a hover object to @p parent
11084     *
11085     * @param parent The parent object
11086     * @return The hover object or NULL if one could not be created
11087     */
11088    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11089    /**
11090     * @brief Sets the target object for the hover.
11091     *
11092     * @param obj The hover object
11093     * @param target The object to center the hover onto.
11094     *
11095     * This function will cause the hover to be centered on the target object.
11096     */
11097    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
11098    /**
11099     * @brief Gets the target object for the hover.
11100     *
11101     * @param obj The hover object
11102     * @return The target object for the hover.
11103     *
11104     * @see elm_hover_target_set()
11105     */
11106    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11107    /**
11108     * @brief Sets the parent object for the hover.
11109     *
11110     * @param obj The hover object
11111     * @param parent The object to locate the hover over.
11112     *
11113     * This function will cause the hover to take up the entire space that the
11114     * parent object fills.
11115     */
11116    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11117    /**
11118     * @brief Gets the parent object for the hover.
11119     *
11120     * @param obj The hover object
11121     * @return The parent object to locate the hover over.
11122     *
11123     * @see elm_hover_parent_set()
11124     */
11125    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11126    /**
11127     * @brief Sets the content of the hover object and the direction in which it
11128     * will pop out.
11129     *
11130     * @param obj The hover object
11131     * @param swallow The direction that the object will be displayed
11132     * at. Accepted values are "left", "top-left", "top", "top-right",
11133     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
11134     * "smart".
11135     * @param content The content to place at @p swallow
11136     *
11137     * Once the content object is set for a given direction, a previously
11138     * set one (on the same direction) will be deleted. If you want to
11139     * keep that old content object, use the elm_hover_content_unset()
11140     * function.
11141     *
11142     * All directions may have contents at the same time, except for
11143     * "smart". This is a special placement hint and its use case
11144     * independs of the calculations coming from
11145     * elm_hover_best_content_location_get(). Its use is for cases when
11146     * one desires only one hover content, but with a dynamic special
11147     * placement within the hover area. The content's geometry, whenever
11148     * it changes, will be used to decide on a best location, not
11149     * extrapolating the hover's parent object view to show it in (still
11150     * being the hover's target determinant of its medium part -- move and
11151     * resize it to simulate finger sizes, for example). If one of the
11152     * directions other than "smart" are used, a previously content set
11153     * using it will be deleted, and vice-versa.
11154     */
11155    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
11156    /**
11157     * @brief Get the content of the hover object, in a given direction.
11158     *
11159     * Return the content object which was set for this widget in the
11160     * @p swallow direction.
11161     *
11162     * @param obj The hover object
11163     * @param swallow The direction that the object was display at.
11164     * @return The content that was being used
11165     *
11166     * @see elm_hover_content_set()
11167     */
11168    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
11169    /**
11170     * @brief Unset the content of the hover object, in a given direction.
11171     *
11172     * Unparent and return the content object set at @p swallow direction.
11173     *
11174     * @param obj The hover object
11175     * @param swallow The direction that the object was display at.
11176     * @return The content that was being used.
11177     *
11178     * @see elm_hover_content_set()
11179     */
11180    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
11181    /**
11182     * @brief Returns the best swallow location for content in the hover.
11183     *
11184     * @param obj The hover object
11185     * @param pref_axis The preferred orientation axis for the hover object to use
11186     * @return The edje location to place content into the hover or @c
11187     *         NULL, on errors.
11188     *
11189     * Best is defined here as the location at which there is the most available
11190     * space.
11191     *
11192     * @p pref_axis may be one of
11193     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
11194     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
11195     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
11196     * - @c ELM_HOVER_AXIS_BOTH -- both
11197     *
11198     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
11199     * nescessarily be along the horizontal axis("left" or "right"). If
11200     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
11201     * be along the vertical axis("top" or "bottom"). Chossing
11202     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
11203     * returned position may be in either axis.
11204     *
11205     * @see elm_hover_content_set()
11206     */
11207    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
11208    /**
11209     * @}
11210     */
11211
11212    /* entry */
11213    /**
11214     * @defgroup Entry Entry
11215     *
11216     * @image html img/widget/entry/preview-00.png
11217     * @image latex img/widget/entry/preview-00.eps width=\textwidth
11218     * @image html img/widget/entry/preview-01.png
11219     * @image latex img/widget/entry/preview-01.eps width=\textwidth
11220     * @image html img/widget/entry/preview-02.png
11221     * @image latex img/widget/entry/preview-02.eps width=\textwidth
11222     * @image html img/widget/entry/preview-03.png
11223     * @image latex img/widget/entry/preview-03.eps width=\textwidth
11224     *
11225     * An entry is a convenience widget which shows a box that the user can
11226     * enter text into. Entries by default don't scroll, so they grow to
11227     * accomodate the entire text, resizing the parent window as needed. This
11228     * can be changed with the elm_entry_scrollable_set() function.
11229     *
11230     * They can also be single line or multi line (the default) and when set
11231     * to multi line mode they support text wrapping in any of the modes
11232     * indicated by #Elm_Wrap_Type.
11233     *
11234     * Other features include password mode, filtering of inserted text with
11235     * elm_entry_text_filter_append() and related functions, inline "items" and
11236     * formatted markup text.
11237     *
11238     * @section entry-markup Formatted text
11239     *
11240     * The markup tags supported by the Entry are defined by the theme, but
11241     * even when writing new themes or extensions it's a good idea to stick to
11242     * a sane default, to maintain coherency and avoid application breakages.
11243     * Currently defined by the default theme are the following tags:
11244     * @li \<br\>: Inserts a line break.
11245     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
11246     * breaks.
11247     * @li \<tab\>: Inserts a tab.
11248     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
11249     * enclosed text.
11250     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
11251     * @li \<link\>...\</link\>: Underlines the enclosed text.
11252     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
11253     *
11254     * @section entry-special Special markups
11255     *
11256     * Besides those used to format text, entries support two special markup
11257     * tags used to insert clickable portions of text or items inlined within
11258     * the text.
11259     *
11260     * @subsection entry-anchors Anchors
11261     *
11262     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
11263     * \</a\> tags and an event will be generated when this text is clicked,
11264     * like this:
11265     *
11266     * @code
11267     * This text is outside <a href=anc-01>but this one is an anchor</a>
11268     * @endcode
11269     *
11270     * The @c href attribute in the opening tag gives the name that will be
11271     * used to identify the anchor and it can be any valid utf8 string.
11272     *
11273     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
11274     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
11275     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
11276     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
11277     * an anchor.
11278     *
11279     * @subsection entry-items Items
11280     *
11281     * Inlined in the text, any other @c Evas_Object can be inserted by using
11282     * \<item\> tags this way:
11283     *
11284     * @code
11285     * <item size=16x16 vsize=full href=emoticon/haha></item>
11286     * @endcode
11287     *
11288     * Just like with anchors, the @c href identifies each item, but these need,
11289     * in addition, to indicate their size, which is done using any one of
11290     * @c size, @c absize or @c relsize attributes. These attributes take their
11291     * value in the WxH format, where W is the width and H the height of the
11292     * item.
11293     *
11294     * @li absize: Absolute pixel size for the item. Whatever value is set will
11295     * be the item's size regardless of any scale value the object may have
11296     * been set to. The final line height will be adjusted to fit larger items.
11297     * @li size: Similar to @c absize, but it's adjusted to the scale value set
11298     * for the object.
11299     * @li relsize: Size is adjusted for the item to fit within the current
11300     * line height.
11301     *
11302     * Besides their size, items are specificed a @c vsize value that affects
11303     * how their final size and position are calculated. The possible values
11304     * are:
11305     * @li ascent: Item will be placed within the line's baseline and its
11306     * ascent. That is, the height between the line where all characters are
11307     * positioned and the highest point in the line. For @c size and @c absize
11308     * items, the descent value will be added to the total line height to make
11309     * them fit. @c relsize items will be adjusted to fit within this space.
11310     * @li full: Items will be placed between the descent and ascent, or the
11311     * lowest point in the line and its highest.
11312     *
11313     * The next image shows different configurations of items and how
11314     * the previously mentioned options affect their sizes. In all cases,
11315     * the green line indicates the ascent, blue for the baseline and red for
11316     * the descent.
11317     *
11318     * @image html entry_item.png
11319     * @image latex entry_item.eps width=\textwidth
11320     *
11321     * And another one to show how size differs from absize. In the first one,
11322     * the scale value is set to 1.0, while the second one is using one of 2.0.
11323     *
11324     * @image html entry_item_scale.png
11325     * @image latex entry_item_scale.eps width=\textwidth
11326     *
11327     * After the size for an item is calculated, the entry will request an
11328     * object to place in its space. For this, the functions set with
11329     * elm_entry_item_provider_append() and related functions will be called
11330     * in order until one of them returns a @c non-NULL value. If no providers
11331     * are available, or all of them return @c NULL, then the entry falls back
11332     * to one of the internal defaults, provided the name matches with one of
11333     * them.
11334     *
11335     * All of the following are currently supported:
11336     *
11337     * - emoticon/angry
11338     * - emoticon/angry-shout
11339     * - emoticon/crazy-laugh
11340     * - emoticon/evil-laugh
11341     * - emoticon/evil
11342     * - emoticon/goggle-smile
11343     * - emoticon/grumpy
11344     * - emoticon/grumpy-smile
11345     * - emoticon/guilty
11346     * - emoticon/guilty-smile
11347     * - emoticon/haha
11348     * - emoticon/half-smile
11349     * - emoticon/happy-panting
11350     * - emoticon/happy
11351     * - emoticon/indifferent
11352     * - emoticon/kiss
11353     * - emoticon/knowing-grin
11354     * - emoticon/laugh
11355     * - emoticon/little-bit-sorry
11356     * - emoticon/love-lots
11357     * - emoticon/love
11358     * - emoticon/minimal-smile
11359     * - emoticon/not-happy
11360     * - emoticon/not-impressed
11361     * - emoticon/omg
11362     * - emoticon/opensmile
11363     * - emoticon/smile
11364     * - emoticon/sorry
11365     * - emoticon/squint-laugh
11366     * - emoticon/surprised
11367     * - emoticon/suspicious
11368     * - emoticon/tongue-dangling
11369     * - emoticon/tongue-poke
11370     * - emoticon/uh
11371     * - emoticon/unhappy
11372     * - emoticon/very-sorry
11373     * - emoticon/what
11374     * - emoticon/wink
11375     * - emoticon/worried
11376     * - emoticon/wtf
11377     *
11378     * Alternatively, an item may reference an image by its path, using
11379     * the URI form @c file:///path/to/an/image.png and the entry will then
11380     * use that image for the item.
11381     *
11382     * @section entry-files Loading and saving files
11383     *
11384     * Entries have convinience functions to load text from a file and save
11385     * changes back to it after a short delay. The automatic saving is enabled
11386     * by default, but can be disabled with elm_entry_autosave_set() and files
11387     * can be loaded directly as plain text or have any markup in them
11388     * recognized. See elm_entry_file_set() for more details.
11389     *
11390     * @section entry-signals Emitted signals
11391     *
11392     * This widget emits the following signals:
11393     *
11394     * @li "changed": The text within the entry was changed.
11395     * @li "changed,user": The text within the entry was changed because of user interaction.
11396     * @li "activated": The enter key was pressed on a single line entry.
11397     * @li "press": A mouse button has been pressed on the entry.
11398     * @li "longpressed": A mouse button has been pressed and held for a couple
11399     * seconds.
11400     * @li "clicked": The entry has been clicked (mouse press and release).
11401     * @li "clicked,double": The entry has been double clicked.
11402     * @li "clicked,triple": The entry has been triple clicked.
11403     * @li "focused": The entry has received focus.
11404     * @li "unfocused": The entry has lost focus.
11405     * @li "selection,paste": A paste of the clipboard contents was requested.
11406     * @li "selection,copy": A copy of the selected text into the clipboard was
11407     * requested.
11408     * @li "selection,cut": A cut of the selected text into the clipboard was
11409     * requested.
11410     * @li "selection,start": A selection has begun and no previous selection
11411     * existed.
11412     * @li "selection,changed": The current selection has changed.
11413     * @li "selection,cleared": The current selection has been cleared.
11414     * @li "cursor,changed": The cursor has changed position.
11415     * @li "anchor,clicked": An anchor has been clicked. The event_info
11416     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11417     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11418     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11419     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11420     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11421     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11422     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11423     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11424     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11425     * @li "preedit,changed": The preedit string has changed.
11426     * @li "language,changed": Program language changed.
11427     *
11428     * @section entry-examples
11429     *
11430     * An overview of the Entry API can be seen in @ref entry_example_01
11431     *
11432     * @{
11433     */
11434    /**
11435     * @typedef Elm_Entry_Anchor_Info
11436     *
11437     * The info sent in the callback for the "anchor,clicked" signals emitted
11438     * by entries.
11439     */
11440    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11441    /**
11442     * @struct _Elm_Entry_Anchor_Info
11443     *
11444     * The info sent in the callback for the "anchor,clicked" signals emitted
11445     * by entries.
11446     */
11447    struct _Elm_Entry_Anchor_Info
11448      {
11449         const char *name; /**< The name of the anchor, as stated in its href */
11450         int         button; /**< The mouse button used to click on it */
11451         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
11452                     y, /**< Anchor geometry, relative to canvas */
11453                     w, /**< Anchor geometry, relative to canvas */
11454                     h; /**< Anchor geometry, relative to canvas */
11455      };
11456    /**
11457     * @typedef Elm_Entry_Filter_Cb
11458     * This callback type is used by entry filters to modify text.
11459     * @param data The data specified as the last param when adding the filter
11460     * @param entry The entry object
11461     * @param text A pointer to the location of the text being filtered. This data can be modified,
11462     * but any additional allocations must be managed by the user.
11463     * @see elm_entry_text_filter_append
11464     * @see elm_entry_text_filter_prepend
11465     */
11466    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11467
11468    /**
11469     * @typedef Elm_Entry_Change_Info
11470     * This corresponds to Edje_Entry_Change_Info. Includes information about
11471     * a change in the entry.
11472     */
11473    typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
11474
11475
11476    /**
11477     * This adds an entry to @p parent object.
11478     *
11479     * By default, entries are:
11480     * @li not scrolled
11481     * @li multi-line
11482     * @li word wrapped
11483     * @li autosave is enabled
11484     *
11485     * @param parent The parent object
11486     * @return The new object or NULL if it cannot be created
11487     */
11488    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11489    /**
11490     * Sets the entry to single line mode.
11491     *
11492     * In single line mode, entries don't ever wrap when the text reaches the
11493     * edge, and instead they keep growing horizontally. Pressing the @c Enter
11494     * key will generate an @c "activate" event instead of adding a new line.
11495     *
11496     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11497     * and pressing enter will break the text into a different line
11498     * without generating any events.
11499     *
11500     * @param obj The entry object
11501     * @param single_line If true, the text in the entry
11502     * will be on a single line.
11503     */
11504    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11505    /**
11506     * Gets whether the entry is set to be single line.
11507     *
11508     * @param obj The entry object
11509     * @return single_line If true, the text in the entry is set to display
11510     * on a single line.
11511     *
11512     * @see elm_entry_single_line_set()
11513     */
11514    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11515    /**
11516     * Sets the entry to password mode.
11517     *
11518     * In password mode, entries are implicitly single line and the display of
11519     * any text in them is replaced with asterisks (*).
11520     *
11521     * @param obj The entry object
11522     * @param password If true, password mode is enabled.
11523     */
11524    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11525    /**
11526     * Gets whether the entry is set to password mode.
11527     *
11528     * @param obj The entry object
11529     * @return If true, the entry is set to display all characters
11530     * as asterisks (*).
11531     *
11532     * @see elm_entry_password_set()
11533     */
11534    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11535    /**
11536     * This sets the text displayed within the entry to @p entry.
11537     *
11538     * @param obj The entry object
11539     * @param entry The text to be displayed
11540     *
11541     * @deprecated Use elm_object_text_set() instead.
11542     * @note Using this function bypasses text filters
11543     */
11544    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11545    /**
11546     * This returns the text currently shown in object @p entry.
11547     * See also elm_entry_entry_set().
11548     *
11549     * @param obj The entry object
11550     * @return The currently displayed text or NULL on failure
11551     *
11552     * @deprecated Use elm_object_text_get() instead.
11553     */
11554    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11555    /**
11556     * Appends @p entry to the text of the entry.
11557     *
11558     * Adds the text in @p entry to the end of any text already present in the
11559     * widget.
11560     *
11561     * The appended text is subject to any filters set for the widget.
11562     *
11563     * @param obj The entry object
11564     * @param entry The text to be displayed
11565     *
11566     * @see elm_entry_text_filter_append()
11567     */
11568    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11569    /**
11570     * Gets whether the entry is empty.
11571     *
11572     * Empty means no text at all. If there are any markup tags, like an item
11573     * tag for which no provider finds anything, and no text is displayed, this
11574     * function still returns EINA_FALSE.
11575     *
11576     * @param obj The entry object
11577     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11578     */
11579    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11580    /**
11581     * Gets any selected text within the entry.
11582     *
11583     * If there's any selected text in the entry, this function returns it as
11584     * a string in markup format. NULL is returned if no selection exists or
11585     * if an error occurred.
11586     *
11587     * The returned value points to an internal string and should not be freed
11588     * or modified in any way. If the @p entry object is deleted or its
11589     * contents are changed, the returned pointer should be considered invalid.
11590     *
11591     * @param obj The entry object
11592     * @return The selected text within the entry or NULL on failure
11593     */
11594    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11595    /**
11596     * Returns the actual textblock object of the entry.
11597     *
11598     * This function exposes the internal textblock object that actually
11599     * contains and draws the text. This should be used for low-level
11600     * manipulations that are otherwise not possible.
11601     *
11602     * Changing the textblock directly from here will not notify edje/elm to
11603     * recalculate the textblock size automatically, so any modifications
11604     * done to the textblock returned by this function should be followed by
11605     * a call to elm_entry_calc_force().
11606     *
11607     * The return value is marked as const as an additional warning.
11608     * One should not use the returned object with any of the generic evas
11609     * functions (geometry_get/resize/move and etc), but only with the textblock
11610     * functions; The former will either not work at all, or break the correct
11611     * functionality.
11612     *
11613     * IMPORTANT: Many functions may change (i.e delete and create a new one)
11614     * the internal textblock object. Do NOT cache the returned object, and try
11615     * not to mix calls on this object with regular elm_entry calls (which may
11616     * change the internal textblock object). This applies to all cursors
11617     * returned from textblock calls, and all the other derivative values.
11618     *
11619     * @param obj The entry object
11620     * @return The textblock object.
11621     */
11622    EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11623    /**
11624     * Forces calculation of the entry size and text layouting.
11625     *
11626     * This should be used after modifying the textblock object directly. See
11627     * elm_entry_textblock_get() for more information.
11628     *
11629     * @param obj The entry object
11630     *
11631     * @see elm_entry_textblock_get()
11632     */
11633    EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11634    /**
11635     * Inserts the given text into the entry at the current cursor position.
11636     *
11637     * This inserts text at the cursor position as if it was typed
11638     * by the user (note that this also allows markup which a user
11639     * can't just "type" as it would be converted to escaped text, so this
11640     * call can be used to insert things like emoticon items or bold push/pop
11641     * tags, other font and color change tags etc.)
11642     *
11643     * If any selection exists, it will be replaced by the inserted text.
11644     *
11645     * The inserted text is subject to any filters set for the widget.
11646     *
11647     * @param obj The entry object
11648     * @param entry The text to insert
11649     *
11650     * @see elm_entry_text_filter_append()
11651     */
11652    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11653    /**
11654     * Set the line wrap type to use on multi-line entries.
11655     *
11656     * Sets the wrap type used by the entry to any of the specified in
11657     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11658     * line (without inserting a line break or paragraph separator) when it
11659     * reaches the far edge of the widget.
11660     *
11661     * Note that this only makes sense for multi-line entries. A widget set
11662     * to be single line will never wrap.
11663     *
11664     * @param obj The entry object
11665     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11666     */
11667    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11668    /**
11669     * Gets the wrap mode the entry was set to use.
11670     *
11671     * @param obj The entry object
11672     * @return Wrap type
11673     *
11674     * @see also elm_entry_line_wrap_set()
11675     */
11676    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11677    /**
11678     * Sets if the entry is to be editable or not.
11679     *
11680     * By default, entries are editable and when focused, any text input by the
11681     * user will be inserted at the current cursor position. But calling this
11682     * function with @p editable as EINA_FALSE will prevent the user from
11683     * inputting text into the entry.
11684     *
11685     * The only way to change the text of a non-editable entry is to use
11686     * elm_object_text_set(), elm_entry_entry_insert() and other related
11687     * functions.
11688     *
11689     * @param obj The entry object
11690     * @param editable If EINA_TRUE, user input will be inserted in the entry,
11691     * if not, the entry is read-only and no user input is allowed.
11692     */
11693    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11694    /**
11695     * Gets whether the entry is editable or not.
11696     *
11697     * @param obj The entry object
11698     * @return If true, the entry is editable by the user.
11699     * If false, it is not editable by the user
11700     *
11701     * @see elm_entry_editable_set()
11702     */
11703    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11704    /**
11705     * This drops any existing text selection within the entry.
11706     *
11707     * @param obj The entry object
11708     */
11709    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11710    /**
11711     * This selects all text within the entry.
11712     *
11713     * @param obj The entry object
11714     */
11715    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11716    /**
11717     * This moves the cursor one place to the right within the entry.
11718     *
11719     * @param obj The entry object
11720     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11721     */
11722    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11723    /**
11724     * This moves the cursor one place to the left within the entry.
11725     *
11726     * @param obj The entry object
11727     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11728     */
11729    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11730    /**
11731     * This moves the cursor one line up within the entry.
11732     *
11733     * @param obj The entry object
11734     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11735     */
11736    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11737    /**
11738     * This moves the cursor one line down within the entry.
11739     *
11740     * @param obj The entry object
11741     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11742     */
11743    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11744    /**
11745     * This moves the cursor to the beginning of the entry.
11746     *
11747     * @param obj The entry object
11748     */
11749    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11750    /**
11751     * This moves the cursor to the end of the entry.
11752     *
11753     * @param obj The entry object
11754     */
11755    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11756    /**
11757     * This moves the cursor to the beginning of the current line.
11758     *
11759     * @param obj The entry object
11760     */
11761    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11762    /**
11763     * This moves the cursor to the end of the current line.
11764     *
11765     * @param obj The entry object
11766     */
11767    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11768    /**
11769     * This begins a selection within the entry as though
11770     * the user were holding down the mouse button to make a selection.
11771     *
11772     * @param obj The entry object
11773     */
11774    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11775    /**
11776     * This ends a selection within the entry as though
11777     * the user had just released the mouse button while making a selection.
11778     *
11779     * @param obj The entry object
11780     */
11781    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11782    /**
11783     * Gets whether a format node exists at the current cursor position.
11784     *
11785     * A format node is anything that defines how the text is rendered. It can
11786     * be a visible format node, such as a line break or a paragraph separator,
11787     * or an invisible one, such as bold begin or end tag.
11788     * This function returns whether any format node exists at the current
11789     * cursor position.
11790     *
11791     * @param obj The entry object
11792     * @return EINA_TRUE if the current cursor position contains a format node,
11793     * EINA_FALSE otherwise.
11794     *
11795     * @see elm_entry_cursor_is_visible_format_get()
11796     */
11797    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11798    /**
11799     * Gets if the current cursor position holds a visible format node.
11800     *
11801     * @param obj The entry object
11802     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11803     * if it's an invisible one or no format exists.
11804     *
11805     * @see elm_entry_cursor_is_format_get()
11806     */
11807    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11808    /**
11809     * Gets the character pointed by the cursor at its current position.
11810     *
11811     * This function returns a string with the utf8 character stored at the
11812     * current cursor position.
11813     * Only the text is returned, any format that may exist will not be part
11814     * of the return value.
11815     *
11816     * @param obj The entry object
11817     * @return The text pointed by the cursors.
11818     */
11819    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11820    /**
11821     * This function returns the geometry of the cursor.
11822     *
11823     * It's useful if you want to draw something on the cursor (or where it is),
11824     * or for example in the case of scrolled entry where you want to show the
11825     * cursor.
11826     *
11827     * @param obj The entry object
11828     * @param x returned geometry
11829     * @param y returned geometry
11830     * @param w returned geometry
11831     * @param h returned geometry
11832     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11833     */
11834    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);
11835    /**
11836     * Sets the cursor position in the entry to the given value
11837     *
11838     * The value in @p pos is the index of the character position within the
11839     * contents of the string as returned by elm_entry_cursor_pos_get().
11840     *
11841     * @param obj The entry object
11842     * @param pos The position of the cursor
11843     */
11844    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11845    /**
11846     * Retrieves the current position of the cursor in the entry
11847     *
11848     * @param obj The entry object
11849     * @return The cursor position
11850     */
11851    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11852    /**
11853     * This executes a "cut" action on the selected text in the entry.
11854     *
11855     * @param obj The entry object
11856     */
11857    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11858    /**
11859     * This executes a "copy" action on the selected text in the entry.
11860     *
11861     * @param obj The entry object
11862     */
11863    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11864    /**
11865     * This executes a "paste" action in the entry.
11866     *
11867     * @param obj The entry object
11868     */
11869    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11870    /**
11871     * This clears and frees the items in a entry's contextual (longpress)
11872     * menu.
11873     *
11874     * @param obj The entry object
11875     *
11876     * @see elm_entry_context_menu_item_add()
11877     */
11878    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11879    /**
11880     * This adds an item to the entry's contextual menu.
11881     *
11882     * A longpress on an entry will make the contextual menu show up, if this
11883     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11884     * By default, this menu provides a few options like enabling selection mode,
11885     * which is useful on embedded devices that need to be explicit about it,
11886     * and when a selection exists it also shows the copy and cut actions.
11887     *
11888     * With this function, developers can add other options to this menu to
11889     * perform any action they deem necessary.
11890     *
11891     * @param obj The entry object
11892     * @param label The item's text label
11893     * @param icon_file The item's icon file
11894     * @param icon_type The item's icon type
11895     * @param func The callback to execute when the item is clicked
11896     * @param data The data to associate with the item for related functions
11897     */
11898    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);
11899    /**
11900     * This disables the entry's contextual (longpress) menu.
11901     *
11902     * @param obj The entry object
11903     * @param disabled If true, the menu is disabled
11904     */
11905    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11906    /**
11907     * This returns whether the entry's contextual (longpress) menu is
11908     * disabled.
11909     *
11910     * @param obj The entry object
11911     * @return If true, the menu is disabled
11912     */
11913    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11914    /**
11915     * This appends a custom item provider to the list for that entry
11916     *
11917     * This appends the given callback. The list is walked from beginning to end
11918     * with each function called given the item href string in the text. If the
11919     * function returns an object handle other than NULL (it should create an
11920     * object to do this), then this object is used to replace that item. If
11921     * not the next provider is called until one provides an item object, or the
11922     * default provider in entry does.
11923     *
11924     * @param obj The entry object
11925     * @param func The function called to provide the item object
11926     * @param data The data passed to @p func
11927     *
11928     * @see @ref entry-items
11929     */
11930    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);
11931    /**
11932     * This prepends a custom item provider to the list for that entry
11933     *
11934     * This prepends the given callback. See elm_entry_item_provider_append() for
11935     * more information
11936     *
11937     * @param obj The entry object
11938     * @param func The function called to provide the item object
11939     * @param data The data passed to @p func
11940     */
11941    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);
11942    /**
11943     * This removes a custom item provider to the list for that entry
11944     *
11945     * This removes the given callback. See elm_entry_item_provider_append() for
11946     * more information
11947     *
11948     * @param obj The entry object
11949     * @param func The function called to provide the item object
11950     * @param data The data passed to @p func
11951     */
11952    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);
11953    /**
11954     * Append a filter function for text inserted in the entry
11955     *
11956     * Append the given callback to the list. This functions will be called
11957     * whenever any text is inserted into the entry, with the text to be inserted
11958     * as a parameter. The callback function is free to alter the text in any way
11959     * it wants, but it must remember to free the given pointer and update it.
11960     * If the new text is to be discarded, the function can free it and set its
11961     * text parameter to NULL. This will also prevent any following filters from
11962     * being called.
11963     *
11964     * @param obj The entry object
11965     * @param func The function to use as text filter
11966     * @param data User data to pass to @p func
11967     */
11968    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11969    /**
11970     * Prepend a filter function for text insdrted in the entry
11971     *
11972     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11973     * for more information
11974     *
11975     * @param obj The entry object
11976     * @param func The function to use as text filter
11977     * @param data User data to pass to @p func
11978     */
11979    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11980    /**
11981     * Remove a filter from the list
11982     *
11983     * Removes the given callback from the filter list. See
11984     * elm_entry_text_filter_append() for more information.
11985     *
11986     * @param obj The entry object
11987     * @param func The filter function to remove
11988     * @param data The user data passed when adding the function
11989     */
11990    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11991    /**
11992     * This converts a markup (HTML-like) string into UTF-8.
11993     *
11994     * The returned string is a malloc'ed buffer and it should be freed when
11995     * not needed anymore.
11996     *
11997     * @param s The string (in markup) to be converted
11998     * @return The converted string (in UTF-8). It should be freed.
11999     */
12000    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
12001    /**
12002     * This converts a UTF-8 string into markup (HTML-like).
12003     *
12004     * The returned string is a malloc'ed buffer and it should be freed when
12005     * not needed anymore.
12006     *
12007     * @param s The string (in UTF-8) to be converted
12008     * @return The converted string (in markup). It should be freed.
12009     */
12010    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
12011    /**
12012     * This sets the file (and implicitly loads it) for the text to display and
12013     * then edit. All changes are written back to the file after a short delay if
12014     * the entry object is set to autosave (which is the default).
12015     *
12016     * If the entry had any other file set previously, any changes made to it
12017     * will be saved if the autosave feature is enabled, otherwise, the file
12018     * will be silently discarded and any non-saved changes will be lost.
12019     *
12020     * @param obj The entry object
12021     * @param file The path to the file to load and save
12022     * @param format The file format
12023     */
12024    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
12025    /**
12026     * Gets the file being edited by the entry.
12027     *
12028     * This function can be used to retrieve any file set on the entry for
12029     * edition, along with the format used to load and save it.
12030     *
12031     * @param obj The entry object
12032     * @param file The path to the file to load and save
12033     * @param format The file format
12034     */
12035    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
12036    /**
12037     * This function writes any changes made to the file set with
12038     * elm_entry_file_set()
12039     *
12040     * @param obj The entry object
12041     */
12042    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
12043    /**
12044     * This sets the entry object to 'autosave' the loaded text file or not.
12045     *
12046     * @param obj The entry object
12047     * @param autosave Autosave the loaded file or not
12048     *
12049     * @see elm_entry_file_set()
12050     */
12051    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
12052    /**
12053     * This gets the entry object's 'autosave' status.
12054     *
12055     * @param obj The entry object
12056     * @return Autosave the loaded file or not
12057     *
12058     * @see elm_entry_file_set()
12059     */
12060    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12061    /**
12062     * Control pasting of text and images for the widget.
12063     *
12064     * Normally the entry allows both text and images to be pasted.  By setting
12065     * textonly to be true, this prevents images from being pasted.
12066     *
12067     * Note this only changes the behaviour of text.
12068     *
12069     * @param obj The entry object
12070     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
12071     * text+image+other.
12072     */
12073    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
12074    /**
12075     * Getting elm_entry text paste/drop mode.
12076     *
12077     * In textonly mode, only text may be pasted or dropped into the widget.
12078     *
12079     * @param obj The entry object
12080     * @return If the widget only accepts text from pastes.
12081     */
12082    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12083    /**
12084     * Enable or disable scrolling in entry
12085     *
12086     * Normally the entry is not scrollable unless you enable it with this call.
12087     *
12088     * @param obj The entry object
12089     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
12090     */
12091    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
12092    /**
12093     * Get the scrollable state of the entry
12094     *
12095     * Normally the entry is not scrollable. This gets the scrollable state
12096     * of the entry. See elm_entry_scrollable_set() for more information.
12097     *
12098     * @param obj The entry object
12099     * @return The scrollable state
12100     */
12101    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
12102    /**
12103     * This sets a widget to be displayed to the left of a scrolled entry.
12104     *
12105     * @param obj The scrolled entry object
12106     * @param icon The widget to display on the left side of the scrolled
12107     * entry.
12108     *
12109     * @note A previously set widget will be destroyed.
12110     * @note If the object being set does not have minimum size hints set,
12111     * it won't get properly displayed.
12112     *
12113     * @see elm_entry_end_set()
12114     */
12115    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
12116    /**
12117     * Gets the leftmost widget of the scrolled entry. This object is
12118     * owned by the scrolled entry and should not be modified.
12119     *
12120     * @param obj The scrolled entry object
12121     * @return the left widget inside the scroller
12122     */
12123    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
12124    /**
12125     * Unset the leftmost widget of the scrolled entry, unparenting and
12126     * returning it.
12127     *
12128     * @param obj The scrolled entry object
12129     * @return the previously set icon sub-object of this entry, on
12130     * success.
12131     *
12132     * @see elm_entry_icon_set()
12133     */
12134    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
12135    /**
12136     * Sets the visibility of the left-side widget of the scrolled entry,
12137     * set by elm_entry_icon_set().
12138     *
12139     * @param obj The scrolled entry object
12140     * @param setting EINA_TRUE if the object should be displayed,
12141     * EINA_FALSE if not.
12142     */
12143    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
12144    /**
12145     * This sets a widget to be displayed to the end of a scrolled entry.
12146     *
12147     * @param obj The scrolled entry object
12148     * @param end The widget to display on the right side of the scrolled
12149     * entry.
12150     *
12151     * @note A previously set widget will be destroyed.
12152     * @note If the object being set does not have minimum size hints set,
12153     * it won't get properly displayed.
12154     *
12155     * @see elm_entry_icon_set
12156     */
12157    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
12158    /**
12159     * Gets the endmost widget of the scrolled entry. This object is owned
12160     * by the scrolled entry and should not be modified.
12161     *
12162     * @param obj The scrolled entry object
12163     * @return the right widget inside the scroller
12164     */
12165    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
12166    /**
12167     * Unset the endmost widget of the scrolled entry, unparenting and
12168     * returning it.
12169     *
12170     * @param obj The scrolled entry object
12171     * @return the previously set icon sub-object of this entry, on
12172     * success.
12173     *
12174     * @see elm_entry_icon_set()
12175     */
12176    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
12177    /**
12178     * Sets the visibility of the end widget of the scrolled entry, set by
12179     * elm_entry_end_set().
12180     *
12181     * @param obj The scrolled entry object
12182     * @param setting EINA_TRUE if the object should be displayed,
12183     * EINA_FALSE if not.
12184     */
12185    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
12186    /**
12187     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
12188     * them).
12189     *
12190     * Setting an entry to single-line mode with elm_entry_single_line_set()
12191     * will automatically disable the display of scrollbars when the entry
12192     * moves inside its scroller.
12193     *
12194     * @param obj The scrolled entry object
12195     * @param h The horizontal scrollbar policy to apply
12196     * @param v The vertical scrollbar policy to apply
12197     */
12198    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
12199    /**
12200     * This enables/disables bouncing within the entry.
12201     *
12202     * This function sets whether the entry will bounce when scrolling reaches
12203     * the end of the contained entry.
12204     *
12205     * @param obj The scrolled entry object
12206     * @param h The horizontal bounce state
12207     * @param v The vertical bounce state
12208     */
12209    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
12210    /**
12211     * Get the bounce mode
12212     *
12213     * @param obj The Entry object
12214     * @param h_bounce Allow bounce horizontally
12215     * @param v_bounce Allow bounce vertically
12216     */
12217    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
12218
12219    /* pre-made filters for entries */
12220    /**
12221     * @typedef Elm_Entry_Filter_Limit_Size
12222     *
12223     * Data for the elm_entry_filter_limit_size() entry filter.
12224     */
12225    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
12226    /**
12227     * @struct _Elm_Entry_Filter_Limit_Size
12228     *
12229     * Data for the elm_entry_filter_limit_size() entry filter.
12230     */
12231    struct _Elm_Entry_Filter_Limit_Size
12232      {
12233         int max_char_count; /**< The maximum number of characters allowed. */
12234         int max_byte_count; /**< The maximum number of bytes allowed*/
12235      };
12236    /**
12237     * Filter inserted text based on user defined character and byte limits
12238     *
12239     * Add this filter to an entry to limit the characters that it will accept
12240     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
12241     * The funtion works on the UTF-8 representation of the string, converting
12242     * it from the set markup, thus not accounting for any format in it.
12243     *
12244     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
12245     * it as data when setting the filter. In it, it's possible to set limits
12246     * by character count or bytes (any of them is disabled if 0), and both can
12247     * be set at the same time. In that case, it first checks for characters,
12248     * then bytes.
12249     *
12250     * The function will cut the inserted text in order to allow only the first
12251     * number of characters that are still allowed. The cut is made in
12252     * characters, even when limiting by bytes, in order to always contain
12253     * valid ones and avoid half unicode characters making it in.
12254     *
12255     * This filter, like any others, does not apply when setting the entry text
12256     * directly with elm_object_text_set() (or the deprecated
12257     * elm_entry_entry_set()).
12258     */
12259    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
12260    /**
12261     * @typedef Elm_Entry_Filter_Accept_Set
12262     *
12263     * Data for the elm_entry_filter_accept_set() entry filter.
12264     */
12265    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
12266    /**
12267     * @struct _Elm_Entry_Filter_Accept_Set
12268     *
12269     * Data for the elm_entry_filter_accept_set() entry filter.
12270     */
12271    struct _Elm_Entry_Filter_Accept_Set
12272      {
12273         const char *accepted; /**< Set of characters accepted in the entry. */
12274         const char *rejected; /**< Set of characters rejected from the entry. */
12275      };
12276    /**
12277     * Filter inserted text based on accepted or rejected sets of characters
12278     *
12279     * Add this filter to an entry to restrict the set of accepted characters
12280     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
12281     * This structure contains both accepted and rejected sets, but they are
12282     * mutually exclusive.
12283     *
12284     * The @c accepted set takes preference, so if it is set, the filter will
12285     * only work based on the accepted characters, ignoring anything in the
12286     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
12287     *
12288     * In both cases, the function filters by matching utf8 characters to the
12289     * raw markup text, so it can be used to remove formatting tags.
12290     *
12291     * This filter, like any others, does not apply when setting the entry text
12292     * directly with elm_object_text_set() (or the deprecated
12293     * elm_entry_entry_set()).
12294     */
12295    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
12296    /**
12297     * Set the input panel layout of the entry
12298     *
12299     * @param obj The entry object
12300     * @param layout layout type
12301     */
12302    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
12303    /**
12304     * Get the input panel layout of the entry
12305     *
12306     * @param obj The entry object
12307     * @return layout type
12308     *
12309     * @see elm_entry_input_panel_layout_set
12310     */
12311    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12312    /**
12313     * Set the autocapitalization type on the immodule.
12314     *
12315     * @param obj The entry object
12316     * @param autocapital_type The type of autocapitalization
12317     */
12318    EAPI void         elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
12319    /**
12320     * Retrieve the autocapitalization type on the immodule.
12321     *
12322     * @param obj The entry object
12323     * @return autocapitalization type
12324     */
12325    EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12326    /**
12327     * Sets the attribute to show the input panel automatically.
12328     *
12329     * @param obj The entry object
12330     * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12331     */
12332    EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12333    /**
12334     * Retrieve the attribute to show the input panel automatically.
12335     *
12336     * @param obj The entry object
12337     * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12338     */
12339    EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12340
12341    /**
12342     * @}
12343     */
12344
12345    /* composite widgets - these basically put together basic widgets above
12346     * in convenient packages that do more than basic stuff */
12347
12348    /* anchorview */
12349    /**
12350     * @defgroup Anchorview Anchorview
12351     *
12352     * @image html img/widget/anchorview/preview-00.png
12353     * @image latex img/widget/anchorview/preview-00.eps
12354     *
12355     * Anchorview is for displaying text that contains markup with anchors
12356     * like <c>\<a href=1234\>something\</\></c> in it.
12357     *
12358     * Besides being styled differently, the anchorview widget provides the
12359     * necessary functionality so that clicking on these anchors brings up a
12360     * popup with user defined content such as "call", "add to contacts" or
12361     * "open web page". This popup is provided using the @ref Hover widget.
12362     *
12363     * This widget is very similar to @ref Anchorblock, so refer to that
12364     * widget for an example. The only difference Anchorview has is that the
12365     * widget is already provided with scrolling functionality, so if the
12366     * text set to it is too large to fit in the given space, it will scroll,
12367     * whereas the @ref Anchorblock widget will keep growing to ensure all the
12368     * text can be displayed.
12369     *
12370     * This widget emits the following signals:
12371     * @li "anchor,clicked": will be called when an anchor is clicked. The
12372     * @p event_info parameter on the callback will be a pointer of type
12373     * ::Elm_Entry_Anchorview_Info.
12374     *
12375     * See @ref Anchorblock for an example on how to use both of them.
12376     *
12377     * @see Anchorblock
12378     * @see Entry
12379     * @see Hover
12380     *
12381     * @{
12382     */
12383    /**
12384     * @typedef Elm_Entry_Anchorview_Info
12385     *
12386     * The info sent in the callback for "anchor,clicked" signals emitted by
12387     * the Anchorview widget.
12388     */
12389    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12390    /**
12391     * @struct _Elm_Entry_Anchorview_Info
12392     *
12393     * The info sent in the callback for "anchor,clicked" signals emitted by
12394     * the Anchorview widget.
12395     */
12396    struct _Elm_Entry_Anchorview_Info
12397      {
12398         const char     *name; /**< Name of the anchor, as indicated in its href
12399                                    attribute */
12400         int             button; /**< The mouse button used to click on it */
12401         Evas_Object    *hover; /**< The hover object to use for the popup */
12402         struct {
12403              Evas_Coord    x, y, w, h;
12404         } anchor, /**< Geometry selection of text used as anchor */
12405           hover_parent; /**< Geometry of the object used as parent by the
12406                              hover */
12407         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12408                                              for content on the left side of
12409                                              the hover. Before calling the
12410                                              callback, the widget will make the
12411                                              necessary calculations to check
12412                                              which sides are fit to be set with
12413                                              content, based on the position the
12414                                              hover is activated and its distance
12415                                              to the edges of its parent object
12416                                              */
12417         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12418                                               the right side of the hover.
12419                                               See @ref hover_left */
12420         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12421                                             of the hover. See @ref hover_left */
12422         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12423                                                below the hover. See @ref
12424                                                hover_left */
12425      };
12426    /**
12427     * Add a new Anchorview object
12428     *
12429     * @param parent The parent object
12430     * @return The new object or NULL if it cannot be created
12431     */
12432    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12433    /**
12434     * Set the text to show in the anchorview
12435     *
12436     * Sets the text of the anchorview to @p text. This text can include markup
12437     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12438     * text that will be specially styled and react to click events, ended with
12439     * either of \</a\> or \</\>. When clicked, the anchor will emit an
12440     * "anchor,clicked" signal that you can attach a callback to with
12441     * evas_object_smart_callback_add(). The name of the anchor given in the
12442     * event info struct will be the one set in the href attribute, in this
12443     * case, anchorname.
12444     *
12445     * Other markup can be used to style the text in different ways, but it's
12446     * up to the style defined in the theme which tags do what.
12447     * @deprecated use elm_object_text_set() instead.
12448     */
12449    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12450    /**
12451     * Get the markup text set for the anchorview
12452     *
12453     * Retrieves the text set on the anchorview, with markup tags included.
12454     *
12455     * @param obj The anchorview object
12456     * @return The markup text set or @c NULL if nothing was set or an error
12457     * occurred
12458     * @deprecated use elm_object_text_set() instead.
12459     */
12460    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12461    /**
12462     * Set the parent of the hover popup
12463     *
12464     * Sets the parent object to use by the hover created by the anchorview
12465     * when an anchor is clicked. See @ref Hover for more details on this.
12466     * If no parent is set, the same anchorview object will be used.
12467     *
12468     * @param obj The anchorview object
12469     * @param parent The object to use as parent for the hover
12470     */
12471    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12472    /**
12473     * Get the parent of the hover popup
12474     *
12475     * Get the object used as parent for the hover created by the anchorview
12476     * widget. See @ref Hover for more details on this.
12477     *
12478     * @param obj The anchorview object
12479     * @return The object used as parent for the hover, NULL if none is set.
12480     */
12481    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12482    /**
12483     * Set the style that the hover should use
12484     *
12485     * When creating the popup hover, anchorview will request that it's
12486     * themed according to @p style.
12487     *
12488     * @param obj The anchorview object
12489     * @param style The style to use for the underlying hover
12490     *
12491     * @see elm_object_style_set()
12492     */
12493    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12494    /**
12495     * Get the style that the hover should use
12496     *
12497     * Get the style the hover created by anchorview will use.
12498     *
12499     * @param obj The anchorview object
12500     * @return The style to use by the hover. NULL means the default is used.
12501     *
12502     * @see elm_object_style_set()
12503     */
12504    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12505    /**
12506     * Ends the hover popup in the anchorview
12507     *
12508     * When an anchor is clicked, the anchorview widget will create a hover
12509     * object to use as a popup with user provided content. This function
12510     * terminates this popup, returning the anchorview to its normal state.
12511     *
12512     * @param obj The anchorview object
12513     */
12514    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12515    /**
12516     * Set bouncing behaviour when the scrolled content reaches an edge
12517     *
12518     * Tell the internal scroller object whether it should bounce or not
12519     * when it reaches the respective edges for each axis.
12520     *
12521     * @param obj The anchorview object
12522     * @param h_bounce Whether to bounce or not in the horizontal axis
12523     * @param v_bounce Whether to bounce or not in the vertical axis
12524     *
12525     * @see elm_scroller_bounce_set()
12526     */
12527    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12528    /**
12529     * Get the set bouncing behaviour of the internal scroller
12530     *
12531     * Get whether the internal scroller should bounce when the edge of each
12532     * axis is reached scrolling.
12533     *
12534     * @param obj The anchorview object
12535     * @param h_bounce Pointer where to store the bounce state of the horizontal
12536     *                 axis
12537     * @param v_bounce Pointer where to store the bounce state of the vertical
12538     *                 axis
12539     *
12540     * @see elm_scroller_bounce_get()
12541     */
12542    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12543    /**
12544     * Appends a custom item provider to the given anchorview
12545     *
12546     * Appends the given function to the list of items providers. This list is
12547     * called, one function at a time, with the given @p data pointer, the
12548     * anchorview object and, in the @p item parameter, the item name as
12549     * referenced in its href string. Following functions in the list will be
12550     * called in order until one of them returns something different to NULL,
12551     * which should be an Evas_Object which will be used in place of the item
12552     * element.
12553     *
12554     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12555     * href=item/name\>\</item\>
12556     *
12557     * @param obj The anchorview object
12558     * @param func The function to add to the list of providers
12559     * @param data User data that will be passed to the callback function
12560     *
12561     * @see elm_entry_item_provider_append()
12562     */
12563    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);
12564    /**
12565     * Prepend a custom item provider to the given anchorview
12566     *
12567     * Like elm_anchorview_item_provider_append(), but it adds the function
12568     * @p func to the beginning of the list, instead of the end.
12569     *
12570     * @param obj The anchorview object
12571     * @param func The function to add to the list of providers
12572     * @param data User data that will be passed to the callback function
12573     */
12574    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);
12575    /**
12576     * Remove a custom item provider from the list of the given anchorview
12577     *
12578     * Removes the function and data pairing that matches @p func and @p data.
12579     * That is, unless the same function and same user data are given, the
12580     * function will not be removed from the list. This allows us to add the
12581     * same callback several times, with different @p data pointers and be
12582     * able to remove them later without conflicts.
12583     *
12584     * @param obj The anchorview object
12585     * @param func The function to remove from the list
12586     * @param data The data matching the function to remove from the list
12587     */
12588    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);
12589    /**
12590     * @}
12591     */
12592
12593    /* anchorblock */
12594    /**
12595     * @defgroup Anchorblock Anchorblock
12596     *
12597     * @image html img/widget/anchorblock/preview-00.png
12598     * @image latex img/widget/anchorblock/preview-00.eps
12599     *
12600     * Anchorblock is for displaying text that contains markup with anchors
12601     * like <c>\<a href=1234\>something\</\></c> in it.
12602     *
12603     * Besides being styled differently, the anchorblock widget provides the
12604     * necessary functionality so that clicking on these anchors brings up a
12605     * popup with user defined content such as "call", "add to contacts" or
12606     * "open web page". This popup is provided using the @ref Hover widget.
12607     *
12608     * This widget emits the following signals:
12609     * @li "anchor,clicked": will be called when an anchor is clicked. The
12610     * @p event_info parameter on the callback will be a pointer of type
12611     * ::Elm_Entry_Anchorblock_Info.
12612     *
12613     * @see Anchorview
12614     * @see Entry
12615     * @see Hover
12616     *
12617     * Since examples are usually better than plain words, we might as well
12618     * try @ref tutorial_anchorblock_example "one".
12619     */
12620    /**
12621     * @addtogroup Anchorblock
12622     * @{
12623     */
12624    /**
12625     * @typedef Elm_Entry_Anchorblock_Info
12626     *
12627     * The info sent in the callback for "anchor,clicked" signals emitted by
12628     * the Anchorblock widget.
12629     */
12630    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12631    /**
12632     * @struct _Elm_Entry_Anchorblock_Info
12633     *
12634     * The info sent in the callback for "anchor,clicked" signals emitted by
12635     * the Anchorblock widget.
12636     */
12637    struct _Elm_Entry_Anchorblock_Info
12638      {
12639         const char     *name; /**< Name of the anchor, as indicated in its href
12640                                    attribute */
12641         int             button; /**< The mouse button used to click on it */
12642         Evas_Object    *hover; /**< The hover object to use for the popup */
12643         struct {
12644              Evas_Coord    x, y, w, h;
12645         } anchor, /**< Geometry selection of text used as anchor */
12646           hover_parent; /**< Geometry of the object used as parent by the
12647                              hover */
12648         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12649                                              for content on the left side of
12650                                              the hover. Before calling the
12651                                              callback, the widget will make the
12652                                              necessary calculations to check
12653                                              which sides are fit to be set with
12654                                              content, based on the position the
12655                                              hover is activated and its distance
12656                                              to the edges of its parent object
12657                                              */
12658         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12659                                               the right side of the hover.
12660                                               See @ref hover_left */
12661         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12662                                             of the hover. See @ref hover_left */
12663         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12664                                                below the hover. See @ref
12665                                                hover_left */
12666      };
12667    /**
12668     * Add a new Anchorblock object
12669     *
12670     * @param parent The parent object
12671     * @return The new object or NULL if it cannot be created
12672     */
12673    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12674    /**
12675     * Set the text to show in the anchorblock
12676     *
12677     * Sets the text of the anchorblock to @p text. This text can include markup
12678     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12679     * of text that will be specially styled and react to click events, ended
12680     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12681     * "anchor,clicked" signal that you can attach a callback to with
12682     * evas_object_smart_callback_add(). The name of the anchor given in the
12683     * event info struct will be the one set in the href attribute, in this
12684     * case, anchorname.
12685     *
12686     * Other markup can be used to style the text in different ways, but it's
12687     * up to the style defined in the theme which tags do what.
12688     * @deprecated use elm_object_text_set() instead.
12689     */
12690    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12691    /**
12692     * Get the markup text set for the anchorblock
12693     *
12694     * Retrieves the text set on the anchorblock, with markup tags included.
12695     *
12696     * @param obj The anchorblock object
12697     * @return The markup text set or @c NULL if nothing was set or an error
12698     * occurred
12699     * @deprecated use elm_object_text_set() instead.
12700     */
12701    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12702    /**
12703     * Set the parent of the hover popup
12704     *
12705     * Sets the parent object to use by the hover created by the anchorblock
12706     * when an anchor is clicked. See @ref Hover for more details on this.
12707     *
12708     * @param obj The anchorblock object
12709     * @param parent The object to use as parent for the hover
12710     */
12711    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12712    /**
12713     * Get the parent of the hover popup
12714     *
12715     * Get the object used as parent for the hover created by the anchorblock
12716     * widget. See @ref Hover for more details on this.
12717     * If no parent is set, the same anchorblock object will be used.
12718     *
12719     * @param obj The anchorblock object
12720     * @return The object used as parent for the hover, NULL if none is set.
12721     */
12722    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12723    /**
12724     * Set the style that the hover should use
12725     *
12726     * When creating the popup hover, anchorblock will request that it's
12727     * themed according to @p style.
12728     *
12729     * @param obj The anchorblock object
12730     * @param style The style to use for the underlying hover
12731     *
12732     * @see elm_object_style_set()
12733     */
12734    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12735    /**
12736     * Get the style that the hover should use
12737     *
12738     * Get the style, the hover created by anchorblock will use.
12739     *
12740     * @param obj The anchorblock object
12741     * @return The style to use by the hover. NULL means the default is used.
12742     *
12743     * @see elm_object_style_set()
12744     */
12745    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12746    /**
12747     * Ends the hover popup in the anchorblock
12748     *
12749     * When an anchor is clicked, the anchorblock widget will create a hover
12750     * object to use as a popup with user provided content. This function
12751     * terminates this popup, returning the anchorblock to its normal state.
12752     *
12753     * @param obj The anchorblock object
12754     */
12755    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12756    /**
12757     * Appends a custom item provider to the given anchorblock
12758     *
12759     * Appends the given function to the list of items providers. This list is
12760     * called, one function at a time, with the given @p data pointer, the
12761     * anchorblock object and, in the @p item parameter, the item name as
12762     * referenced in its href string. Following functions in the list will be
12763     * called in order until one of them returns something different to NULL,
12764     * which should be an Evas_Object which will be used in place of the item
12765     * element.
12766     *
12767     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12768     * href=item/name\>\</item\>
12769     *
12770     * @param obj The anchorblock object
12771     * @param func The function to add to the list of providers
12772     * @param data User data that will be passed to the callback function
12773     *
12774     * @see elm_entry_item_provider_append()
12775     */
12776    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);
12777    /**
12778     * Prepend a custom item provider to the given anchorblock
12779     *
12780     * Like elm_anchorblock_item_provider_append(), but it adds the function
12781     * @p func to the beginning of the list, instead of the end.
12782     *
12783     * @param obj The anchorblock object
12784     * @param func The function to add to the list of providers
12785     * @param data User data that will be passed to the callback function
12786     */
12787    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);
12788    /**
12789     * Remove a custom item provider from the list of the given anchorblock
12790     *
12791     * Removes the function and data pairing that matches @p func and @p data.
12792     * That is, unless the same function and same user data are given, the
12793     * function will not be removed from the list. This allows us to add the
12794     * same callback several times, with different @p data pointers and be
12795     * able to remove them later without conflicts.
12796     *
12797     * @param obj The anchorblock object
12798     * @param func The function to remove from the list
12799     * @param data The data matching the function to remove from the list
12800     */
12801    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);
12802    /**
12803     * @}
12804     */
12805
12806    /**
12807     * @defgroup Bubble Bubble
12808     *
12809     * @image html img/widget/bubble/preview-00.png
12810     * @image latex img/widget/bubble/preview-00.eps
12811     * @image html img/widget/bubble/preview-01.png
12812     * @image latex img/widget/bubble/preview-01.eps
12813     * @image html img/widget/bubble/preview-02.png
12814     * @image latex img/widget/bubble/preview-02.eps
12815     *
12816     * @brief The Bubble is a widget to show text similar to how speech is
12817     * represented in comics.
12818     *
12819     * The bubble widget contains 5 important visual elements:
12820     * @li The frame is a rectangle with rounded edjes and an "arrow".
12821     * @li The @p icon is an image to which the frame's arrow points to.
12822     * @li The @p label is a text which appears to the right of the icon if the
12823     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12824     * otherwise.
12825     * @li The @p info is a text which appears to the right of the label. Info's
12826     * font is of a ligther color than label.
12827     * @li The @p content is an evas object that is shown inside the frame.
12828     *
12829     * The position of the arrow, icon, label and info depends on which corner is
12830     * selected. The four available corners are:
12831     * @li "top_left" - Default
12832     * @li "top_right"
12833     * @li "bottom_left"
12834     * @li "bottom_right"
12835     *
12836     * Signals that you can add callbacks for are:
12837     * @li "clicked" - This is called when a user has clicked the bubble.
12838     *
12839     * Default contents parts of the bubble that you can use for are:
12840     * @li "default" - A content of the bubble
12841     * @li "icon" - An icon of the bubble
12842     *
12843     * Default text parts of the button widget that you can use for are:
12844     * @li NULL - Label of the bubble
12845     *
12846          * For an example of using a buble see @ref bubble_01_example_page "this".
12847     *
12848     * @{
12849     */
12850
12851    /**
12852     * Add a new bubble to the parent
12853     *
12854     * @param parent The parent object
12855     * @return The new object or NULL if it cannot be created
12856     *
12857     * This function adds a text bubble to the given parent evas object.
12858     */
12859    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12860    /**
12861     * Set the label of the bubble
12862     *
12863     * @param obj The bubble object
12864     * @param label The string to set in the label
12865     *
12866     * This function sets the title of the bubble. Where this appears depends on
12867     * the selected corner.
12868     * @deprecated use elm_object_text_set() instead.
12869     */
12870    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12871    /**
12872     * Get the label of the bubble
12873     *
12874     * @param obj The bubble object
12875     * @return The string of set in the label
12876     *
12877     * This function gets the title of the bubble.
12878     * @deprecated use elm_object_text_get() instead.
12879     */
12880    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12881    /**
12882     * Set the info of the bubble
12883     *
12884     * @param obj The bubble object
12885     * @param info The given info about the bubble
12886     *
12887     * This function sets the info of the bubble. Where this appears depends on
12888     * the selected corner.
12889     * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12890     */
12891    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12892    /**
12893     * Get the info of the bubble
12894     *
12895     * @param obj The bubble object
12896     *
12897     * @return The "info" string of the bubble
12898     *
12899     * This function gets the info text.
12900     * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12901     */
12902    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12903    /**
12904     * Set the content to be shown in the bubble
12905     *
12906     * Once the content object is set, a previously set one will be deleted.
12907     * If you want to keep the old content object, use the
12908     * elm_bubble_content_unset() function.
12909     *
12910     * @param obj The bubble object
12911     * @param content The given content of the bubble
12912     *
12913     * This function sets the content shown on the middle of the bubble.
12914     *
12915     * @deprecated use elm_object_content_set() instead
12916     *
12917     */
12918    EINA_DEPRECATED EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12919    /**
12920     * Get the content shown in the bubble
12921     *
12922     * Return the content object which is set for this widget.
12923     *
12924     * @param obj The bubble object
12925     * @return The content that is being used
12926     *
12927     * @deprecated use elm_object_content_get() instead
12928     *
12929     */
12930    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12931    /**
12932     * Unset the content shown in the bubble
12933     *
12934     * Unparent and return the content object which was set for this widget.
12935     *
12936     * @param obj The bubble object
12937     * @return The content that was being used
12938     *
12939     * @deprecated use elm_object_content_unset() instead
12940     *
12941     */
12942    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12943    /**
12944     * Set the icon of the bubble
12945     *
12946     * Once the icon object is set, a previously set one will be deleted.
12947     * If you want to keep the old content object, use the
12948     * elm_icon_content_unset() function.
12949     *
12950     * @param obj The bubble object
12951     * @param icon The given icon for the bubble
12952     *
12953     * @deprecated use elm_object_part_content_set() instead
12954     *
12955     */
12956    EINA_DEPRECATED EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12957    /**
12958     * Get the icon of the bubble
12959     *
12960     * @param obj The bubble object
12961     * @return The icon for the bubble
12962     *
12963     * This function gets the icon shown on the top left of bubble.
12964     *
12965     * @deprecated use elm_object_part_content_get() instead
12966     *
12967     */
12968    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12969    /**
12970     * Unset the icon of the bubble
12971     *
12972     * Unparent and return the icon object which was set for this widget.
12973     *
12974     * @param obj The bubble object
12975     * @return The icon that was being used
12976     *
12977     * @deprecated use elm_object_part_content_unset() instead
12978     *
12979     */
12980    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12981    /**
12982     * Set the corner of the bubble
12983     *
12984     * @param obj The bubble object.
12985     * @param corner The given corner for the bubble.
12986     *
12987     * This function sets the corner of the bubble. The corner will be used to
12988     * determine where the arrow in the frame points to and where label, icon and
12989     * info are shown.
12990     *
12991     * Possible values for corner are:
12992     * @li "top_left" - Default
12993     * @li "top_right"
12994     * @li "bottom_left"
12995     * @li "bottom_right"
12996     */
12997    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12998    /**
12999     * Get the corner of the bubble
13000     *
13001     * @param obj The bubble object.
13002     * @return The given corner for the bubble.
13003     *
13004     * This function gets the selected corner of the bubble.
13005     */
13006    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13007    /**
13008     * @}
13009     */
13010
13011    /**
13012     * @defgroup Photo Photo
13013     *
13014     * For displaying the photo of a person (contact). Simple, yet
13015     * with a very specific purpose.
13016     *
13017     * Signals that you can add callbacks for are:
13018     *
13019     * "clicked" - This is called when a user has clicked the photo
13020     * "drag,start" - Someone started dragging the image out of the object
13021     * "drag,end" - Dragged item was dropped (somewhere)
13022     *
13023     * @{
13024     */
13025
13026    /**
13027     * Add a new photo to the parent
13028     *
13029     * @param parent The parent object
13030     * @return The new object or NULL if it cannot be created
13031     *
13032     * @ingroup Photo
13033     */
13034    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13035
13036    /**
13037     * Set the file that will be used as photo
13038     *
13039     * @param obj The photo object
13040     * @param file The path to file that will be used as photo
13041     *
13042     * @return (1 = success, 0 = error)
13043     *
13044     * @ingroup Photo
13045     */
13046    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
13047
13048     /**
13049     * Set the file that will be used as thumbnail in the photo.
13050     *
13051     * @param obj The photo object.
13052     * @param file The path to file that will be used as thumb.
13053     * @param group The key used in case of an EET file.
13054     *
13055     * @ingroup Photo
13056     */
13057    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
13058
13059    /**
13060     * Set the size that will be used on the photo
13061     *
13062     * @param obj The photo object
13063     * @param size The size that the photo will be
13064     *
13065     * @ingroup Photo
13066     */
13067    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
13068
13069    /**
13070     * Set if the photo should be completely visible or not.
13071     *
13072     * @param obj The photo object
13073     * @param fill if true the photo will be completely visible
13074     *
13075     * @ingroup Photo
13076     */
13077    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
13078
13079    /**
13080     * Set editability of the photo.
13081     *
13082     * An editable photo can be dragged to or from, and can be cut or
13083     * pasted too.  Note that pasting an image or dropping an item on
13084     * the image will delete the existing content.
13085     *
13086     * @param obj The photo object.
13087     * @param set To set of clear editablity.
13088     */
13089    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
13090
13091    /**
13092     * @}
13093     */
13094
13095    /* gesture layer */
13096    /**
13097     * @defgroup Elm_Gesture_Layer Gesture Layer
13098     * Gesture Layer Usage:
13099     *
13100     * Use Gesture Layer to detect gestures.
13101     * The advantage is that you don't have to implement
13102     * gesture detection, just set callbacks of gesture state.
13103     * By using gesture layer we make standard interface.
13104     *
13105     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
13106     * with a parent object parameter.
13107     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
13108     * call. Usually with same object as target (2nd parameter).
13109     *
13110     * Now you need to tell gesture layer what gestures you follow.
13111     * This is done with @ref elm_gesture_layer_cb_set call.
13112     * By setting the callback you actually saying to gesture layer:
13113     * I would like to know when the gesture @ref Elm_Gesture_Types
13114     * switches to state @ref Elm_Gesture_State.
13115     *
13116     * Next, you need to implement the actual action that follows the input
13117     * in your callback.
13118     *
13119     * Note that if you like to stop being reported about a gesture, just set
13120     * all callbacks referring this gesture to NULL.
13121     * (again with @ref elm_gesture_layer_cb_set)
13122     *
13123     * The information reported by gesture layer to your callback is depending
13124     * on @ref Elm_Gesture_Types:
13125     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
13126     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
13127     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
13128     *
13129     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
13130     * @ref ELM_GESTURE_MOMENTUM.
13131     *
13132     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
13133     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
13134     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
13135     * Note that we consider a flick as a line-gesture that should be completed
13136     * in flick-time-limit as defined in @ref Config.
13137     *
13138     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
13139     *
13140     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
13141     *
13142     *
13143     * Gesture Layer Tweaks:
13144     *
13145     * Note that line, flick, gestures can start without the need to remove fingers from surface.
13146     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
13147     *
13148     * Setting glayer_continues_enable to false in @ref Config will change this behavior
13149     * so gesture starts when user touches (a *DOWN event) touch-surface
13150     * and ends when no fingers touches surface (a *UP event).
13151     */
13152
13153    /**
13154     * @enum _Elm_Gesture_Types
13155     * Enum of supported gesture types.
13156     * @ingroup Elm_Gesture_Layer
13157     */
13158    enum _Elm_Gesture_Types
13159      {
13160         ELM_GESTURE_FIRST = 0,
13161
13162         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
13163         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
13164         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
13165         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
13166
13167         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
13168
13169         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
13170         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
13171
13172         ELM_GESTURE_ZOOM, /**< Zoom */
13173         ELM_GESTURE_ROTATE, /**< Rotate */
13174
13175         ELM_GESTURE_LAST
13176      };
13177
13178    /**
13179     * @typedef Elm_Gesture_Types
13180     * gesture types enum
13181     * @ingroup Elm_Gesture_Layer
13182     */
13183    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
13184
13185    /**
13186     * @enum _Elm_Gesture_State
13187     * Enum of gesture states.
13188     * @ingroup Elm_Gesture_Layer
13189     */
13190    enum _Elm_Gesture_State
13191      {
13192         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
13193         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
13194         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
13195         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
13196         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
13197      };
13198
13199    /**
13200     * @typedef Elm_Gesture_State
13201     * gesture states enum
13202     * @ingroup Elm_Gesture_Layer
13203     */
13204    typedef enum _Elm_Gesture_State Elm_Gesture_State;
13205
13206    /**
13207     * @struct _Elm_Gesture_Taps_Info
13208     * Struct holds taps info for user
13209     * @ingroup Elm_Gesture_Layer
13210     */
13211    struct _Elm_Gesture_Taps_Info
13212      {
13213         Evas_Coord x, y;         /**< Holds center point between fingers */
13214         unsigned int n;          /**< Number of fingers tapped           */
13215         unsigned int timestamp;  /**< event timestamp       */
13216      };
13217
13218    /**
13219     * @typedef Elm_Gesture_Taps_Info
13220     * holds taps info for user
13221     * @ingroup Elm_Gesture_Layer
13222     */
13223    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
13224
13225    /**
13226     * @struct _Elm_Gesture_Momentum_Info
13227     * Struct holds momentum info for user
13228     * x1 and y1 are not necessarily in sync
13229     * x1 holds x value of x direction starting point
13230     * and same holds for y1.
13231     * This is noticeable when doing V-shape movement
13232     * @ingroup Elm_Gesture_Layer
13233     */
13234    struct _Elm_Gesture_Momentum_Info
13235      {  /* Report line ends, timestamps, and momentum computed        */
13236         Evas_Coord x1; /**< Final-swipe direction starting point on X */
13237         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
13238         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
13239         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
13240
13241         unsigned int tx; /**< Timestamp of start of final x-swipe */
13242         unsigned int ty; /**< Timestamp of start of final y-swipe */
13243
13244         Evas_Coord mx; /**< Momentum on X */
13245         Evas_Coord my; /**< Momentum on Y */
13246
13247         unsigned int n;  /**< Number of fingers */
13248      };
13249
13250    /**
13251     * @typedef Elm_Gesture_Momentum_Info
13252     * holds momentum info for user
13253     * @ingroup Elm_Gesture_Layer
13254     */
13255     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
13256
13257    /**
13258     * @struct _Elm_Gesture_Line_Info
13259     * Struct holds line info for user
13260     * @ingroup Elm_Gesture_Layer
13261     */
13262    struct _Elm_Gesture_Line_Info
13263      {  /* Report line ends, timestamps, and momentum computed      */
13264         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
13265         double angle;              /**< Angle (direction) of lines  */
13266      };
13267
13268    /**
13269     * @typedef Elm_Gesture_Line_Info
13270     * Holds line info for user
13271     * @ingroup Elm_Gesture_Layer
13272     */
13273     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
13274
13275    /**
13276     * @struct _Elm_Gesture_Zoom_Info
13277     * Struct holds zoom info for user
13278     * @ingroup Elm_Gesture_Layer
13279     */
13280    struct _Elm_Gesture_Zoom_Info
13281      {
13282         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
13283         Evas_Coord radius; /**< Holds radius between fingers reported to user */
13284         double zoom;            /**< Zoom value: 1.0 means no zoom             */
13285         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
13286      };
13287
13288    /**
13289     * @typedef Elm_Gesture_Zoom_Info
13290     * Holds zoom info for user
13291     * @ingroup Elm_Gesture_Layer
13292     */
13293    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
13294
13295    /**
13296     * @struct _Elm_Gesture_Rotate_Info
13297     * Struct holds rotation info for user
13298     * @ingroup Elm_Gesture_Layer
13299     */
13300    struct _Elm_Gesture_Rotate_Info
13301      {
13302         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
13303         Evas_Coord radius; /**< Holds radius between fingers reported to user */
13304         double base_angle; /**< Holds start-angle */
13305         double angle;      /**< Rotation value: 0.0 means no rotation         */
13306         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
13307      };
13308
13309    /**
13310     * @typedef Elm_Gesture_Rotate_Info
13311     * Holds rotation info for user
13312     * @ingroup Elm_Gesture_Layer
13313     */
13314    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
13315
13316    /**
13317     * @typedef Elm_Gesture_Event_Cb
13318     * User callback used to stream gesture info from gesture layer
13319     * @param data user data
13320     * @param event_info gesture report info
13321     * Returns a flag field to be applied on the causing event.
13322     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13323     * upon the event, in an irreversible way.
13324     *
13325     * @ingroup Elm_Gesture_Layer
13326     */
13327    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13328
13329    /**
13330     * Use function to set callbacks to be notified about
13331     * change of state of gesture.
13332     * When a user registers a callback with this function
13333     * this means this gesture has to be tested.
13334     *
13335     * When ALL callbacks for a gesture are set to NULL
13336     * it means user isn't interested in gesture-state
13337     * and it will not be tested.
13338     *
13339     * @param obj Pointer to gesture-layer.
13340     * @param idx The gesture you would like to track its state.
13341     * @param cb callback function pointer.
13342     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13343     * @param data user info to be sent to callback (usually, Smart Data)
13344     *
13345     * @ingroup Elm_Gesture_Layer
13346     */
13347    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);
13348
13349    /**
13350     * Call this function to get repeat-events settings.
13351     *
13352     * @param obj Pointer to gesture-layer.
13353     *
13354     * @return repeat events settings.
13355     * @see elm_gesture_layer_hold_events_set()
13356     * @ingroup Elm_Gesture_Layer
13357     */
13358    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13359
13360    /**
13361     * This function called in order to make gesture-layer repeat events.
13362     * Set this of you like to get the raw events only if gestures were not detected.
13363     * Clear this if you like gesture layer to fwd events as testing gestures.
13364     *
13365     * @param obj Pointer to gesture-layer.
13366     * @param r Repeat: TRUE/FALSE
13367     *
13368     * @ingroup Elm_Gesture_Layer
13369     */
13370    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13371
13372    /**
13373     * This function sets step-value for zoom action.
13374     * Set step to any positive value.
13375     * Cancel step setting by setting to 0.0
13376     *
13377     * @param obj Pointer to gesture-layer.
13378     * @param s new zoom step value.
13379     *
13380     * @ingroup Elm_Gesture_Layer
13381     */
13382    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13383
13384    /**
13385     * This function sets step-value for rotate action.
13386     * Set step to any positive value.
13387     * Cancel step setting by setting to 0.0
13388     *
13389     * @param obj Pointer to gesture-layer.
13390     * @param s new roatate step value.
13391     *
13392     * @ingroup Elm_Gesture_Layer
13393     */
13394    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13395
13396    /**
13397     * This function called to attach gesture-layer to an Evas_Object.
13398     * @param obj Pointer to gesture-layer.
13399     * @param t Pointer to underlying object (AKA Target)
13400     *
13401     * @return TRUE, FALSE on success, failure.
13402     *
13403     * @ingroup Elm_Gesture_Layer
13404     */
13405    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13406
13407    /**
13408     * Call this function to construct a new gesture-layer object.
13409     * This does not activate the gesture layer. You have to
13410     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13411     *
13412     * @param parent the parent object.
13413     *
13414     * @return Pointer to new gesture-layer object.
13415     *
13416     * @ingroup Elm_Gesture_Layer
13417     */
13418    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13419
13420    /**
13421     * @defgroup Thumb Thumb
13422     *
13423     * @image html img/widget/thumb/preview-00.png
13424     * @image latex img/widget/thumb/preview-00.eps
13425     *
13426     * A thumb object is used for displaying the thumbnail of an image or video.
13427     * You must have compiled Elementary with Ethumb_Client support and the DBus
13428     * service must be present and auto-activated in order to have thumbnails to
13429     * be generated.
13430     *
13431     * Once the thumbnail object becomes visible, it will check if there is a
13432     * previously generated thumbnail image for the file set on it. If not, it
13433     * will start generating this thumbnail.
13434     *
13435     * Different config settings will cause different thumbnails to be generated
13436     * even on the same file.
13437     *
13438     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13439     * Ethumb documentation to change this path, and to see other configuration
13440     * options.
13441     *
13442     * Signals that you can add callbacks for are:
13443     *
13444     * - "clicked" - This is called when a user has clicked the thumb without dragging
13445     *             around.
13446     * - "clicked,double" - This is called when a user has double-clicked the thumb.
13447     * - "press" - This is called when a user has pressed down the thumb.
13448     * - "generate,start" - The thumbnail generation started.
13449     * - "generate,stop" - The generation process stopped.
13450     * - "generate,error" - The generation failed.
13451     * - "load,error" - The thumbnail image loading failed.
13452     *
13453     * available styles:
13454     * - default
13455     * - noframe
13456     *
13457     * An example of use of thumbnail:
13458     *
13459     * - @ref thumb_example_01
13460     */
13461
13462    /**
13463     * @addtogroup Thumb
13464     * @{
13465     */
13466
13467    /**
13468     * @enum _Elm_Thumb_Animation_Setting
13469     * @typedef Elm_Thumb_Animation_Setting
13470     *
13471     * Used to set if a video thumbnail is animating or not.
13472     *
13473     * @ingroup Thumb
13474     */
13475    typedef enum _Elm_Thumb_Animation_Setting
13476      {
13477         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13478         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
13479         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
13480         ELM_THUMB_ANIMATION_LAST
13481      } Elm_Thumb_Animation_Setting;
13482
13483    /**
13484     * Add a new thumb object to the parent.
13485     *
13486     * @param parent The parent object.
13487     * @return The new object or NULL if it cannot be created.
13488     *
13489     * @see elm_thumb_file_set()
13490     * @see elm_thumb_ethumb_client_get()
13491     *
13492     * @ingroup Thumb
13493     */
13494    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13495    /**
13496     * Reload thumbnail if it was generated before.
13497     *
13498     * @param obj The thumb object to reload
13499     *
13500     * This is useful if the ethumb client configuration changed, like its
13501     * size, aspect or any other property one set in the handle returned
13502     * by elm_thumb_ethumb_client_get().
13503     *
13504     * If the options didn't change, the thumbnail won't be generated again, but
13505     * the old one will still be used.
13506     *
13507     * @see elm_thumb_file_set()
13508     *
13509     * @ingroup Thumb
13510     */
13511    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13512    /**
13513     * Set the file that will be used as thumbnail.
13514     *
13515     * @param obj The thumb object.
13516     * @param file The path to file that will be used as thumb.
13517     * @param key The key used in case of an EET file.
13518     *
13519     * The file can be an image or a video (in that case, acceptable extensions are:
13520     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13521     * function elm_thumb_animate().
13522     *
13523     * @see elm_thumb_file_get()
13524     * @see elm_thumb_reload()
13525     * @see elm_thumb_animate()
13526     *
13527     * @ingroup Thumb
13528     */
13529    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13530    /**
13531     * Get the image or video path and key used to generate the thumbnail.
13532     *
13533     * @param obj The thumb object.
13534     * @param file Pointer to filename.
13535     * @param key Pointer to key.
13536     *
13537     * @see elm_thumb_file_set()
13538     * @see elm_thumb_path_get()
13539     *
13540     * @ingroup Thumb
13541     */
13542    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13543    /**
13544     * Get the path and key to the image or video generated by ethumb.
13545     *
13546     * One just need to make sure that the thumbnail was generated before getting
13547     * its path; otherwise, the path will be NULL. One way to do that is by asking
13548     * for the path when/after the "generate,stop" smart callback is called.
13549     *
13550     * @param obj The thumb object.
13551     * @param file Pointer to thumb path.
13552     * @param key Pointer to thumb key.
13553     *
13554     * @see elm_thumb_file_get()
13555     *
13556     * @ingroup Thumb
13557     */
13558    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13559    /**
13560     * Set the animation state for the thumb object. If its content is an animated
13561     * video, you may start/stop the animation or tell it to play continuously and
13562     * looping.
13563     *
13564     * @param obj The thumb object.
13565     * @param setting The animation setting.
13566     *
13567     * @see elm_thumb_file_set()
13568     *
13569     * @ingroup Thumb
13570     */
13571    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13572    /**
13573     * Get the animation state for the thumb object.
13574     *
13575     * @param obj The thumb object.
13576     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13577     * on errors.
13578     *
13579     * @see elm_thumb_animate_set()
13580     *
13581     * @ingroup Thumb
13582     */
13583    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13584    /**
13585     * Get the ethumb_client handle so custom configuration can be made.
13586     *
13587     * @return Ethumb_Client instance or NULL.
13588     *
13589     * This must be called before the objects are created to be sure no object is
13590     * visible and no generation started.
13591     *
13592     * Example of usage:
13593     *
13594     * @code
13595     * #include <Elementary.h>
13596     * #ifndef ELM_LIB_QUICKLAUNCH
13597     * EAPI_MAIN int
13598     * elm_main(int argc, char **argv)
13599     * {
13600     *    Ethumb_Client *client;
13601     *
13602     *    elm_need_ethumb();
13603     *
13604     *    // ... your code
13605     *
13606     *    client = elm_thumb_ethumb_client_get();
13607     *    if (!client)
13608     *      {
13609     *         ERR("could not get ethumb_client");
13610     *         return 1;
13611     *      }
13612     *    ethumb_client_size_set(client, 100, 100);
13613     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
13614     *    // ... your code
13615     *
13616     *    // Create elm_thumb objects here
13617     *
13618     *    elm_run();
13619     *    elm_shutdown();
13620     *    return 0;
13621     * }
13622     * #endif
13623     * ELM_MAIN()
13624     * @endcode
13625     *
13626     * @note There's only one client handle for Ethumb, so once a configuration
13627     * change is done to it, any other request for thumbnails (for any thumbnail
13628     * object) will use that configuration. Thus, this configuration is global.
13629     *
13630     * @ingroup Thumb
13631     */
13632    EAPI void                        *elm_thumb_ethumb_client_get(void);
13633    /**
13634     * Get the ethumb_client connection state.
13635     *
13636     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13637     * otherwise.
13638     */
13639    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
13640    /**
13641     * Make the thumbnail 'editable'.
13642     *
13643     * @param obj Thumb object.
13644     * @param set Turn on or off editability. Default is @c EINA_FALSE.
13645     *
13646     * This means the thumbnail is a valid drag target for drag and drop, and can be
13647     * cut or pasted too.
13648     *
13649     * @see elm_thumb_editable_get()
13650     *
13651     * @ingroup Thumb
13652     */
13653    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13654    /**
13655     * Make the thumbnail 'editable'.
13656     *
13657     * @param obj Thumb object.
13658     * @return Editability.
13659     *
13660     * This means the thumbnail is a valid drag target for drag and drop, and can be
13661     * cut or pasted too.
13662     *
13663     * @see elm_thumb_editable_set()
13664     *
13665     * @ingroup Thumb
13666     */
13667    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13668
13669    /**
13670     * @}
13671     */
13672
13673    /**
13674     * @defgroup Web Web
13675     *
13676     * @image html img/widget/web/preview-00.png
13677     * @image latex img/widget/web/preview-00.eps
13678     *
13679     * A web object is used for displaying web pages (HTML/CSS/JS)
13680     * using WebKit-EFL. You must have compiled Elementary with
13681     * ewebkit support.
13682     *
13683     * Signals that you can add callbacks for are:
13684     * @li "download,request": A file download has been requested. Event info is
13685     * a pointer to a Elm_Web_Download
13686     * @li "editorclient,contents,changed": Editor client's contents changed
13687     * @li "editorclient,selection,changed": Editor client's selection changed
13688     * @li "frame,created": A new frame was created. Event info is an
13689     * Evas_Object which can be handled with WebKit's ewk_frame API
13690     * @li "icon,received": An icon was received by the main frame
13691     * @li "inputmethod,changed": Input method changed. Event info is an
13692     * Eina_Bool indicating whether it's enabled or not
13693     * @li "js,windowobject,clear": JS window object has been cleared
13694     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13695     * is a char *link[2], where the first string contains the URL the link
13696     * points to, and the second one the title of the link
13697     * @li "link,hover,out": Mouse cursor left the link
13698     * @li "load,document,finished": Loading of a document finished. Event info
13699     * is the frame that finished loading
13700     * @li "load,error": Load failed. Event info is a pointer to
13701     * Elm_Web_Frame_Load_Error
13702     * @li "load,finished": Load finished. Event info is NULL on success, on
13703     * error it's a pointer to Elm_Web_Frame_Load_Error
13704     * @li "load,newwindow,show": A new window was created and is ready to be
13705     * shown
13706     * @li "load,progress": Overall load progress. Event info is a pointer to
13707     * a double containing a value between 0.0 and 1.0
13708     * @li "load,provisional": Started provisional load
13709     * @li "load,started": Loading of a document started
13710     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13711     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13712     * the menubar is visible, or EINA_FALSE in case it's not
13713     * @li "menubar,visible,set": Informs menubar visibility. Event info is
13714     * an Eina_Bool indicating the visibility
13715     * @li "popup,created": A dropdown widget was activated, requesting its
13716     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13717     * @li "popup,willdelete": The web object is ready to destroy the popup
13718     * object created. Event info is a pointer to Elm_Web_Menu
13719     * @li "ready": Page is fully loaded
13720     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13721     * info is a pointer to Eina_Bool where the visibility state should be set
13722     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13723     * is an Eina_Bool with the visibility state set
13724     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13725     * a string with the new text
13726     * @li "statusbar,visible,get": Queries visibility of the status bar.
13727     * Event info is a pointer to Eina_Bool where the visibility state should be
13728     * set.
13729     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13730     * an Eina_Bool with the visibility value
13731     * @li "title,changed": Title of the main frame changed. Event info is a
13732     * string with the new title
13733     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13734     * is a pointer to Eina_Bool where the visibility state should be set
13735     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13736     * info is an Eina_Bool with the visibility state
13737     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13738     * a string with the text to show
13739     * @li "uri,changed": URI of the main frame changed. Event info is a string
13740     * with the new URI
13741     * @li "view,resized": The web object internal's view changed sized
13742     * @li "windows,close,request": A JavaScript request to close the current
13743     * window was requested
13744     * @li "zoom,animated,end": Animated zoom finished
13745     *
13746     * available styles:
13747     * - default
13748     *
13749     * An example of use of web:
13750     *
13751     * - @ref web_example_01 TBD
13752     */
13753
13754    /**
13755     * @addtogroup Web
13756     * @{
13757     */
13758
13759    /**
13760     * Structure used to report load errors.
13761     *
13762     * Load errors are reported as signal by elm_web. All the strings are
13763     * temporary references and should @b not be used after the signal
13764     * callback returns. If it's required, make copies with strdup() or
13765     * eina_stringshare_add() (they are not even guaranteed to be
13766     * stringshared, so must use eina_stringshare_add() and not
13767     * eina_stringshare_ref()).
13768     */
13769    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13770    /**
13771     * Structure used to report load errors.
13772     *
13773     * Load errors are reported as signal by elm_web. All the strings are
13774     * temporary references and should @b not be used after the signal
13775     * callback returns. If it's required, make copies with strdup() or
13776     * eina_stringshare_add() (they are not even guaranteed to be
13777     * stringshared, so must use eina_stringshare_add() and not
13778     * eina_stringshare_ref()).
13779     */
13780    struct _Elm_Web_Frame_Load_Error
13781      {
13782         int code; /**< Numeric error code */
13783         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13784         const char *domain; /**< Error domain name */
13785         const char *description; /**< Error description (already localized) */
13786         const char *failing_url; /**< The URL that failed to load */
13787         Evas_Object *frame; /**< Frame object that produced the error */
13788      };
13789
13790    /**
13791     * The possibles types that the items in a menu can be
13792     */
13793    typedef enum _Elm_Web_Menu_Item_Type
13794      {
13795         ELM_WEB_MENU_SEPARATOR,
13796         ELM_WEB_MENU_GROUP,
13797         ELM_WEB_MENU_OPTION
13798      } Elm_Web_Menu_Item_Type;
13799
13800    /**
13801     * Structure describing the items in a menu
13802     */
13803    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13804    /**
13805     * Structure describing the items in a menu
13806     */
13807    struct _Elm_Web_Menu_Item
13808      {
13809         const char *text; /**< The text for the item */
13810         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13811      };
13812
13813    /**
13814     * Structure describing the menu of a popup
13815     *
13816     * This structure will be passed as the @c event_info for the "popup,create"
13817     * signal, which is emitted when a dropdown menu is opened. Users wanting
13818     * to handle these popups by themselves should listen to this signal and
13819     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13820     * property as @c EINA_FALSE means that the user will not handle the popup
13821     * and the default implementation will be used.
13822     *
13823     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13824     * will be emitted to notify the user that it can destroy any objects and
13825     * free all data related to it.
13826     *
13827     * @see elm_web_popup_selected_set()
13828     * @see elm_web_popup_destroy()
13829     */
13830    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13831    /**
13832     * Structure describing the menu of a popup
13833     *
13834     * This structure will be passed as the @c event_info for the "popup,create"
13835     * signal, which is emitted when a dropdown menu is opened. Users wanting
13836     * to handle these popups by themselves should listen to this signal and
13837     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13838     * property as @c EINA_FALSE means that the user will not handle the popup
13839     * and the default implementation will be used.
13840     *
13841     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13842     * will be emitted to notify the user that it can destroy any objects and
13843     * free all data related to it.
13844     *
13845     * @see elm_web_popup_selected_set()
13846     * @see elm_web_popup_destroy()
13847     */
13848    struct _Elm_Web_Menu
13849      {
13850         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13851         int x; /**< The X position of the popup, relative to the elm_web object */
13852         int y; /**< The Y position of the popup, relative to the elm_web object */
13853         int width; /**< Width of the popup menu */
13854         int height; /**< Height of the popup menu */
13855
13856         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. */
13857      };
13858
13859    typedef struct _Elm_Web_Download Elm_Web_Download;
13860    struct _Elm_Web_Download
13861      {
13862         const char *url;
13863      };
13864
13865    /**
13866     * Types of zoom available.
13867     */
13868    typedef enum _Elm_Web_Zoom_Mode
13869      {
13870         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_web_zoom_set */
13871         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13872         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13873         ELM_WEB_ZOOM_MODE_LAST
13874      } Elm_Web_Zoom_Mode;
13875    /**
13876     * Opaque handler containing the features (such as statusbar, menubar, etc)
13877     * that are to be set on a newly requested window.
13878     */
13879    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13880    /**
13881     * Callback type for the create_window hook.
13882     *
13883     * The function parameters are:
13884     * @li @p data User data pointer set when setting the hook function
13885     * @li @p obj The elm_web object requesting the new window
13886     * @li @p js Set to @c EINA_TRUE if the request was originated from
13887     * JavaScript. @c EINA_FALSE otherwise.
13888     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13889     * the features requested for the new window.
13890     *
13891     * The returned value of the function should be the @c elm_web widget where
13892     * the request will be loaded. That is, if a new window or tab is created,
13893     * the elm_web widget in it should be returned, and @b NOT the window
13894     * object.
13895     * Returning @c NULL should cancel the request.
13896     *
13897     * @see elm_web_window_create_hook_set()
13898     */
13899    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13900    /**
13901     * Callback type for the JS alert hook.
13902     *
13903     * The function parameters are:
13904     * @li @p data User data pointer set when setting the hook function
13905     * @li @p obj The elm_web object requesting the new window
13906     * @li @p message The message to show in the alert dialog
13907     *
13908     * The function should return the object representing the alert dialog.
13909     * Elm_Web will run a second main loop to handle the dialog and normal
13910     * flow of the application will be restored when the object is deleted, so
13911     * the user should handle the popup properly in order to delete the object
13912     * when the action is finished.
13913     * If the function returns @c NULL the popup will be ignored.
13914     *
13915     * @see elm_web_dialog_alert_hook_set()
13916     */
13917    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13918    /**
13919     * Callback type for the JS confirm hook.
13920     *
13921     * The function parameters are:
13922     * @li @p data User data pointer set when setting the hook function
13923     * @li @p obj The elm_web object requesting the new window
13924     * @li @p message The message to show in the confirm dialog
13925     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13926     * the user selected @c Ok, @c EINA_FALSE otherwise.
13927     *
13928     * The function should return the object representing the confirm dialog.
13929     * Elm_Web will run a second main loop to handle the dialog and normal
13930     * flow of the application will be restored when the object is deleted, so
13931     * the user should handle the popup properly in order to delete the object
13932     * when the action is finished.
13933     * If the function returns @c NULL the popup will be ignored.
13934     *
13935     * @see elm_web_dialog_confirm_hook_set()
13936     */
13937    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13938    /**
13939     * Callback type for the JS prompt hook.
13940     *
13941     * The function parameters are:
13942     * @li @p data User data pointer set when setting the hook function
13943     * @li @p obj The elm_web object requesting the new window
13944     * @li @p message The message to show in the prompt dialog
13945     * @li @p def_value The default value to present the user in the entry
13946     * @li @p value Pointer where to store the value given by the user. Must
13947     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13948     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13949     * the user selected @c Ok, @c EINA_FALSE otherwise.
13950     *
13951     * The function should return the object representing the prompt dialog.
13952     * Elm_Web will run a second main loop to handle the dialog and normal
13953     * flow of the application will be restored when the object is deleted, so
13954     * the user should handle the popup properly in order to delete the object
13955     * when the action is finished.
13956     * If the function returns @c NULL the popup will be ignored.
13957     *
13958     * @see elm_web_dialog_prompt_hook_set()
13959     */
13960    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13961    /**
13962     * Callback type for the JS file selector hook.
13963     *
13964     * The function parameters are:
13965     * @li @p data User data pointer set when setting the hook function
13966     * @li @p obj The elm_web object requesting the new window
13967     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13968     * @li @p accept_types Mime types accepted
13969     * @li @p selected Pointer where to store the list of malloc'ed strings
13970     * containing the path to each file selected. Must be @c NULL if the file
13971     * dialog is cancelled
13972     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13973     * the user selected @c Ok, @c EINA_FALSE otherwise.
13974     *
13975     * The function should return the object representing the file selector
13976     * dialog.
13977     * Elm_Web will run a second main loop to handle the dialog and normal
13978     * flow of the application will be restored when the object is deleted, so
13979     * the user should handle the popup properly in order to delete the object
13980     * when the action is finished.
13981     * If the function returns @c NULL the popup will be ignored.
13982     *
13983     * @see elm_web_dialog_file selector_hook_set()
13984     */
13985    typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, Eina_List *accept_types, Eina_List **selected, Eina_Bool *ret);
13986    /**
13987     * Callback type for the JS console message hook.
13988     *
13989     * When a console message is added from JavaScript, any set function to the
13990     * console message hook will be called for the user to handle. There is no
13991     * default implementation of this hook.
13992     *
13993     * The function parameters are:
13994     * @li @p data User data pointer set when setting the hook function
13995     * @li @p obj The elm_web object that originated the message
13996     * @li @p message The message sent
13997     * @li @p line_number The line number
13998     * @li @p source_id Source id
13999     *
14000     * @see elm_web_console_message_hook_set()
14001     */
14002    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
14003    /**
14004     * Add a new web object to the parent.
14005     *
14006     * @param parent The parent object.
14007     * @return The new object or NULL if it cannot be created.
14008     *
14009     * @see elm_web_uri_set()
14010     * @see elm_web_webkit_view_get()
14011     */
14012    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14013
14014    /**
14015     * Get internal ewk_view object from web object.
14016     *
14017     * Elementary may not provide some low level features of EWebKit,
14018     * instead of cluttering the API with proxy methods we opted to
14019     * return the internal reference. Be careful using it as it may
14020     * interfere with elm_web behavior.
14021     *
14022     * @param obj The web object.
14023     * @return The internal ewk_view object or NULL if it does not
14024     *         exist. (Failure to create or Elementary compiled without
14025     *         ewebkit)
14026     *
14027     * @see elm_web_add()
14028     */
14029    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14030
14031    /**
14032     * Sets the function to call when a new window is requested
14033     *
14034     * This hook will be called when a request to create a new window is
14035     * issued from the web page loaded.
14036     * There is no default implementation for this feature, so leaving this
14037     * unset or passing @c NULL in @p func will prevent new windows from
14038     * opening.
14039     *
14040     * @param obj The web object where to set the hook function
14041     * @param func The hook function to be called when a window is requested
14042     * @param data User data
14043     */
14044    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
14045    /**
14046     * Sets the function to call when an alert dialog
14047     *
14048     * This hook will be called when a JavaScript alert dialog is requested.
14049     * If no function is set or @c NULL is passed in @p func, the default
14050     * implementation will take place.
14051     *
14052     * @param obj The web object where to set the hook function
14053     * @param func The callback function to be used
14054     * @param data User data
14055     *
14056     * @see elm_web_inwin_mode_set()
14057     */
14058    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
14059    /**
14060     * Sets the function to call when an confirm dialog
14061     *
14062     * This hook will be called when a JavaScript confirm dialog is requested.
14063     * If no function is set or @c NULL is passed in @p func, the default
14064     * implementation will take place.
14065     *
14066     * @param obj The web object where to set the hook function
14067     * @param func The callback function to be used
14068     * @param data User data
14069     *
14070     * @see elm_web_inwin_mode_set()
14071     */
14072    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
14073    /**
14074     * Sets the function to call when an prompt dialog
14075     *
14076     * This hook will be called when a JavaScript prompt dialog is requested.
14077     * If no function is set or @c NULL is passed in @p func, the default
14078     * implementation will take place.
14079     *
14080     * @param obj The web object where to set the hook function
14081     * @param func The callback function to be used
14082     * @param data User data
14083     *
14084     * @see elm_web_inwin_mode_set()
14085     */
14086    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
14087    /**
14088     * Sets the function to call when an file selector dialog
14089     *
14090     * This hook will be called when a JavaScript file selector dialog is
14091     * requested.
14092     * If no function is set or @c NULL is passed in @p func, the default
14093     * implementation will take place.
14094     *
14095     * @param obj The web object where to set the hook function
14096     * @param func The callback function to be used
14097     * @param data User data
14098     *
14099     * @see elm_web_inwin_mode_set()
14100     */
14101    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
14102    /**
14103     * Sets the function to call when a console message is emitted from JS
14104     *
14105     * This hook will be called when a console message is emitted from
14106     * JavaScript. There is no default implementation for this feature.
14107     *
14108     * @param obj The web object where to set the hook function
14109     * @param func The callback function to be used
14110     * @param data User data
14111     */
14112    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
14113    /**
14114     * Gets the status of the tab propagation
14115     *
14116     * @param obj The web object to query
14117     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
14118     *
14119     * @see elm_web_tab_propagate_set()
14120     */
14121    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
14122    /**
14123     * Sets whether to use tab propagation
14124     *
14125     * If tab propagation is enabled, whenever the user presses the Tab key,
14126     * Elementary will handle it and switch focus to the next widget.
14127     * The default value is disabled, where WebKit will handle the Tab key to
14128     * cycle focus though its internal objects, jumping to the next widget
14129     * only when that cycle ends.
14130     *
14131     * @param obj The web object
14132     * @param propagate Whether to propagate Tab keys to Elementary or not
14133     */
14134    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
14135    /**
14136     * Sets the URI for the web object
14137     *
14138     * It must be a full URI, with resource included, in the form
14139     * http://www.enlightenment.org or file:///tmp/something.html
14140     *
14141     * @param obj The web object
14142     * @param uri The URI to set
14143     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
14144     */
14145    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
14146    /**
14147     * Gets the current URI for the object
14148     *
14149     * The returned string must not be freed and is guaranteed to be
14150     * stringshared.
14151     *
14152     * @param obj The web object
14153     * @return A stringshared internal string with the current URI, or NULL on
14154     * failure
14155     */
14156    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
14157    /**
14158     * Gets the current title
14159     *
14160     * The returned string must not be freed and is guaranteed to be
14161     * stringshared.
14162     *
14163     * @param obj The web object
14164     * @return A stringshared internal string with the current title, or NULL on
14165     * failure
14166     */
14167    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
14168    /**
14169     * Sets the background color to be used by the web object
14170     *
14171     * This is the color that will be used by default when the loaded page
14172     * does not set it's own. Color values are pre-multiplied.
14173     *
14174     * @param obj The web object
14175     * @param r Red component
14176     * @param g Green component
14177     * @param b Blue component
14178     * @param a Alpha component
14179     */
14180    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
14181    /**
14182     * Gets the background color to be used by the web object
14183     *
14184     * This is the color that will be used by default when the loaded page
14185     * does not set it's own. Color values are pre-multiplied.
14186     *
14187     * @param obj The web object
14188     * @param r Red component
14189     * @param g Green component
14190     * @param b Blue component
14191     * @param a Alpha component
14192     */
14193    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
14194    /**
14195     * Gets a copy of the currently selected text
14196     *
14197     * The string returned must be freed by the user when it's done with it.
14198     *
14199     * @param obj The web object
14200     * @return A newly allocated string, or NULL if nothing is selected or an
14201     * error occurred
14202     */
14203    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
14204    /**
14205     * Tells the web object which index in the currently open popup was selected
14206     *
14207     * When the user handles the popup creation from the "popup,created" signal,
14208     * it needs to tell the web object which item was selected by calling this
14209     * function with the index corresponding to the item.
14210     *
14211     * @param obj The web object
14212     * @param index The index selected
14213     *
14214     * @see elm_web_popup_destroy()
14215     */
14216    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
14217    /**
14218     * Dismisses an open dropdown popup
14219     *
14220     * When the popup from a dropdown widget is to be dismissed, either after
14221     * selecting an option or to cancel it, this function must be called, which
14222     * will later emit an "popup,willdelete" signal to notify the user that
14223     * any memory and objects related to this popup can be freed.
14224     *
14225     * @param obj The web object
14226     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
14227     * if there was no menu to destroy
14228     */
14229    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
14230    /**
14231     * Searches the given string in a document.
14232     *
14233     * @param obj The web object where to search the text
14234     * @param string String to search
14235     * @param case_sensitive If search should be case sensitive or not
14236     * @param forward If search is from cursor and on or backwards
14237     * @param wrap If search should wrap at the end
14238     *
14239     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
14240     * or failure
14241     */
14242    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
14243    /**
14244     * Marks matches of the given string in a document.
14245     *
14246     * @param obj The web object where to search text
14247     * @param string String to match
14248     * @param case_sensitive If match should be case sensitive or not
14249     * @param highlight If matches should be highlighted
14250     * @param limit Maximum amount of matches, or zero to unlimited
14251     *
14252     * @return number of matched @a string
14253     */
14254    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
14255    /**
14256     * Clears all marked matches in the document
14257     *
14258     * @param obj The web object
14259     *
14260     * @return EINA_TRUE on success, EINA_FALSE otherwise
14261     */
14262    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
14263    /**
14264     * Sets whether to highlight the matched marks
14265     *
14266     * If enabled, marks set with elm_web_text_matches_mark() will be
14267     * highlighted.
14268     *
14269     * @param obj The web object
14270     * @param highlight Whether to highlight the marks or not
14271     *
14272     * @return EINA_TRUE on success, EINA_FALSE otherwise
14273     */
14274    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
14275    /**
14276     * Gets whether highlighting marks is enabled
14277     *
14278     * @param The web object
14279     *
14280     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
14281     * otherwise
14282     */
14283    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
14284    /**
14285     * Gets the overall loading progress of the page
14286     *
14287     * Returns the estimated loading progress of the page, with a value between
14288     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
14289     * included in the page.
14290     *
14291     * @param The web object
14292     *
14293     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
14294     * failure
14295     */
14296    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
14297    /**
14298     * Stops loading the current page
14299     *
14300     * Cancels the loading of the current page in the web object. This will
14301     * cause a "load,error" signal to be emitted, with the is_cancellation
14302     * flag set to EINA_TRUE.
14303     *
14304     * @param obj The web object
14305     *
14306     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
14307     */
14308    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
14309    /**
14310     * Requests a reload of the current document in the object
14311     *
14312     * @param obj The web object
14313     *
14314     * @return EINA_TRUE on success, EINA_FALSE otherwise
14315     */
14316    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
14317    /**
14318     * Requests a reload of the current document, avoiding any existing caches
14319     *
14320     * @param obj The web object
14321     *
14322     * @return EINA_TRUE on success, EINA_FALSE otherwise
14323     */
14324    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
14325    /**
14326     * Goes back one step in the browsing history
14327     *
14328     * This is equivalent to calling elm_web_object_navigate(obj, -1);
14329     *
14330     * @param obj The web object
14331     *
14332     * @return EINA_TRUE on success, EINA_FALSE otherwise
14333     *
14334     * @see elm_web_history_enable_set()
14335     * @see elm_web_back_possible()
14336     * @see elm_web_forward()
14337     * @see elm_web_navigate()
14338     */
14339    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
14340    /**
14341     * Goes forward one step in the browsing history
14342     *
14343     * This is equivalent to calling elm_web_object_navigate(obj, 1);
14344     *
14345     * @param obj The web object
14346     *
14347     * @return EINA_TRUE on success, EINA_FALSE otherwise
14348     *
14349     * @see elm_web_history_enable_set()
14350     * @see elm_web_forward_possible()
14351     * @see elm_web_back()
14352     * @see elm_web_navigate()
14353     */
14354    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
14355    /**
14356     * Jumps the given number of steps in the browsing history
14357     *
14358     * The @p steps value can be a negative integer to back in history, or a
14359     * positive to move forward.
14360     *
14361     * @param obj The web object
14362     * @param steps The number of steps to jump
14363     *
14364     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14365     * history exists to jump the given number of steps
14366     *
14367     * @see elm_web_history_enable_set()
14368     * @see elm_web_navigate_possible()
14369     * @see elm_web_back()
14370     * @see elm_web_forward()
14371     */
14372    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
14373    /**
14374     * Queries whether it's possible to go back in history
14375     *
14376     * @param obj The web object
14377     *
14378     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14379     * otherwise
14380     */
14381    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
14382    /**
14383     * Queries whether it's possible to go forward in history
14384     *
14385     * @param obj The web object
14386     *
14387     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14388     * otherwise
14389     */
14390    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
14391    /**
14392     * Queries whether it's possible to jump the given number of steps
14393     *
14394     * The @p steps value can be a negative integer to back in history, or a
14395     * positive to move forward.
14396     *
14397     * @param obj The web object
14398     * @param steps The number of steps to check for
14399     *
14400     * @return EINA_TRUE if enough history exists to perform the given jump,
14401     * EINA_FALSE otherwise
14402     */
14403    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
14404    /**
14405     * Gets whether browsing history is enabled for the given object
14406     *
14407     * @param obj The web object
14408     *
14409     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14410     */
14411    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
14412    /**
14413     * Enables or disables the browsing history
14414     *
14415     * @param obj The web object
14416     * @param enable Whether to enable or disable the browsing history
14417     */
14418    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14419    /**
14420     * Sets the zoom level of the web object
14421     *
14422     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14423     * values meaning zoom in and lower meaning zoom out. This function will
14424     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14425     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14426     *
14427     * @param obj The web object
14428     * @param zoom The zoom level to set
14429     */
14430    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
14431    /**
14432     * Gets the current zoom level set on the web object
14433     *
14434     * Note that this is the zoom level set on the web object and not that
14435     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14436     * the two zoom levels should match, but for the other two modes the
14437     * Webkit zoom is calculated internally to match the chosen mode without
14438     * changing the zoom level set for the web object.
14439     *
14440     * @param obj The web object
14441     *
14442     * @return The zoom level set on the object
14443     */
14444    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
14445    /**
14446     * Sets the zoom mode to use
14447     *
14448     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14449     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14450     *
14451     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14452     * with the elm_web_zoom_set() function.
14453     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14454     * make sure the entirety of the web object's contents are shown.
14455     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14456     * fit the contents in the web object's size, without leaving any space
14457     * unused.
14458     *
14459     * @param obj The web object
14460     * @param mode The mode to set
14461     */
14462    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14463    /**
14464     * Gets the currently set zoom mode
14465     *
14466     * @param obj The web object
14467     *
14468     * @return The current zoom mode set for the object, or
14469     * ::ELM_WEB_ZOOM_MODE_LAST on error
14470     */
14471    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
14472    /**
14473     * Shows the given region in the web object
14474     *
14475     * @param obj The web object
14476     * @param x The x coordinate of the region to show
14477     * @param y The y coordinate of the region to show
14478     * @param w The width of the region to show
14479     * @param h The height of the region to show
14480     */
14481    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14482    /**
14483     * Brings in the region to the visible area
14484     *
14485     * Like elm_web_region_show(), but it animates the scrolling of the object
14486     * to show the area
14487     *
14488     * @param obj The web object
14489     * @param x The x coordinate of the region to show
14490     * @param y The y coordinate of the region to show
14491     * @param w The width of the region to show
14492     * @param h The height of the region to show
14493     */
14494    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14495    /**
14496     * Sets the default dialogs to use an Inwin instead of a normal window
14497     *
14498     * If set, then the default implementation for the JavaScript dialogs and
14499     * file selector will be opened in an Inwin. Otherwise they will use a
14500     * normal separated window.
14501     *
14502     * @param obj The web object
14503     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14504     */
14505    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14506    /**
14507     * Gets whether Inwin mode is set for the current object
14508     *
14509     * @param obj The web object
14510     *
14511     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14512     */
14513    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
14514
14515    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14516    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14517    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);
14518    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14519
14520    /**
14521     * @}
14522     */
14523
14524    /**
14525     * @defgroup Hoversel Hoversel
14526     *
14527     * @image html img/widget/hoversel/preview-00.png
14528     * @image latex img/widget/hoversel/preview-00.eps
14529     *
14530     * A hoversel is a button that pops up a list of items (automatically
14531     * choosing the direction to display) that have a label and, optionally, an
14532     * icon to select from. It is a convenience widget to avoid the need to do
14533     * all the piecing together yourself. It is intended for a small number of
14534     * items in the hoversel menu (no more than 8), though is capable of many
14535     * more.
14536     *
14537     * Signals that you can add callbacks for are:
14538     * "clicked" - the user clicked the hoversel button and popped up the sel
14539     * "selected" - an item in the hoversel list is selected. event_info is the item
14540     * "dismissed" - the hover is dismissed
14541     *
14542     * See @ref tutorial_hoversel for an example.
14543     * @{
14544     */
14545    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14546    /**
14547     * @brief Add a new Hoversel object
14548     *
14549     * @param parent The parent object
14550     * @return The new object or NULL if it cannot be created
14551     */
14552    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14553    /**
14554     * @brief This sets the hoversel to expand horizontally.
14555     *
14556     * @param obj The hoversel object
14557     * @param horizontal If true, the hover will expand horizontally to the
14558     * right.
14559     *
14560     * @note The initial button will display horizontally regardless of this
14561     * setting.
14562     */
14563    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14564    /**
14565     * @brief This returns whether the hoversel is set to expand horizontally.
14566     *
14567     * @param obj The hoversel object
14568     * @return If true, the hover will expand horizontally to the right.
14569     *
14570     * @see elm_hoversel_horizontal_set()
14571     */
14572    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14573    /**
14574     * @brief Set the Hover parent
14575     *
14576     * @param obj The hoversel object
14577     * @param parent The parent to use
14578     *
14579     * Sets the hover parent object, the area that will be darkened when the
14580     * hoversel is clicked. Should probably be the window that the hoversel is
14581     * in. See @ref Hover objects for more information.
14582     */
14583    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14584    /**
14585     * @brief Get the Hover parent
14586     *
14587     * @param obj The hoversel object
14588     * @return The used parent
14589     *
14590     * Gets the hover parent object.
14591     *
14592     * @see elm_hoversel_hover_parent_set()
14593     */
14594    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14595    /**
14596     * @brief Set the hoversel button label
14597     *
14598     * @param obj The hoversel object
14599     * @param label The label text.
14600     *
14601     * This sets the label of the button that is always visible (before it is
14602     * clicked and expanded).
14603     *
14604     * @deprecated elm_object_text_set()
14605     */
14606    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14607    /**
14608     * @brief Get the hoversel button label
14609     *
14610     * @param obj The hoversel object
14611     * @return The label text.
14612     *
14613     * @deprecated elm_object_text_get()
14614     */
14615    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14616    /**
14617     * @brief Set the icon of the hoversel button
14618     *
14619     * @param obj The hoversel object
14620     * @param icon The icon object
14621     *
14622     * Sets the icon of the button that is always visible (before it is clicked
14623     * and expanded).  Once the icon object is set, a previously set one will be
14624     * deleted, if you want to keep that old content object, use the
14625     * elm_hoversel_icon_unset() function.
14626     *
14627     * @see elm_object_content_set() for the button widget
14628     */
14629    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14630    /**
14631     * @brief Get the icon of the hoversel button
14632     *
14633     * @param obj The hoversel object
14634     * @return The icon object
14635     *
14636     * Get the icon of the button that is always visible (before it is clicked
14637     * and expanded). Also see elm_object_content_get() for the button widget.
14638     *
14639     * @see elm_hoversel_icon_set()
14640     */
14641    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14642    /**
14643     * @brief Get and unparent the icon of the hoversel button
14644     *
14645     * @param obj The hoversel object
14646     * @return The icon object that was being used
14647     *
14648     * Unparent and return the icon of the button that is always visible
14649     * (before it is clicked and expanded).
14650     *
14651     * @see elm_hoversel_icon_set()
14652     * @see elm_object_content_unset() for the button widget
14653     */
14654    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14655    /**
14656     * @brief This triggers the hoversel popup from code, the same as if the user
14657     * had clicked the button.
14658     *
14659     * @param obj The hoversel object
14660     */
14661    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14662    /**
14663     * @brief This dismisses the hoversel popup as if the user had clicked
14664     * outside the hover.
14665     *
14666     * @param obj The hoversel object
14667     */
14668    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14669    /**
14670     * @brief Returns whether the hoversel is expanded.
14671     *
14672     * @param obj The hoversel object
14673     * @return  This will return EINA_TRUE if the hoversel is expanded or
14674     * EINA_FALSE if it is not expanded.
14675     */
14676    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14677    /**
14678     * @brief This will remove all the children items from the hoversel.
14679     *
14680     * @param obj The hoversel object
14681     *
14682     * @warning Should @b not be called while the hoversel is active; use
14683     * elm_hoversel_expanded_get() to check first.
14684     *
14685     * @see elm_hoversel_item_del_cb_set()
14686     * @see elm_hoversel_item_del()
14687     */
14688    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14689    /**
14690     * @brief Get the list of items within the given hoversel.
14691     *
14692     * @param obj The hoversel object
14693     * @return Returns a list of Elm_Hoversel_Item*
14694     *
14695     * @see elm_hoversel_item_add()
14696     */
14697    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14698    /**
14699     * @brief Add an item to the hoversel button
14700     *
14701     * @param obj The hoversel object
14702     * @param label The text label to use for the item (NULL if not desired)
14703     * @param icon_file An image file path on disk to use for the icon or standard
14704     * icon name (NULL if not desired)
14705     * @param icon_type The icon type if relevant
14706     * @param func Convenience function to call when this item is selected
14707     * @param data Data to pass to item-related functions
14708     * @return A handle to the item added.
14709     *
14710     * This adds an item to the hoversel to show when it is clicked. Note: if you
14711     * need to use an icon from an edje file then use
14712     * elm_hoversel_item_icon_set() right after the this function, and set
14713     * icon_file to NULL here.
14714     *
14715     * For more information on what @p icon_file and @p icon_type are see the
14716     * @ref Icon "icon documentation".
14717     */
14718    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);
14719    /**
14720     * @brief Delete an item from the hoversel
14721     *
14722     * @param item The item to delete
14723     *
14724     * This deletes the item from the hoversel (should not be called while the
14725     * hoversel is active; use elm_hoversel_expanded_get() to check first).
14726     *
14727     * @see elm_hoversel_item_add()
14728     * @see elm_hoversel_item_del_cb_set()
14729     */
14730    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14731    /**
14732     * @brief Set the function to be called when an item from the hoversel is
14733     * freed.
14734     *
14735     * @param item The item to set the callback on
14736     * @param func The function called
14737     *
14738     * That function will receive these parameters:
14739     * @li void *item_data
14740     * @li Evas_Object *the_item_object
14741     * @li Elm_Hoversel_Item *the_object_struct
14742     *
14743     * @see elm_hoversel_item_add()
14744     */
14745    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14746    /**
14747     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14748     * that will be passed to associated function callbacks.
14749     *
14750     * @param item The item to get the data from
14751     * @return The data pointer set with elm_hoversel_item_add()
14752     *
14753     * @see elm_hoversel_item_add()
14754     */
14755    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14756    /**
14757     * @brief This returns the label text of the given hoversel item.
14758     *
14759     * @param item The item to get the label
14760     * @return The label text of the hoversel item
14761     *
14762     * @see elm_hoversel_item_add()
14763     */
14764    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14765    /**
14766     * @brief This sets the icon for the given hoversel item.
14767     *
14768     * @param item The item to set the icon
14769     * @param icon_file An image file path on disk to use for the icon or standard
14770     * icon name
14771     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14772     * to NULL if the icon is not an edje file
14773     * @param icon_type The icon type
14774     *
14775     * The icon can be loaded from the standard set, from an image file, or from
14776     * an edje file.
14777     *
14778     * @see elm_hoversel_item_add()
14779     */
14780    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);
14781    /**
14782     * @brief Get the icon object of the hoversel item
14783     *
14784     * @param item The item to get the icon from
14785     * @param icon_file The image file path on disk used for the icon or standard
14786     * icon name
14787     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14788     * if the icon is not an edje file
14789     * @param icon_type The icon type
14790     *
14791     * @see elm_hoversel_item_icon_set()
14792     * @see elm_hoversel_item_add()
14793     */
14794    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);
14795    /**
14796     * @}
14797     */
14798
14799    /**
14800     * @defgroup Toolbar Toolbar
14801     * @ingroup Elementary
14802     *
14803     * @image html img/widget/toolbar/preview-00.png
14804     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14805     *
14806     * @image html img/toolbar.png
14807     * @image latex img/toolbar.eps width=\textwidth
14808     *
14809     * A toolbar is a widget that displays a list of items inside
14810     * a box. It can be scrollable, show a menu with items that don't fit
14811     * to toolbar size or even crop them.
14812     *
14813     * Only one item can be selected at a time.
14814     *
14815     * Items can have multiple states, or show menus when selected by the user.
14816     *
14817     * Smart callbacks one can listen to:
14818     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14819     * - "language,changed" - when the program language changes
14820     *
14821     * Available styles for it:
14822     * - @c "default"
14823     * - @c "transparent" - no background or shadow, just show the content
14824     *
14825     * List of examples:
14826     * @li @ref toolbar_example_01
14827     * @li @ref toolbar_example_02
14828     * @li @ref toolbar_example_03
14829     */
14830
14831    /**
14832     * @addtogroup Toolbar
14833     * @{
14834     */
14835
14836    /**
14837     * @enum _Elm_Toolbar_Shrink_Mode
14838     * @typedef Elm_Toolbar_Shrink_Mode
14839     *
14840     * Set toolbar's items display behavior, it can be scrollabel,
14841     * show a menu with exceeding items, or simply hide them.
14842     *
14843     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14844     * from elm config.
14845     *
14846     * Values <b> don't </b> work as bitmask, only one can be choosen.
14847     *
14848     * @see elm_toolbar_mode_shrink_set()
14849     * @see elm_toolbar_mode_shrink_get()
14850     *
14851     * @ingroup Toolbar
14852     */
14853    typedef enum _Elm_Toolbar_Shrink_Mode
14854      {
14855         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
14856         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
14857         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14858         ELM_TOOLBAR_SHRINK_MENU,   /**< Inserts a button to pop up a menu with exceeding items. */
14859         ELM_TOOLBAR_SHRINK_LAST    /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14860      } Elm_Toolbar_Shrink_Mode;
14861
14862    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(). */
14863
14864    /**
14865     * Add a new toolbar widget to the given parent Elementary
14866     * (container) object.
14867     *
14868     * @param parent The parent object.
14869     * @return a new toolbar widget handle or @c NULL, on errors.
14870     *
14871     * This function inserts a new toolbar widget on the canvas.
14872     *
14873     * @ingroup Toolbar
14874     */
14875    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14876    /**
14877     * Set the icon size, in pixels, to be used by toolbar items.
14878     *
14879     * @param obj The toolbar object
14880     * @param icon_size The icon size in pixels
14881     *
14882     * @note Default value is @c 32. It reads value from elm config.
14883     *
14884     * @see elm_toolbar_icon_size_get()
14885     *
14886     * @ingroup Toolbar
14887     */
14888    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14889    /**
14890     * Get the icon size, in pixels, to be used by toolbar items.
14891     *
14892     * @param obj The toolbar object.
14893     * @return The icon size in pixels.
14894     *
14895     * @see elm_toolbar_icon_size_set() for details.
14896     *
14897     * @ingroup Toolbar
14898     */
14899    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14900    /**
14901     * Sets icon lookup order, for toolbar items' icons.
14902     *
14903     * @param obj The toolbar object.
14904     * @param order The icon lookup order.
14905     *
14906     * Icons added before calling this function will not be affected.
14907     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14908     *
14909     * @see elm_toolbar_icon_order_lookup_get()
14910     *
14911     * @ingroup Toolbar
14912     */
14913    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14914    /**
14915     * Gets the icon lookup order.
14916     *
14917     * @param obj The toolbar object.
14918     * @return The icon lookup order.
14919     *
14920     * @see elm_toolbar_icon_order_lookup_set() for details.
14921     *
14922     * @ingroup Toolbar
14923     */
14924    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14925    /**
14926     * Set whether the toolbar should always have an item selected.
14927     *
14928     * @param obj The toolbar object.
14929     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14930     * disable it.
14931     *
14932     * This will cause the toolbar to always have an item selected, and clicking
14933     * the selected item will not cause a selected event to be emitted. Enabling this mode
14934     * will immediately select the first toolbar item.
14935     *
14936     * Always-selected is disabled by default.
14937     *
14938     * @see elm_toolbar_always_select_mode_get().
14939     *
14940     * @ingroup Toolbar
14941     */
14942    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14943    /**
14944     * Get whether the toolbar should always have an item selected.
14945     *
14946     * @param obj The toolbar object.
14947     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14948     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14949     *
14950     * @see elm_toolbar_always_select_mode_set() for details.
14951     *
14952     * @ingroup Toolbar
14953     */
14954    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14955    /**
14956     * Set whether the toolbar items' should be selected by the user or not.
14957     *
14958     * @param obj The toolbar object.
14959     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14960     * enable it.
14961     *
14962     * This will turn off the ability to select items entirely and they will
14963     * neither appear selected nor emit selected signals. The clicked
14964     * callback function will still be called.
14965     *
14966     * Selection is enabled by default.
14967     *
14968     * @see elm_toolbar_no_select_mode_get().
14969     *
14970     * @ingroup Toolbar
14971     */
14972    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14973
14974    /**
14975     * Set whether the toolbar items' should be selected by the user or not.
14976     *
14977     * @param obj The toolbar object.
14978     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14979     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14980     *
14981     * @see elm_toolbar_no_select_mode_set() for details.
14982     *
14983     * @ingroup Toolbar
14984     */
14985    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14986    /**
14987     * Append item to the toolbar.
14988     *
14989     * @param obj The toolbar object.
14990     * @param icon A string with icon name or the absolute path of an image file.
14991     * @param label The label of the item.
14992     * @param func The function to call when the item is clicked.
14993     * @param data The data to associate with the item for related callbacks.
14994     * @return The created item or @c NULL upon failure.
14995     *
14996     * A new item will be created and appended to the toolbar, i.e., will
14997     * be set as @b last item.
14998     *
14999     * Items created with this method can be deleted with
15000     * elm_toolbar_item_del().
15001     *
15002     * Associated @p data can be properly freed when item is deleted if a
15003     * callback function is set with elm_toolbar_item_del_cb_set().
15004     *
15005     * If a function is passed as argument, it will be called everytime this item
15006     * is selected, i.e., the user clicks over an unselected item.
15007     * If such function isn't needed, just passing
15008     * @c NULL as @p func is enough. The same should be done for @p data.
15009     *
15010     * Toolbar will load icon image from fdo or current theme.
15011     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15012     * If an absolute path is provided it will load it direct from a file.
15013     *
15014     * @see elm_toolbar_item_icon_set()
15015     * @see elm_toolbar_item_del()
15016     * @see elm_toolbar_item_del_cb_set()
15017     *
15018     * @ingroup Toolbar
15019     */
15020    EAPI Elm_Object_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);
15021    /**
15022     * Prepend item to the toolbar.
15023     *
15024     * @param obj The toolbar object.
15025     * @param icon A string with icon name or the absolute path of an image file.
15026     * @param label The label of the item.
15027     * @param func The function to call when the item is clicked.
15028     * @param data The data to associate with the item for related callbacks.
15029     * @return The created item or @c NULL upon failure.
15030     *
15031     * A new item will be created and prepended to the toolbar, i.e., will
15032     * be set as @b first item.
15033     *
15034     * Items created with this method can be deleted with
15035     * elm_toolbar_item_del().
15036     *
15037     * Associated @p data can be properly freed when item is deleted if a
15038     * callback function is set with elm_toolbar_item_del_cb_set().
15039     *
15040     * If a function is passed as argument, it will be called everytime this item
15041     * is selected, i.e., the user clicks over an unselected item.
15042     * If such function isn't needed, just passing
15043     * @c NULL as @p func is enough. The same should be done for @p data.
15044     *
15045     * Toolbar will load icon image from fdo or current theme.
15046     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15047     * If an absolute path is provided it will load it direct from a file.
15048     *
15049     * @see elm_toolbar_item_icon_set()
15050     * @see elm_toolbar_item_del()
15051     * @see elm_toolbar_item_del_cb_set()
15052     *
15053     * @ingroup Toolbar
15054     */
15055    EAPI Elm_Object_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);
15056    /**
15057     * Insert a new item into the toolbar object before item @p before.
15058     *
15059     * @param obj The toolbar object.
15060     * @param before The toolbar item to insert before.
15061     * @param icon A string with icon name or the absolute path of an image file.
15062     * @param label The label of the item.
15063     * @param func The function to call when the item is clicked.
15064     * @param data The data to associate with the item for related callbacks.
15065     * @return The created item or @c NULL upon failure.
15066     *
15067     * A new item will be created and added to the toolbar. Its position in
15068     * this toolbar will be just before item @p before.
15069     *
15070     * Items created with this method can be deleted with
15071     * elm_toolbar_item_del().
15072     *
15073     * Associated @p data can be properly freed when item is deleted if a
15074     * callback function is set with elm_toolbar_item_del_cb_set().
15075     *
15076     * If a function is passed as argument, it will be called everytime this item
15077     * is selected, i.e., the user clicks over an unselected item.
15078     * If such function isn't needed, just passing
15079     * @c NULL as @p func is enough. The same should be done for @p data.
15080     *
15081     * Toolbar will load icon image from fdo or current theme.
15082     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15083     * If an absolute path is provided it will load it direct from a file.
15084     *
15085     * @see elm_toolbar_item_icon_set()
15086     * @see elm_toolbar_item_del()
15087     * @see elm_toolbar_item_del_cb_set()
15088     *
15089     * @ingroup Toolbar
15090     */
15091    EAPI Elm_Object_Item       *elm_toolbar_item_insert_before(Evas_Object *obj, Elm_Object_Item *before, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15092
15093    /**
15094     * Insert a new item into the toolbar object after item @p after.
15095     *
15096     * @param obj The toolbar object.
15097     * @param after The toolbar item to insert after.
15098     * @param icon A string with icon name or the absolute path of an image file.
15099     * @param label The label of the item.
15100     * @param func The function to call when the item is clicked.
15101     * @param data The data to associate with the item for related callbacks.
15102     * @return The created item or @c NULL upon failure.
15103     *
15104     * A new item will be created and added to the toolbar. Its position in
15105     * this toolbar will be just after item @p after.
15106     *
15107     * Items created with this method can be deleted with
15108     * elm_toolbar_item_del().
15109     *
15110     * Associated @p data can be properly freed when item is deleted if a
15111     * callback function is set with elm_toolbar_item_del_cb_set().
15112     *
15113     * If a function is passed as argument, it will be called everytime this item
15114     * is selected, i.e., the user clicks over an unselected item.
15115     * If such function isn't needed, just passing
15116     * @c NULL as @p func is enough. The same should be done for @p data.
15117     *
15118     * Toolbar will load icon image from fdo or current theme.
15119     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15120     * If an absolute path is provided it will load it direct from a file.
15121     *
15122     * @see elm_toolbar_item_icon_set()
15123     * @see elm_toolbar_item_del()
15124     * @see elm_toolbar_item_del_cb_set()
15125     *
15126     * @ingroup Toolbar
15127     */
15128    EAPI Elm_Object_Item       *elm_toolbar_item_insert_after(Evas_Object *obj, Elm_Object_Item *after, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15129    /**
15130     * Get the first item in the given toolbar widget's list of
15131     * items.
15132     *
15133     * @param obj The toolbar object
15134     * @return The first item or @c NULL, if it has no items (and on
15135     * errors)
15136     *
15137     * @see elm_toolbar_item_append()
15138     * @see elm_toolbar_last_item_get()
15139     *
15140     * @ingroup Toolbar
15141     */
15142    EAPI Elm_Object_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15143    /**
15144     * Get the last item in the given toolbar widget's list of
15145     * items.
15146     *
15147     * @param obj The toolbar object
15148     * @return The last item or @c NULL, if it has no items (and on
15149     * errors)
15150     *
15151     * @see elm_toolbar_item_prepend()
15152     * @see elm_toolbar_first_item_get()
15153     *
15154     * @ingroup Toolbar
15155     */
15156    EAPI Elm_Object_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15157    /**
15158     * Get the item after @p item in toolbar.
15159     *
15160     * @param it The toolbar item.
15161     * @return The item after @p item, or @c NULL if none or on failure.
15162     *
15163     * @note If it is the last item, @c NULL will be returned.
15164     *
15165     * @see elm_toolbar_item_append()
15166     *
15167     * @ingroup Toolbar
15168     */
15169    EAPI Elm_Object_Item       *elm_toolbar_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15170    /**
15171     * Get the item before @p item in toolbar.
15172     *
15173     * @param item The toolbar item.
15174     * @return The item before @p item, or @c NULL if none or on failure.
15175     *
15176     * @note If it is the first item, @c NULL will be returned.
15177     *
15178     * @see elm_toolbar_item_prepend()
15179     *
15180     * @ingroup Toolbar
15181     */
15182    EAPI Elm_Object_Item       *elm_toolbar_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15183    /**
15184     * Get the toolbar object from an item.
15185     *
15186     * @param it The item.
15187     * @return The toolbar object.
15188     *
15189     * This returns the toolbar object itself that an item belongs to.
15190     *
15191     * @ingroup Toolbar
15192     */
15193    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15194    /**
15195     * Set the priority of a toolbar item.
15196     *
15197     * @param it The toolbar item.
15198     * @param priority The item priority. The default is zero.
15199     *
15200     * This is used only when the toolbar shrink mode is set to
15201     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
15202     * When space is less than required, items with low priority
15203     * will be removed from the toolbar and added to a dynamically-created menu,
15204     * while items with higher priority will remain on the toolbar,
15205     * with the same order they were added.
15206     *
15207     * @see elm_toolbar_item_priority_get()
15208     *
15209     * @ingroup Toolbar
15210     */
15211    EAPI void                    elm_toolbar_item_priority_set(Elm_Object_Item *it, int priority) EINA_ARG_NONNULL(1);
15212    /**
15213     * Get the priority of a toolbar item.
15214     *
15215     * @param it The toolbar item.
15216     * @return The @p item priority, or @c 0 on failure.
15217     *
15218     * @see elm_toolbar_item_priority_set() for details.
15219     *
15220     * @ingroup Toolbar
15221     */
15222    EAPI int                     elm_toolbar_item_priority_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15223    /**
15224     * Get the label of item.
15225     *
15226     * @param it The item of toolbar.
15227     * @return The label of item.
15228     *
15229     * The return value is a pointer to the label associated to @p item when
15230     * it was created, with function elm_toolbar_item_append() or similar,
15231     * or later,
15232     * with function elm_toolbar_item_label_set. If no label
15233     * was passed as argument, it will return @c NULL.
15234     *
15235     * @see elm_toolbar_item_label_set() for more details.
15236     * @see elm_toolbar_item_append()
15237     *
15238     * @ingroup Toolbar
15239     */
15240    EAPI const char             *elm_toolbar_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15241    /**
15242     * Set the label of item.
15243     *
15244     * @param it The item of toolbar.
15245     * @param text The label of item.
15246     *
15247     * The label to be displayed by the item.
15248     * Label will be placed at icons bottom (if set).
15249     *
15250     * If a label was passed as argument on item creation, with function
15251     * elm_toolbar_item_append() or similar, it will be already
15252     * displayed by the item.
15253     *
15254     * @see elm_toolbar_item_label_get()
15255     * @see elm_toolbar_item_append()
15256     *
15257     * @ingroup Toolbar
15258     */
15259    EAPI void                    elm_toolbar_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
15260    /**
15261     * Return the data associated with a given toolbar widget item.
15262     *
15263     * @param it The toolbar widget item handle.
15264     * @return The data associated with @p item.
15265     *
15266     * @see elm_toolbar_item_data_set()
15267     *
15268     * @ingroup Toolbar
15269     */
15270    EAPI void                   *elm_toolbar_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15271    /**
15272     * Set the data associated with a given toolbar widget item.
15273     *
15274     * @param it The toolbar widget item handle
15275     * @param data The new data pointer to set to @p item.
15276     *
15277     * This sets new item data on @p item.
15278     *
15279     * @warning The old data pointer won't be touched by this function, so
15280     * the user had better to free that old data himself/herself.
15281     *
15282     * @ingroup Toolbar
15283     */
15284    EAPI void                    elm_toolbar_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
15285    /**
15286     * Returns a pointer to a toolbar item by its label.
15287     *
15288     * @param obj The toolbar object.
15289     * @param label The label of the item to find.
15290     *
15291     * @return The pointer to the toolbar item matching @p label or @c NULL
15292     * on failure.
15293     *
15294     * @ingroup Toolbar
15295     */
15296    EAPI Elm_Object_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15297    /*
15298     * Get whether the @p item is selected or not.
15299     *
15300     * @param it The toolbar item.
15301     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15302     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15303     *
15304     * @see elm_toolbar_selected_item_set() for details.
15305     * @see elm_toolbar_item_selected_get()
15306     *
15307     * @ingroup Toolbar
15308     */
15309    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15310    /**
15311     * Set the selected state of an item.
15312     *
15313     * @param it The toolbar item
15314     * @param selected The selected state
15315     *
15316     * This sets the selected state of the given item @p it.
15317     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15318     *
15319     * If a new item is selected the previosly selected will be unselected.
15320     * Previoulsy selected item can be get with function
15321     * elm_toolbar_selected_item_get().
15322     *
15323     * Selected items will be highlighted.
15324     *
15325     * @see elm_toolbar_item_selected_get()
15326     * @see elm_toolbar_selected_item_get()
15327     *
15328     * @ingroup Toolbar
15329     */
15330    EAPI void                    elm_toolbar_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
15331    /**
15332     * Get the selected item.
15333     *
15334     * @param obj The toolbar object.
15335     * @return The selected toolbar item.
15336     *
15337     * The selected item can be unselected with function
15338     * elm_toolbar_item_selected_set().
15339     *
15340     * The selected item always will be highlighted on toolbar.
15341     *
15342     * @see elm_toolbar_selected_items_get()
15343     *
15344     * @ingroup Toolbar
15345     */
15346    EAPI Elm_Object_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15347    /**
15348     * Set the icon associated with @p item.
15349     *
15350     * @param obj The parent of this item.
15351     * @param it The toolbar item.
15352     * @param icon A string with icon name or the absolute path of an image file.
15353     *
15354     * Toolbar will load icon image from fdo or current theme.
15355     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15356     * If an absolute path is provided it will load it direct from a file.
15357     *
15358     * @see elm_toolbar_icon_order_lookup_set()
15359     * @see elm_toolbar_icon_order_lookup_get()
15360     *
15361     * @ingroup Toolbar
15362     */
15363    EAPI void                    elm_toolbar_item_icon_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1);
15364    /**
15365     * Get the string used to set the icon of @p item.
15366     *
15367     * @param it The toolbar item.
15368     * @return The string associated with the icon object.
15369     *
15370     * @see elm_toolbar_item_icon_set() for details.
15371     *
15372     * @ingroup Toolbar
15373     */
15374    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15375    /**
15376     * Get the object of @p item.
15377     *
15378     * @param it The toolbar item.
15379     * @return The object
15380     *
15381     * @ingroup Toolbar
15382     */
15383    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15384    /**
15385     * Get the icon object of @p item.
15386     *
15387     * @param it The toolbar item.
15388     * @return The icon object
15389     *
15390     * @see elm_toolbar_item_icon_set(), elm_toolbar_item_icon_file_set(),
15391     * or elm_toolbar_item_icon_memfile_set() for details.
15392     *
15393     * @ingroup Toolbar
15394     */
15395    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15396    /**
15397     * Set the icon associated with @p item to an image in a binary buffer.
15398     *
15399     * @param it The toolbar item.
15400     * @param img The binary data that will be used as an image
15401     * @param size The size of binary data @p img
15402     * @param format Optional format of @p img to pass to the image loader
15403     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15404     *
15405     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15406     *
15407     * @note The icon image set by this function can be changed by
15408     * elm_toolbar_item_icon_set().
15409     *
15410     * @ingroup Toolbar
15411     */
15412    EAPI Eina_Bool elm_toolbar_item_icon_memfile_set(Elm_Object_Item *it, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1);
15413
15414    /**
15415     * Set the icon associated with @p item to an image in a binary buffer.
15416     *
15417     * @param it The toolbar item.
15418     * @param file The file that contains the image
15419     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15420     *
15421     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15422     *
15423     * @note The icon image set by this function can be changed by
15424     * elm_toolbar_item_icon_set().
15425     *
15426     * @ingroup Toolbar
15427     */
15428    EAPI Eina_Bool elm_toolbar_item_icon_file_set(Elm_Object_Item *it, const char *file, const char *key) EINA_ARG_NONNULL(1);
15429
15430    /**
15431     * Delete them item from the toolbar.
15432     *
15433     * @param it The item of toolbar to be deleted.
15434     *
15435     * @see elm_toolbar_item_append()
15436     * @see elm_toolbar_item_del_cb_set()
15437     *
15438     * @ingroup Toolbar
15439     */
15440    EAPI void                    elm_toolbar_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15441
15442    /**
15443     * Set the function called when a toolbar item is freed.
15444     *
15445     * @param it The item to set the callback on.
15446     * @param func The function called.
15447     *
15448     * If there is a @p func, then it will be called prior item's memory release.
15449     * That will be called with the following arguments:
15450     * @li item's data;
15451     * @li item's Evas object;
15452     * @li item itself;
15453     *
15454     * This way, a data associated to a toolbar item could be properly freed.
15455     *
15456     * @ingroup Toolbar
15457     */
15458    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15459
15460    /**
15461     * Get a value whether toolbar item is disabled or not.
15462     *
15463     * @param it The item.
15464     * @return The disabled state.
15465     *
15466     * @see elm_toolbar_item_disabled_set() for more details.
15467     *
15468     * @ingroup Toolbar
15469     */
15470    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15471
15472    /**
15473     * Sets the disabled/enabled state of a toolbar item.
15474     *
15475     * @param it The item.
15476     * @param disabled The disabled state.
15477     *
15478     * A disabled item cannot be selected or unselected. It will also
15479     * change its appearance (generally greyed out). This sets the
15480     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15481     * enabled).
15482     *
15483     * @ingroup Toolbar
15484     */
15485    EAPI void                    elm_toolbar_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15486
15487    /**
15488     * Set or unset item as a separator.
15489     *
15490     * @param it The toolbar item.
15491     * @param setting @c EINA_TRUE to set item @p item as separator or
15492     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15493     *
15494     * Items aren't set as separator by default.
15495     *
15496     * If set as separator it will display separator theme, so won't display
15497     * icons or label.
15498     *
15499     * @see elm_toolbar_item_separator_get()
15500     *
15501     * @ingroup Toolbar
15502     */
15503    EAPI void                    elm_toolbar_item_separator_set(Elm_Object_Item *it, Eina_Bool separator) EINA_ARG_NONNULL(1);
15504
15505    /**
15506     * Get a value whether item is a separator or not.
15507     *
15508     * @param it The toolbar item.
15509     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15510     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15511     *
15512     * @see elm_toolbar_item_separator_set() for details.
15513     *
15514     * @ingroup Toolbar
15515     */
15516    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15517
15518    /**
15519     * Set the shrink state of toolbar @p obj.
15520     *
15521     * @param obj The toolbar object.
15522     * @param shrink_mode Toolbar's items display behavior.
15523     *
15524     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15525     * but will enforce a minimun size so all the items will fit, won't scroll
15526     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15527     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15528     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15529     *
15530     * @ingroup Toolbar
15531     */
15532    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15533
15534    /**
15535     * Get the shrink mode of toolbar @p obj.
15536     *
15537     * @param obj The toolbar object.
15538     * @return Toolbar's items display behavior.
15539     *
15540     * @see elm_toolbar_mode_shrink_set() for details.
15541     *
15542     * @ingroup Toolbar
15543     */
15544    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15545
15546    /**
15547     * Enable/disable homogeneous mode.
15548     *
15549     * @param obj The toolbar object
15550     * @param homogeneous Assume the items within the toolbar are of the
15551     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15552     *
15553     * This will enable the homogeneous mode where items are of the same size.
15554     * @see elm_toolbar_homogeneous_get()
15555     *
15556     * @ingroup Toolbar
15557     */
15558    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15559
15560    /**
15561     * Get whether the homogeneous mode is enabled.
15562     *
15563     * @param obj The toolbar object.
15564     * @return Assume the items within the toolbar are of the same height
15565     * and width (EINA_TRUE = on, EINA_FALSE = off).
15566     *
15567     * @see elm_toolbar_homogeneous_set()
15568     *
15569     * @ingroup Toolbar
15570     */
15571    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15572    /**
15573     * Set the parent object of the toolbar items' menus.
15574     *
15575     * @param obj The toolbar object.
15576     * @param parent The parent of the menu objects.
15577     *
15578     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15579     *
15580     * For more details about setting the parent for toolbar menus, see
15581     * elm_menu_parent_set().
15582     *
15583     * @see elm_menu_parent_set() for details.
15584     * @see elm_toolbar_item_menu_set() for details.
15585     *
15586     * @ingroup Toolbar
15587     */
15588    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15589    /**
15590     * Get the parent object of the toolbar items' menus.
15591     *
15592     * @param obj The toolbar object.
15593     * @return The parent of the menu objects.
15594     *
15595     * @see elm_toolbar_menu_parent_set() for details.
15596     *
15597     * @ingroup Toolbar
15598     */
15599    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15600    /**
15601     * Set the alignment of the items.
15602     *
15603     * @param obj The toolbar object.
15604     * @param align The new alignment, a float between <tt> 0.0 </tt>
15605     * and <tt> 1.0 </tt>.
15606     *
15607     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15608     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15609     * items.
15610     *
15611     * Centered items by default.
15612     *
15613     * @see elm_toolbar_align_get()
15614     *
15615     * @ingroup Toolbar
15616     */
15617    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15618    /**
15619     * Get the alignment of the items.
15620     *
15621     * @param obj The toolbar object.
15622     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15623     * <tt> 1.0 </tt>.
15624     *
15625     * @see elm_toolbar_align_set() for details.
15626     *
15627     * @ingroup Toolbar
15628     */
15629    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15630    /**
15631     * Set whether the toolbar item opens a menu.
15632     *
15633     * @param it The toolbar item.
15634     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15635     *
15636     * A toolbar item can be set to be a menu, using this function.
15637     *
15638     * Once it is set to be a menu, it can be manipulated through the
15639     * menu-like function elm_toolbar_menu_parent_set() and the other
15640     * elm_menu functions, using the Evas_Object @c menu returned by
15641     * elm_toolbar_item_menu_get().
15642     *
15643     * So, items to be displayed in this item's menu should be added with
15644     * elm_menu_item_add().
15645     *
15646     * The following code exemplifies the most basic usage:
15647     * @code
15648     * tb = elm_toolbar_add(win)
15649     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15650     * elm_toolbar_item_menu_set(item, EINA_TRUE);
15651     * elm_toolbar_menu_parent_set(tb, win);
15652     * menu = elm_toolbar_item_menu_get(item);
15653     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15654     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15655     * NULL);
15656     * @endcode
15657     *
15658     * @see elm_toolbar_item_menu_get()
15659     *
15660     * @ingroup Toolbar
15661     */
15662    EAPI void                    elm_toolbar_item_menu_set(Elm_Object_Item *it, Eina_Bool menu) EINA_ARG_NONNULL(1);
15663    /**
15664     * Get toolbar item's menu.
15665     *
15666     * @param it The toolbar item.
15667     * @return Item's menu object or @c NULL on failure.
15668     *
15669     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15670     * this function will set it.
15671     *
15672     * @see elm_toolbar_item_menu_set() for details.
15673     *
15674     * @ingroup Toolbar
15675     */
15676    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15677    /**
15678     * Add a new state to @p item.
15679     *
15680     * @param it The toolbar item.
15681     * @param icon A string with icon name or the absolute path of an image file.
15682     * @param label The label of the new state.
15683     * @param func The function to call when the item is clicked when this
15684     * state is selected.
15685     * @param data The data to associate with the state.
15686     * @return The toolbar item state, or @c NULL upon failure.
15687     *
15688     * Toolbar will load icon image from fdo or current theme.
15689     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15690     * If an absolute path is provided it will load it direct from a file.
15691     *
15692     * States created with this function can be removed with
15693     * elm_toolbar_item_state_del().
15694     *
15695     * @see elm_toolbar_item_state_del()
15696     * @see elm_toolbar_item_state_sel()
15697     * @see elm_toolbar_item_state_get()
15698     *
15699     * @ingroup Toolbar
15700     */
15701    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_add(Elm_Object_Item *it, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15702    /**
15703     * Delete a previoulsy added state to @p item.
15704     *
15705     * @param it The toolbar item.
15706     * @param state The state to be deleted.
15707     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15708     *
15709     * @see elm_toolbar_item_state_add()
15710     */
15711    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15712    /**
15713     * Set @p state as the current state of @p it.
15714     *
15715     * @param it The toolbar item.
15716     * @param state The state to use.
15717     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15718     *
15719     * If @p state is @c NULL, it won't select any state and the default item's
15720     * icon and label will be used. It's the same behaviour than
15721     * elm_toolbar_item_state_unser().
15722     *
15723     * @see elm_toolbar_item_state_unset()
15724     *
15725     * @ingroup Toolbar
15726     */
15727    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15728    /**
15729     * Unset the state of @p it.
15730     *
15731     * @param it The toolbar item.
15732     *
15733     * The default icon and label from this item will be displayed.
15734     *
15735     * @see elm_toolbar_item_state_set() for more details.
15736     *
15737     * @ingroup Toolbar
15738     */
15739    EAPI void                    elm_toolbar_item_state_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15740    /**
15741     * Get the current state of @p it.
15742     *
15743     * @param it The toolbar item.
15744     * @return The selected state or @c NULL if none is selected or on failure.
15745     *
15746     * @see elm_toolbar_item_state_set() for details.
15747     * @see elm_toolbar_item_state_unset()
15748     * @see elm_toolbar_item_state_add()
15749     *
15750     * @ingroup Toolbar
15751     */
15752    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15753    /**
15754     * Get the state after selected state in toolbar's @p item.
15755     *
15756     * @param it The toolbar item to change state.
15757     * @return The state after current state, or @c NULL on failure.
15758     *
15759     * If last state is selected, this function will return first state.
15760     *
15761     * @see elm_toolbar_item_state_set()
15762     * @see elm_toolbar_item_state_add()
15763     *
15764     * @ingroup Toolbar
15765     */
15766    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15767    /**
15768     * Get the state before selected state in toolbar's @p item.
15769     *
15770     * @param it The toolbar item to change state.
15771     * @return The state before current state, or @c NULL on failure.
15772     *
15773     * If first state is selected, this function will return last state.
15774     *
15775     * @see elm_toolbar_item_state_set()
15776     * @see elm_toolbar_item_state_add()
15777     *
15778     * @ingroup Toolbar
15779     */
15780    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15781    /**
15782     * Set the text to be shown in a given toolbar item's tooltips.
15783     *
15784     * @param it toolbar item.
15785     * @param text The text to set in the content.
15786     *
15787     * Setup the text as tooltip to object. The item can have only one tooltip,
15788     * so any previous tooltip data - set with this function or
15789     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15790     *
15791     * @see elm_object_tooltip_text_set() for more details.
15792     *
15793     * @ingroup Toolbar
15794     */
15795    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Object_Item *it, const char *text) EINA_ARG_NONNULL(1);
15796    /**
15797     * Set the content to be shown in the tooltip item.
15798     *
15799     * Setup the tooltip to item. The item can have only one tooltip,
15800     * so any previous tooltip data is removed. @p func(with @p data) will
15801     * be called every time that need show the tooltip and it should
15802     * return a valid Evas_Object. This object is then managed fully by
15803     * tooltip system and is deleted when the tooltip is gone.
15804     *
15805     * @param it the toolbar item being attached a tooltip.
15806     * @param func the function used to create the tooltip contents.
15807     * @param data what to provide to @a func as callback data/context.
15808     * @param del_cb called when data is not needed anymore, either when
15809     *        another callback replaces @a func, the tooltip is unset with
15810     *        elm_toolbar_item_tooltip_unset() or the owner @a item
15811     *        dies. This callback receives as the first parameter the
15812     *        given @a data, and @c event_info is the item.
15813     *
15814     * @see elm_object_tooltip_content_cb_set() for more details.
15815     *
15816     * @ingroup Toolbar
15817     */
15818    EAPI void             elm_toolbar_item_tooltip_content_cb_set(Elm_Object_Item *it, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
15819    /**
15820     * Unset tooltip from item.
15821     *
15822     * @param it toolbar item to remove previously set tooltip.
15823     *
15824     * Remove tooltip from item. The callback provided as del_cb to
15825     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15826     * it is not used anymore.
15827     *
15828     * @see elm_object_tooltip_unset() for more details.
15829     * @see elm_toolbar_item_tooltip_content_cb_set()
15830     *
15831     * @ingroup Toolbar
15832     */
15833    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15834    /**
15835     * Sets a different style for this item tooltip.
15836     *
15837     * @note before you set a style you should define a tooltip with
15838     *       elm_toolbar_item_tooltip_content_cb_set() or
15839     *       elm_toolbar_item_tooltip_text_set()
15840     *
15841     * @param it toolbar item with tooltip already set.
15842     * @param style the theme style to use (default, transparent, ...)
15843     *
15844     * @see elm_object_tooltip_style_set() for more details.
15845     *
15846     * @ingroup Toolbar
15847     */
15848    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
15849    /**
15850     * Get the style for this item tooltip.
15851     *
15852     * @param it toolbar item with tooltip already set.
15853     * @return style the theme style in use, defaults to "default". If the
15854     *         object does not have a tooltip set, then NULL is returned.
15855     *
15856     * @see elm_object_tooltip_style_get() for more details.
15857     * @see elm_toolbar_item_tooltip_style_set()
15858     *
15859     * @ingroup Toolbar
15860     */
15861    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15862    /**
15863     * Set the type of mouse pointer/cursor decoration to be shown,
15864     * when the mouse pointer is over the given toolbar widget item
15865     *
15866     * @param it toolbar item to customize cursor on
15867     * @param cursor the cursor type's name
15868     *
15869     * This function works analogously as elm_object_cursor_set(), but
15870     * here the cursor's changing area is restricted to the item's
15871     * area, and not the whole widget's. Note that that item cursors
15872     * have precedence over widget cursors, so that a mouse over an
15873     * item with custom cursor set will always show @b that cursor.
15874     *
15875     * If this function is called twice for an object, a previously set
15876     * cursor will be unset on the second call.
15877     *
15878     * @see elm_object_cursor_set()
15879     * @see elm_toolbar_item_cursor_get()
15880     * @see elm_toolbar_item_cursor_unset()
15881     *
15882     * @ingroup Toolbar
15883     */
15884    EAPI void             elm_toolbar_item_cursor_set(Elm_Object_Item *it, const char *cursor) EINA_ARG_NONNULL(1);
15885
15886    /*
15887     * Get the type of mouse pointer/cursor decoration set to be shown,
15888     * when the mouse pointer is over the given toolbar widget item
15889     *
15890     * @param it toolbar item with custom cursor set
15891     * @return the cursor type's name or @c NULL, if no custom cursors
15892     * were set to @p item (and on errors)
15893     *
15894     * @see elm_object_cursor_get()
15895     * @see elm_toolbar_item_cursor_set()
15896     * @see elm_toolbar_item_cursor_unset()
15897     *
15898     * @ingroup Toolbar
15899     */
15900    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15901
15902    /**
15903     * Unset any custom mouse pointer/cursor decoration set to be
15904     * shown, when the mouse pointer is over the given toolbar widget
15905     * item, thus making it show the @b default cursor again.
15906     *
15907     * @param it a toolbar item
15908     *
15909     * Use this call to undo any custom settings on this item's cursor
15910     * decoration, bringing it back to defaults (no custom style set).
15911     *
15912     * @see elm_object_cursor_unset()
15913     * @see elm_toolbar_item_cursor_set()
15914     *
15915     * @ingroup Toolbar
15916     */
15917    EAPI void             elm_toolbar_item_cursor_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15918
15919    /**
15920     * Set a different @b style for a given custom cursor set for a
15921     * toolbar item.
15922     *
15923     * @param it toolbar item with custom cursor set
15924     * @param style the <b>theme style</b> to use (e.g. @c "default",
15925     * @c "transparent", etc)
15926     *
15927     * This function only makes sense when one is using custom mouse
15928     * cursor decorations <b>defined in a theme file</b>, which can have,
15929     * given a cursor name/type, <b>alternate styles</b> on it. It
15930     * works analogously as elm_object_cursor_style_set(), but here
15931     * applyed only to toolbar item objects.
15932     *
15933     * @warning Before you set a cursor style you should have definen a
15934     *       custom cursor previously on the item, with
15935     *       elm_toolbar_item_cursor_set()
15936     *
15937     * @see elm_toolbar_item_cursor_engine_only_set()
15938     * @see elm_toolbar_item_cursor_style_get()
15939     *
15940     * @ingroup Toolbar
15941     */
15942    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
15943
15944    /**
15945     * Get the current @b style set for a given toolbar item's custom
15946     * cursor
15947     *
15948     * @param it toolbar item with custom cursor set.
15949     * @return style the cursor style in use. If the object does not
15950     *         have a cursor set, then @c NULL is returned.
15951     *
15952     * @see elm_toolbar_item_cursor_style_set() for more details
15953     *
15954     * @ingroup Toolbar
15955     */
15956    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15957
15958    /**
15959     * Set if the (custom)cursor for a given toolbar item should be
15960     * searched in its theme, also, or should only rely on the
15961     * rendering engine.
15962     *
15963     * @param it item with custom (custom) cursor already set on
15964     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15965     * only on those provided by the rendering engine, @c EINA_FALSE to
15966     * have them searched on the widget's theme, as well.
15967     *
15968     * @note This call is of use only if you've set a custom cursor
15969     * for toolbar items, with elm_toolbar_item_cursor_set().
15970     *
15971     * @note By default, cursors will only be looked for between those
15972     * provided by the rendering engine.
15973     *
15974     * @ingroup Toolbar
15975     */
15976    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15977
15978    /**
15979     * Get if the (custom) cursor for a given toolbar item is being
15980     * searched in its theme, also, or is only relying on the rendering
15981     * engine.
15982     *
15983     * @param it a toolbar item
15984     * @return @c EINA_TRUE, if cursors are being looked for only on
15985     * those provided by the rendering engine, @c EINA_FALSE if they
15986     * are being searched on the widget's theme, as well.
15987     *
15988     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15989     *
15990     * @ingroup Toolbar
15991     */
15992    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15993
15994    /**
15995     * Change a toolbar's orientation
15996     * @param obj The toolbar object
15997     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15998     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15999     * @ingroup Toolbar
16000     * @deprecated use elm_toolbar_horizontal_set() instead.
16001     */
16002    EINA_DEPRECATED EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
16003
16004    /**
16005     * Change a toolbar's orientation
16006     * @param obj The toolbar object
16007     * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
16008     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
16009     * @ingroup Toolbar
16010     */
16011    EAPI void             elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16012
16013    /**
16014     * Get a toolbar's orientation
16015     * @param obj The toolbar object
16016     * @return If @c EINA_TRUE, the toolbar is vertical
16017     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
16018     * @ingroup Toolbar
16019     * @deprecated use elm_toolbar_horizontal_get() instead.
16020     */
16021    EINA_DEPRECATED EAPI Eina_Bool        elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16022
16023    /**
16024     * Get a toolbar's orientation
16025     * @param obj The toolbar object
16026     * @return If @c EINA_TRUE, the toolbar is horizontal
16027     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
16028     * @ingroup Toolbar
16029     */
16030    EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
16031    /**
16032     * @}
16033     */
16034
16035    /**
16036     * @defgroup Tooltips Tooltips
16037     *
16038     * The Tooltip is an (internal, for now) smart object used to show a
16039     * content in a frame on mouse hover of objects(or widgets), with
16040     * tips/information about them.
16041     *
16042     * @{
16043     */
16044
16045    EAPI double       elm_tooltip_delay_get(void);
16046    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
16047    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
16048    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
16049    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
16050    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
16051 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
16052    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);
16053    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16054    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
16055    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16056    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
16057    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16058
16059    /**
16060     * @}
16061     */
16062
16063    /**
16064     * @defgroup Cursors Cursors
16065     *
16066     * The Elementary cursor is an internal smart object used to
16067     * customize the mouse cursor displayed over objects (or
16068     * widgets). In the most common scenario, the cursor decoration
16069     * comes from the graphical @b engine Elementary is running
16070     * on. Those engines may provide different decorations for cursors,
16071     * and Elementary provides functions to choose them (think of X11
16072     * cursors, as an example).
16073     *
16074     * There's also the possibility of, besides using engine provided
16075     * cursors, also use ones coming from Edje theming files. Both
16076     * globally and per widget, Elementary makes it possible for one to
16077     * make the cursors lookup to be held on engines only or on
16078     * Elementary's theme file, too. To set cursor's hot spot,
16079     * two data items should be added to cursor's theme: "hot_x" and
16080     * "hot_y", that are the offset from upper-left corner of the cursor
16081     * (coordinates 0,0).
16082     *
16083     * @{
16084     */
16085
16086    /**
16087     * Set the cursor to be shown when mouse is over the object
16088     *
16089     * Set the cursor that will be displayed when mouse is over the
16090     * object. The object can have only one cursor set to it, so if
16091     * this function is called twice for an object, the previous set
16092     * will be unset.
16093     * If using X cursors, a definition of all the valid cursor names
16094     * is listed on Elementary_Cursors.h. If an invalid name is set
16095     * the default cursor will be used.
16096     *
16097     * @param obj the object being set a cursor.
16098     * @param cursor the cursor name to be used.
16099     *
16100     * @ingroup Cursors
16101     */
16102    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
16103
16104    /**
16105     * Get the cursor to be shown when mouse is over the object
16106     *
16107     * @param obj an object with cursor already set.
16108     * @return the cursor name.
16109     *
16110     * @ingroup Cursors
16111     */
16112    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16113
16114    /**
16115     * Unset cursor for object
16116     *
16117     * Unset cursor for object, and set the cursor to default if the mouse
16118     * was over this object.
16119     *
16120     * @param obj Target object
16121     * @see elm_object_cursor_set()
16122     *
16123     * @ingroup Cursors
16124     */
16125    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16126
16127    /**
16128     * Sets a different style for this object cursor.
16129     *
16130     * @note before you set a style you should define a cursor with
16131     *       elm_object_cursor_set()
16132     *
16133     * @param obj an object with cursor already set.
16134     * @param style the theme style to use (default, transparent, ...)
16135     *
16136     * @ingroup Cursors
16137     */
16138    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
16139
16140    /**
16141     * Get the style for this object cursor.
16142     *
16143     * @param obj an object with cursor already set.
16144     * @return style the theme style in use, defaults to "default". If the
16145     *         object does not have a cursor set, then NULL is returned.
16146     *
16147     * @ingroup Cursors
16148     */
16149    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16150
16151    /**
16152     * Set if the cursor set should be searched on the theme or should use
16153     * the provided by the engine, only.
16154     *
16155     * @note before you set if should look on theme you should define a cursor
16156     * with elm_object_cursor_set(). By default it will only look for cursors
16157     * provided by the engine.
16158     *
16159     * @param obj an object with cursor already set.
16160     * @param engine_only boolean to define it cursors should be looked only
16161     * between the provided by the engine or searched on widget's theme as well.
16162     *
16163     * @ingroup Cursors
16164     */
16165    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16166
16167    /**
16168     * Get the cursor engine only usage for this object cursor.
16169     *
16170     * @param obj an object with cursor already set.
16171     * @return engine_only boolean to define it cursors should be
16172     * looked only between the provided by the engine or searched on
16173     * widget's theme as well. If the object does not have a cursor
16174     * set, then EINA_FALSE is returned.
16175     *
16176     * @ingroup Cursors
16177     */
16178    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16179
16180    /**
16181     * Get the configured cursor engine only usage
16182     *
16183     * This gets the globally configured exclusive usage of engine cursors.
16184     *
16185     * @return 1 if only engine cursors should be used
16186     * @ingroup Cursors
16187     */
16188    EAPI int          elm_cursor_engine_only_get(void);
16189
16190    /**
16191     * Set the configured cursor engine only usage
16192     *
16193     * This sets the globally configured exclusive usage of engine cursors.
16194     * It won't affect cursors set before changing this value.
16195     *
16196     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
16197     * look for them on theme before.
16198     * @return EINA_TRUE if value is valid and setted (0 or 1)
16199     * @ingroup Cursors
16200     */
16201    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
16202
16203    /**
16204     * @}
16205     */
16206
16207    /**
16208     * @defgroup Menu Menu
16209     *
16210     * @image html img/widget/menu/preview-00.png
16211     * @image latex img/widget/menu/preview-00.eps
16212     *
16213     * A menu is a list of items displayed above its parent. When the menu is
16214     * showing its parent is darkened. Each item can have a sub-menu. The menu
16215     * object can be used to display a menu on a right click event, in a toolbar,
16216     * anywhere.
16217     *
16218     * Signals that you can add callbacks for are:
16219     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
16220     *
16221     * Default contents parts of the menu items that you can use for are:
16222     * @li "default" - A main content of the menu item
16223     *
16224     * Default text parts of the menu items that you can use for are:
16225     * @li "default" - label in the menu item
16226     *
16227     * @see @ref tutorial_menu
16228     * @{
16229     */
16230
16231    /**
16232     * @brief Add a new menu to the parent
16233     *
16234     * @param parent The parent object.
16235     * @return The new object or NULL if it cannot be created.
16236     */
16237    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16238    /**
16239     * @brief Set the parent for the given menu widget
16240     *
16241     * @param obj The menu object.
16242     * @param parent The new parent.
16243     */
16244    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16245    /**
16246     * @brief Get the parent for the given menu widget
16247     *
16248     * @param obj The menu object.
16249     * @return The parent.
16250     *
16251     * @see elm_menu_parent_set()
16252     */
16253    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16254    /**
16255     * @brief Move the menu to a new position
16256     *
16257     * @param obj The menu object.
16258     * @param x The new position.
16259     * @param y The new position.
16260     *
16261     * Sets the top-left position of the menu to (@p x,@p y).
16262     *
16263     * @note @p x and @p y coordinates are relative to parent.
16264     */
16265    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
16266    /**
16267     * @brief Close a opened menu
16268     *
16269     * @param obj the menu object
16270     * @return void
16271     *
16272     * Hides the menu and all it's sub-menus.
16273     */
16274    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
16275    /**
16276     * @brief Returns a list of @p item's items.
16277     *
16278     * @param obj The menu object
16279     * @return An Eina_List* of @p item's items
16280     */
16281    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16282    /**
16283     * @brief Get the Evas_Object of an Elm_Object_Item
16284     *
16285     * @param it The menu item object.
16286     * @return The edje object containing the swallowed content
16287     *
16288     * @warning Don't manipulate this object!
16289     *
16290     */
16291    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16292    /**
16293     * @brief Add an item at the end of the given menu widget
16294     *
16295     * @param obj The menu object.
16296     * @param parent The parent menu item (optional)
16297     * @param icon An icon display on the item. The icon will be destryed by the menu.
16298     * @param label The label of the item.
16299     * @param func Function called when the user select the item.
16300     * @param data Data sent by the callback.
16301     * @return Returns the new item.
16302     */
16303    EAPI Elm_Object_Item     *elm_menu_item_add(Evas_Object *obj, Elm_Object_Item *parent, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
16304    /**
16305     * @brief Add an object swallowed in an item at the end of the given menu
16306     * widget
16307     *
16308     * @param obj The menu object.
16309     * @param parent The parent menu item (optional)
16310     * @param subobj The object to swallow
16311     * @param func Function called when the user select the item.
16312     * @param data Data sent by the callback.
16313     * @return Returns the new item.
16314     *
16315     * Add an evas object as an item to the menu.
16316     */
16317    EAPI Elm_Object_Item     *elm_menu_item_add_object(Evas_Object *obj, Elm_Object_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
16318    /**
16319     * @brief Set the label of a menu item
16320     *
16321     * @param it The menu item object.
16322     * @param label The label to set for @p item
16323     *
16324     * @warning Don't use this funcion on items created with
16325     * elm_menu_item_add_object() or elm_menu_item_separator_add().
16326     *
16327     * @deprecated Use elm_object_item_text_set() instead
16328     */
16329    EINA_DEPRECATED EAPI void               elm_menu_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
16330    /**
16331     * @brief Get the label of a menu item
16332     *
16333     * @param it The menu item object.
16334     * @return The label of @p item
16335          * @deprecated Use elm_object_item_text_get() instead
16336     */
16337    EINA_DEPRECATED EAPI const char        *elm_menu_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16338    /**
16339     * @brief Set the icon of a menu item to the standard icon with name @p icon
16340     *
16341     * @param it The menu item object.
16342     * @param icon The icon object to set for the content of @p item
16343     *
16344     * Once this icon is set, any previously set icon will be deleted.
16345     */
16346    EAPI void               elm_menu_item_object_icon_name_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1, 2);
16347    /**
16348     * @brief Get the string representation from the icon of a menu item
16349     *
16350     * @param it The menu item object.
16351     * @return The string representation of @p item's icon or NULL
16352     *
16353     * @see elm_menu_item_object_icon_name_set()
16354     */
16355    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16356    /**
16357     * @brief Set the content object of a menu item
16358     *
16359     * @param it The menu item object
16360     * @param The content object or NULL
16361     * @return EINA_TRUE on success, else EINA_FALSE
16362     *
16363     * Use this function to change the object swallowed by a menu item, deleting
16364     * any previously swallowed object.
16365     *
16366     * @deprecated Use elm_object_item_content_set() instead
16367     */
16368    EINA_DEPRECATED EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Object_Item *it, Evas_Object *obj) EINA_ARG_NONNULL(1);
16369    /**
16370     * @brief Get the content object of a menu item
16371     *
16372     * @param it The menu item object
16373     * @return The content object or NULL
16374     * @note If @p item was added with elm_menu_item_add_object, this
16375     * function will return the object passed, else it will return the
16376     * icon object.
16377     *
16378     * @see elm_menu_item_object_content_set()
16379     *
16380     * @deprecated Use elm_object_item_content_get() instead
16381     */
16382    EINA_DEPRECATED EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16383    /**
16384     * @brief Set the selected state of @p item.
16385     *
16386     * @param it The menu item object.
16387     * @param selected The selected/unselected state of the item
16388     */
16389    EAPI void               elm_menu_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
16390    /**
16391     * @brief Get the selected state of @p item.
16392     *
16393     * @param it The menu item object.
16394     * @return The selected/unselected state of the item
16395     *
16396     * @see elm_menu_item_selected_set()
16397     */
16398    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16399    /**
16400     * @brief Set the disabled state of @p item.
16401     *
16402     * @param it The menu item object.
16403     * @param disabled The enabled/disabled state of the item
16404     * @deprecated Use elm_object_item_disabled_set() instead
16405     */
16406    EINA_DEPRECATED EAPI void               elm_menu_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16407    /**
16408     * @brief Get the disabled state of @p item.
16409     *
16410     * @param it The menu item object.
16411     * @return The enabled/disabled state of the item
16412     *
16413     * @see elm_menu_item_disabled_set()
16414     * @deprecated Use elm_object_item_disabled_get() instead
16415     */
16416    EINA_DEPRECATED EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16417    /**
16418     * @brief Add a separator item to menu @p obj under @p parent.
16419     *
16420     * @param obj The menu object
16421     * @param parent The item to add the separator under
16422     * @return The created item or NULL on failure
16423     *
16424     * This is item is a @ref Separator.
16425     */
16426    EAPI Elm_Object_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Object_Item *parent) EINA_ARG_NONNULL(1);
16427    /**
16428     * @brief Returns whether @p item is a separator.
16429     *
16430     * @param it The item to check
16431     * @return If true, @p item is a separator
16432     *
16433     * @see elm_menu_item_separator_add()
16434     */
16435    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16436    /**
16437     * @brief Deletes an item from the menu.
16438     *
16439     * @param it The item to delete.
16440     *
16441     * @see elm_menu_item_add()
16442     */
16443    EAPI void               elm_menu_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16444    /**
16445     * @brief Set the function called when a menu item is deleted.
16446     *
16447     * @param it The item to set the callback on
16448     * @param func The function called
16449     *
16450     * @see elm_menu_item_add()
16451     * @see elm_menu_item_del()
16452     */
16453    EAPI void               elm_menu_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16454    /**
16455     * @brief Returns the data associated with menu item @p item.
16456     *
16457     * @param it The item
16458     * @return The data associated with @p item or NULL if none was set.
16459     *
16460     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16461          *
16462          * @deprecated Use elm_object_item_data_get() instead
16463     */
16464    EINA_DEPRECATED EAPI void              *elm_menu_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16465    /**
16466     * @brief Sets the data to be associated with menu item @p item.
16467     *
16468     * @param it The item
16469     * @param data The data to be associated with @p item
16470          *
16471          * @deprecated Use elm_object_item_data_set() instead
16472     */
16473    EINA_DEPRECATED EAPI void               elm_menu_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
16474
16475    /**
16476     * @brief Returns a list of @p item's subitems.
16477     *
16478     * @param it The item
16479     * @return An Eina_List* of @p item's subitems
16480     *
16481     * @see elm_menu_add()
16482     */
16483    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16484    /**
16485     * @brief Get the position of a menu item
16486     *
16487     * @param it The menu item
16488     * @return The item's index
16489     *
16490     * This function returns the index position of a menu item in a menu.
16491     * For a sub-menu, this number is relative to the first item in the sub-menu.
16492     *
16493     * @note Index values begin with 0
16494     */
16495    EAPI unsigned int       elm_menu_item_index_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
16496    /**
16497     * @brief @brief Return a menu item's owner menu
16498     *
16499     * @param it The menu item
16500     * @return The menu object owning @p item, or NULL on failure
16501     *
16502     * Use this function to get the menu object owning an item.
16503     */
16504    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
16505    /**
16506     * @brief Get the selected item in the menu
16507     *
16508     * @param obj The menu object
16509     * @return The selected item, or NULL if none
16510     *
16511     * @see elm_menu_item_selected_get()
16512     * @see elm_menu_item_selected_set()
16513     */
16514    EAPI Elm_Object_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16515    /**
16516     * @brief Get the last item in the menu
16517     *
16518     * @param obj The menu object
16519     * @return The last item, or NULL if none
16520     */
16521    EAPI Elm_Object_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16522    /**
16523     * @brief Get the first item in the menu
16524     *
16525     * @param obj The menu object
16526     * @return The first item, or NULL if none
16527     */
16528    EAPI Elm_Object_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16529    /**
16530     * @brief Get the next item in the menu.
16531     *
16532     * @param it The menu item object.
16533     * @return The item after it, or NULL if none
16534     */
16535    EAPI Elm_Object_Item *elm_menu_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16536    /**
16537     * @brief Get the previous item in the menu.
16538     *
16539     * @param it The menu item object.
16540     * @return The item before it, or NULL if none
16541     */
16542    EAPI Elm_Object_Item *elm_menu_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16543    /**
16544     * @}
16545     */
16546
16547    /**
16548     * @defgroup List List
16549     * @ingroup Elementary
16550     *
16551     * @image html img/widget/list/preview-00.png
16552     * @image latex img/widget/list/preview-00.eps width=\textwidth
16553     *
16554     * @image html img/list.png
16555     * @image latex img/list.eps width=\textwidth
16556     *
16557     * A list widget is a container whose children are displayed vertically or
16558     * horizontally, in order, and can be selected.
16559     * The list can accept only one or multiple items selection. Also has many
16560     * modes of items displaying.
16561     *
16562     * A list is a very simple type of list widget.  For more robust
16563     * lists, @ref Genlist should probably be used.
16564     *
16565     * Smart callbacks one can listen to:
16566     * - @c "activated" - The user has double-clicked or pressed
16567     *   (enter|return|spacebar) on an item. The @c event_info parameter
16568     *   is the item that was activated.
16569     * - @c "clicked,double" - The user has double-clicked an item.
16570     *   The @c event_info parameter is the item that was double-clicked.
16571     * - "selected" - when the user selected an item
16572     * - "unselected" - when the user unselected an item
16573     * - "longpressed" - an item in the list is long-pressed
16574     * - "edge,top" - the list is scrolled until the top edge
16575     * - "edge,bottom" - the list is scrolled until the bottom edge
16576     * - "edge,left" - the list is scrolled until the left edge
16577     * - "edge,right" - the list is scrolled until the right edge
16578     * - "language,changed" - the program's language changed
16579     *
16580     * Available styles for it:
16581     * - @c "default"
16582     *
16583     * List of examples:
16584     * @li @ref list_example_01
16585     * @li @ref list_example_02
16586     * @li @ref list_example_03
16587     */
16588
16589    /**
16590     * @addtogroup List
16591     * @{
16592     */
16593
16594    /**
16595     * @enum _Elm_List_Mode
16596     * @typedef Elm_List_Mode
16597     *
16598     * Set list's resize behavior, transverse axis scroll and
16599     * items cropping. See each mode's description for more details.
16600     *
16601     * @note Default value is #ELM_LIST_SCROLL.
16602     *
16603     * Values <b> don't </b> work as bitmask, only one can be choosen.
16604     *
16605     * @see elm_list_mode_set()
16606     * @see elm_list_mode_get()
16607     *
16608     * @ingroup List
16609     */
16610    typedef enum _Elm_List_Mode
16611      {
16612         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. */
16613         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). */
16614         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. */
16615         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. */
16616         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16617      } Elm_List_Mode;
16618
16619    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().  */
16620
16621    /**
16622     * Add a new list widget to the given parent Elementary
16623     * (container) object.
16624     *
16625     * @param parent The parent object.
16626     * @return a new list widget handle or @c NULL, on errors.
16627     *
16628     * This function inserts a new list widget on the canvas.
16629     *
16630     * @ingroup List
16631     */
16632    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16633
16634    /**
16635     * Starts the list.
16636     *
16637     * @param obj The list object
16638     *
16639     * @note Call before running show() on the list object.
16640     * @warning If not called, it won't display the list properly.
16641     *
16642     * @code
16643     * li = elm_list_add(win);
16644     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16645     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16646     * elm_list_go(li);
16647     * evas_object_show(li);
16648     * @endcode
16649     *
16650     * @ingroup List
16651     */
16652    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16653
16654    /**
16655     * Enable or disable multiple items selection on the list object.
16656     *
16657     * @param obj The list object
16658     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16659     * disable it.
16660     *
16661     * Disabled by default. If disabled, the user can select a single item of
16662     * the list each time. Selected items are highlighted on list.
16663     * If enabled, many items can be selected.
16664     *
16665     * If a selected item is selected again, it will be unselected.
16666     *
16667     * @see elm_list_multi_select_get()
16668     *
16669     * @ingroup List
16670     */
16671    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16672
16673    /**
16674     * Get a value whether multiple items selection is enabled or not.
16675     *
16676     * @see elm_list_multi_select_set() for details.
16677     *
16678     * @param obj The list object.
16679     * @return @c EINA_TRUE means multiple items selection is enabled.
16680     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16681     * @c EINA_FALSE is returned.
16682     *
16683     * @ingroup List
16684     */
16685    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16686
16687    /**
16688     * Set which mode to use for the list object.
16689     *
16690     * @param obj The list object
16691     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16692     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16693     *
16694     * Set list's resize behavior, transverse axis scroll and
16695     * items cropping. See each mode's description for more details.
16696     *
16697     * @note Default value is #ELM_LIST_SCROLL.
16698     *
16699     * Only one can be set, if a previous one was set, it will be changed
16700     * by the new mode set. Bitmask won't work as well.
16701     *
16702     * @see elm_list_mode_get()
16703     *
16704     * @ingroup List
16705     */
16706    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16707
16708    /**
16709     * Get the mode the list is at.
16710     *
16711     * @param obj The list object
16712     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16713     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16714     *
16715     * @note see elm_list_mode_set() for more information.
16716     *
16717     * @ingroup List
16718     */
16719    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16720
16721    /**
16722     * Enable or disable horizontal mode on the list object.
16723     *
16724     * @param obj The list object.
16725     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16726     * disable it, i.e., to enable vertical mode.
16727     *
16728     * @note Vertical mode is set by default.
16729     *
16730     * On horizontal mode items are displayed on list from left to right,
16731     * instead of from top to bottom. Also, the list will scroll horizontally.
16732     * Each item will presents left icon on top and right icon, or end, at
16733     * the bottom.
16734     *
16735     * @see elm_list_horizontal_get()
16736     *
16737     * @ingroup List
16738     */
16739    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16740
16741    /**
16742     * Get a value whether horizontal mode is enabled or not.
16743     *
16744     * @param obj The list object.
16745     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16746     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16747     * @c EINA_FALSE is returned.
16748     *
16749     * @see elm_list_horizontal_set() for details.
16750     *
16751     * @ingroup List
16752     */
16753    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16754
16755    /**
16756     * Enable or disable always select mode on the list object.
16757     *
16758     * @param obj The list object
16759     * @param always_select @c EINA_TRUE to enable always select mode or
16760     * @c EINA_FALSE to disable it.
16761     *
16762     * @note Always select mode is disabled by default.
16763     *
16764     * Default behavior of list items is to only call its callback function
16765     * the first time it's pressed, i.e., when it is selected. If a selected
16766     * item is pressed again, and multi-select is disabled, it won't call
16767     * this function (if multi-select is enabled it will unselect the item).
16768     *
16769     * If always select is enabled, it will call the callback function
16770     * everytime a item is pressed, so it will call when the item is selected,
16771     * and again when a selected item is pressed.
16772     *
16773     * @see elm_list_always_select_mode_get()
16774     * @see elm_list_multi_select_set()
16775     *
16776     * @ingroup List
16777     */
16778    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16779
16780    /**
16781     * Get a value whether always select mode is enabled or not, meaning that
16782     * an item will always call its callback function, even if already selected.
16783     *
16784     * @param obj The list object
16785     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16786     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16787     * @c EINA_FALSE is returned.
16788     *
16789     * @see elm_list_always_select_mode_set() for details.
16790     *
16791     * @ingroup List
16792     */
16793    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16794
16795    /**
16796     * Set bouncing behaviour when the scrolled content reaches an edge.
16797     *
16798     * Tell the internal scroller object whether it should bounce or not
16799     * when it reaches the respective edges for each axis.
16800     *
16801     * @param obj The list object
16802     * @param h_bounce Whether to bounce or not in the horizontal axis.
16803     * @param v_bounce Whether to bounce or not in the vertical axis.
16804     *
16805     * @see elm_scroller_bounce_set()
16806     *
16807     * @ingroup List
16808     */
16809    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16810
16811    /**
16812     * Get the bouncing behaviour of the internal scroller.
16813     *
16814     * Get whether the internal scroller should bounce when the edge of each
16815     * axis is reached scrolling.
16816     *
16817     * @param obj The list object.
16818     * @param h_bounce Pointer where to store the bounce state of the horizontal
16819     * axis.
16820     * @param v_bounce Pointer where to store the bounce state of the vertical
16821     * axis.
16822     *
16823     * @see elm_scroller_bounce_get()
16824     * @see elm_list_bounce_set()
16825     *
16826     * @ingroup List
16827     */
16828    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16829
16830    /**
16831     * Set the scrollbar policy.
16832     *
16833     * @param obj The list object
16834     * @param policy_h Horizontal scrollbar policy.
16835     * @param policy_v Vertical scrollbar policy.
16836     *
16837     * This sets the scrollbar visibility policy for the given scroller.
16838     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16839     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16840     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16841     * This applies respectively for the horizontal and vertical scrollbars.
16842     *
16843     * The both are disabled by default, i.e., are set to
16844     * #ELM_SCROLLER_POLICY_OFF.
16845     *
16846     * @ingroup List
16847     */
16848    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16849
16850    /**
16851     * Get the scrollbar policy.
16852     *
16853     * @see elm_list_scroller_policy_get() for details.
16854     *
16855     * @param obj The list object.
16856     * @param policy_h Pointer where to store horizontal scrollbar policy.
16857     * @param policy_v Pointer where to store vertical scrollbar policy.
16858     *
16859     * @ingroup List
16860     */
16861    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);
16862
16863    /**
16864     * Append a new item to the list object.
16865     *
16866     * @param obj The list object.
16867     * @param label The label of the list item.
16868     * @param icon The icon object to use for the left side of the item. An
16869     * icon can be any Evas object, but usually it is an icon created
16870     * with elm_icon_add().
16871     * @param end The icon object to use for the right side of the item. An
16872     * icon can be any Evas object.
16873     * @param func The function to call when the item is clicked.
16874     * @param data The data to associate with the item for related callbacks.
16875     *
16876     * @return The created item or @c NULL upon failure.
16877     *
16878     * A new item will be created and appended to the list, i.e., will
16879     * be set as @b last item.
16880     *
16881     * Items created with this method can be deleted with
16882     * elm_list_item_del().
16883     *
16884     * Associated @p data can be properly freed when item is deleted if a
16885     * callback function is set with elm_list_item_del_cb_set().
16886     *
16887     * If a function is passed as argument, it will be called everytime this item
16888     * is selected, i.e., the user clicks over an unselected item.
16889     * If always select is enabled it will call this function every time
16890     * user clicks over an item (already selected or not).
16891     * If such function isn't needed, just passing
16892     * @c NULL as @p func is enough. The same should be done for @p data.
16893     *
16894     * Simple example (with no function callback or data associated):
16895     * @code
16896     * li = elm_list_add(win);
16897     * ic = elm_icon_add(win);
16898     * elm_icon_file_set(ic, "path/to/image", NULL);
16899     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16900     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16901     * elm_list_go(li);
16902     * evas_object_show(li);
16903     * @endcode
16904     *
16905     * @see elm_list_always_select_mode_set()
16906     * @see elm_list_item_del()
16907     * @see elm_list_item_del_cb_set()
16908     * @see elm_list_clear()
16909     * @see elm_icon_add()
16910     *
16911     * @ingroup List
16912     */
16913    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);
16914
16915    /**
16916     * Prepend a new item to the list object.
16917     *
16918     * @param obj The list object.
16919     * @param label The label of the list item.
16920     * @param icon The icon object to use for the left side of the item. An
16921     * icon can be any Evas object, but usually it is an icon created
16922     * with elm_icon_add().
16923     * @param end The icon object to use for the right side of the item. An
16924     * icon can be any Evas object.
16925     * @param func The function to call when the item is clicked.
16926     * @param data The data to associate with the item for related callbacks.
16927     *
16928     * @return The created item or @c NULL upon failure.
16929     *
16930     * A new item will be created and prepended to the list, i.e., will
16931     * be set as @b first item.
16932     *
16933     * Items created with this method can be deleted with
16934     * elm_list_item_del().
16935     *
16936     * Associated @p data can be properly freed when item is deleted if a
16937     * callback function is set with elm_list_item_del_cb_set().
16938     *
16939     * If a function is passed as argument, it will be called everytime this item
16940     * is selected, i.e., the user clicks over an unselected item.
16941     * If always select is enabled it will call this function every time
16942     * user clicks over an item (already selected or not).
16943     * If such function isn't needed, just passing
16944     * @c NULL as @p func is enough. The same should be done for @p data.
16945     *
16946     * @see elm_list_item_append() for a simple code example.
16947     * @see elm_list_always_select_mode_set()
16948     * @see elm_list_item_del()
16949     * @see elm_list_item_del_cb_set()
16950     * @see elm_list_clear()
16951     * @see elm_icon_add()
16952     *
16953     * @ingroup List
16954     */
16955    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);
16956
16957    /**
16958     * Insert a new item into the list object before item @p before.
16959     *
16960     * @param obj The list object.
16961     * @param before The list item to insert before.
16962     * @param label The label of the list item.
16963     * @param icon The icon object to use for the left side of the item. An
16964     * icon can be any Evas object, but usually it is an icon created
16965     * with elm_icon_add().
16966     * @param end The icon object to use for the right side of the item. An
16967     * icon can be any Evas object.
16968     * @param func The function to call when the item is clicked.
16969     * @param data The data to associate with the item for related callbacks.
16970     *
16971     * @return The created item or @c NULL upon failure.
16972     *
16973     * A new item will be created and added to the list. Its position in
16974     * this list will be just before item @p before.
16975     *
16976     * Items created with this method can be deleted with
16977     * elm_list_item_del().
16978     *
16979     * Associated @p data can be properly freed when item is deleted if a
16980     * callback function is set with elm_list_item_del_cb_set().
16981     *
16982     * If a function is passed as argument, it will be called everytime this item
16983     * is selected, i.e., the user clicks over an unselected item.
16984     * If always select is enabled it will call this function every time
16985     * user clicks over an item (already selected or not).
16986     * If such function isn't needed, just passing
16987     * @c NULL as @p func is enough. The same should be done for @p data.
16988     *
16989     * @see elm_list_item_append() for a simple code example.
16990     * @see elm_list_always_select_mode_set()
16991     * @see elm_list_item_del()
16992     * @see elm_list_item_del_cb_set()
16993     * @see elm_list_clear()
16994     * @see elm_icon_add()
16995     *
16996     * @ingroup List
16997     */
16998    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);
16999
17000    /**
17001     * Insert a new item into the list object after item @p after.
17002     *
17003     * @param obj The list object.
17004     * @param after The list item to insert after.
17005     * @param label The label of the list item.
17006     * @param icon The icon object to use for the left side of the item. An
17007     * icon can be any Evas object, but usually it is an icon created
17008     * with elm_icon_add().
17009     * @param end The icon object to use for the right side of the item. An
17010     * icon can be any Evas object.
17011     * @param func The function to call when the item is clicked.
17012     * @param data The data to associate with the item for related callbacks.
17013     *
17014     * @return The created item or @c NULL upon failure.
17015     *
17016     * A new item will be created and added to the list. Its position in
17017     * this list will be just after item @p after.
17018     *
17019     * Items created with this method can be deleted with
17020     * elm_list_item_del().
17021     *
17022     * Associated @p data can be properly freed when item is deleted if a
17023     * callback function is set with elm_list_item_del_cb_set().
17024     *
17025     * If a function is passed as argument, it will be called everytime this item
17026     * is selected, i.e., the user clicks over an unselected item.
17027     * If always select is enabled it will call this function every time
17028     * user clicks over an item (already selected or not).
17029     * If such function isn't needed, just passing
17030     * @c NULL as @p func is enough. The same should be done for @p data.
17031     *
17032     * @see elm_list_item_append() for a simple code example.
17033     * @see elm_list_always_select_mode_set()
17034     * @see elm_list_item_del()
17035     * @see elm_list_item_del_cb_set()
17036     * @see elm_list_clear()
17037     * @see elm_icon_add()
17038     *
17039     * @ingroup List
17040     */
17041    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);
17042
17043    /**
17044     * Insert a new item into the sorted list object.
17045     *
17046     * @param obj The list object.
17047     * @param label The label of the list item.
17048     * @param icon The icon object to use for the left side of the item. An
17049     * icon can be any Evas object, but usually it is an icon created
17050     * with elm_icon_add().
17051     * @param end The icon object to use for the right side of the item. An
17052     * icon can be any Evas object.
17053     * @param func The function to call when the item is clicked.
17054     * @param data The data to associate with the item for related callbacks.
17055     * @param cmp_func The comparing function to be used to sort list
17056     * items <b>by #Elm_List_Item item handles</b>. This function will
17057     * receive two items and compare them, returning a non-negative integer
17058     * if the second item should be place after the first, or negative value
17059     * if should be placed before.
17060     *
17061     * @return The created item or @c NULL upon failure.
17062     *
17063     * @note This function inserts values into a list object assuming it was
17064     * sorted and the result will be sorted.
17065     *
17066     * A new item will be created and added to the list. Its position in
17067     * this list will be found comparing the new item with previously inserted
17068     * items using function @p cmp_func.
17069     *
17070     * Items created with this method can be deleted with
17071     * elm_list_item_del().
17072     *
17073     * Associated @p data can be properly freed when item is deleted if a
17074     * callback function is set with elm_list_item_del_cb_set().
17075     *
17076     * If a function is passed as argument, it will be called everytime this item
17077     * is selected, i.e., the user clicks over an unselected item.
17078     * If always select is enabled it will call this function every time
17079     * user clicks over an item (already selected or not).
17080     * If such function isn't needed, just passing
17081     * @c NULL as @p func is enough. The same should be done for @p data.
17082     *
17083     * @see elm_list_item_append() for a simple code example.
17084     * @see elm_list_always_select_mode_set()
17085     * @see elm_list_item_del()
17086     * @see elm_list_item_del_cb_set()
17087     * @see elm_list_clear()
17088     * @see elm_icon_add()
17089     *
17090     * @ingroup List
17091     */
17092    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);
17093
17094    /**
17095     * Remove all list's items.
17096     *
17097     * @param obj The list object
17098     *
17099     * @see elm_list_item_del()
17100     * @see elm_list_item_append()
17101     *
17102     * @ingroup List
17103     */
17104    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17105
17106    /**
17107     * Get a list of all the list items.
17108     *
17109     * @param obj The list object
17110     * @return An @c Eina_List of list items, #Elm_List_Item,
17111     * or @c NULL on failure.
17112     *
17113     * @see elm_list_item_append()
17114     * @see elm_list_item_del()
17115     * @see elm_list_clear()
17116     *
17117     * @ingroup List
17118     */
17119    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17120
17121    /**
17122     * Get the selected item.
17123     *
17124     * @param obj The list object.
17125     * @return The selected list item.
17126     *
17127     * The selected item can be unselected with function
17128     * elm_list_item_selected_set().
17129     *
17130     * The selected item always will be highlighted on list.
17131     *
17132     * @see elm_list_selected_items_get()
17133     *
17134     * @ingroup List
17135     */
17136    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17137
17138    /**
17139     * Return a list of the currently selected list items.
17140     *
17141     * @param obj The list object.
17142     * @return An @c Eina_List of list items, #Elm_List_Item,
17143     * or @c NULL on failure.
17144     *
17145     * Multiple items can be selected if multi select is enabled. It can be
17146     * done with elm_list_multi_select_set().
17147     *
17148     * @see elm_list_selected_item_get()
17149     * @see elm_list_multi_select_set()
17150     *
17151     * @ingroup List
17152     */
17153    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17154
17155    /**
17156     * Set the selected state of an item.
17157     *
17158     * @param item The list item
17159     * @param selected The selected state
17160     *
17161     * This sets the selected state of the given item @p it.
17162     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
17163     *
17164     * If a new item is selected the previosly selected will be unselected,
17165     * unless multiple selection is enabled with elm_list_multi_select_set().
17166     * Previoulsy selected item can be get with function
17167     * elm_list_selected_item_get().
17168     *
17169     * Selected items will be highlighted.
17170     *
17171     * @see elm_list_item_selected_get()
17172     * @see elm_list_selected_item_get()
17173     * @see elm_list_multi_select_set()
17174     *
17175     * @ingroup List
17176     */
17177    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17178
17179    /*
17180     * Get whether the @p item is selected or not.
17181     *
17182     * @param item The list item.
17183     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
17184     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
17185     *
17186     * @see elm_list_selected_item_set() for details.
17187     * @see elm_list_item_selected_get()
17188     *
17189     * @ingroup List
17190     */
17191    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17192
17193    /**
17194     * Set or unset item as a separator.
17195     *
17196     * @param it The list item.
17197     * @param setting @c EINA_TRUE to set item @p it as separator or
17198     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
17199     *
17200     * Items aren't set as separator by default.
17201     *
17202     * If set as separator it will display separator theme, so won't display
17203     * icons or label.
17204     *
17205     * @see elm_list_item_separator_get()
17206     *
17207     * @ingroup List
17208     */
17209    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
17210
17211    /**
17212     * Get a value whether item is a separator or not.
17213     *
17214     * @see elm_list_item_separator_set() for details.
17215     *
17216     * @param it The list item.
17217     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
17218     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
17219     *
17220     * @ingroup List
17221     */
17222    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17223
17224    /**
17225     * Show @p item in the list view.
17226     *
17227     * @param item The list item to be shown.
17228     *
17229     * It won't animate list until item is visible. If such behavior is wanted,
17230     * use elm_list_bring_in() intead.
17231     *
17232     * @ingroup List
17233     */
17234    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17235
17236    /**
17237     * Bring in the given item to list view.
17238     *
17239     * @param item The item.
17240     *
17241     * This causes list to jump to the given item @p item and show it
17242     * (by scrolling), if it is not fully visible.
17243     *
17244     * This may use animation to do so and take a period of time.
17245     *
17246     * If animation isn't wanted, elm_list_item_show() can be used.
17247     *
17248     * @ingroup List
17249     */
17250    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17251
17252    /**
17253     * Delete them item from the list.
17254     *
17255     * @param item The item of list to be deleted.
17256     *
17257     * If deleting all list items is required, elm_list_clear()
17258     * should be used instead of getting items list and deleting each one.
17259     *
17260     * @see elm_list_clear()
17261     * @see elm_list_item_append()
17262     * @see elm_list_item_del_cb_set()
17263     *
17264     * @ingroup List
17265     */
17266    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17267
17268    /**
17269     * Set the function called when a list item is freed.
17270     *
17271     * @param item The item to set the callback on
17272     * @param func The function called
17273     *
17274     * If there is a @p func, then it will be called prior item's memory release.
17275     * That will be called with the following arguments:
17276     * @li item's data;
17277     * @li item's Evas object;
17278     * @li item itself;
17279     *
17280     * This way, a data associated to a list item could be properly freed.
17281     *
17282     * @ingroup List
17283     */
17284    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17285
17286    /**
17287     * Get the data associated to the item.
17288     *
17289     * @param item The list item
17290     * @return The data associated to @p item
17291     *
17292     * The return value is a pointer to data associated to @p item when it was
17293     * created, with function elm_list_item_append() or similar. If no data
17294     * was passed as argument, it will return @c NULL.
17295     *
17296     * @see elm_list_item_append()
17297     *
17298     * @ingroup List
17299     */
17300    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17301
17302    /**
17303     * Get the left side icon associated to the item.
17304     *
17305     * @param item The list item
17306     * @return The left side icon associated to @p item
17307     *
17308     * The return value is a pointer to the icon associated to @p item when
17309     * it was
17310     * created, with function elm_list_item_append() or similar, or later
17311     * with function elm_list_item_icon_set(). If no icon
17312     * was passed as argument, it will return @c NULL.
17313     *
17314     * @see elm_list_item_append()
17315     * @see elm_list_item_icon_set()
17316     *
17317     * @ingroup List
17318     */
17319    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17320
17321    /**
17322     * Set the left side icon associated to the item.
17323     *
17324     * @param item The list item
17325     * @param icon The left side icon object to associate with @p item
17326     *
17327     * The icon object to use at left side of the item. An
17328     * icon can be any Evas object, but usually it is an icon created
17329     * with elm_icon_add().
17330     *
17331     * Once the icon object is set, a previously set one will be deleted.
17332     * @warning Setting the same icon for two items will cause the icon to
17333     * dissapear from the first item.
17334     *
17335     * If an icon was passed as argument on item creation, with function
17336     * elm_list_item_append() or similar, it will be already
17337     * associated to the item.
17338     *
17339     * @see elm_list_item_append()
17340     * @see elm_list_item_icon_get()
17341     *
17342     * @ingroup List
17343     */
17344    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17345
17346    /**
17347     * Get the right side icon associated to the item.
17348     *
17349     * @param item The list item
17350     * @return The right side icon associated to @p item
17351     *
17352     * The return value is a pointer to the icon associated to @p item when
17353     * it was
17354     * created, with function elm_list_item_append() or similar, or later
17355     * with function elm_list_item_icon_set(). If no icon
17356     * was passed as argument, it will return @c NULL.
17357     *
17358     * @see elm_list_item_append()
17359     * @see elm_list_item_icon_set()
17360     *
17361     * @ingroup List
17362     */
17363    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17364
17365    /**
17366     * Set the right side icon associated to the item.
17367     *
17368     * @param item The list item
17369     * @param end The right side icon object to associate with @p item
17370     *
17371     * The icon object to use at right side of the item. An
17372     * icon can be any Evas object, but usually it is an icon created
17373     * with elm_icon_add().
17374     *
17375     * Once the icon object is set, a previously set one will be deleted.
17376     * @warning Setting the same icon for two items will cause the icon to
17377     * dissapear from the first item.
17378     *
17379     * If an icon was passed as argument on item creation, with function
17380     * elm_list_item_append() or similar, it will be already
17381     * associated to the item.
17382     *
17383     * @see elm_list_item_append()
17384     * @see elm_list_item_end_get()
17385     *
17386     * @ingroup List
17387     */
17388    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17389
17390    /**
17391     * Gets the base object of the item.
17392     *
17393     * @param item The list item
17394     * @return The base object associated with @p item
17395     *
17396     * Base object is the @c Evas_Object that represents that item.
17397     *
17398     * @ingroup List
17399     */
17400    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17401    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17402
17403    /**
17404     * Get the label of item.
17405     *
17406     * @param item The item of list.
17407     * @return The label of item.
17408     *
17409     * The return value is a pointer to the label associated to @p item when
17410     * it was created, with function elm_list_item_append(), or later
17411     * with function elm_list_item_label_set. If no label
17412     * was passed as argument, it will return @c NULL.
17413     *
17414     * @see elm_list_item_label_set() for more details.
17415     * @see elm_list_item_append()
17416     *
17417     * @ingroup List
17418     */
17419    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17420
17421    /**
17422     * Set the label of item.
17423     *
17424     * @param item The item of list.
17425     * @param text The label of item.
17426     *
17427     * The label to be displayed by the item.
17428     * Label will be placed between left and right side icons (if set).
17429     *
17430     * If a label was passed as argument on item creation, with function
17431     * elm_list_item_append() or similar, it will be already
17432     * displayed by the item.
17433     *
17434     * @see elm_list_item_label_get()
17435     * @see elm_list_item_append()
17436     *
17437     * @ingroup List
17438     */
17439    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17440
17441
17442    /**
17443     * Get the item before @p it in list.
17444     *
17445     * @param it The list item.
17446     * @return The item before @p it, or @c NULL if none or on failure.
17447     *
17448     * @note If it is the first item, @c NULL will be returned.
17449     *
17450     * @see elm_list_item_append()
17451     * @see elm_list_items_get()
17452     *
17453     * @ingroup List
17454     */
17455    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17456
17457    /**
17458     * Get the item after @p it in list.
17459     *
17460     * @param it The list item.
17461     * @return The item after @p it, or @c NULL if none or on failure.
17462     *
17463     * @note If it is the last item, @c NULL will be returned.
17464     *
17465     * @see elm_list_item_append()
17466     * @see elm_list_items_get()
17467     *
17468     * @ingroup List
17469     */
17470    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17471
17472    /**
17473     * Sets the disabled/enabled state of a list item.
17474     *
17475     * @param it The item.
17476     * @param disabled The disabled state.
17477     *
17478     * A disabled item cannot be selected or unselected. It will also
17479     * change its appearance (generally greyed out). This sets the
17480     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17481     * enabled).
17482     *
17483     * @ingroup List
17484     */
17485    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17486
17487    /**
17488     * Get a value whether list item is disabled or not.
17489     *
17490     * @param it The item.
17491     * @return The disabled state.
17492     *
17493     * @see elm_list_item_disabled_set() for more details.
17494     *
17495     * @ingroup List
17496     */
17497    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17498
17499    /**
17500     * Set the text to be shown in a given list item's tooltips.
17501     *
17502     * @param item Target item.
17503     * @param text The text to set in the content.
17504     *
17505     * Setup the text as tooltip to object. The item can have only one tooltip,
17506     * so any previous tooltip data - set with this function or
17507     * elm_list_item_tooltip_content_cb_set() - is removed.
17508     *
17509     * @see elm_object_tooltip_text_set() for more details.
17510     *
17511     * @ingroup List
17512     */
17513    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17514
17515
17516    /**
17517     * @brief Disable size restrictions on an object's tooltip
17518     * @param item The tooltip's anchor object
17519     * @param disable If EINA_TRUE, size restrictions are disabled
17520     * @return EINA_FALSE on failure, EINA_TRUE on success
17521     *
17522     * This function allows a tooltip to expand beyond its parant window's canvas.
17523     * It will instead be limited only by the size of the display.
17524     */
17525    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17526    /**
17527     * @brief Retrieve size restriction state of an object's tooltip
17528     * @param obj The tooltip's anchor object
17529     * @return If EINA_TRUE, size restrictions are disabled
17530     *
17531     * This function returns whether a tooltip is allowed to expand beyond
17532     * its parant window's canvas.
17533     * It will instead be limited only by the size of the display.
17534     */
17535    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17536
17537    /**
17538     * Set the content to be shown in the tooltip item.
17539     *
17540     * Setup the tooltip to item. The item can have only one tooltip,
17541     * so any previous tooltip data is removed. @p func(with @p data) will
17542     * be called every time that need show the tooltip and it should
17543     * return a valid Evas_Object. This object is then managed fully by
17544     * tooltip system and is deleted when the tooltip is gone.
17545     *
17546     * @param item the list item being attached a tooltip.
17547     * @param func the function used to create the tooltip contents.
17548     * @param data what to provide to @a func as callback data/context.
17549     * @param del_cb called when data is not needed anymore, either when
17550     *        another callback replaces @a func, the tooltip is unset with
17551     *        elm_list_item_tooltip_unset() or the owner @a item
17552     *        dies. This callback receives as the first parameter the
17553     *        given @a data, and @c event_info is the item.
17554     *
17555     * @see elm_object_tooltip_content_cb_set() for more details.
17556     *
17557     * @ingroup List
17558     */
17559    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);
17560
17561    /**
17562     * Unset tooltip from item.
17563     *
17564     * @param item list item to remove previously set tooltip.
17565     *
17566     * Remove tooltip from item. The callback provided as del_cb to
17567     * elm_list_item_tooltip_content_cb_set() will be called to notify
17568     * it is not used anymore.
17569     *
17570     * @see elm_object_tooltip_unset() for more details.
17571     * @see elm_list_item_tooltip_content_cb_set()
17572     *
17573     * @ingroup List
17574     */
17575    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17576
17577    /**
17578     * Sets a different style for this item tooltip.
17579     *
17580     * @note before you set a style you should define a tooltip with
17581     *       elm_list_item_tooltip_content_cb_set() or
17582     *       elm_list_item_tooltip_text_set()
17583     *
17584     * @param item list item with tooltip already set.
17585     * @param style the theme style to use (default, transparent, ...)
17586     *
17587     * @see elm_object_tooltip_style_set() for more details.
17588     *
17589     * @ingroup List
17590     */
17591    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17592
17593    /**
17594     * Get the style for this item tooltip.
17595     *
17596     * @param item list item with tooltip already set.
17597     * @return style the theme style in use, defaults to "default". If the
17598     *         object does not have a tooltip set, then NULL is returned.
17599     *
17600     * @see elm_object_tooltip_style_get() for more details.
17601     * @see elm_list_item_tooltip_style_set()
17602     *
17603     * @ingroup List
17604     */
17605    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17606
17607    /**
17608     * Set the type of mouse pointer/cursor decoration to be shown,
17609     * when the mouse pointer is over the given list widget item
17610     *
17611     * @param item list item to customize cursor on
17612     * @param cursor the cursor type's name
17613     *
17614     * This function works analogously as elm_object_cursor_set(), but
17615     * here the cursor's changing area is restricted to the item's
17616     * area, and not the whole widget's. Note that that item cursors
17617     * have precedence over widget cursors, so that a mouse over an
17618     * item with custom cursor set will always show @b that cursor.
17619     *
17620     * If this function is called twice for an object, a previously set
17621     * cursor will be unset on the second call.
17622     *
17623     * @see elm_object_cursor_set()
17624     * @see elm_list_item_cursor_get()
17625     * @see elm_list_item_cursor_unset()
17626     *
17627     * @ingroup List
17628     */
17629    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17630
17631    /*
17632     * Get the type of mouse pointer/cursor decoration set to be shown,
17633     * when the mouse pointer is over the given list widget item
17634     *
17635     * @param item list item with custom cursor set
17636     * @return the cursor type's name or @c NULL, if no custom cursors
17637     * were set to @p item (and on errors)
17638     *
17639     * @see elm_object_cursor_get()
17640     * @see elm_list_item_cursor_set()
17641     * @see elm_list_item_cursor_unset()
17642     *
17643     * @ingroup List
17644     */
17645    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17646
17647    /**
17648     * Unset any custom mouse pointer/cursor decoration set to be
17649     * shown, when the mouse pointer is over the given list widget
17650     * item, thus making it show the @b default cursor again.
17651     *
17652     * @param item a list item
17653     *
17654     * Use this call to undo any custom settings on this item's cursor
17655     * decoration, bringing it back to defaults (no custom style set).
17656     *
17657     * @see elm_object_cursor_unset()
17658     * @see elm_list_item_cursor_set()
17659     *
17660     * @ingroup List
17661     */
17662    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17663
17664    /**
17665     * Set a different @b style for a given custom cursor set for a
17666     * list item.
17667     *
17668     * @param item list item with custom cursor set
17669     * @param style the <b>theme style</b> to use (e.g. @c "default",
17670     * @c "transparent", etc)
17671     *
17672     * This function only makes sense when one is using custom mouse
17673     * cursor decorations <b>defined in a theme file</b>, which can have,
17674     * given a cursor name/type, <b>alternate styles</b> on it. It
17675     * works analogously as elm_object_cursor_style_set(), but here
17676     * applyed only to list item objects.
17677     *
17678     * @warning Before you set a cursor style you should have definen a
17679     *       custom cursor previously on the item, with
17680     *       elm_list_item_cursor_set()
17681     *
17682     * @see elm_list_item_cursor_engine_only_set()
17683     * @see elm_list_item_cursor_style_get()
17684     *
17685     * @ingroup List
17686     */
17687    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17688
17689    /**
17690     * Get the current @b style set for a given list item's custom
17691     * cursor
17692     *
17693     * @param item list item with custom cursor set.
17694     * @return style the cursor style in use. If the object does not
17695     *         have a cursor set, then @c NULL is returned.
17696     *
17697     * @see elm_list_item_cursor_style_set() for more details
17698     *
17699     * @ingroup List
17700     */
17701    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17702
17703    /**
17704     * Set if the (custom)cursor for a given list item should be
17705     * searched in its theme, also, or should only rely on the
17706     * rendering engine.
17707     *
17708     * @param item item with custom (custom) cursor already set on
17709     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17710     * only on those provided by the rendering engine, @c EINA_FALSE to
17711     * have them searched on the widget's theme, as well.
17712     *
17713     * @note This call is of use only if you've set a custom cursor
17714     * for list items, with elm_list_item_cursor_set().
17715     *
17716     * @note By default, cursors will only be looked for between those
17717     * provided by the rendering engine.
17718     *
17719     * @ingroup List
17720     */
17721    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17722
17723    /**
17724     * Get if the (custom) cursor for a given list item is being
17725     * searched in its theme, also, or is only relying on the rendering
17726     * engine.
17727     *
17728     * @param item a list item
17729     * @return @c EINA_TRUE, if cursors are being looked for only on
17730     * those provided by the rendering engine, @c EINA_FALSE if they
17731     * are being searched on the widget's theme, as well.
17732     *
17733     * @see elm_list_item_cursor_engine_only_set(), for more details
17734     *
17735     * @ingroup List
17736     */
17737    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17738
17739    /**
17740     * @}
17741     */
17742
17743    /**
17744     * @defgroup Slider Slider
17745     * @ingroup Elementary
17746     *
17747     * @image html img/widget/slider/preview-00.png
17748     * @image latex img/widget/slider/preview-00.eps width=\textwidth
17749     *
17750     * The slider adds a dragable ā€œsliderā€ widget for selecting the value of
17751     * something within a range.
17752     *
17753     * A slider can be horizontal or vertical. It can contain an Icon and has a
17754     * primary label as well as a units label (that is formatted with floating
17755     * point values and thus accepts a printf-style format string, like
17756     * ā€œ%1.2f unitsā€. There is also an indicator string that may be somewhere
17757     * else (like on the slider itself) that also accepts a format string like
17758     * units. Label, Icon Unit and Indicator strings/objects are optional.
17759     *
17760     * A slider may be inverted which means values invert, with high vales being
17761     * on the left or top and low values on the right or bottom (as opposed to
17762     * normally being low on the left or top and high on the bottom and right).
17763     *
17764     * The slider should have its minimum and maximum values set by the
17765     * application with  elm_slider_min_max_set() and value should also be set by
17766     * the application before use with  elm_slider_value_set(). The span of the
17767     * slider is its length (horizontally or vertically). This will be scaled by
17768     * the object or applications scaling factor. At any point code can query the
17769     * slider for its value with elm_slider_value_get().
17770     *
17771     * Smart callbacks one can listen to:
17772     * - "changed" - Whenever the slider value is changed by the user.
17773     * - "slider,drag,start" - dragging the slider indicator around has started.
17774     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17775     * - "delay,changed" - A short time after the value is changed by the user.
17776     * This will be called only when the user stops dragging for
17777     * a very short period or when they release their
17778     * finger/mouse, so it avoids possibly expensive reactions to
17779     * the value change.
17780     *
17781     * Available styles for it:
17782     * - @c "default"
17783     *
17784     * Default contents parts of the slider widget that you can use for are:
17785     * @li "icon" - An icon of the slider
17786     * @li "end" - A end part content of the slider
17787     *
17788     * Default text parts of the silder widget that you can use for are:
17789     * @li "default" - Label of the silder
17790     * Here is an example on its usage:
17791     * @li @ref slider_example
17792     */
17793
17794    /**
17795     * @addtogroup Slider
17796     * @{
17797     */
17798
17799    /**
17800     * Add a new slider widget to the given parent Elementary
17801     * (container) object.
17802     *
17803     * @param parent The parent object.
17804     * @return a new slider widget handle or @c NULL, on errors.
17805     *
17806     * This function inserts a new slider widget on the canvas.
17807     *
17808     * @ingroup Slider
17809     */
17810    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17811
17812    /**
17813     * Set the label of a given slider widget
17814     *
17815     * @param obj The progress bar object
17816     * @param label The text label string, in UTF-8
17817     *
17818     * @ingroup Slider
17819     * @deprecated use elm_object_text_set() instead.
17820     */
17821    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17822
17823    /**
17824     * Get the label of a given slider widget
17825     *
17826     * @param obj The progressbar object
17827     * @return The text label string, in UTF-8
17828     *
17829     * @ingroup Slider
17830     * @deprecated use elm_object_text_get() instead.
17831     */
17832    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17833
17834    /**
17835     * Set the icon object of the slider object.
17836     *
17837     * @param obj The slider object.
17838     * @param icon The icon object.
17839     *
17840     * On horizontal mode, icon is placed at left, and on vertical mode,
17841     * placed at top.
17842     *
17843     * @note Once the icon object is set, a previously set one will be deleted.
17844     * If you want to keep that old content object, use the
17845     * elm_slider_icon_unset() function.
17846     *
17847     * @warning If the object being set does not have minimum size hints set,
17848     * it won't get properly displayed.
17849     *
17850     * @ingroup Slider
17851     * @deprecated use elm_object_part_content_set() instead.
17852     */
17853    EINA_DEPRECATED EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17854
17855    /**
17856     * Unset an icon set on a given slider widget.
17857     *
17858     * @param obj The slider object.
17859     * @return The icon object that was being used, if any was set, or
17860     * @c NULL, otherwise (and on errors).
17861     *
17862     * On horizontal mode, icon is placed at left, and on vertical mode,
17863     * placed at top.
17864     *
17865     * This call will unparent and return the icon object which was set
17866     * for this widget, previously, on success.
17867     *
17868     * @see elm_slider_icon_set() for more details
17869     * @see elm_slider_icon_get()
17870     * @deprecated use elm_object_part_content_unset() instead.
17871     *
17872     * @ingroup Slider
17873     */
17874    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17875
17876    /**
17877     * Retrieve the icon object set for a given slider widget.
17878     *
17879     * @param obj The slider object.
17880     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17881     * otherwise (and on errors).
17882     *
17883     * On horizontal mode, icon is placed at left, and on vertical mode,
17884     * placed at top.
17885     *
17886     * @see elm_slider_icon_set() for more details
17887     * @see elm_slider_icon_unset()
17888     *
17889     * @deprecated use elm_object_part_content_get() instead.
17890     *
17891     * @ingroup Slider
17892     */
17893    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17894
17895    /**
17896     * Set the end object of the slider object.
17897     *
17898     * @param obj The slider object.
17899     * @param end The end object.
17900     *
17901     * On horizontal mode, end is placed at left, and on vertical mode,
17902     * placed at bottom.
17903     *
17904     * @note Once the icon object is set, a previously set one will be deleted.
17905     * If you want to keep that old content object, use the
17906     * elm_slider_end_unset() function.
17907     *
17908     * @warning If the object being set does not have minimum size hints set,
17909     * it won't get properly displayed.
17910     *
17911     * @deprecated use elm_object_part_content_set() instead.
17912     *
17913     * @ingroup Slider
17914     */
17915    EINA_DEPRECATED EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17916
17917    /**
17918     * Unset an end object set on a given slider widget.
17919     *
17920     * @param obj The slider object.
17921     * @return The end object that was being used, if any was set, or
17922     * @c NULL, otherwise (and on errors).
17923     *
17924     * On horizontal mode, end is placed at left, and on vertical mode,
17925     * placed at bottom.
17926     *
17927     * This call will unparent and return the icon object which was set
17928     * for this widget, previously, on success.
17929     *
17930     * @see elm_slider_end_set() for more details.
17931     * @see elm_slider_end_get()
17932     *
17933     * @deprecated use elm_object_part_content_unset() instead
17934     * instead.
17935     *
17936     * @ingroup Slider
17937     */
17938    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17939
17940    /**
17941     * Retrieve the end object set for a given slider widget.
17942     *
17943     * @param obj The slider object.
17944     * @return The end object's handle, if @p obj had one set, or @c NULL,
17945     * otherwise (and on errors).
17946     *
17947     * On horizontal mode, icon is placed at right, and on vertical mode,
17948     * placed at bottom.
17949     *
17950     * @see elm_slider_end_set() for more details.
17951     * @see elm_slider_end_unset()
17952     *
17953     *
17954     * @deprecated use elm_object_part_content_get() instead
17955     * instead.
17956     *
17957     * @ingroup Slider
17958     */
17959    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17960
17961    /**
17962     * Set the (exact) length of the bar region of a given slider widget.
17963     *
17964     * @param obj The slider object.
17965     * @param size The length of the slider's bar region.
17966     *
17967     * This sets the minimum width (when in horizontal mode) or height
17968     * (when in vertical mode) of the actual bar area of the slider
17969     * @p obj. This in turn affects the object's minimum size. Use
17970     * this when you're not setting other size hints expanding on the
17971     * given direction (like weight and alignment hints) and you would
17972     * like it to have a specific size.
17973     *
17974     * @note Icon, end, label, indicator and unit text around @p obj
17975     * will require their
17976     * own space, which will make @p obj to require more the @p size,
17977     * actually.
17978     *
17979     * @see elm_slider_span_size_get()
17980     *
17981     * @ingroup Slider
17982     */
17983    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17984
17985    /**
17986     * Get the length set for the bar region of a given slider widget
17987     *
17988     * @param obj The slider object.
17989     * @return The length of the slider's bar region.
17990     *
17991     * If that size was not set previously, with
17992     * elm_slider_span_size_set(), this call will return @c 0.
17993     *
17994     * @ingroup Slider
17995     */
17996    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17997
17998    /**
17999     * Set the format string for the unit label.
18000     *
18001     * @param obj The slider object.
18002     * @param format The format string for the unit display.
18003     *
18004     * Unit label is displayed all the time, if set, after slider's bar.
18005     * In horizontal mode, at right and in vertical mode, at bottom.
18006     *
18007     * If @c NULL, unit label won't be visible. If not it sets the format
18008     * string for the label text. To the label text is provided a floating point
18009     * value, so the label text can display up to 1 floating point value.
18010     * Note that this is optional.
18011     *
18012     * Use a format string such as "%1.2f meters" for example, and it will
18013     * display values like: "3.14 meters" for a value equal to 3.14159.
18014     *
18015     * Default is unit label disabled.
18016     *
18017     * @see elm_slider_indicator_format_get()
18018     *
18019     * @ingroup Slider
18020     */
18021    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
18022
18023    /**
18024     * Get the unit label format of the slider.
18025     *
18026     * @param obj The slider object.
18027     * @return The unit label format string in UTF-8.
18028     *
18029     * Unit label is displayed all the time, if set, after slider's bar.
18030     * In horizontal mode, at right and in vertical mode, at bottom.
18031     *
18032     * @see elm_slider_unit_format_set() for more
18033     * information on how this works.
18034     *
18035     * @ingroup Slider
18036     */
18037    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18038
18039    /**
18040     * Set the format string for the indicator label.
18041     *
18042     * @param obj The slider object.
18043     * @param indicator The format string for the indicator display.
18044     *
18045     * The slider may display its value somewhere else then unit label,
18046     * for example, above the slider knob that is dragged around. This function
18047     * sets the format string used for this.
18048     *
18049     * If @c NULL, indicator label won't be visible. If not it sets the format
18050     * string for the label text. To the label text is provided a floating point
18051     * value, so the label text can display up to 1 floating point value.
18052     * Note that this is optional.
18053     *
18054     * Use a format string such as "%1.2f meters" for example, and it will
18055     * display values like: "3.14 meters" for a value equal to 3.14159.
18056     *
18057     * Default is indicator label disabled.
18058     *
18059     * @see elm_slider_indicator_format_get()
18060     *
18061     * @ingroup Slider
18062     */
18063    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
18064
18065    /**
18066     * Get the indicator label format of the slider.
18067     *
18068     * @param obj The slider object.
18069     * @return The indicator label format string in UTF-8.
18070     *
18071     * The slider may display its value somewhere else then unit label,
18072     * for example, above the slider knob that is dragged around. This function
18073     * gets the format string used for this.
18074     *
18075     * @see elm_slider_indicator_format_set() for more
18076     * information on how this works.
18077     *
18078     * @ingroup Slider
18079     */
18080    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18081
18082    /**
18083     * Set the format function pointer for the indicator label
18084     *
18085     * @param obj The slider object.
18086     * @param func The indicator format function.
18087     * @param free_func The freeing function for the format string.
18088     *
18089     * Set the callback function to format the indicator string.
18090     *
18091     * @see elm_slider_indicator_format_set() for more info on how this works.
18092     *
18093     * @ingroup Slider
18094     */
18095   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);
18096
18097   /**
18098    * Set the format function pointer for the units label
18099    *
18100    * @param obj The slider object.
18101    * @param func The units format function.
18102    * @param free_func The freeing function for the format string.
18103    *
18104    * Set the callback function to format the indicator string.
18105    *
18106    * @see elm_slider_units_format_set() for more info on how this works.
18107    *
18108    * @ingroup Slider
18109    */
18110   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);
18111
18112   /**
18113    * Set the orientation of a given slider widget.
18114    *
18115    * @param obj The slider object.
18116    * @param horizontal Use @c EINA_TRUE to make @p obj to be
18117    * @b horizontal, @c EINA_FALSE to make it @b vertical.
18118    *
18119    * Use this function to change how your slider is to be
18120    * disposed: vertically or horizontally.
18121    *
18122    * By default it's displayed horizontally.
18123    *
18124    * @see elm_slider_horizontal_get()
18125    *
18126    * @ingroup Slider
18127    */
18128    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
18129
18130    /**
18131     * Retrieve the orientation of a given slider widget
18132     *
18133     * @param obj The slider object.
18134     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
18135     * @c EINA_FALSE if it's @b vertical (and on errors).
18136     *
18137     * @see elm_slider_horizontal_set() for more details.
18138     *
18139     * @ingroup Slider
18140     */
18141    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18142
18143    /**
18144     * Set the minimum and maximum values for the slider.
18145     *
18146     * @param obj The slider object.
18147     * @param min The minimum value.
18148     * @param max The maximum value.
18149     *
18150     * Define the allowed range of values to be selected by the user.
18151     *
18152     * If actual value is less than @p min, it will be updated to @p min. If it
18153     * is bigger then @p max, will be updated to @p max. Actual value can be
18154     * get with elm_slider_value_get().
18155     *
18156     * By default, min is equal to 0.0, and max is equal to 1.0.
18157     *
18158     * @warning Maximum must be greater than minimum, otherwise behavior
18159     * is undefined.
18160     *
18161     * @see elm_slider_min_max_get()
18162     *
18163     * @ingroup Slider
18164     */
18165    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
18166
18167    /**
18168     * Get the minimum and maximum values of the slider.
18169     *
18170     * @param obj The slider object.
18171     * @param min Pointer where to store the minimum value.
18172     * @param max Pointer where to store the maximum value.
18173     *
18174     * @note If only one value is needed, the other pointer can be passed
18175     * as @c NULL.
18176     *
18177     * @see elm_slider_min_max_set() for details.
18178     *
18179     * @ingroup Slider
18180     */
18181    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
18182
18183    /**
18184     * Set the value the slider displays.
18185     *
18186     * @param obj The slider object.
18187     * @param val The value to be displayed.
18188     *
18189     * Value will be presented on the unit label following format specified with
18190     * elm_slider_unit_format_set() and on indicator with
18191     * elm_slider_indicator_format_set().
18192     *
18193     * @warning The value must to be between min and max values. This values
18194     * are set by elm_slider_min_max_set().
18195     *
18196     * @see elm_slider_value_get()
18197     * @see elm_slider_unit_format_set()
18198     * @see elm_slider_indicator_format_set()
18199     * @see elm_slider_min_max_set()
18200     *
18201     * @ingroup Slider
18202     */
18203    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
18204
18205    /**
18206     * Get the value displayed by the spinner.
18207     *
18208     * @param obj The spinner object.
18209     * @return The value displayed.
18210     *
18211     * @see elm_spinner_value_set() for details.
18212     *
18213     * @ingroup Slider
18214     */
18215    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18216
18217    /**
18218     * Invert a given slider widget's displaying values order
18219     *
18220     * @param obj The slider object.
18221     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
18222     * @c EINA_FALSE to bring it back to default, non-inverted values.
18223     *
18224     * A slider may be @b inverted, in which state it gets its
18225     * values inverted, with high vales being on the left or top and
18226     * low values on the right or bottom, as opposed to normally have
18227     * the low values on the former and high values on the latter,
18228     * respectively, for horizontal and vertical modes.
18229     *
18230     * @see elm_slider_inverted_get()
18231     *
18232     * @ingroup Slider
18233     */
18234    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
18235
18236    /**
18237     * Get whether a given slider widget's displaying values are
18238     * inverted or not.
18239     *
18240     * @param obj The slider object.
18241     * @return @c EINA_TRUE, if @p obj has inverted values,
18242     * @c EINA_FALSE otherwise (and on errors).
18243     *
18244     * @see elm_slider_inverted_set() for more details.
18245     *
18246     * @ingroup Slider
18247     */
18248    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18249
18250    /**
18251     * Set whether to enlarge slider indicator (augmented knob) or not.
18252     *
18253     * @param obj The slider object.
18254     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
18255     * let the knob always at default size.
18256     *
18257     * By default, indicator will be bigger while dragged by the user.
18258     *
18259     * @warning It won't display values set with
18260     * elm_slider_indicator_format_set() if you disable indicator.
18261     *
18262     * @ingroup Slider
18263     */
18264    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
18265
18266    /**
18267     * Get whether a given slider widget's enlarging indicator or not.
18268     *
18269     * @param obj The slider object.
18270     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
18271     * @c EINA_FALSE otherwise (and on errors).
18272     *
18273     * @see elm_slider_indicator_show_set() for details.
18274     *
18275     * @ingroup Slider
18276     */
18277    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18278
18279    /**
18280     * @}
18281     */
18282
18283    /**
18284     * @addtogroup Actionslider Actionslider
18285     *
18286     * @image html img/widget/actionslider/preview-00.png
18287     * @image latex img/widget/actionslider/preview-00.eps
18288     *
18289     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18290     * properties. The user drags and releases the indicator, to choose a label.
18291     *
18292     * Labels occupy the following positions.
18293     * a. Left
18294     * b. Right
18295     * c. Center
18296     *
18297     * Positions can be enabled or disabled.
18298     *
18299     * Magnets can be set on the above positions.
18300     *
18301     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18302     *
18303     * @note By default all positions are set as enabled.
18304     *
18305     * Signals that you can add callbacks for are:
18306     *
18307     * "selected" - when user selects an enabled position (the label is passed
18308     *              as event info)".
18309     * @n
18310     * "pos_changed" - when the indicator reaches any of the positions("left",
18311     *                 "right" or "center").
18312     *
18313     * See an example of actionslider usage @ref actionslider_example_page "here"
18314     * @{
18315     */
18316    typedef enum _Elm_Actionslider_Pos
18317      {
18318         ELM_ACTIONSLIDER_NONE = 0,
18319         ELM_ACTIONSLIDER_LEFT = 1 << 0,
18320         ELM_ACTIONSLIDER_CENTER = 1 << 1,
18321         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
18322         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
18323      } Elm_Actionslider_Pos;
18324
18325    /**
18326     * Add a new actionslider to the parent.
18327     *
18328     * @param parent The parent object
18329     * @return The new actionslider object or NULL if it cannot be created
18330     */
18331    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18332    /**
18333     * Set actionslider labels.
18334     *
18335     * @param obj The actionslider object
18336     * @param left_label The label to be set on the left.
18337     * @param center_label The label to be set on the center.
18338     * @param right_label The label to be set on the right.
18339     * @deprecated use elm_object_text_set() instead.
18340     */
18341    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);
18342    /**
18343     * Get actionslider labels.
18344     *
18345     * @param obj The actionslider object
18346     * @param left_label A char** to place the left_label of @p obj into.
18347     * @param center_label A char** to place the center_label of @p obj into.
18348     * @param right_label A char** to place the right_label of @p obj into.
18349     * @deprecated use elm_object_text_set() instead.
18350     */
18351    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);
18352    /**
18353     * Get actionslider selected label.
18354     *
18355     * @param obj The actionslider object
18356     * @return The selected label
18357     */
18358    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18359    /**
18360     * Set actionslider indicator position.
18361     *
18362     * @param obj The actionslider object.
18363     * @param pos The position of the indicator.
18364     */
18365    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18366    /**
18367     * Get actionslider indicator position.
18368     *
18369     * @param obj The actionslider object.
18370     * @return The position of the indicator.
18371     */
18372    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18373    /**
18374     * Set actionslider magnet position. To make multiple positions magnets @c or
18375     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
18376     *
18377     * @param obj The actionslider object.
18378     * @param pos Bit mask indicating the magnet positions.
18379     */
18380    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18381    /**
18382     * Get actionslider magnet position.
18383     *
18384     * @param obj The actionslider object.
18385     * @return The positions with magnet property.
18386     */
18387    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18388    /**
18389     * Set actionslider enabled position. To set multiple positions as enabled @c or
18390     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
18391     *
18392     * @note All the positions are enabled by default.
18393     *
18394     * @param obj The actionslider object.
18395     * @param pos Bit mask indicating the enabled positions.
18396     */
18397    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18398    /**
18399     * Get actionslider enabled position.
18400     *
18401     * @param obj The actionslider object.
18402     * @return The enabled positions.
18403     */
18404    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18405    /**
18406     * Set the label used on the indicator.
18407     *
18408     * @param obj The actionslider object
18409     * @param label The label to be set on the indicator.
18410     * @deprecated use elm_object_text_set() instead.
18411     */
18412    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18413    /**
18414     * Get the label used on the indicator object.
18415     *
18416     * @param obj The actionslider object
18417     * @return The indicator label
18418     * @deprecated use elm_object_text_get() instead.
18419     */
18420    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18421    /**
18422     * @}
18423     */
18424
18425    /**
18426     * @defgroup Genlist Genlist
18427     *
18428     * @image html img/widget/genlist/preview-00.png
18429     * @image latex img/widget/genlist/preview-00.eps
18430     * @image html img/genlist.png
18431     * @image latex img/genlist.eps
18432     *
18433     * This widget aims to have more expansive list than the simple list in
18434     * Elementary that could have more flexible items and allow many more entries
18435     * while still being fast and low on memory usage. At the same time it was
18436     * also made to be able to do tree structures. But the price to pay is more
18437     * complexity when it comes to usage. If all you want is a simple list with
18438     * icons and a single text, use the normal @ref List object.
18439     *
18440     * Genlist has a fairly large API, mostly because it's relatively complex,
18441     * trying to be both expansive, powerful and efficient. First we will begin
18442     * an overview on the theory behind genlist.
18443     *
18444     * @section Genlist_Item_Class Genlist item classes - creating items
18445     *
18446     * In order to have the ability to add and delete items on the fly, genlist
18447     * implements a class (callback) system where the application provides a
18448     * structure with information about that type of item (genlist may contain
18449     * multiple different items with different classes, states and styles).
18450     * Genlist will call the functions in this struct (methods) when an item is
18451     * "realized" (i.e., created dynamically, while the user is scrolling the
18452     * grid). All objects will simply be deleted when no longer needed with
18453     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18454     * following members:
18455     * - @c item_style - This is a constant string and simply defines the name
18456     *   of the item style. It @b must be specified and the default should be @c
18457     *   "default".
18458     *
18459     * - @c func - A struct with pointers to functions that will be called when
18460     *   an item is going to be actually created. All of them receive a @c data
18461     *   parameter that will point to the same data passed to
18462     *   elm_genlist_item_append() and related item creation functions, and a @c
18463     *   obj parameter that points to the genlist object itself.
18464     *
18465     * The function pointers inside @c func are @c text_get, @c content_get, @c
18466     * state_get and @c del. The 3 first functions also receive a @c part
18467     * parameter described below. A brief description of these functions follows:
18468     *
18469     * - @c text_get - The @c part parameter is the name string of one of the
18470     *   existing text parts in the Edje group implementing the item's theme.
18471     *   This function @b must return a strdup'()ed string, as the caller will
18472     *   free() it when done. See #Elm_Genlist_Item_Text_Get_Cb.
18473     * - @c content_get - The @c part parameter is the name string of one of the
18474     *   existing (content) swallow parts in the Edje group implementing the item's
18475     *   theme. It must return @c NULL, when no content is desired, or a valid
18476     *   object handle, otherwise.  The object will be deleted by the genlist on
18477     *   its deletion or when the item is "unrealized".  See
18478     *   #Elm_Genlist_Item_Content_Get_Cb.
18479     * - @c func.state_get - The @c part parameter is the name string of one of
18480     *   the state parts in the Edje group implementing the item's theme. Return
18481     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18482     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18483     *   and @c "elm" as "emission" and "source" arguments, respectively, when
18484     *   the state is true (the default is false), where @c XXX is the name of
18485     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
18486     * - @c func.del - This is intended for use when genlist items are deleted,
18487     *   so any data attached to the item (e.g. its data parameter on creation)
18488     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
18489     *
18490     * available item styles:
18491     * - default
18492     * - default_style - The text part is a textblock
18493     *
18494     * @image html img/widget/genlist/preview-04.png
18495     * @image latex img/widget/genlist/preview-04.eps
18496     *
18497     * - double_label
18498     *
18499     * @image html img/widget/genlist/preview-01.png
18500     * @image latex img/widget/genlist/preview-01.eps
18501     *
18502     * - icon_top_text_bottom
18503     *
18504     * @image html img/widget/genlist/preview-02.png
18505     * @image latex img/widget/genlist/preview-02.eps
18506     *
18507     * - group_index
18508     *
18509     * @image html img/widget/genlist/preview-03.png
18510     * @image latex img/widget/genlist/preview-03.eps
18511     *
18512     * @section Genlist_Items Structure of items
18513     *
18514     * An item in a genlist can have 0 or more texts (they can be regular
18515     * text or textblock Evas objects - that's up to the style to determine), 0
18516     * or more contents (which are simply objects swallowed into the genlist item's
18517     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18518     * behavior left to the user to define. The Edje part names for each of
18519     * these properties will be looked up, in the theme file for the genlist,
18520     * under the Edje (string) data items named @c "labels", @c "contents" and @c
18521     * "states", respectively. For each of those properties, if more than one
18522     * part is provided, they must have names listed separated by spaces in the
18523     * data fields. For the default genlist item theme, we have @b one text 
18524     * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18525     * "elm.swallow.end") and @b no state parts.
18526     *
18527     * A genlist item may be at one of several styles. Elementary provides one
18528     * by default - "default", but this can be extended by system or application
18529     * custom themes/overlays/extensions (see @ref Theme "themes" for more
18530     * details).
18531     *
18532     * @section Genlist_Manipulation Editing and Navigating
18533     *
18534     * Items can be added by several calls. All of them return a @ref
18535     * Elm_Genlist_Item handle that is an internal member inside the genlist.
18536     * They all take a data parameter that is meant to be used for a handle to
18537     * the applications internal data (eg the struct with the original item
18538     * data). The parent parameter is the parent genlist item this belongs to if
18539     * it is a tree or an indexed group, and NULL if there is no parent. The
18540     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18541     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18542     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18543     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
18544     * is set then this item is group index item that is displayed at the top
18545     * until the next group comes. The func parameter is a convenience callback
18546     * that is called when the item is selected and the data parameter will be
18547     * the func_data parameter, obj be the genlist object and event_info will be
18548     * the genlist item.
18549     *
18550     * elm_genlist_item_append() adds an item to the end of the list, or if
18551     * there is a parent, to the end of all the child items of the parent.
18552     * elm_genlist_item_prepend() is the same but adds to the beginning of
18553     * the list or children list. elm_genlist_item_insert_before() inserts at
18554     * item before another item and elm_genlist_item_insert_after() inserts after
18555     * the indicated item.
18556     *
18557     * The application can clear the list with elm_genlist_clear() which deletes
18558     * all the items in the list and elm_genlist_item_del() will delete a specific
18559     * item. elm_genlist_item_subitems_clear() will clear all items that are
18560     * children of the indicated parent item.
18561     *
18562     * To help inspect list items you can jump to the item at the top of the list
18563     * with elm_genlist_first_item_get() which will return the item pointer, and
18564     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18565     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18566     * and previous items respectively relative to the indicated item. Using
18567     * these calls you can walk the entire item list/tree. Note that as a tree
18568     * the items are flattened in the list, so elm_genlist_item_parent_get() will
18569     * let you know which item is the parent (and thus know how to skip them if
18570     * wanted).
18571     *
18572     * @section Genlist_Muti_Selection Multi-selection
18573     *
18574     * If the application wants multiple items to be able to be selected,
18575     * elm_genlist_multi_select_set() can enable this. If the list is
18576     * single-selection only (the default), then elm_genlist_selected_item_get()
18577     * will return the selected item, if any, or NULL if none is selected. If the
18578     * list is multi-select then elm_genlist_selected_items_get() will return a
18579     * list (that is only valid as long as no items are modified (added, deleted,
18580     * selected or unselected)).
18581     *
18582     * @section Genlist_Usage_Hints Usage hints
18583     *
18584     * There are also convenience functions. elm_genlist_item_genlist_get() will
18585     * return the genlist object the item belongs to. elm_genlist_item_show()
18586     * will make the scroller scroll to show that specific item so its visible.
18587     * elm_genlist_item_data_get() returns the data pointer set by the item
18588     * creation functions.
18589     *
18590     * If an item changes (state of boolean changes, text or contents change),
18591     * then use elm_genlist_item_update() to have genlist update the item with
18592     * the new state. Genlist will re-realize the item thus call the functions
18593     * in the _Elm_Genlist_Item_Class for that item.
18594     *
18595     * To programmatically (un)select an item use elm_genlist_item_selected_set().
18596     * To get its selected state use elm_genlist_item_selected_get(). Similarly
18597     * to expand/contract an item and get its expanded state, use
18598     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18599     * again to make an item disabled (unable to be selected and appear
18600     * differently) use elm_genlist_item_disabled_set() to set this and
18601     * elm_genlist_item_disabled_get() to get the disabled state.
18602     *
18603     * In general to indicate how the genlist should expand items horizontally to
18604     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18605     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18606     * mode means that if items are too wide to fit, the scroller will scroll
18607     * horizontally. Otherwise items are expanded to fill the width of the
18608     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18609     * to the viewport width and limited to that size. This can be combined with
18610     * a different style that uses edjes' ellipsis feature (cutting text off like
18611     * this: "tex...").
18612     *
18613     * Items will only call their selection func and callback when first becoming
18614     * selected. Any further clicks will do nothing, unless you enable always
18615     * select with elm_genlist_always_select_mode_set(). This means even if
18616     * selected, every click will make the selected callbacks be called.
18617     * elm_genlist_no_select_mode_set() will turn off the ability to select
18618     * items entirely and they will neither appear selected nor call selected
18619     * callback functions.
18620     *
18621     * Remember that you can create new styles and add your own theme augmentation
18622     * per application with elm_theme_extension_add(). If you absolutely must
18623     * have a specific style that overrides any theme the user or system sets up
18624     * you can use elm_theme_overlay_add() to add such a file.
18625     *
18626     * @section Genlist_Implementation Implementation
18627     *
18628     * Evas tracks every object you create. Every time it processes an event
18629     * (mouse move, down, up etc.) it needs to walk through objects and find out
18630     * what event that affects. Even worse every time it renders display updates,
18631     * in order to just calculate what to re-draw, it needs to walk through many
18632     * many many objects. Thus, the more objects you keep active, the more
18633     * overhead Evas has in just doing its work. It is advisable to keep your
18634     * active objects to the minimum working set you need. Also remember that
18635     * object creation and deletion carries an overhead, so there is a
18636     * middle-ground, which is not easily determined. But don't keep massive lists
18637     * of objects you can't see or use. Genlist does this with list objects. It
18638     * creates and destroys them dynamically as you scroll around. It groups them
18639     * into blocks so it can determine the visibility etc. of a whole block at
18640     * once as opposed to having to walk the whole list. This 2-level list allows
18641     * for very large numbers of items to be in the list (tests have used up to
18642     * 2,000,000 items). Also genlist employs a queue for adding items. As items
18643     * may be different sizes, every item added needs to be calculated as to its
18644     * size and thus this presents a lot of overhead on populating the list, this
18645     * genlist employs a queue. Any item added is queued and spooled off over
18646     * time, actually appearing some time later, so if your list has many members
18647     * you may find it takes a while for them to all appear, with your process
18648     * consuming a lot of CPU while it is busy spooling.
18649     *
18650     * Genlist also implements a tree structure, but it does so with callbacks to
18651     * the application, with the application filling in tree structures when
18652     * requested (allowing for efficient building of a very deep tree that could
18653     * even be used for file-management). See the above smart signal callbacks for
18654     * details.
18655     *
18656     * @section Genlist_Smart_Events Genlist smart events
18657     *
18658     * Signals that you can add callbacks for are:
18659     * - @c "activated" - The user has double-clicked or pressed
18660     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
18661     *   item that was activated.
18662     * - @c "clicked,double" - The user has double-clicked an item.  The @c
18663     *   event_info parameter is the item that was double-clicked.
18664     * - @c "selected" - This is called when a user has made an item selected.
18665     *   The event_info parameter is the genlist item that was selected.
18666     * - @c "unselected" - This is called when a user has made an item
18667     *   unselected. The event_info parameter is the genlist item that was
18668     *   unselected.
18669     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18670     *   called and the item is now meant to be expanded. The event_info
18671     *   parameter is the genlist item that was indicated to expand.  It is the
18672     *   job of this callback to then fill in the child items.
18673     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18674     *   called and the item is now meant to be contracted. The event_info
18675     *   parameter is the genlist item that was indicated to contract. It is the
18676     *   job of this callback to then delete the child items.
18677     * - @c "expand,request" - This is called when a user has indicated they want
18678     *   to expand a tree branch item. The callback should decide if the item can
18679     *   expand (has any children) and then call elm_genlist_item_expanded_set()
18680     *   appropriately to set the state. The event_info parameter is the genlist
18681     *   item that was indicated to expand.
18682     * - @c "contract,request" - This is called when a user has indicated they
18683     *   want to contract a tree branch item. The callback should decide if the
18684     *   item can contract (has any children) and then call
18685     *   elm_genlist_item_expanded_set() appropriately to set the state. The
18686     *   event_info parameter is the genlist item that was indicated to contract.
18687     * - @c "realized" - This is called when the item in the list is created as a
18688     *   real evas object. event_info parameter is the genlist item that was
18689     *   created. The object may be deleted at any time, so it is up to the
18690     *   caller to not use the object pointer from elm_genlist_item_object_get()
18691     *   in a way where it may point to freed objects.
18692     * - @c "unrealized" - This is called just before an item is unrealized.
18693     *   After this call content objects provided will be deleted and the item
18694     *   object itself delete or be put into a floating cache.
18695     * - @c "drag,start,up" - This is called when the item in the list has been
18696     *   dragged (not scrolled) up.
18697     * - @c "drag,start,down" - This is called when the item in the list has been
18698     *   dragged (not scrolled) down.
18699     * - @c "drag,start,left" - This is called when the item in the list has been
18700     *   dragged (not scrolled) left.
18701     * - @c "drag,start,right" - This is called when the item in the list has
18702     *   been dragged (not scrolled) right.
18703     * - @c "drag,stop" - This is called when the item in the list has stopped
18704     *   being dragged.
18705     * - @c "drag" - This is called when the item in the list is being dragged.
18706     * - @c "longpressed" - This is called when the item is pressed for a certain
18707     *   amount of time. By default it's 1 second.
18708     * - @c "scroll,anim,start" - This is called when scrolling animation has
18709     *   started.
18710     * - @c "scroll,anim,stop" - This is called when scrolling animation has
18711     *   stopped.
18712     * - @c "scroll,drag,start" - This is called when dragging the content has
18713     *   started.
18714     * - @c "scroll,drag,stop" - This is called when dragging the content has
18715     *   stopped.
18716     * - @c "edge,top" - This is called when the genlist is scrolled until
18717     *   the top edge.
18718     * - @c "edge,bottom" - This is called when the genlist is scrolled
18719     *   until the bottom edge.
18720     * - @c "edge,left" - This is called when the genlist is scrolled
18721     *   until the left edge.
18722     * - @c "edge,right" - This is called when the genlist is scrolled
18723     *   until the right edge.
18724     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18725     *   swiped left.
18726     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18727     *   swiped right.
18728     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18729     *   swiped up.
18730     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18731     *   swiped down.
18732     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18733     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
18734     *   multi-touch pinched in.
18735     * - @c "swipe" - This is called when the genlist is swiped.
18736     * - @c "moved" - This is called when a genlist item is moved.
18737     * - @c "language,changed" - This is called when the program's language is
18738     *   changed.
18739     *
18740     * @section Genlist_Examples Examples
18741     *
18742     * Here is a list of examples that use the genlist, trying to show some of
18743     * its capabilities:
18744     * - @ref genlist_example_01
18745     * - @ref genlist_example_02
18746     * - @ref genlist_example_03
18747     * - @ref genlist_example_04
18748     * - @ref genlist_example_05
18749     */
18750
18751    /**
18752     * @addtogroup Genlist
18753     * @{
18754     */
18755
18756    /**
18757     * @enum _Elm_Genlist_Item_Flags
18758     * @typedef Elm_Genlist_Item_Flags
18759     *
18760     * Defines if the item is of any special type (has subitems or it's the
18761     * index of a group), or is just a simple item.
18762     *
18763     * @ingroup Genlist
18764     */
18765    typedef enum _Elm_Genlist_Item_Flags
18766      {
18767         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18768         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18769         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18770      } Elm_Genlist_Item_Flags;
18771    typedef enum _Elm_Genlist_Item_Field_Flags
18772      {
18773         ELM_GENLIST_ITEM_FIELD_ALL = 0,
18774         ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18775         ELM_GENLIST_ITEM_FIELD_CONTENT = (1 << 1),
18776         ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18777      } Elm_Genlist_Item_Field_Flags;
18778    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
18779    #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18780    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18781    #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18782    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18783    /**
18784     * Text fetching class function for Elm_Gen_Item_Class.
18785     * @param data The data passed in the item creation function
18786     * @param obj The base widget object
18787     * @param part The part name of the swallow
18788     * @return The allocated (NOT stringshared) string to set as the text
18789     */
18790    typedef char        *(*Elm_Genlist_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18791    /**
18792     * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
18793     * @param data The data passed in the item creation function
18794     * @param obj The base widget object
18795     * @param part The part name of the swallow
18796     * @return The content object to swallow
18797     */
18798    typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part);
18799    /**
18800     * State fetching class function for Elm_Gen_Item_Class.
18801     * @param data The data passed in the item creation function
18802     * @param obj The base widget object
18803     * @param part The part name of the swallow
18804     * @return The hell if I know
18805     */
18806    typedef Eina_Bool    (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18807    /**
18808     * Deletion class function for Elm_Gen_Item_Class.
18809     * @param data The data passed in the item creation function
18810     * @param obj The base widget object
18811     */
18812    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj);
18813
18814    /**
18815     * @struct _Elm_Genlist_Item_Class
18816     *
18817     * Genlist item class definition structs.
18818     *
18819     * This struct contains the style and fetching functions that will define the
18820     * contents of each item.
18821     *
18822     * @see @ref Genlist_Item_Class
18823     */
18824    struct _Elm_Genlist_Item_Class
18825      {
18826         const char                *item_style; /**< style of this class. */
18827         struct Elm_Genlist_Item_Class_Func
18828           {
18829              Elm_Genlist_Item_Text_Get_Cb    text_get; /**< Text fetching class function for genlist item classes.*/
18830              Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
18831              Elm_Genlist_Item_State_Get_Cb   state_get; /**< State fetching class function for genlist item classes. */
18832              Elm_Genlist_Item_Del_Cb         del; /**< Deletion class function for genlist item classes. */
18833           } func;
18834      };
18835    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18836    /**
18837     * Add a new genlist widget to the given parent Elementary
18838     * (container) object
18839     *
18840     * @param parent The parent object
18841     * @return a new genlist widget handle or @c NULL, on errors
18842     *
18843     * This function inserts a new genlist widget on the canvas.
18844     *
18845     * @see elm_genlist_item_append()
18846     * @see elm_genlist_item_del()
18847     * @see elm_genlist_clear()
18848     *
18849     * @ingroup Genlist
18850     */
18851    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18852    /**
18853     * Remove all items from a given genlist widget.
18854     *
18855     * @param obj The genlist object
18856     *
18857     * This removes (and deletes) all items in @p obj, leaving it empty.
18858     *
18859     * @see elm_genlist_item_del(), to remove just one item.
18860     *
18861     * @ingroup Genlist
18862     */
18863    EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18864    /**
18865     * Enable or disable multi-selection in the genlist
18866     *
18867     * @param obj The genlist object
18868     * @param multi Multi-select enable/disable. Default is disabled.
18869     *
18870     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18871     * the list. This allows more than 1 item to be selected. To retrieve the list
18872     * of selected items, use elm_genlist_selected_items_get().
18873     *
18874     * @see elm_genlist_selected_items_get()
18875     * @see elm_genlist_multi_select_get()
18876     *
18877     * @ingroup Genlist
18878     */
18879    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18880    /**
18881     * Gets if multi-selection in genlist is enabled or disabled.
18882     *
18883     * @param obj The genlist object
18884     * @return Multi-select enabled/disabled
18885     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18886     *
18887     * @see elm_genlist_multi_select_set()
18888     *
18889     * @ingroup Genlist
18890     */
18891    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18892    /**
18893     * This sets the horizontal stretching mode.
18894     *
18895     * @param obj The genlist object
18896     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18897     *
18898     * This sets the mode used for sizing items horizontally. Valid modes
18899     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18900     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18901     * the scroller will scroll horizontally. Otherwise items are expanded
18902     * to fill the width of the viewport of the scroller. If it is
18903     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18904     * limited to that size.
18905     *
18906     * @see elm_genlist_horizontal_get()
18907     *
18908     * @ingroup Genlist
18909     */
18910    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18911    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18912    /**
18913     * Gets the horizontal stretching mode.
18914     *
18915     * @param obj The genlist object
18916     * @return The mode to use
18917     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18918     *
18919     * @see elm_genlist_horizontal_set()
18920     *
18921     * @ingroup Genlist
18922     */
18923    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18924    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18925    /**
18926     * Set the always select mode.
18927     *
18928     * @param obj The genlist object
18929     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18930     * EINA_FALSE = off). Default is @c EINA_FALSE.
18931     *
18932     * Items will only call their selection func and callback when first
18933     * becoming selected. Any further clicks will do nothing, unless you
18934     * enable always select with elm_genlist_always_select_mode_set().
18935     * This means that, even if selected, every click will make the selected
18936     * callbacks be called.
18937     *
18938     * @see elm_genlist_always_select_mode_get()
18939     *
18940     * @ingroup Genlist
18941     */
18942    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18943    /**
18944     * Get the always select mode.
18945     *
18946     * @param obj The genlist object
18947     * @return The always select mode
18948     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18949     *
18950     * @see elm_genlist_always_select_mode_set()
18951     *
18952     * @ingroup Genlist
18953     */
18954    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18955    /**
18956     * Enable/disable the no select mode.
18957     *
18958     * @param obj The genlist object
18959     * @param no_select The no select mode
18960     * (EINA_TRUE = on, EINA_FALSE = off)
18961     *
18962     * This will turn off the ability to select items entirely and they
18963     * will neither appear selected nor call selected callback functions.
18964     *
18965     * @see elm_genlist_no_select_mode_get()
18966     *
18967     * @ingroup Genlist
18968     */
18969    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18970    /**
18971     * Gets whether the no select mode is enabled.
18972     *
18973     * @param obj The genlist object
18974     * @return The no select mode
18975     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18976     *
18977     * @see elm_genlist_no_select_mode_set()
18978     *
18979     * @ingroup Genlist
18980     */
18981    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18982    /**
18983     * Enable/disable compress mode.
18984     *
18985     * @param obj The genlist object
18986     * @param compress The compress mode
18987     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18988     *
18989     * This will enable the compress mode where items are "compressed"
18990     * horizontally to fit the genlist scrollable viewport width. This is
18991     * special for genlist.  Do not rely on
18992     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18993     * work as genlist needs to handle it specially.
18994     *
18995     * @see elm_genlist_compress_mode_get()
18996     *
18997     * @ingroup Genlist
18998     */
18999    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
19000    /**
19001     * Get whether the compress mode is enabled.
19002     *
19003     * @param obj The genlist object
19004     * @return The compress mode
19005     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19006     *
19007     * @see elm_genlist_compress_mode_set()
19008     *
19009     * @ingroup Genlist
19010     */
19011    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19012    /**
19013     * Enable/disable height-for-width mode.
19014     *
19015     * @param obj The genlist object
19016     * @param setting The height-for-width mode (@c EINA_TRUE = on,
19017     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
19018     *
19019     * With height-for-width mode the item width will be fixed (restricted
19020     * to a minimum of) to the list width when calculating its size in
19021     * order to allow the height to be calculated based on it. This allows,
19022     * for instance, text block to wrap lines if the Edje part is
19023     * configured with "text.min: 0 1".
19024     *
19025     * @note This mode will make list resize slower as it will have to
19026     *       recalculate every item height again whenever the list width
19027     *       changes!
19028     *
19029     * @note When height-for-width mode is enabled, it also enables
19030     *       compress mode (see elm_genlist_compress_mode_set()) and
19031     *       disables homogeneous (see elm_genlist_homogeneous_set()).
19032     *
19033     * @ingroup Genlist
19034     */
19035    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
19036    /**
19037     * Get whether the height-for-width mode is enabled.
19038     *
19039     * @param obj The genlist object
19040     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
19041     * off)
19042     *
19043     * @ingroup Genlist
19044     */
19045    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19046    /**
19047     * Enable/disable horizontal and vertical bouncing effect.
19048     *
19049     * @param obj The genlist object
19050     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
19051     * EINA_FALSE = off). Default is @c EINA_FALSE.
19052     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
19053     * EINA_FALSE = off). Default is @c EINA_TRUE.
19054     *
19055     * This will enable or disable the scroller bouncing effect for the
19056     * genlist. See elm_scroller_bounce_set() for details.
19057     *
19058     * @see elm_scroller_bounce_set()
19059     * @see elm_genlist_bounce_get()
19060     *
19061     * @ingroup Genlist
19062     */
19063    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
19064    /**
19065     * Get whether the horizontal and vertical bouncing effect is enabled.
19066     *
19067     * @param obj The genlist object
19068     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
19069     * option is set.
19070     * @param v_bounce Pointer to a bool to receive if the bounce vertically
19071     * option is set.
19072     *
19073     * @see elm_genlist_bounce_set()
19074     *
19075     * @ingroup Genlist
19076     */
19077    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
19078    /**
19079     * Enable/disable homogeneous mode.
19080     *
19081     * @param obj The genlist object
19082     * @param homogeneous Assume the items within the genlist are of the
19083     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
19084     * EINA_FALSE.
19085     *
19086     * This will enable the homogeneous mode where items are of the same
19087     * height and width so that genlist may do the lazy-loading at its
19088     * maximum (which increases the performance for scrolling the list). This
19089     * implies 'compressed' mode.
19090     *
19091     * @see elm_genlist_compress_mode_set()
19092     * @see elm_genlist_homogeneous_get()
19093     *
19094     * @ingroup Genlist
19095     */
19096    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
19097    /**
19098     * Get whether the homogeneous mode is enabled.
19099     *
19100     * @param obj The genlist object
19101     * @return Assume the items within the genlist are of the same height
19102     * and width (EINA_TRUE = on, EINA_FALSE = off)
19103     *
19104     * @see elm_genlist_homogeneous_set()
19105     *
19106     * @ingroup Genlist
19107     */
19108    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19109    /**
19110     * Set the maximum number of items within an item block
19111     *
19112     * @param obj The genlist object
19113     * @param n   Maximum number of items within an item block. Default is 32.
19114     *
19115     * This will configure the block count to tune to the target with
19116     * particular performance matrix.
19117     *
19118     * A block of objects will be used to reduce the number of operations due to
19119     * many objects in the screen. It can determine the visibility, or if the
19120     * object has changed, it theme needs to be updated, etc. doing this kind of
19121     * calculation to the entire block, instead of per object.
19122     *
19123     * The default value for the block count is enough for most lists, so unless
19124     * you know you will have a lot of objects visible in the screen at the same
19125     * time, don't try to change this.
19126     *
19127     * @see elm_genlist_block_count_get()
19128     * @see @ref Genlist_Implementation
19129     *
19130     * @ingroup Genlist
19131     */
19132    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
19133    /**
19134     * Get the maximum number of items within an item block
19135     *
19136     * @param obj The genlist object
19137     * @return Maximum number of items within an item block
19138     *
19139     * @see elm_genlist_block_count_set()
19140     *
19141     * @ingroup Genlist
19142     */
19143    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19144    /**
19145     * Set the timeout in seconds for the longpress event.
19146     *
19147     * @param obj The genlist object
19148     * @param timeout timeout in seconds. Default is 1.
19149     *
19150     * This option will change how long it takes to send an event "longpressed"
19151     * after the mouse down signal is sent to the list. If this event occurs, no
19152     * "clicked" event will be sent.
19153     *
19154     * @see elm_genlist_longpress_timeout_set()
19155     *
19156     * @ingroup Genlist
19157     */
19158    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19159    /**
19160     * Get the timeout in seconds for the longpress event.
19161     *
19162     * @param obj The genlist object
19163     * @return timeout in seconds
19164     *
19165     * @see elm_genlist_longpress_timeout_get()
19166     *
19167     * @ingroup Genlist
19168     */
19169    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19170    /**
19171     * Append a new item in a given genlist widget.
19172     *
19173     * @param obj The genlist object
19174     * @param itc The item class for the item
19175     * @param data The item data
19176     * @param parent The parent item, or NULL if none
19177     * @param flags Item flags
19178     * @param func Convenience function called when the item is selected
19179     * @param func_data Data passed to @p func above.
19180     * @return A handle to the item added or @c NULL if not possible
19181     *
19182     * This adds the given item to the end of the list or the end of
19183     * the children list if the @p parent is given.
19184     *
19185     * @see elm_genlist_item_prepend()
19186     * @see elm_genlist_item_insert_before()
19187     * @see elm_genlist_item_insert_after()
19188     * @see elm_genlist_item_del()
19189     *
19190     * @ingroup Genlist
19191     */
19192    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);
19193    /**
19194     * Prepend a new item in a given genlist widget.
19195     *
19196     * @param obj The genlist object
19197     * @param itc The item class for the item
19198     * @param data The item data
19199     * @param parent The parent item, or NULL if none
19200     * @param flags Item flags
19201     * @param func Convenience function called when the item is selected
19202     * @param func_data Data passed to @p func above.
19203     * @return A handle to the item added or NULL if not possible
19204     *
19205     * This adds an item to the beginning of the list or beginning of the
19206     * children of the parent if given.
19207     *
19208     * @see elm_genlist_item_append()
19209     * @see elm_genlist_item_insert_before()
19210     * @see elm_genlist_item_insert_after()
19211     * @see elm_genlist_item_del()
19212     *
19213     * @ingroup Genlist
19214     */
19215    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);
19216    /**
19217     * Insert an item before another in a genlist widget
19218     *
19219     * @param obj The genlist object
19220     * @param itc The item class for the item
19221     * @param data The item data
19222     * @param before The item to place this new one before.
19223     * @param flags Item flags
19224     * @param func Convenience function called when the item is selected
19225     * @param func_data Data passed to @p func above.
19226     * @return A handle to the item added or @c NULL if not possible
19227     *
19228     * This inserts an item before another in the list. It will be in the
19229     * same tree level or group as the item it is inserted before.
19230     *
19231     * @see elm_genlist_item_append()
19232     * @see elm_genlist_item_prepend()
19233     * @see elm_genlist_item_insert_after()
19234     * @see elm_genlist_item_del()
19235     *
19236     * @ingroup Genlist
19237     */
19238    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);
19239    /**
19240     * Insert an item after another in a genlist widget
19241     *
19242     * @param obj The genlist object
19243     * @param itc The item class for the item
19244     * @param data The item data
19245     * @param after The item to place this new one after.
19246     * @param flags Item flags
19247     * @param func Convenience function called when the item is selected
19248     * @param func_data Data passed to @p func above.
19249     * @return A handle to the item added or @c NULL if not possible
19250     *
19251     * This inserts an item after another in the list. It will be in the
19252     * same tree level or group as the item it is inserted after.
19253     *
19254     * @see elm_genlist_item_append()
19255     * @see elm_genlist_item_prepend()
19256     * @see elm_genlist_item_insert_before()
19257     * @see elm_genlist_item_del()
19258     *
19259     * @ingroup Genlist
19260     */
19261    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);
19262    /**
19263     * Insert a new item into the sorted genlist object
19264     *
19265     * @param obj The genlist object
19266     * @param itc The item class for the item
19267     * @param data The item data
19268     * @param parent The parent item, or NULL if none
19269     * @param flags Item flags
19270     * @param comp The function called for the sort
19271     * @param func Convenience function called when item selected
19272     * @param func_data Data passed to @p func above.
19273     * @return A handle to the item added or NULL if not possible
19274     *
19275     * @ingroup Genlist
19276     */
19277    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);
19278    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);
19279    /* operations to retrieve existing items */
19280    /**
19281     * Get the selectd item in the genlist.
19282     *
19283     * @param obj The genlist object
19284     * @return The selected item, or NULL if none is selected.
19285     *
19286     * This gets the selected item in the list (if multi-selection is enabled, only
19287     * the item that was first selected in the list is returned - which is not very
19288     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19289     * used).
19290     *
19291     * If no item is selected, NULL is returned.
19292     *
19293     * @see elm_genlist_selected_items_get()
19294     *
19295     * @ingroup Genlist
19296     */
19297    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19298    /**
19299     * Get a list of selected items in the genlist.
19300     *
19301     * @param obj The genlist object
19302     * @return The list of selected items, or NULL if none are selected.
19303     *
19304     * It returns a list of the selected items. This list pointer is only valid so
19305     * long as the selection doesn't change (no items are selected or unselected, or
19306     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
19307     * pointers. The order of the items in this list is the order which they were
19308     * selected, i.e. the first item in this list is the first item that was
19309     * selected, and so on.
19310     *
19311     * @note If not in multi-select mode, consider using function
19312     * elm_genlist_selected_item_get() instead.
19313     *
19314     * @see elm_genlist_multi_select_set()
19315     * @see elm_genlist_selected_item_get()
19316     *
19317     * @ingroup Genlist
19318     */
19319    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19320    /**
19321     * Get the mode item style of items in the genlist
19322     * @param obj The genlist object
19323     * @return The mode item style string, or NULL if none is specified
19324     *
19325     * This is a constant string and simply defines the name of the
19326     * style that will be used for mode animations. It can be
19327     * @c NULL if you don't plan to use Genlist mode. See
19328     * elm_genlist_item_mode_set() for more info.
19329     *
19330     * @ingroup Genlist
19331     */
19332    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19333    /**
19334     * Set the mode item style of items in the genlist
19335     * @param obj The genlist object
19336     * @param style The mode item style string, or NULL if none is desired
19337     *
19338     * This is a constant string and simply defines the name of the
19339     * style that will be used for mode animations. It can be
19340     * @c NULL if you don't plan to use Genlist mode. See
19341     * elm_genlist_item_mode_set() for more info.
19342     *
19343     * @ingroup Genlist
19344     */
19345    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
19346    /**
19347     * Get a list of realized items in genlist
19348     *
19349     * @param obj The genlist object
19350     * @return The list of realized items, nor NULL if none are realized.
19351     *
19352     * This returns a list of the realized items in the genlist. The list
19353     * contains Elm_Genlist_Item pointers. The list must be freed by the
19354     * caller when done with eina_list_free(). The item pointers in the
19355     * list are only valid so long as those items are not deleted or the
19356     * genlist is not deleted.
19357     *
19358     * @see elm_genlist_realized_items_update()
19359     *
19360     * @ingroup Genlist
19361     */
19362    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19363    /**
19364     * Get the item that is at the x, y canvas coords.
19365     *
19366     * @param obj The gelinst object.
19367     * @param x The input x coordinate
19368     * @param y The input y coordinate
19369     * @param posret The position relative to the item returned here
19370     * @return The item at the coordinates or NULL if none
19371     *
19372     * This returns the item at the given coordinates (which are canvas
19373     * relative, not object-relative). If an item is at that coordinate,
19374     * that item handle is returned, and if @p posret is not NULL, the
19375     * integer pointed to is set to a value of -1, 0 or 1, depending if
19376     * the coordinate is on the upper portion of that item (-1), on the
19377     * middle section (0) or on the lower part (1). If NULL is returned as
19378     * an item (no item found there), then posret may indicate -1 or 1
19379     * based if the coordinate is above or below all items respectively in
19380     * the genlist.
19381     *
19382     * @ingroup Genlist
19383     */
19384    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);
19385    /**
19386     * Get the first item in the genlist
19387     *
19388     * This returns the first item in the list.
19389     *
19390     * @param obj The genlist object
19391     * @return The first item, or NULL if none
19392     *
19393     * @ingroup Genlist
19394     */
19395    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19396    /**
19397     * Get the last item in the genlist
19398     *
19399     * This returns the last item in the list.
19400     *
19401     * @return The last item, or NULL if none
19402     *
19403     * @ingroup Genlist
19404     */
19405    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19406    /**
19407     * Set the scrollbar policy
19408     *
19409     * @param obj The genlist object
19410     * @param policy_h Horizontal scrollbar policy.
19411     * @param policy_v Vertical scrollbar policy.
19412     *
19413     * This sets the scrollbar visibility policy for the given genlist
19414     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19415     * made visible if it is needed, and otherwise kept hidden.
19416     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19417     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19418     * respectively for the horizontal and vertical scrollbars. Default is
19419     * #ELM_SMART_SCROLLER_POLICY_AUTO
19420     *
19421     * @see elm_genlist_scroller_policy_get()
19422     *
19423     * @ingroup Genlist
19424     */
19425    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19426    /**
19427     * Get the scrollbar policy
19428     *
19429     * @param obj The genlist object
19430     * @param policy_h Pointer to store the horizontal scrollbar policy.
19431     * @param policy_v Pointer to store the vertical scrollbar policy.
19432     *
19433     * @see elm_genlist_scroller_policy_set()
19434     *
19435     * @ingroup Genlist
19436     */
19437    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);
19438    /**
19439     * Get the @b next item in a genlist widget's internal list of items,
19440     * given a handle to one of those items.
19441     *
19442     * @param item The genlist item to fetch next from
19443     * @return The item after @p item, or @c NULL if there's none (and
19444     * on errors)
19445     *
19446     * This returns the item placed after the @p item, on the container
19447     * genlist.
19448     *
19449     * @see elm_genlist_item_prev_get()
19450     *
19451     * @ingroup Genlist
19452     */
19453    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19454    /**
19455     * Get the @b previous item in a genlist widget's internal list of items,
19456     * given a handle to one of those items.
19457     *
19458     * @param item The genlist item to fetch previous from
19459     * @return The item before @p item, or @c NULL if there's none (and
19460     * on errors)
19461     *
19462     * This returns the item placed before the @p item, on the container
19463     * genlist.
19464     *
19465     * @see elm_genlist_item_next_get()
19466     *
19467     * @ingroup Genlist
19468     */
19469    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19470    /**
19471     * Get the genlist object's handle which contains a given genlist
19472     * item
19473     *
19474     * @param item The item to fetch the container from
19475     * @return The genlist (parent) object
19476     *
19477     * This returns the genlist object itself that an item belongs to.
19478     *
19479     * @ingroup Genlist
19480     */
19481    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19482    /**
19483     * Get the parent item of the given item
19484     *
19485     * @param it The item
19486     * @return The parent of the item or @c NULL if it has no parent.
19487     *
19488     * This returns the item that was specified as parent of the item @p it on
19489     * elm_genlist_item_append() and insertion related functions.
19490     *
19491     * @ingroup Genlist
19492     */
19493    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19494    /**
19495     * Remove all sub-items (children) of the given item
19496     *
19497     * @param it The item
19498     *
19499     * This removes all items that are children (and their descendants) of the
19500     * given item @p it.
19501     *
19502     * @see elm_genlist_clear()
19503     * @see elm_genlist_item_del()
19504     *
19505     * @ingroup Genlist
19506     */
19507    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19508    /**
19509     * Set whether a given genlist item is selected or not
19510     *
19511     * @param it The item
19512     * @param selected Use @c EINA_TRUE, to make it selected, @c
19513     * EINA_FALSE to make it unselected
19514     *
19515     * This sets the selected state of an item. If multi selection is
19516     * not enabled on the containing genlist and @p selected is @c
19517     * EINA_TRUE, any other previously selected items will get
19518     * unselected in favor of this new one.
19519     *
19520     * @see elm_genlist_item_selected_get()
19521     *
19522     * @ingroup Genlist
19523     */
19524    EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19525    /**
19526     * Get whether a given genlist item is selected or not
19527     *
19528     * @param it The item
19529     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19530     *
19531     * @see elm_genlist_item_selected_set() for more details
19532     *
19533     * @ingroup Genlist
19534     */
19535    EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19536    /**
19537     * Sets the expanded state of an item.
19538     *
19539     * @param it The item
19540     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19541     *
19542     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19543     * expanded or not.
19544     *
19545     * The theme will respond to this change visually, and a signal "expanded" or
19546     * "contracted" will be sent from the genlist with a pointer to the item that
19547     * has been expanded/contracted.
19548     *
19549     * Calling this function won't show or hide any child of this item (if it is
19550     * a parent). You must manually delete and create them on the callbacks fo
19551     * the "expanded" or "contracted" signals.
19552     *
19553     * @see elm_genlist_item_expanded_get()
19554     *
19555     * @ingroup Genlist
19556     */
19557    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19558    /**
19559     * Get the expanded state of an item
19560     *
19561     * @param it The item
19562     * @return The expanded state
19563     *
19564     * This gets the expanded state of an item.
19565     *
19566     * @see elm_genlist_item_expanded_set()
19567     *
19568     * @ingroup Genlist
19569     */
19570    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19571    /**
19572     * Get the depth of expanded item
19573     *
19574     * @param it The genlist item object
19575     * @return The depth of expanded item
19576     *
19577     * @ingroup Genlist
19578     */
19579    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19580    /**
19581     * Set whether a given genlist item is disabled or not.
19582     *
19583     * @param it The item
19584     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19585     * to enable it back.
19586     *
19587     * A disabled item cannot be selected or unselected. It will also
19588     * change its appearance, to signal the user it's disabled.
19589     *
19590     * @see elm_genlist_item_disabled_get()
19591     *
19592     * @ingroup Genlist
19593     */
19594    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19595    /**
19596     * Get whether a given genlist item is disabled or not.
19597     *
19598     * @param it The item
19599     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19600     * (and on errors).
19601     *
19602     * @see elm_genlist_item_disabled_set() for more details
19603     *
19604     * @ingroup Genlist
19605     */
19606    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19607    /**
19608     * Sets the display only state of an item.
19609     *
19610     * @param it The item
19611     * @param display_only @c EINA_TRUE if the item is display only, @c
19612     * EINA_FALSE otherwise.
19613     *
19614     * A display only item cannot be selected or unselected. It is for
19615     * display only and not selecting or otherwise clicking, dragging
19616     * etc. by the user, thus finger size rules will not be applied to
19617     * this item.
19618     *
19619     * It's good to set group index items to display only state.
19620     *
19621     * @see elm_genlist_item_display_only_get()
19622     *
19623     * @ingroup Genlist
19624     */
19625    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19626    /**
19627     * Get the display only state of an item
19628     *
19629     * @param it The item
19630     * @return @c EINA_TRUE if the item is display only, @c
19631     * EINA_FALSE otherwise.
19632     *
19633     * @see elm_genlist_item_display_only_set()
19634     *
19635     * @ingroup Genlist
19636     */
19637    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19638    /**
19639     * Show the portion of a genlist's internal list containing a given
19640     * item, immediately.
19641     *
19642     * @param it The item to display
19643     *
19644     * This causes genlist to jump to the given item @p it and show it (by
19645     * immediately scrolling to that position), if it is not fully visible.
19646     *
19647     * @see elm_genlist_item_bring_in()
19648     * @see elm_genlist_item_top_show()
19649     * @see elm_genlist_item_middle_show()
19650     *
19651     * @ingroup Genlist
19652     */
19653    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19654    /**
19655     * Animatedly bring in, to the visible are of a genlist, a given
19656     * item on it.
19657     *
19658     * @param it The item to display
19659     *
19660     * This causes genlist to jump to the given item @p it and show it (by
19661     * animatedly scrolling), if it is not fully visible. This may use animation
19662     * to do so and take a period of time
19663     *
19664     * @see elm_genlist_item_show()
19665     * @see elm_genlist_item_top_bring_in()
19666     * @see elm_genlist_item_middle_bring_in()
19667     *
19668     * @ingroup Genlist
19669     */
19670    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19671    /**
19672     * Show the portion of a genlist's internal list containing a given
19673     * item, immediately.
19674     *
19675     * @param it The item to display
19676     *
19677     * This causes genlist to jump to the given item @p it and show it (by
19678     * immediately scrolling to that position), if it is not fully visible.
19679     *
19680     * The item will be positioned at the top of the genlist viewport.
19681     *
19682     * @see elm_genlist_item_show()
19683     * @see elm_genlist_item_top_bring_in()
19684     *
19685     * @ingroup Genlist
19686     */
19687    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19688    /**
19689     * Animatedly bring in, to the visible are of a genlist, a given
19690     * item on it.
19691     *
19692     * @param it The item
19693     *
19694     * This causes genlist to jump to the given item @p it and show it (by
19695     * animatedly scrolling), if it is not fully visible. This may use animation
19696     * to do so and take a period of time
19697     *
19698     * The item will be positioned at the top of the genlist viewport.
19699     *
19700     * @see elm_genlist_item_bring_in()
19701     * @see elm_genlist_item_top_show()
19702     *
19703     * @ingroup Genlist
19704     */
19705    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19706    /**
19707     * Show the portion of a genlist's internal list containing a given
19708     * item, immediately.
19709     *
19710     * @param it The item to display
19711     *
19712     * This causes genlist to jump to the given item @p it and show it (by
19713     * immediately scrolling to that position), if it is not fully visible.
19714     *
19715     * The item will be positioned at the middle of the genlist viewport.
19716     *
19717     * @see elm_genlist_item_show()
19718     * @see elm_genlist_item_middle_bring_in()
19719     *
19720     * @ingroup Genlist
19721     */
19722    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19723    /**
19724     * Animatedly bring in, to the visible are of a genlist, a given
19725     * item on it.
19726     *
19727     * @param it The item
19728     *
19729     * This causes genlist to jump to the given item @p it and show it (by
19730     * animatedly scrolling), if it is not fully visible. This may use animation
19731     * to do so and take a period of time
19732     *
19733     * The item will be positioned at the middle of the genlist viewport.
19734     *
19735     * @see elm_genlist_item_bring_in()
19736     * @see elm_genlist_item_middle_show()
19737     *
19738     * @ingroup Genlist
19739     */
19740    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19741    /**
19742     * Remove a genlist item from the its parent, deleting it.
19743     *
19744     * @param item The item to be removed.
19745     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19746     *
19747     * @see elm_genlist_clear(), to remove all items in a genlist at
19748     * once.
19749     *
19750     * @ingroup Genlist
19751     */
19752    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19753    /**
19754     * Return the data associated to a given genlist item
19755     *
19756     * @param item The genlist item.
19757     * @return the data associated to this item.
19758     *
19759     * This returns the @c data value passed on the
19760     * elm_genlist_item_append() and related item addition calls.
19761     *
19762     * @see elm_genlist_item_append()
19763     * @see elm_genlist_item_data_set()
19764     *
19765     * @ingroup Genlist
19766     */
19767    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19768    /**
19769     * Set the data associated to a given genlist item
19770     *
19771     * @param item The genlist item
19772     * @param data The new data pointer to set on it
19773     *
19774     * This @b overrides the @c data value passed on the
19775     * elm_genlist_item_append() and related item addition calls. This
19776     * function @b won't call elm_genlist_item_update() automatically,
19777     * so you'd issue it afterwards if you want to hove the item
19778     * updated to reflect the that new data.
19779     *
19780     * @see elm_genlist_item_data_get()
19781     *
19782     * @ingroup Genlist
19783     */
19784    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19785    /**
19786     * Tells genlist to "orphan" contents fetchs by the item class
19787     *
19788     * @param it The item
19789     *
19790     * This instructs genlist to release references to contents in the item,
19791     * meaning that they will no longer be managed by genlist and are
19792     * floating "orphans" that can be re-used elsewhere if the user wants
19793     * to.
19794     *
19795     * @ingroup Genlist
19796     */
19797    EAPI void               elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19798    EINA_DEPRECATED EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19799    /**
19800     * Get the real Evas object created to implement the view of a
19801     * given genlist item
19802     *
19803     * @param item The genlist item.
19804     * @return the Evas object implementing this item's view.
19805     *
19806     * This returns the actual Evas object used to implement the
19807     * specified genlist item's view. This may be @c NULL, as it may
19808     * not have been created or may have been deleted, at any time, by
19809     * the genlist. <b>Do not modify this object</b> (move, resize,
19810     * show, hide, etc.), as the genlist is controlling it. This
19811     * function is for querying, emitting custom signals or hooking
19812     * lower level callbacks for events on that object. Do not delete
19813     * this object under any circumstances.
19814     *
19815     * @see elm_genlist_item_data_get()
19816     *
19817     * @ingroup Genlist
19818     */
19819    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19820    /**
19821     * Update the contents of an item
19822     *
19823     * @param it The item
19824     *
19825     * This updates an item by calling all the item class functions again
19826     * to get the contents, texts and states. Use this when the original
19827     * item data has changed and the changes are desired to be reflected.
19828     *
19829     * Use elm_genlist_realized_items_update() to update all already realized
19830     * items.
19831     *
19832     * @see elm_genlist_realized_items_update()
19833     *
19834     * @ingroup Genlist
19835     */
19836    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19837    /**
19838     * Promote an item to the top of the list
19839     *
19840     * @param it The item
19841     *
19842     * @ingroup Genlist
19843     */
19844    EAPI void               elm_genlist_item_promote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
19845    /**
19846     * Demote an item to the end of the list
19847     *
19848     * @param it The item
19849     *
19850     * @ingroup Genlist
19851     */
19852    EAPI void               elm_genlist_item_demote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
19853    /**
19854     * Update the part of an item
19855     *
19856     * @param it The item
19857     * @param parts The name of item's part
19858     * @param itf The flags of item's part type
19859     *
19860     * This updates an item's part by calling item's fetching functions again
19861     * to get the contents, texts and states. Use this when the original
19862     * item data has changed and the changes are desired to be reflected.
19863     * Second parts argument is used for globbing to match '*', '?', and '.'
19864     * It can be used at updating multi fields.
19865     *
19866     * Use elm_genlist_realized_items_update() to update an item's all
19867     * property.
19868     *
19869     * @see elm_genlist_item_update()
19870     *
19871     * @ingroup Genlist
19872     */
19873    EAPI void               elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19874    /**
19875     * Update the item class of an item
19876     *
19877     * @param it The item
19878     * @param itc The item class for the item
19879     *
19880     * This sets another class fo the item, changing the way that it is
19881     * displayed. After changing the item class, elm_genlist_item_update() is
19882     * called on the item @p it.
19883     *
19884     * @ingroup Genlist
19885     */
19886    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19887    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19888    /**
19889     * Set the text to be shown in a given genlist item's tooltips.
19890     *
19891     * @param item The genlist item
19892     * @param text The text to set in the content
19893     *
19894     * This call will setup the text to be used as tooltip to that item
19895     * (analogous to elm_object_tooltip_text_set(), but being item
19896     * tooltips with higher precedence than object tooltips). It can
19897     * have only one tooltip at a time, so any previous tooltip data
19898     * will get removed.
19899     *
19900     * In order to set a content or something else as a tooltip, look at
19901     * elm_genlist_item_tooltip_content_cb_set().
19902     *
19903     * @ingroup Genlist
19904     */
19905    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19906    /**
19907     * Set the content to be shown in a given genlist item's tooltips
19908     *
19909     * @param item The genlist item.
19910     * @param func The function returning the tooltip contents.
19911     * @param data What to provide to @a func as callback data/context.
19912     * @param del_cb Called when data is not needed anymore, either when
19913     *        another callback replaces @p func, the tooltip is unset with
19914     *        elm_genlist_item_tooltip_unset() or the owner @p item
19915     *        dies. This callback receives as its first parameter the
19916     *        given @p data, being @c event_info the item handle.
19917     *
19918     * This call will setup the tooltip's contents to @p item
19919     * (analogous to elm_object_tooltip_content_cb_set(), but being
19920     * item tooltips with higher precedence than object tooltips). It
19921     * can have only one tooltip at a time, so any previous tooltip
19922     * content will get removed. @p func (with @p data) will be called
19923     * every time Elementary needs to show the tooltip and it should
19924     * return a valid Evas object, which will be fully managed by the
19925     * tooltip system, getting deleted when the tooltip is gone.
19926     *
19927     * In order to set just a text as a tooltip, look at
19928     * elm_genlist_item_tooltip_text_set().
19929     *
19930     * @ingroup Genlist
19931     */
19932    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);
19933    /**
19934     * Unset a tooltip from a given genlist item
19935     *
19936     * @param item genlist item to remove a previously set tooltip from.
19937     *
19938     * This call removes any tooltip set on @p item. The callback
19939     * provided as @c del_cb to
19940     * elm_genlist_item_tooltip_content_cb_set() will be called to
19941     * notify it is not used anymore (and have resources cleaned, if
19942     * need be).
19943     *
19944     * @see elm_genlist_item_tooltip_content_cb_set()
19945     *
19946     * @ingroup Genlist
19947     */
19948    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19949    /**
19950     * Set a different @b style for a given genlist item's tooltip.
19951     *
19952     * @param item genlist item with tooltip set
19953     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19954     * "default", @c "transparent", etc)
19955     *
19956     * Tooltips can have <b>alternate styles</b> to be displayed on,
19957     * which are defined by the theme set on Elementary. This function
19958     * works analogously as elm_object_tooltip_style_set(), but here
19959     * applied only to genlist item objects. The default style for
19960     * tooltips is @c "default".
19961     *
19962     * @note before you set a style you should define a tooltip with
19963     *       elm_genlist_item_tooltip_content_cb_set() or
19964     *       elm_genlist_item_tooltip_text_set()
19965     *
19966     * @see elm_genlist_item_tooltip_style_get()
19967     *
19968     * @ingroup Genlist
19969     */
19970    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19971    /**
19972     * Get the style set a given genlist item's tooltip.
19973     *
19974     * @param item genlist item with tooltip already set on.
19975     * @return style the theme style in use, which defaults to
19976     *         "default". If the object does not have a tooltip set,
19977     *         then @c NULL is returned.
19978     *
19979     * @see elm_genlist_item_tooltip_style_set() for more details
19980     *
19981     * @ingroup Genlist
19982     */
19983    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19984    /**
19985     * @brief Disable size restrictions on an object's tooltip
19986     * @param item The tooltip's anchor object
19987     * @param disable If EINA_TRUE, size restrictions are disabled
19988     * @return EINA_FALSE on failure, EINA_TRUE on success
19989     *
19990     * This function allows a tooltip to expand beyond its parant window's canvas.
19991     * It will instead be limited only by the size of the display.
19992     */
19993    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19994    /**
19995     * @brief Retrieve size restriction state of an object's tooltip
19996     * @param item The tooltip's anchor object
19997     * @return If EINA_TRUE, size restrictions are disabled
19998     *
19999     * This function returns whether a tooltip is allowed to expand beyond
20000     * its parant window's canvas.
20001     * It will instead be limited only by the size of the display.
20002     */
20003    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
20004    /**
20005     * Set the type of mouse pointer/cursor decoration to be shown,
20006     * when the mouse pointer is over the given genlist widget item
20007     *
20008     * @param item genlist item to customize cursor on
20009     * @param cursor the cursor type's name
20010     *
20011     * This function works analogously as elm_object_cursor_set(), but
20012     * here the cursor's changing area is restricted to the item's
20013     * area, and not the whole widget's. Note that that item cursors
20014     * have precedence over widget cursors, so that a mouse over @p
20015     * item will always show cursor @p type.
20016     *
20017     * If this function is called twice for an object, a previously set
20018     * cursor will be unset on the second call.
20019     *
20020     * @see elm_object_cursor_set()
20021     * @see elm_genlist_item_cursor_get()
20022     * @see elm_genlist_item_cursor_unset()
20023     *
20024     * @ingroup Genlist
20025     */
20026    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
20027    /**
20028     * Get the type of mouse pointer/cursor decoration set to be shown,
20029     * when the mouse pointer is over the given genlist widget item
20030     *
20031     * @param item genlist item with custom cursor set
20032     * @return the cursor type's name or @c NULL, if no custom cursors
20033     * were set to @p item (and on errors)
20034     *
20035     * @see elm_object_cursor_get()
20036     * @see elm_genlist_item_cursor_set() for more details
20037     * @see elm_genlist_item_cursor_unset()
20038     *
20039     * @ingroup Genlist
20040     */
20041    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20042    /**
20043     * Unset any custom mouse pointer/cursor decoration set to be
20044     * shown, when the mouse pointer is over the given genlist widget
20045     * item, thus making it show the @b default cursor again.
20046     *
20047     * @param item a genlist item
20048     *
20049     * Use this call to undo any custom settings on this item's cursor
20050     * decoration, bringing it back to defaults (no custom style set).
20051     *
20052     * @see elm_object_cursor_unset()
20053     * @see elm_genlist_item_cursor_set() for more details
20054     *
20055     * @ingroup Genlist
20056     */
20057    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20058    /**
20059     * Set a different @b style for a given custom cursor set for a
20060     * genlist item.
20061     *
20062     * @param item genlist item with custom cursor set
20063     * @param style the <b>theme style</b> to use (e.g. @c "default",
20064     * @c "transparent", etc)
20065     *
20066     * This function only makes sense when one is using custom mouse
20067     * cursor decorations <b>defined in a theme file</b> , which can
20068     * have, given a cursor name/type, <b>alternate styles</b> on
20069     * it. It works analogously as elm_object_cursor_style_set(), but
20070     * here applied only to genlist item objects.
20071     *
20072     * @warning Before you set a cursor style you should have defined a
20073     *       custom cursor previously on the item, with
20074     *       elm_genlist_item_cursor_set()
20075     *
20076     * @see elm_genlist_item_cursor_engine_only_set()
20077     * @see elm_genlist_item_cursor_style_get()
20078     *
20079     * @ingroup Genlist
20080     */
20081    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
20082    /**
20083     * Get the current @b style set for a given genlist item's custom
20084     * cursor
20085     *
20086     * @param item genlist item with custom cursor set.
20087     * @return style the cursor style in use. If the object does not
20088     *         have a cursor set, then @c NULL is returned.
20089     *
20090     * @see elm_genlist_item_cursor_style_set() for more details
20091     *
20092     * @ingroup Genlist
20093     */
20094    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20095    /**
20096     * Set if the (custom) cursor for a given genlist item should be
20097     * searched in its theme, also, or should only rely on the
20098     * rendering engine.
20099     *
20100     * @param item item with custom (custom) cursor already set on
20101     * @param engine_only Use @c EINA_TRUE to have cursors looked for
20102     * only on those provided by the rendering engine, @c EINA_FALSE to
20103     * have them searched on the widget's theme, as well.
20104     *
20105     * @note This call is of use only if you've set a custom cursor
20106     * for genlist items, with elm_genlist_item_cursor_set().
20107     *
20108     * @note By default, cursors will only be looked for between those
20109     * provided by the rendering engine.
20110     *
20111     * @ingroup Genlist
20112     */
20113    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
20114    /**
20115     * Get if the (custom) cursor for a given genlist item is being
20116     * searched in its theme, also, or is only relying on the rendering
20117     * engine.
20118     *
20119     * @param item a genlist item
20120     * @return @c EINA_TRUE, if cursors are being looked for only on
20121     * those provided by the rendering engine, @c EINA_FALSE if they
20122     * are being searched on the widget's theme, as well.
20123     *
20124     * @see elm_genlist_item_cursor_engine_only_set(), for more details
20125     *
20126     * @ingroup Genlist
20127     */
20128    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20129    /**
20130     * Update the contents of all realized items.
20131     *
20132     * @param obj The genlist object.
20133     *
20134     * This updates all realized items by calling all the item class functions again
20135     * to get the contents, texts and states. Use this when the original
20136     * item data has changed and the changes are desired to be reflected.
20137     *
20138     * To update just one item, use elm_genlist_item_update().
20139     *
20140     * @see elm_genlist_realized_items_get()
20141     * @see elm_genlist_item_update()
20142     *
20143     * @ingroup Genlist
20144     */
20145    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
20146    /**
20147     * Activate a genlist mode on an item
20148     *
20149     * @param item The genlist item
20150     * @param mode Mode name
20151     * @param mode_set Boolean to define set or unset mode.
20152     *
20153     * A genlist mode is a different way of selecting an item. Once a mode is
20154     * activated on an item, any other selected item is immediately unselected.
20155     * This feature provides an easy way of implementing a new kind of animation
20156     * for selecting an item, without having to entirely rewrite the item style
20157     * theme. However, the elm_genlist_selected_* API can't be used to get what
20158     * item is activate for a mode.
20159     *
20160     * The current item style will still be used, but applying a genlist mode to
20161     * an item will select it using a different kind of animation.
20162     *
20163     * The current active item for a mode can be found by
20164     * elm_genlist_mode_item_get().
20165     *
20166     * The characteristics of genlist mode are:
20167     * - Only one mode can be active at any time, and for only one item.
20168     * - Genlist handles deactivating other items when one item is activated.
20169     * - A mode is defined in the genlist theme (edc), and more modes can easily
20170     *   be added.
20171     * - A mode style and the genlist item style are different things. They
20172     *   can be combined to provide a default style to the item, with some kind
20173     *   of animation for that item when the mode is activated.
20174     *
20175     * When a mode is activated on an item, a new view for that item is created.
20176     * The theme of this mode defines the animation that will be used to transit
20177     * the item from the old view to the new view. This second (new) view will be
20178     * active for that item while the mode is active on the item, and will be
20179     * destroyed after the mode is totally deactivated from that item.
20180     *
20181     * @see elm_genlist_mode_get()
20182     * @see elm_genlist_mode_item_get()
20183     *
20184     * @ingroup Genlist
20185     */
20186    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
20187    /**
20188     * Get the last (or current) genlist mode used.
20189     *
20190     * @param obj The genlist object
20191     *
20192     * This function just returns the name of the last used genlist mode. It will
20193     * be the current mode if it's still active.
20194     *
20195     * @see elm_genlist_item_mode_set()
20196     * @see elm_genlist_mode_item_get()
20197     *
20198     * @ingroup Genlist
20199     */
20200    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20201    /**
20202     * Get active genlist mode item
20203     *
20204     * @param obj The genlist object
20205     * @return The active item for that current mode. Or @c NULL if no item is
20206     * activated with any mode.
20207     *
20208     * This function returns the item that was activated with a mode, by the
20209     * function elm_genlist_item_mode_set().
20210     *
20211     * @see elm_genlist_item_mode_set()
20212     * @see elm_genlist_mode_get()
20213     *
20214     * @ingroup Genlist
20215     */
20216    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20217
20218    /**
20219     * Set reorder mode
20220     *
20221     * @param obj The genlist object
20222     * @param reorder_mode The reorder mode
20223     * (EINA_TRUE = on, EINA_FALSE = off)
20224     *
20225     * @ingroup Genlist
20226     */
20227    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
20228
20229    /**
20230     * Get the reorder mode
20231     *
20232     * @param obj The genlist object
20233     * @return The reorder mode
20234     * (EINA_TRUE = on, EINA_FALSE = off)
20235     *
20236     * @ingroup Genlist
20237     */
20238    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20239
20240    /**
20241     * @}
20242     */
20243
20244    /**
20245     * @defgroup Check Check
20246     *
20247     * @image html img/widget/check/preview-00.png
20248     * @image latex img/widget/check/preview-00.eps
20249     * @image html img/widget/check/preview-01.png
20250     * @image latex img/widget/check/preview-01.eps
20251     * @image html img/widget/check/preview-02.png
20252     * @image latex img/widget/check/preview-02.eps
20253     *
20254     * @brief The check widget allows for toggling a value between true and
20255     * false.
20256     *
20257     * Check objects are a lot like radio objects in layout and functionality
20258     * except they do not work as a group, but independently and only toggle the
20259     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
20260     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
20261     * returns the current state. For convenience, like the radio objects, you
20262     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
20263     * for it to modify.
20264     *
20265     * Signals that you can add callbacks for are:
20266     * "changed" - This is called whenever the user changes the state of one of
20267     *             the check object(event_info is NULL).
20268     *
20269     * Default contents parts of the check widget that you can use for are:
20270     * @li "icon" - An icon of the check
20271     *
20272     * Default text parts of the check widget that you can use for are:
20273     * @li "elm.text" - Label of the check
20274     *
20275     * @ref tutorial_check should give you a firm grasp of how to use this widget
20276     * .
20277     * @{
20278     */
20279    /**
20280     * @brief Add a new Check object
20281     *
20282     * @param parent The parent object
20283     * @return The new object or NULL if it cannot be created
20284     */
20285    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20286    /**
20287     * @brief Set the text label of the check object
20288     *
20289     * @param obj The check object
20290     * @param label The text label string in UTF-8
20291     *
20292     * @deprecated use elm_object_text_set() instead.
20293     */
20294    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20295    /**
20296     * @brief Get the text label of the check object
20297     *
20298     * @param obj The check object
20299     * @return The text label string in UTF-8
20300     *
20301     * @deprecated use elm_object_text_get() instead.
20302     */
20303    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20304    /**
20305     * @brief Set the icon object of the check object
20306     *
20307     * @param obj The check object
20308     * @param icon The icon object
20309     *
20310     * Once the icon object is set, a previously set one will be deleted.
20311     * If you want to keep that old content object, use the
20312     * elm_object_content_unset() function.
20313     *
20314     * @deprecated use elm_object_part_content_set() instead.
20315     *
20316     */
20317    EINA_DEPRECATED EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20318    /**
20319     * @brief Get the icon object of the check object
20320     *
20321     * @param obj The check object
20322     * @return The icon object
20323     *
20324     * @deprecated use elm_object_part_content_get() instead.
20325     *
20326     */
20327    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20328    /**
20329     * @brief Unset the icon used for the check object
20330     *
20331     * @param obj The check object
20332     * @return The icon object that was being used
20333     *
20334     * Unparent and return the icon object which was set for this widget.
20335     *
20336     * @deprecated use elm_object_part_content_unset() instead.
20337     *
20338     */
20339    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20340    /**
20341     * @brief Set the on/off state of the check object
20342     *
20343     * @param obj The check object
20344     * @param state The state to use (1 == on, 0 == off)
20345     *
20346     * This sets the state of the check. If set
20347     * with elm_check_state_pointer_set() the state of that variable is also
20348     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
20349     */
20350    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20351    /**
20352     * @brief Get the state of the check object
20353     *
20354     * @param obj The check object
20355     * @return The boolean state
20356     */
20357    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20358    /**
20359     * @brief Set a convenience pointer to a boolean to change
20360     *
20361     * @param obj The check object
20362     * @param statep Pointer to the boolean to modify
20363     *
20364     * This sets a pointer to a boolean, that, in addition to the check objects
20365     * state will also be modified directly. To stop setting the object pointed
20366     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
20367     * then when this is called, the check objects state will also be modified to
20368     * reflect the value of the boolean @p statep points to, just like calling
20369     * elm_check_state_set().
20370     */
20371    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
20372    EINA_DEPRECATED EAPI void         elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
20373    EINA_DEPRECATED EAPI void         elm_check_states_labels_get(const Evas_Object *obj, const char **ontext, const char **offtext) EINA_ARG_NONNULL(1,2,3);
20374
20375    /**
20376     * @}
20377     */
20378
20379    /**
20380     * @defgroup Radio Radio
20381     *
20382     * @image html img/widget/radio/preview-00.png
20383     * @image latex img/widget/radio/preview-00.eps
20384     *
20385     * @brief Radio is a widget that allows for 1 or more options to be displayed
20386     * and have the user choose only 1 of them.
20387     *
20388     * A radio object contains an indicator, an optional Label and an optional
20389     * icon object. While it's possible to have a group of only one radio they,
20390     * are normally used in groups of 2 or more. To add a radio to a group use
20391     * elm_radio_group_add(). The radio object(s) will select from one of a set
20392     * of integer values, so any value they are configuring needs to be mapped to
20393     * a set of integers. To configure what value that radio object represents,
20394     * use  elm_radio_state_value_set() to set the integer it represents. To set
20395     * the value the whole group(which one is currently selected) is to indicate
20396     * use elm_radio_value_set() on any group member, and to get the groups value
20397     * use elm_radio_value_get(). For convenience the radio objects are also able
20398     * to directly set an integer(int) to the value that is selected. To specify
20399     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20400     * The radio objects will modify this directly. That implies the pointer must
20401     * point to valid memory for as long as the radio objects exist.
20402     *
20403     * Signals that you can add callbacks for are:
20404     * @li changed - This is called whenever the user changes the state of one of
20405     * the radio objects within the group of radio objects that work together.
20406     *
20407     * Default contents parts of the radio widget that you can use for are:
20408     * @li "icon" - An icon of the radio
20409     *
20410     * @ref tutorial_radio show most of this API in action.
20411     * @{
20412     */
20413    /**
20414     * @brief Add a new radio to the parent
20415     *
20416     * @param parent The parent object
20417     * @return The new object or NULL if it cannot be created
20418     */
20419    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20420    /**
20421     * @brief Set the text label of the radio object
20422     *
20423     * @param obj The radio object
20424     * @param label The text label string in UTF-8
20425     *
20426     * @deprecated use elm_object_text_set() instead.
20427     */
20428    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20429    /**
20430     * @brief Get the text label of the radio object
20431     *
20432     * @param obj The radio object
20433     * @return The text label string in UTF-8
20434     *
20435     * @deprecated use elm_object_text_set() instead.
20436     */
20437    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20438    /**
20439     * @brief Set the icon object of the radio object
20440     *
20441     * @param obj The radio object
20442     * @param icon The icon object
20443     *
20444     * Once the icon object is set, a previously set one will be deleted. If you
20445     * want to keep that old content object, use the elm_radio_icon_unset()
20446     * function.
20447     *
20448     * @deprecated use elm_object_part_content_set() instead.
20449     *
20450     */
20451    EINA_DEPRECATED EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20452    /**
20453     * @brief Get the icon object of the radio object
20454     *
20455     * @param obj The radio object
20456     * @return The icon object
20457     *
20458     * @see elm_radio_icon_set()
20459     *
20460     * @deprecated use elm_object_part_content_get() instead.
20461     *
20462     */
20463    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20464    /**
20465     * @brief Unset the icon used for the radio object
20466     *
20467     * @param obj The radio object
20468     * @return The icon object that was being used
20469     *
20470     * Unparent and return the icon object which was set for this widget.
20471     *
20472     * @see elm_radio_icon_set()
20473     * @deprecated use elm_object_part_content_unset() instead.
20474     *
20475     */
20476    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20477    /**
20478     * @brief Add this radio to a group of other radio objects
20479     *
20480     * @param obj The radio object
20481     * @param group Any object whose group the @p obj is to join.
20482     *
20483     * Radio objects work in groups. Each member should have a different integer
20484     * value assigned. In order to have them work as a group, they need to know
20485     * about each other. This adds the given radio object to the group of which
20486     * the group object indicated is a member.
20487     */
20488    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20489    /**
20490     * @brief Set the integer value that this radio object represents
20491     *
20492     * @param obj The radio object
20493     * @param value The value to use if this radio object is selected
20494     *
20495     * This sets the value of the radio.
20496     */
20497    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20498    /**
20499     * @brief Get the integer value that this radio object represents
20500     *
20501     * @param obj The radio object
20502     * @return The value used if this radio object is selected
20503     *
20504     * This gets the value of the radio.
20505     *
20506     * @see elm_radio_value_set()
20507     */
20508    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20509    /**
20510     * @brief Set the value of the radio.
20511     *
20512     * @param obj The radio object
20513     * @param value The value to use for the group
20514     *
20515     * This sets the value of the radio group and will also set the value if
20516     * pointed to, to the value supplied, but will not call any callbacks.
20517     */
20518    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20519    /**
20520     * @brief Get the state of the radio object
20521     *
20522     * @param obj The radio object
20523     * @return The integer state
20524     */
20525    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20526    /**
20527     * @brief Set a convenience pointer to a integer to change
20528     *
20529     * @param obj The radio object
20530     * @param valuep Pointer to the integer to modify
20531     *
20532     * This sets a pointer to a integer, that, in addition to the radio objects
20533     * state will also be modified directly. To stop setting the object pointed
20534     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20535     * when this is called, the radio objects state will also be modified to
20536     * reflect the value of the integer valuep points to, just like calling
20537     * elm_radio_value_set().
20538     */
20539    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20540    /**
20541     * @}
20542     */
20543
20544    /**
20545     * @defgroup Pager Pager
20546     *
20547     * @image html img/widget/pager/preview-00.png
20548     * @image latex img/widget/pager/preview-00.eps
20549     *
20550     * @brief Widget that allows flipping between one or more ā€œpagesā€
20551     * of objects.
20552     *
20553     * The flipping between pages of objects is animated. All content
20554     * in the pager is kept in a stack, being the last content added
20555     * (visible one) on the top of that stack.
20556     *
20557     * Objects can be pushed or popped from the stack or deleted as
20558     * well. Pushes and pops will animate the widget accordingly to its
20559     * style (a pop will also delete the child object once the
20560     * animation is finished). Any object already in the pager can be
20561     * promoted to the top (from its current stacking position) through
20562     * the use of elm_pager_content_promote(). New objects are pushed
20563     * to the top with elm_pager_content_push(). When the top item is
20564     * no longer wanted, simply pop it with elm_pager_content_pop() and
20565     * it will also be deleted. If an object is no longer needed and is
20566     * not the top item, just delete it as normal. You can query which
20567     * objects are the top and bottom with
20568     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20569     *
20570     * Signals that you can add callbacks for are:
20571     * - @c "show,finished" - when a new page is actually shown on the top
20572     * - @c "hide,finished" - when a previous page is hidden
20573     *
20574     * Only after the first of that signals the child object is
20575     * guaranteed to be visible, as in @c evas_object_visible_get().
20576     *
20577     * This widget has the following styles available:
20578     * - @c "default"
20579     * - @c "fade"
20580     * - @c "fade_translucide"
20581     * - @c "fade_invisible"
20582     *
20583     * @note These styles affect only the flipping animations on the
20584     * default theme; the appearance when not animating is unaffected
20585     * by them.
20586     *
20587     * @ref tutorial_pager gives a good overview of the usage of the API.
20588     * @{
20589     */
20590
20591    /**
20592     * Add a new pager to the parent
20593     *
20594     * @param parent The parent object
20595     * @return The new object or NULL if it cannot be created
20596     *
20597     * @ingroup Pager
20598     */
20599    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20600
20601    /**
20602     * @brief Push an object to the top of the pager stack (and show it).
20603     *
20604     * @param obj The pager object
20605     * @param content The object to push
20606     *
20607     * The object pushed becomes a child of the pager, it will be controlled and
20608     * deleted when the pager is deleted.
20609     *
20610     * @note If the content is already in the stack use
20611     * elm_pager_content_promote().
20612     * @warning Using this function on @p content already in the stack results in
20613     * undefined behavior.
20614     */
20615    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20616
20617    /**
20618     * @brief Pop the object that is on top of the stack
20619     *
20620     * @param obj The pager object
20621     *
20622     * This pops the object that is on the top(visible) of the pager, makes it
20623     * disappear, then deletes the object. The object that was underneath it on
20624     * the stack will become visible.
20625     */
20626    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20627
20628    /**
20629     * @brief Moves an object already in the pager stack to the top of the stack.
20630     *
20631     * @param obj The pager object
20632     * @param content The object to promote
20633     *
20634     * This will take the @p content and move it to the top of the stack as
20635     * if it had been pushed there.
20636     *
20637     * @note If the content isn't already in the stack use
20638     * elm_pager_content_push().
20639     * @warning Using this function on @p content not already in the stack
20640     * results in undefined behavior.
20641     */
20642    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20643
20644    /**
20645     * @brief Return the object at the bottom of the pager stack
20646     *
20647     * @param obj The pager object
20648     * @return The bottom object or NULL if none
20649     */
20650    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20651
20652    /**
20653     * @brief  Return the object at the top of the pager stack
20654     *
20655     * @param obj The pager object
20656     * @return The top object or NULL if none
20657     */
20658    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20659
20660    /**
20661     * @}
20662     */
20663
20664    /**
20665     * @defgroup Slideshow Slideshow
20666     *
20667     * @image html img/widget/slideshow/preview-00.png
20668     * @image latex img/widget/slideshow/preview-00.eps
20669     *
20670     * This widget, as the name indicates, is a pre-made image
20671     * slideshow panel, with API functions acting on (child) image
20672     * items presentation. Between those actions, are:
20673     * - advance to next/previous image
20674     * - select the style of image transition animation
20675     * - set the exhibition time for each image
20676     * - start/stop the slideshow
20677     *
20678     * The transition animations are defined in the widget's theme,
20679     * consequently new animations can be added without having to
20680     * update the widget's code.
20681     *
20682     * @section Slideshow_Items Slideshow items
20683     *
20684     * For slideshow items, just like for @ref Genlist "genlist" ones,
20685     * the user defines a @b classes, specifying functions that will be
20686     * called on the item's creation and deletion times.
20687     *
20688     * The #Elm_Slideshow_Item_Class structure contains the following
20689     * members:
20690     *
20691     * - @c func.get - When an item is displayed, this function is
20692     *   called, and it's where one should create the item object, de
20693     *   facto. For example, the object can be a pure Evas image object
20694     *   or an Elementary @ref Photocam "photocam" widget. See
20695     *   #SlideshowItemGetFunc.
20696     * - @c func.del - When an item is no more displayed, this function
20697     *   is called, where the user must delete any data associated to
20698     *   the item. See #SlideshowItemDelFunc.
20699     *
20700     * @section Slideshow_Caching Slideshow caching
20701     *
20702     * The slideshow provides facilities to have items adjacent to the
20703     * one being displayed <b>already "realized"</b> (i.e. loaded) for
20704     * you, so that the system does not have to decode image data
20705     * anymore at the time it has to actually switch images on its
20706     * viewport. The user is able to set the numbers of items to be
20707     * cached @b before and @b after the current item, in the widget's
20708     * item list.
20709     *
20710     * Smart events one can add callbacks for are:
20711     *
20712     * - @c "changed" - when the slideshow switches its view to a new
20713     *   item
20714     *
20715     * List of examples for the slideshow widget:
20716     * @li @ref slideshow_example
20717     */
20718
20719    /**
20720     * @addtogroup Slideshow
20721     * @{
20722     */
20723
20724    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20725    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20726    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
20727    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20728    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20729
20730    /**
20731     * @struct _Elm_Slideshow_Item_Class
20732     *
20733     * Slideshow item class definition. See @ref Slideshow_Items for
20734     * field details.
20735     */
20736    struct _Elm_Slideshow_Item_Class
20737      {
20738         struct _Elm_Slideshow_Item_Class_Func
20739           {
20740              SlideshowItemGetFunc get;
20741              SlideshowItemDelFunc del;
20742           } func;
20743      }; /**< #Elm_Slideshow_Item_Class member definitions */
20744
20745    /**
20746     * Add a new slideshow widget to the given parent Elementary
20747     * (container) object
20748     *
20749     * @param parent The parent object
20750     * @return A new slideshow widget handle or @c NULL, on errors
20751     *
20752     * This function inserts a new slideshow widget on the canvas.
20753     *
20754     * @ingroup Slideshow
20755     */
20756    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20757
20758    /**
20759     * Add (append) a new item in a given slideshow widget.
20760     *
20761     * @param obj The slideshow object
20762     * @param itc The item class for the item
20763     * @param data The item's data
20764     * @return A handle to the item added or @c NULL, on errors
20765     *
20766     * Add a new item to @p obj's internal list of items, appending it.
20767     * The item's class must contain the function really fetching the
20768     * image object to show for this item, which could be an Evas image
20769     * object or an Elementary photo, for example. The @p data
20770     * parameter is going to be passed to both class functions of the
20771     * item.
20772     *
20773     * @see #Elm_Slideshow_Item_Class
20774     * @see elm_slideshow_item_sorted_insert()
20775     *
20776     * @ingroup Slideshow
20777     */
20778    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20779
20780    /**
20781     * Insert a new item into the given slideshow widget, using the @p func
20782     * function to sort items (by item handles).
20783     *
20784     * @param obj The slideshow object
20785     * @param itc The item class for the item
20786     * @param data The item's data
20787     * @param func The comparing function to be used to sort slideshow
20788     * items <b>by #Elm_Slideshow_Item item handles</b>
20789     * @return Returns The slideshow item handle, on success, or
20790     * @c NULL, on errors
20791     *
20792     * Add a new item to @p obj's internal list of items, in a position
20793     * determined by the @p func comparing function. The item's class
20794     * must contain the function really fetching the image object to
20795     * show for this item, which could be an Evas image object or an
20796     * Elementary photo, for example. The @p data parameter is going to
20797     * be passed to both class functions of the item.
20798     *
20799     * @see #Elm_Slideshow_Item_Class
20800     * @see elm_slideshow_item_add()
20801     *
20802     * @ingroup Slideshow
20803     */
20804    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);
20805
20806    /**
20807     * Display a given slideshow widget's item, programmatically.
20808     *
20809     * @param obj The slideshow object
20810     * @param item The item to display on @p obj's viewport
20811     *
20812     * The change between the current item and @p item will use the
20813     * transition @p obj is set to use (@see
20814     * elm_slideshow_transition_set()).
20815     *
20816     * @ingroup Slideshow
20817     */
20818    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20819
20820    /**
20821     * Slide to the @b next item, in a given slideshow widget
20822     *
20823     * @param obj The slideshow object
20824     *
20825     * The sliding animation @p obj is set to use will be the
20826     * transition effect used, after this call is issued.
20827     *
20828     * @note If the end of the slideshow's internal list of items is
20829     * reached, it'll wrap around to the list's beginning, again.
20830     *
20831     * @ingroup Slideshow
20832     */
20833    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20834
20835    /**
20836     * Slide to the @b previous item, in a given slideshow widget
20837     *
20838     * @param obj The slideshow object
20839     *
20840     * The sliding animation @p obj is set to use will be the
20841     * transition effect used, after this call is issued.
20842     *
20843     * @note If the beginning of the slideshow's internal list of items
20844     * is reached, it'll wrap around to the list's end, again.
20845     *
20846     * @ingroup Slideshow
20847     */
20848    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20849
20850    /**
20851     * Returns the list of sliding transition/effect names available, for a
20852     * given slideshow widget.
20853     *
20854     * @param obj The slideshow object
20855     * @return The list of transitions (list of @b stringshared strings
20856     * as data)
20857     *
20858     * The transitions, which come from @p obj's theme, must be an EDC
20859     * data item named @c "transitions" on the theme file, with (prefix)
20860     * names of EDC programs actually implementing them.
20861     *
20862     * The available transitions for slideshows on the default theme are:
20863     * - @c "fade" - the current item fades out, while the new one
20864     *   fades in to the slideshow's viewport.
20865     * - @c "black_fade" - the current item fades to black, and just
20866     *   then, the new item will fade in.
20867     * - @c "horizontal" - the current item slides horizontally, until
20868     *   it gets out of the slideshow's viewport, while the new item
20869     *   comes from the left to take its place.
20870     * - @c "vertical" - the current item slides vertically, until it
20871     *   gets out of the slideshow's viewport, while the new item comes
20872     *   from the bottom to take its place.
20873     * - @c "square" - the new item starts to appear from the middle of
20874     *   the current one, but with a tiny size, growing until its
20875     *   target (full) size and covering the old one.
20876     *
20877     * @warning The stringshared strings get no new references
20878     * exclusive to the user grabbing the list, here, so if you'd like
20879     * to use them out of this call's context, you'd better @c
20880     * eina_stringshare_ref() them.
20881     *
20882     * @see elm_slideshow_transition_set()
20883     *
20884     * @ingroup Slideshow
20885     */
20886    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20887
20888    /**
20889     * Set the current slide transition/effect in use for a given
20890     * slideshow widget
20891     *
20892     * @param obj The slideshow object
20893     * @param transition The new transition's name string
20894     *
20895     * If @p transition is implemented in @p obj's theme (i.e., is
20896     * contained in the list returned by
20897     * elm_slideshow_transitions_get()), this new sliding effect will
20898     * be used on the widget.
20899     *
20900     * @see elm_slideshow_transitions_get() for more details
20901     *
20902     * @ingroup Slideshow
20903     */
20904    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20905
20906    /**
20907     * Get the current slide transition/effect in use for a given
20908     * slideshow widget
20909     *
20910     * @param obj The slideshow object
20911     * @return The current transition's name
20912     *
20913     * @see elm_slideshow_transition_set() for more details
20914     *
20915     * @ingroup Slideshow
20916     */
20917    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20918
20919    /**
20920     * Set the interval between each image transition on a given
20921     * slideshow widget, <b>and start the slideshow, itself</b>
20922     *
20923     * @param obj The slideshow object
20924     * @param timeout The new displaying timeout for images
20925     *
20926     * After this call, the slideshow widget will start cycling its
20927     * view, sequentially and automatically, with the images of the
20928     * items it has. The time between each new image displayed is going
20929     * to be @p timeout, in @b seconds. If a different timeout was set
20930     * previously and an slideshow was in progress, it will continue
20931     * with the new time between transitions, after this call.
20932     *
20933     * @note A value less than or equal to 0 on @p timeout will disable
20934     * the widget's internal timer, thus halting any slideshow which
20935     * could be happening on @p obj.
20936     *
20937     * @see elm_slideshow_timeout_get()
20938     *
20939     * @ingroup Slideshow
20940     */
20941    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20942
20943    /**
20944     * Get the interval set for image transitions on a given slideshow
20945     * widget.
20946     *
20947     * @param obj The slideshow object
20948     * @return Returns the timeout set on it
20949     *
20950     * @see elm_slideshow_timeout_set() for more details
20951     *
20952     * @ingroup Slideshow
20953     */
20954    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20955
20956    /**
20957     * Set if, after a slideshow is started, for a given slideshow
20958     * widget, its items should be displayed cyclically or not.
20959     *
20960     * @param obj The slideshow object
20961     * @param loop Use @c EINA_TRUE to make it cycle through items or
20962     * @c EINA_FALSE for it to stop at the end of @p obj's internal
20963     * list of items
20964     *
20965     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20966     * ignore what is set by this functions, i.e., they'll @b always
20967     * cycle through items. This affects only the "automatic"
20968     * slideshow, as set by elm_slideshow_timeout_set().
20969     *
20970     * @see elm_slideshow_loop_get()
20971     *
20972     * @ingroup Slideshow
20973     */
20974    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20975
20976    /**
20977     * Get if, after a slideshow is started, for a given slideshow
20978     * widget, its items are to be displayed cyclically or not.
20979     *
20980     * @param obj The slideshow object
20981     * @return @c EINA_TRUE, if the items in @p obj will be cycled
20982     * through or @c EINA_FALSE, otherwise
20983     *
20984     * @see elm_slideshow_loop_set() for more details
20985     *
20986     * @ingroup Slideshow
20987     */
20988    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20989
20990    /**
20991     * Remove all items from a given slideshow widget
20992     *
20993     * @param obj The slideshow object
20994     *
20995     * This removes (and deletes) all items in @p obj, leaving it
20996     * empty.
20997     *
20998     * @see elm_slideshow_item_del(), to remove just one item.
20999     *
21000     * @ingroup Slideshow
21001     */
21002    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21003
21004    /**
21005     * Get the internal list of items in a given slideshow widget.
21006     *
21007     * @param obj The slideshow object
21008     * @return The list of items (#Elm_Slideshow_Item as data) or
21009     * @c NULL on errors.
21010     *
21011     * This list is @b not to be modified in any way and must not be
21012     * freed. Use the list members with functions like
21013     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
21014     *
21015     * @warning This list is only valid until @p obj object's internal
21016     * items list is changed. It should be fetched again with another
21017     * call to this function when changes happen.
21018     *
21019     * @ingroup Slideshow
21020     */
21021    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21022
21023    /**
21024     * Delete a given item from a slideshow widget.
21025     *
21026     * @param item The slideshow item
21027     *
21028     * @ingroup Slideshow
21029     */
21030    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
21031
21032    /**
21033     * Return the data associated with a given slideshow item
21034     *
21035     * @param item The slideshow item
21036     * @return Returns the data associated to this item
21037     *
21038     * @ingroup Slideshow
21039     */
21040    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
21041
21042    /**
21043     * Returns the currently displayed item, in a given slideshow widget
21044     *
21045     * @param obj The slideshow object
21046     * @return A handle to the item being displayed in @p obj or
21047     * @c NULL, if none is (and on errors)
21048     *
21049     * @ingroup Slideshow
21050     */
21051    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21052
21053    /**
21054     * Get the real Evas object created to implement the view of a
21055     * given slideshow item
21056     *
21057     * @param item The slideshow item.
21058     * @return the Evas object implementing this item's view.
21059     *
21060     * This returns the actual Evas object used to implement the
21061     * specified slideshow item's view. This may be @c NULL, as it may
21062     * not have been created or may have been deleted, at any time, by
21063     * the slideshow. <b>Do not modify this object</b> (move, resize,
21064     * show, hide, etc.), as the slideshow is controlling it. This
21065     * function is for querying, emitting custom signals or hooking
21066     * lower level callbacks for events on that object. Do not delete
21067     * this object under any circumstances.
21068     *
21069     * @see elm_slideshow_item_data_get()
21070     *
21071     * @ingroup Slideshow
21072     */
21073    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
21074
21075    /**
21076     * Get the the item, in a given slideshow widget, placed at
21077     * position @p nth, in its internal items list
21078     *
21079     * @param obj The slideshow object
21080     * @param nth The number of the item to grab a handle to (0 being
21081     * the first)
21082     * @return The item stored in @p obj at position @p nth or @c NULL,
21083     * if there's no item with that index (and on errors)
21084     *
21085     * @ingroup Slideshow
21086     */
21087    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
21088
21089    /**
21090     * Set the current slide layout in use for a given slideshow widget
21091     *
21092     * @param obj The slideshow object
21093     * @param layout The new layout's name string
21094     *
21095     * If @p layout is implemented in @p obj's theme (i.e., is contained
21096     * in the list returned by elm_slideshow_layouts_get()), this new
21097     * images layout will be used on the widget.
21098     *
21099     * @see elm_slideshow_layouts_get() for more details
21100     *
21101     * @ingroup Slideshow
21102     */
21103    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
21104
21105    /**
21106     * Get the current slide layout in use for a given slideshow widget
21107     *
21108     * @param obj The slideshow object
21109     * @return The current layout's name
21110     *
21111     * @see elm_slideshow_layout_set() for more details
21112     *
21113     * @ingroup Slideshow
21114     */
21115    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21116
21117    /**
21118     * Returns the list of @b layout names available, for a given
21119     * slideshow widget.
21120     *
21121     * @param obj The slideshow object
21122     * @return The list of layouts (list of @b stringshared strings
21123     * as data)
21124     *
21125     * Slideshow layouts will change how the widget is to dispose each
21126     * image item in its viewport, with regard to cropping, scaling,
21127     * etc.
21128     *
21129     * The layouts, which come from @p obj's theme, must be an EDC
21130     * data item name @c "layouts" on the theme file, with (prefix)
21131     * names of EDC programs actually implementing them.
21132     *
21133     * The available layouts for slideshows on the default theme are:
21134     * - @c "fullscreen" - item images with original aspect, scaled to
21135     *   touch top and down slideshow borders or, if the image's heigh
21136     *   is not enough, left and right slideshow borders.
21137     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
21138     *   one, but always leaving 10% of the slideshow's dimensions of
21139     *   distance between the item image's borders and the slideshow
21140     *   borders, for each axis.
21141     *
21142     * @warning The stringshared strings get no new references
21143     * exclusive to the user grabbing the list, here, so if you'd like
21144     * to use them out of this call's context, you'd better @c
21145     * eina_stringshare_ref() them.
21146     *
21147     * @see elm_slideshow_layout_set()
21148     *
21149     * @ingroup Slideshow
21150     */
21151    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21152
21153    /**
21154     * Set the number of items to cache, on a given slideshow widget,
21155     * <b>before the current item</b>
21156     *
21157     * @param obj The slideshow object
21158     * @param count Number of items to cache before the current one
21159     *
21160     * The default value for this property is @c 2. See
21161     * @ref Slideshow_Caching "slideshow caching" for more details.
21162     *
21163     * @see elm_slideshow_cache_before_get()
21164     *
21165     * @ingroup Slideshow
21166     */
21167    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
21168
21169    /**
21170     * Retrieve the number of items to cache, on a given slideshow widget,
21171     * <b>before the current item</b>
21172     *
21173     * @param obj The slideshow object
21174     * @return The number of items set to be cached before the current one
21175     *
21176     * @see elm_slideshow_cache_before_set() for more details
21177     *
21178     * @ingroup Slideshow
21179     */
21180    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21181
21182    /**
21183     * Set the number of items to cache, on a given slideshow widget,
21184     * <b>after the current item</b>
21185     *
21186     * @param obj The slideshow object
21187     * @param count Number of items to cache after the current one
21188     *
21189     * The default value for this property is @c 2. See
21190     * @ref Slideshow_Caching "slideshow caching" for more details.
21191     *
21192     * @see elm_slideshow_cache_after_get()
21193     *
21194     * @ingroup Slideshow
21195     */
21196    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
21197
21198    /**
21199     * Retrieve the number of items to cache, on a given slideshow widget,
21200     * <b>after the current item</b>
21201     *
21202     * @param obj The slideshow object
21203     * @return The number of items set to be cached after the current one
21204     *
21205     * @see elm_slideshow_cache_after_set() for more details
21206     *
21207     * @ingroup Slideshow
21208     */
21209    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21210
21211    /**
21212     * Get the number of items stored in a given slideshow widget
21213     *
21214     * @param obj The slideshow object
21215     * @return The number of items on @p obj, at the moment of this call
21216     *
21217     * @ingroup Slideshow
21218     */
21219    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21220
21221    /**
21222     * @}
21223     */
21224
21225    /**
21226     * @defgroup Fileselector File Selector
21227     *
21228     * @image html img/widget/fileselector/preview-00.png
21229     * @image latex img/widget/fileselector/preview-00.eps
21230     *
21231     * A file selector is a widget that allows a user to navigate
21232     * through a file system, reporting file selections back via its
21233     * API.
21234     *
21235     * It contains shortcut buttons for home directory (@c ~) and to
21236     * jump one directory upwards (..), as well as cancel/ok buttons to
21237     * confirm/cancel a given selection. After either one of those two
21238     * former actions, the file selector will issue its @c "done" smart
21239     * callback.
21240     *
21241     * There's a text entry on it, too, showing the name of the current
21242     * selection. There's the possibility of making it editable, so it
21243     * is useful on file saving dialogs on applications, where one
21244     * gives a file name to save contents to, in a given directory in
21245     * the system. This custom file name will be reported on the @c
21246     * "done" smart callback (explained in sequence).
21247     *
21248     * Finally, it has a view to display file system items into in two
21249     * possible forms:
21250     * - list
21251     * - grid
21252     *
21253     * If Elementary is built with support of the Ethumb thumbnailing
21254     * library, the second form of view will display preview thumbnails
21255     * of files which it supports.
21256     *
21257     * Smart callbacks one can register to:
21258     *
21259     * - @c "selected" - the user has clicked on a file (when not in
21260     *      folders-only mode) or directory (when in folders-only mode)
21261     * - @c "directory,open" - the list has been populated with new
21262     *      content (@c event_info is a pointer to the directory's
21263     *      path, a @b stringshared string)
21264     * - @c "done" - the user has clicked on the "ok" or "cancel"
21265     *      buttons (@c event_info is a pointer to the selection's
21266     *      path, a @b stringshared string)
21267     *
21268     * Here is an example on its usage:
21269     * @li @ref fileselector_example
21270     */
21271
21272    /**
21273     * @addtogroup Fileselector
21274     * @{
21275     */
21276
21277    /**
21278     * Defines how a file selector widget is to layout its contents
21279     * (file system entries).
21280     */
21281    typedef enum _Elm_Fileselector_Mode
21282      {
21283         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
21284         ELM_FILESELECTOR_GRID, /**< layout as a grid */
21285         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
21286      } Elm_Fileselector_Mode;
21287
21288    /**
21289     * Add a new file selector widget to the given parent Elementary
21290     * (container) object
21291     *
21292     * @param parent The parent object
21293     * @return a new file selector widget handle or @c NULL, on errors
21294     *
21295     * This function inserts a new file selector widget on the canvas.
21296     *
21297     * @ingroup Fileselector
21298     */
21299    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21300
21301    /**
21302     * Enable/disable the file name entry box where the user can type
21303     * in a name for a file, in a given file selector widget
21304     *
21305     * @param obj The file selector object
21306     * @param is_save @c EINA_TRUE to make the file selector a "saving
21307     * dialog", @c EINA_FALSE otherwise
21308     *
21309     * Having the entry editable is useful on file saving dialogs on
21310     * applications, where one gives a file name to save contents to,
21311     * in a given directory in the system. This custom file name will
21312     * be reported on the @c "done" smart callback.
21313     *
21314     * @see elm_fileselector_is_save_get()
21315     *
21316     * @ingroup Fileselector
21317     */
21318    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
21319
21320    /**
21321     * Get whether the given file selector is in "saving dialog" mode
21322     *
21323     * @param obj The file selector object
21324     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
21325     * mode, @c EINA_FALSE otherwise (and on errors)
21326     *
21327     * @see elm_fileselector_is_save_set() for more details
21328     *
21329     * @ingroup Fileselector
21330     */
21331    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21332
21333    /**
21334     * Enable/disable folder-only view for a given file selector widget
21335     *
21336     * @param obj The file selector object
21337     * @param only @c EINA_TRUE to make @p obj only display
21338     * directories, @c EINA_FALSE to make files to be displayed in it
21339     * too
21340     *
21341     * If enabled, the widget's view will only display folder items,
21342     * naturally.
21343     *
21344     * @see elm_fileselector_folder_only_get()
21345     *
21346     * @ingroup Fileselector
21347     */
21348    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
21349
21350    /**
21351     * Get whether folder-only view is set for a given file selector
21352     * widget
21353     *
21354     * @param obj The file selector object
21355     * @return only @c EINA_TRUE if @p obj is only displaying
21356     * directories, @c EINA_FALSE if files are being displayed in it
21357     * too (and on errors)
21358     *
21359     * @see elm_fileselector_folder_only_get()
21360     *
21361     * @ingroup Fileselector
21362     */
21363    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21364
21365    /**
21366     * Enable/disable the "ok" and "cancel" buttons on a given file
21367     * selector widget
21368     *
21369     * @param obj The file selector object
21370     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21371     *
21372     * @note A file selector without those buttons will never emit the
21373     * @c "done" smart event, and is only usable if one is just hooking
21374     * to the other two events.
21375     *
21376     * @see elm_fileselector_buttons_ok_cancel_get()
21377     *
21378     * @ingroup Fileselector
21379     */
21380    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21381
21382    /**
21383     * Get whether the "ok" and "cancel" buttons on a given file
21384     * selector widget are being shown.
21385     *
21386     * @param obj The file selector object
21387     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21388     * otherwise (and on errors)
21389     *
21390     * @see elm_fileselector_buttons_ok_cancel_set() for more details
21391     *
21392     * @ingroup Fileselector
21393     */
21394    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21395
21396    /**
21397     * Enable/disable a tree view in the given file selector widget,
21398     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21399     *
21400     * @param obj The file selector object
21401     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21402     * disable
21403     *
21404     * In a tree view, arrows are created on the sides of directories,
21405     * allowing them to expand in place.
21406     *
21407     * @note If it's in other mode, the changes made by this function
21408     * will only be visible when one switches back to "list" mode.
21409     *
21410     * @see elm_fileselector_expandable_get()
21411     *
21412     * @ingroup Fileselector
21413     */
21414    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21415
21416    /**
21417     * Get whether tree view is enabled for the given file selector
21418     * widget
21419     *
21420     * @param obj The file selector object
21421     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21422     * otherwise (and or errors)
21423     *
21424     * @see elm_fileselector_expandable_set() for more details
21425     *
21426     * @ingroup Fileselector
21427     */
21428    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21429
21430    /**
21431     * Set, programmatically, the @b directory that a given file
21432     * selector widget will display contents from
21433     *
21434     * @param obj The file selector object
21435     * @param path The path to display in @p obj
21436     *
21437     * This will change the @b directory that @p obj is displaying. It
21438     * will also clear the text entry area on the @p obj object, which
21439     * displays select files' names.
21440     *
21441     * @see elm_fileselector_path_get()
21442     *
21443     * @ingroup Fileselector
21444     */
21445    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21446
21447    /**
21448     * Get the parent directory's path that a given file selector
21449     * widget is displaying
21450     *
21451     * @param obj The file selector object
21452     * @return The (full) path of the directory the file selector is
21453     * displaying, a @b stringshared string
21454     *
21455     * @see elm_fileselector_path_set()
21456     *
21457     * @ingroup Fileselector
21458     */
21459    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21460
21461    /**
21462     * Set, programmatically, the currently selected file/directory in
21463     * the given file selector widget
21464     *
21465     * @param obj The file selector object
21466     * @param path The (full) path to a file or directory
21467     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21468     * latter case occurs if the directory or file pointed to do not
21469     * exist.
21470     *
21471     * @see elm_fileselector_selected_get()
21472     *
21473     * @ingroup Fileselector
21474     */
21475    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21476
21477    /**
21478     * Get the currently selected item's (full) path, in the given file
21479     * selector widget
21480     *
21481     * @param obj The file selector object
21482     * @return The absolute path of the selected item, a @b
21483     * stringshared string
21484     *
21485     * @note Custom editions on @p obj object's text entry, if made,
21486     * will appear on the return string of this function, naturally.
21487     *
21488     * @see elm_fileselector_selected_set() for more details
21489     *
21490     * @ingroup Fileselector
21491     */
21492    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21493
21494    /**
21495     * Set the mode in which a given file selector widget will display
21496     * (layout) file system entries in its view
21497     *
21498     * @param obj The file selector object
21499     * @param mode The mode of the fileselector, being it one of
21500     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21501     * first one, naturally, will display the files in a list. The
21502     * latter will make the widget to display its entries in a grid
21503     * form.
21504     *
21505     * @note By using elm_fileselector_expandable_set(), the user may
21506     * trigger a tree view for that list.
21507     *
21508     * @note If Elementary is built with support of the Ethumb
21509     * thumbnailing library, the second form of view will display
21510     * preview thumbnails of files which it supports. You must have
21511     * elm_need_ethumb() called in your Elementary for thumbnailing to
21512     * work, though.
21513     *
21514     * @see elm_fileselector_expandable_set().
21515     * @see elm_fileselector_mode_get().
21516     *
21517     * @ingroup Fileselector
21518     */
21519    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21520
21521    /**
21522     * Get the mode in which a given file selector widget is displaying
21523     * (layouting) file system entries in its view
21524     *
21525     * @param obj The fileselector object
21526     * @return The mode in which the fileselector is at
21527     *
21528     * @see elm_fileselector_mode_set() for more details
21529     *
21530     * @ingroup Fileselector
21531     */
21532    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21533
21534    /**
21535     * @}
21536     */
21537
21538    /**
21539     * @defgroup Progressbar Progress bar
21540     *
21541     * The progress bar is a widget for visually representing the
21542     * progress status of a given job/task.
21543     *
21544     * A progress bar may be horizontal or vertical. It may display an
21545     * icon besides it, as well as primary and @b units labels. The
21546     * former is meant to label the widget as a whole, while the
21547     * latter, which is formatted with floating point values (and thus
21548     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21549     * units"</c>), is meant to label the widget's <b>progress
21550     * value</b>. Label, icon and unit strings/objects are @b optional
21551     * for progress bars.
21552     *
21553     * A progress bar may be @b inverted, in which state it gets its
21554     * values inverted, with high values being on the left or top and
21555     * low values on the right or bottom, as opposed to normally have
21556     * the low values on the former and high values on the latter,
21557     * respectively, for horizontal and vertical modes.
21558     *
21559     * The @b span of the progress, as set by
21560     * elm_progressbar_span_size_set(), is its length (horizontally or
21561     * vertically), unless one puts size hints on the widget to expand
21562     * on desired directions, by any container. That length will be
21563     * scaled by the object or applications scaling factor. At any
21564     * point code can query the progress bar for its value with
21565     * elm_progressbar_value_get().
21566     *
21567     * Available widget styles for progress bars:
21568     * - @c "default"
21569     * - @c "wheel" (simple style, no text, no progression, only
21570     *      "pulse" effect is available)
21571     *
21572     * Default contents parts of the progressbar widget that you can use for are:
21573     * @li "icon" - An icon of the progressbar
21574     *
21575     * Here is an example on its usage:
21576     * @li @ref progressbar_example
21577     */
21578
21579    /**
21580     * Add a new progress bar widget to the given parent Elementary
21581     * (container) object
21582     *
21583     * @param parent The parent object
21584     * @return a new progress bar widget handle or @c NULL, on errors
21585     *
21586     * This function inserts a new progress bar widget on the canvas.
21587     *
21588     * @ingroup Progressbar
21589     */
21590    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21591
21592    /**
21593     * Set whether a given progress bar widget is at "pulsing mode" or
21594     * not.
21595     *
21596     * @param obj The progress bar object
21597     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21598     * @c EINA_FALSE to put it back to its default one
21599     *
21600     * By default, progress bars will display values from the low to
21601     * high value boundaries. There are, though, contexts in which the
21602     * state of progression of a given task is @b unknown.  For those,
21603     * one can set a progress bar widget to a "pulsing state", to give
21604     * the user an idea that some computation is being held, but
21605     * without exact progress values. In the default theme it will
21606     * animate its bar with the contents filling in constantly and back
21607     * to non-filled, in a loop. To start and stop this pulsing
21608     * animation, one has to explicitly call elm_progressbar_pulse().
21609     *
21610     * @see elm_progressbar_pulse_get()
21611     * @see elm_progressbar_pulse()
21612     *
21613     * @ingroup Progressbar
21614     */
21615    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21616
21617    /**
21618     * Get whether a given progress bar widget is at "pulsing mode" or
21619     * not.
21620     *
21621     * @param obj The progress bar object
21622     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21623     * if it's in the default one (and on errors)
21624     *
21625     * @ingroup Progressbar
21626     */
21627    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21628
21629    /**
21630     * Start/stop a given progress bar "pulsing" animation, if its
21631     * under that mode
21632     *
21633     * @param obj The progress bar object
21634     * @param state @c EINA_TRUE, to @b start the pulsing animation,
21635     * @c EINA_FALSE to @b stop it
21636     *
21637     * @note This call won't do anything if @p obj is not under "pulsing mode".
21638     *
21639     * @see elm_progressbar_pulse_set() for more details.
21640     *
21641     * @ingroup Progressbar
21642     */
21643    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21644
21645    /**
21646     * Set the progress value (in percentage) on a given progress bar
21647     * widget
21648     *
21649     * @param obj The progress bar object
21650     * @param val The progress value (@b must be between @c 0.0 and @c
21651     * 1.0)
21652     *
21653     * Use this call to set progress bar levels.
21654     *
21655     * @note If you passes a value out of the specified range for @p
21656     * val, it will be interpreted as the @b closest of the @b boundary
21657     * values in the range.
21658     *
21659     * @ingroup Progressbar
21660     */
21661    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21662
21663    /**
21664     * Get the progress value (in percentage) on a given progress bar
21665     * widget
21666     *
21667     * @param obj The progress bar object
21668     * @return The value of the progressbar
21669     *
21670     * @see elm_progressbar_value_set() for more details
21671     *
21672     * @ingroup Progressbar
21673     */
21674    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21675
21676    /**
21677     * Set the label of a given progress bar widget
21678     *
21679     * @param obj The progress bar object
21680     * @param label The text label string, in UTF-8
21681     *
21682     * @ingroup Progressbar
21683     * @deprecated use elm_object_text_set() instead.
21684     */
21685    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21686
21687    /**
21688     * Get the label of a given progress bar widget
21689     *
21690     * @param obj The progressbar object
21691     * @return The text label string, in UTF-8
21692     *
21693     * @ingroup Progressbar
21694     * @deprecated use elm_object_text_set() instead.
21695     */
21696    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21697
21698    /**
21699     * Set the icon object of a given progress bar widget
21700     *
21701     * @param obj The progress bar object
21702     * @param icon The icon object
21703     *
21704     * Use this call to decorate @p obj with an icon next to it.
21705     *
21706     * @note Once the icon object is set, a previously set one will be
21707     * deleted. If you want to keep that old content object, use the
21708     * elm_progressbar_icon_unset() function.
21709     *
21710     * @see elm_progressbar_icon_get()
21711     * @deprecated use elm_object_part_content_set() instead.
21712     *
21713     * @ingroup Progressbar
21714     */
21715    EINA_DEPRECATED EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21716
21717    /**
21718     * Retrieve the icon object set for a given progress bar widget
21719     *
21720     * @param obj The progress bar object
21721     * @return The icon object's handle, if @p obj had one set, or @c NULL,
21722     * otherwise (and on errors)
21723     *
21724     * @see elm_progressbar_icon_set() for more details
21725     * @deprecated use elm_object_part_content_get() instead.
21726     *
21727     * @ingroup Progressbar
21728     */
21729    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21730
21731    /**
21732     * Unset an icon set on a given progress bar widget
21733     *
21734     * @param obj The progress bar object
21735     * @return The icon object that was being used, if any was set, or
21736     * @c NULL, otherwise (and on errors)
21737     *
21738     * This call will unparent and return the icon object which was set
21739     * for this widget, previously, on success.
21740     *
21741     * @see elm_progressbar_icon_set() for more details
21742     * @deprecated use elm_object_part_content_unset() instead.
21743     *
21744     * @ingroup Progressbar
21745     */
21746    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21747
21748    /**
21749     * Set the (exact) length of the bar region of a given progress bar
21750     * widget
21751     *
21752     * @param obj The progress bar object
21753     * @param size The length of the progress bar's bar region
21754     *
21755     * This sets the minimum width (when in horizontal mode) or height
21756     * (when in vertical mode) of the actual bar area of the progress
21757     * bar @p obj. This in turn affects the object's minimum size. Use
21758     * this when you're not setting other size hints expanding on the
21759     * given direction (like weight and alignment hints) and you would
21760     * like it to have a specific size.
21761     *
21762     * @note Icon, label and unit text around @p obj will require their
21763     * own space, which will make @p obj to require more the @p size,
21764     * actually.
21765     *
21766     * @see elm_progressbar_span_size_get()
21767     *
21768     * @ingroup Progressbar
21769     */
21770    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21771
21772    /**
21773     * Get the length set for the bar region of a given progress bar
21774     * widget
21775     *
21776     * @param obj The progress bar object
21777     * @return The length of the progress bar's bar region
21778     *
21779     * If that size was not set previously, with
21780     * elm_progressbar_span_size_set(), this call will return @c 0.
21781     *
21782     * @ingroup Progressbar
21783     */
21784    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21785
21786    /**
21787     * Set the format string for a given progress bar widget's units
21788     * label
21789     *
21790     * @param obj The progress bar object
21791     * @param format The format string for @p obj's units label
21792     *
21793     * If @c NULL is passed on @p format, it will make @p obj's units
21794     * area to be hidden completely. If not, it'll set the <b>format
21795     * string</b> for the units label's @b text. The units label is
21796     * provided a floating point value, so the units text is up display
21797     * at most one floating point falue. Note that the units label is
21798     * optional. Use a format string such as "%1.2f meters" for
21799     * example.
21800     *
21801     * @note The default format string for a progress bar is an integer
21802     * percentage, as in @c "%.0f %%".
21803     *
21804     * @see elm_progressbar_unit_format_get()
21805     *
21806     * @ingroup Progressbar
21807     */
21808    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21809
21810    /**
21811     * Retrieve the format string set for a given progress bar widget's
21812     * units label
21813     *
21814     * @param obj The progress bar object
21815     * @return The format set string for @p obj's units label or
21816     * @c NULL, if none was set (and on errors)
21817     *
21818     * @see elm_progressbar_unit_format_set() for more details
21819     *
21820     * @ingroup Progressbar
21821     */
21822    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21823
21824    /**
21825     * Set the orientation of a given progress bar widget
21826     *
21827     * @param obj The progress bar object
21828     * @param horizontal Use @c EINA_TRUE to make @p obj to be
21829     * @b horizontal, @c EINA_FALSE to make it @b vertical
21830     *
21831     * Use this function to change how your progress bar is to be
21832     * disposed: vertically or horizontally.
21833     *
21834     * @see elm_progressbar_horizontal_get()
21835     *
21836     * @ingroup Progressbar
21837     */
21838    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21839
21840    /**
21841     * Retrieve the orientation of a given progress bar widget
21842     *
21843     * @param obj The progress bar object
21844     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21845     * @c EINA_FALSE if it's @b vertical (and on errors)
21846     *
21847     * @see elm_progressbar_horizontal_set() for more details
21848     *
21849     * @ingroup Progressbar
21850     */
21851    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21852
21853    /**
21854     * Invert a given progress bar widget's displaying values order
21855     *
21856     * @param obj The progress bar object
21857     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21858     * @c EINA_FALSE to bring it back to default, non-inverted values.
21859     *
21860     * A progress bar may be @b inverted, in which state it gets its
21861     * values inverted, with high values being on the left or top and
21862     * low values on the right or bottom, as opposed to normally have
21863     * the low values on the former and high values on the latter,
21864     * respectively, for horizontal and vertical modes.
21865     *
21866     * @see elm_progressbar_inverted_get()
21867     *
21868     * @ingroup Progressbar
21869     */
21870    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21871
21872    /**
21873     * Get whether a given progress bar widget's displaying values are
21874     * inverted or not
21875     *
21876     * @param obj The progress bar object
21877     * @return @c EINA_TRUE, if @p obj has inverted values,
21878     * @c EINA_FALSE otherwise (and on errors)
21879     *
21880     * @see elm_progressbar_inverted_set() for more details
21881     *
21882     * @ingroup Progressbar
21883     */
21884    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21885
21886    /**
21887     * @defgroup Separator Separator
21888     *
21889     * @brief Separator is a very thin object used to separate other objects.
21890     *
21891     * A separator can be vertical or horizontal.
21892     *
21893     * @ref tutorial_separator is a good example of how to use a separator.
21894     * @{
21895     */
21896    /**
21897     * @brief Add a separator object to @p parent
21898     *
21899     * @param parent The parent object
21900     *
21901     * @return The separator object, or NULL upon failure
21902     */
21903    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21904    /**
21905     * @brief Set the horizontal mode of a separator object
21906     *
21907     * @param obj The separator object
21908     * @param horizontal If true, the separator is horizontal
21909     */
21910    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21911    /**
21912     * @brief Get the horizontal mode of a separator object
21913     *
21914     * @param obj The separator object
21915     * @return If true, the separator is horizontal
21916     *
21917     * @see elm_separator_horizontal_set()
21918     */
21919    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21920    /**
21921     * @}
21922     */
21923
21924    /**
21925     * @defgroup Spinner Spinner
21926     * @ingroup Elementary
21927     *
21928     * @image html img/widget/spinner/preview-00.png
21929     * @image latex img/widget/spinner/preview-00.eps
21930     *
21931     * A spinner is a widget which allows the user to increase or decrease
21932     * numeric values using arrow buttons, or edit values directly, clicking
21933     * over it and typing the new value.
21934     *
21935     * By default the spinner will not wrap and has a label
21936     * of "%.0f" (just showing the integer value of the double).
21937     *
21938     * A spinner has a label that is formatted with floating
21939     * point values and thus accepts a printf-style format string, like
21940     * ā€œ%1.2f unitsā€.
21941     *
21942     * It also allows specific values to be replaced by pre-defined labels.
21943     *
21944     * Smart callbacks one can register to:
21945     *
21946     * - "changed" - Whenever the spinner value is changed.
21947     * - "delay,changed" - A short time after the value is changed by the user.
21948     *    This will be called only when the user stops dragging for a very short
21949     *    period or when they release their finger/mouse, so it avoids possibly
21950     *    expensive reactions to the value change.
21951     *
21952     * Available styles for it:
21953     * - @c "default";
21954     * - @c "vertical": up/down buttons at the right side and text left aligned.
21955     *
21956     * Here is an example on its usage:
21957     * @ref spinner_example
21958     */
21959
21960    /**
21961     * @addtogroup Spinner
21962     * @{
21963     */
21964
21965    /**
21966     * Add a new spinner widget to the given parent Elementary
21967     * (container) object.
21968     *
21969     * @param parent The parent object.
21970     * @return a new spinner widget handle or @c NULL, on errors.
21971     *
21972     * This function inserts a new spinner widget on the canvas.
21973     *
21974     * @ingroup Spinner
21975     *
21976     */
21977    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21978
21979    /**
21980     * Set the format string of the displayed label.
21981     *
21982     * @param obj The spinner object.
21983     * @param fmt The format string for the label display.
21984     *
21985     * If @c NULL, this sets the format to "%.0f". If not it sets the format
21986     * string for the label text. The label text is provided a floating point
21987     * value, so the label text can display up to 1 floating point value.
21988     * Note that this is optional.
21989     *
21990     * Use a format string such as "%1.2f meters" for example, and it will
21991     * display values like: "3.14 meters" for a value equal to 3.14159.
21992     *
21993     * Default is "%0.f".
21994     *
21995     * @see elm_spinner_label_format_get()
21996     *
21997     * @ingroup Spinner
21998     */
21999    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
22000
22001    /**
22002     * Get the label format of the spinner.
22003     *
22004     * @param obj The spinner object.
22005     * @return The text label format string in UTF-8.
22006     *
22007     * @see elm_spinner_label_format_set() for details.
22008     *
22009     * @ingroup Spinner
22010     */
22011    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22012
22013    /**
22014     * Set the minimum and maximum values for the spinner.
22015     *
22016     * @param obj The spinner object.
22017     * @param min The minimum value.
22018     * @param max The maximum value.
22019     *
22020     * Define the allowed range of values to be selected by the user.
22021     *
22022     * If actual value is less than @p min, it will be updated to @p min. If it
22023     * is bigger then @p max, will be updated to @p max. Actual value can be
22024     * get with elm_spinner_value_get().
22025     *
22026     * By default, min is equal to 0, and max is equal to 100.
22027     *
22028     * @warning Maximum must be greater than minimum.
22029     *
22030     * @see elm_spinner_min_max_get()
22031     *
22032     * @ingroup Spinner
22033     */
22034    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
22035
22036    /**
22037     * Get the minimum and maximum values of the spinner.
22038     *
22039     * @param obj The spinner object.
22040     * @param min Pointer where to store the minimum value.
22041     * @param max Pointer where to store the maximum value.
22042     *
22043     * @note If only one value is needed, the other pointer can be passed
22044     * as @c NULL.
22045     *
22046     * @see elm_spinner_min_max_set() for details.
22047     *
22048     * @ingroup Spinner
22049     */
22050    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
22051
22052    /**
22053     * Set the step used to increment or decrement the spinner value.
22054     *
22055     * @param obj The spinner object.
22056     * @param step The step value.
22057     *
22058     * This value will be incremented or decremented to the displayed value.
22059     * It will be incremented while the user keep right or top arrow pressed,
22060     * and will be decremented while the user keep left or bottom arrow pressed.
22061     *
22062     * The interval to increment / decrement can be set with
22063     * elm_spinner_interval_set().
22064     *
22065     * By default step value is equal to 1.
22066     *
22067     * @see elm_spinner_step_get()
22068     *
22069     * @ingroup Spinner
22070     */
22071    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
22072
22073    /**
22074     * Get the step used to increment or decrement the spinner value.
22075     *
22076     * @param obj The spinner object.
22077     * @return The step value.
22078     *
22079     * @see elm_spinner_step_get() for more details.
22080     *
22081     * @ingroup Spinner
22082     */
22083    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22084
22085    /**
22086     * Set the value the spinner displays.
22087     *
22088     * @param obj The spinner object.
22089     * @param val The value to be displayed.
22090     *
22091     * Value will be presented on the label following format specified with
22092     * elm_spinner_format_set().
22093     *
22094     * @warning The value must to be between min and max values. This values
22095     * are set by elm_spinner_min_max_set().
22096     *
22097     * @see elm_spinner_value_get().
22098     * @see elm_spinner_format_set().
22099     * @see elm_spinner_min_max_set().
22100     *
22101     * @ingroup Spinner
22102     */
22103    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
22104
22105    /**
22106     * Get the value displayed by the spinner.
22107     *
22108     * @param obj The spinner object.
22109     * @return The value displayed.
22110     *
22111     * @see elm_spinner_value_set() for details.
22112     *
22113     * @ingroup Spinner
22114     */
22115    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22116
22117    /**
22118     * Set whether the spinner should wrap when it reaches its
22119     * minimum or maximum value.
22120     *
22121     * @param obj The spinner object.
22122     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
22123     * disable it.
22124     *
22125     * Disabled by default. If disabled, when the user tries to increment the
22126     * value,
22127     * but displayed value plus step value is bigger than maximum value,
22128     * the spinner
22129     * won't allow it. The same happens when the user tries to decrement it,
22130     * but the value less step is less than minimum value.
22131     *
22132     * When wrap is enabled, in such situations it will allow these changes,
22133     * but will get the value that would be less than minimum and subtracts
22134     * from maximum. Or add the value that would be more than maximum to
22135     * the minimum.
22136     *
22137     * E.g.:
22138     * @li min value = 10
22139     * @li max value = 50
22140     * @li step value = 20
22141     * @li displayed value = 20
22142     *
22143     * When the user decrement value (using left or bottom arrow), it will
22144     * displays @c 40, because max - (min - (displayed - step)) is
22145     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
22146     *
22147     * @see elm_spinner_wrap_get().
22148     *
22149     * @ingroup Spinner
22150     */
22151    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
22152
22153    /**
22154     * Get whether the spinner should wrap when it reaches its
22155     * minimum or maximum value.
22156     *
22157     * @param obj The spinner object
22158     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
22159     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22160     *
22161     * @see elm_spinner_wrap_set() for details.
22162     *
22163     * @ingroup Spinner
22164     */
22165    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22166
22167    /**
22168     * Set whether the spinner can be directly edited by the user or not.
22169     *
22170     * @param obj The spinner object.
22171     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
22172     * don't allow users to edit it directly.
22173     *
22174     * Spinner objects can have edition @b disabled, in which state they will
22175     * be changed only by arrows.
22176     * Useful for contexts
22177     * where you don't want your users to interact with it writting the value.
22178     * Specially
22179     * when using special values, the user can see real value instead
22180     * of special label on edition.
22181     *
22182     * It's enabled by default.
22183     *
22184     * @see elm_spinner_editable_get()
22185     *
22186     * @ingroup Spinner
22187     */
22188    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22189
22190    /**
22191     * Get whether the spinner can be directly edited by the user or not.
22192     *
22193     * @param obj The spinner object.
22194     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
22195     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22196     *
22197     * @see elm_spinner_editable_set() for details.
22198     *
22199     * @ingroup Spinner
22200     */
22201    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22202
22203    /**
22204     * Set a special string to display in the place of the numerical value.
22205     *
22206     * @param obj The spinner object.
22207     * @param value The value to be replaced.
22208     * @param label The label to be used.
22209     *
22210     * It's useful for cases when a user should select an item that is
22211     * better indicated by a label than a value. For example, weekdays or months.
22212     *
22213     * E.g.:
22214     * @code
22215     * sp = elm_spinner_add(win);
22216     * elm_spinner_min_max_set(sp, 1, 3);
22217     * elm_spinner_special_value_add(sp, 1, "January");
22218     * elm_spinner_special_value_add(sp, 2, "February");
22219     * elm_spinner_special_value_add(sp, 3, "March");
22220     * evas_object_show(sp);
22221     * @endcode
22222     *
22223     * @ingroup Spinner
22224     */
22225    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
22226
22227    /**
22228     * Set the interval on time updates for an user mouse button hold
22229     * on spinner widgets' arrows.
22230     *
22231     * @param obj The spinner object.
22232     * @param interval The (first) interval value in seconds.
22233     *
22234     * This interval value is @b decreased while the user holds the
22235     * mouse pointer either incrementing or decrementing spinner's value.
22236     *
22237     * This helps the user to get to a given value distant from the
22238     * current one easier/faster, as it will start to change quicker and
22239     * quicker on mouse button holds.
22240     *
22241     * The calculation for the next change interval value, starting from
22242     * the one set with this call, is the previous interval divided by
22243     * @c 1.05, so it decreases a little bit.
22244     *
22245     * The default starting interval value for automatic changes is
22246     * @c 0.85 seconds.
22247     *
22248     * @see elm_spinner_interval_get()
22249     *
22250     * @ingroup Spinner
22251     */
22252    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
22253
22254    /**
22255     * Get the interval on time updates for an user mouse button hold
22256     * on spinner widgets' arrows.
22257     *
22258     * @param obj The spinner object.
22259     * @return The (first) interval value, in seconds, set on it.
22260     *
22261     * @see elm_spinner_interval_set() for more details.
22262     *
22263     * @ingroup Spinner
22264     */
22265    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22266
22267    /**
22268     * @}
22269     */
22270
22271    /**
22272     * @defgroup Index Index
22273     *
22274     * @image html img/widget/index/preview-00.png
22275     * @image latex img/widget/index/preview-00.eps
22276     *
22277     * An index widget gives you an index for fast access to whichever
22278     * group of other UI items one might have. It's a list of text
22279     * items (usually letters, for alphabetically ordered access).
22280     *
22281     * Index widgets are by default hidden and just appear when the
22282     * user clicks over it's reserved area in the canvas. In its
22283     * default theme, it's an area one @ref Fingers "finger" wide on
22284     * the right side of the index widget's container.
22285     *
22286     * When items on the index are selected, smart callbacks get
22287     * called, so that its user can make other container objects to
22288     * show a given area or child object depending on the index item
22289     * selected. You'd probably be using an index together with @ref
22290     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
22291     * "general grids".
22292     *
22293     * Smart events one  can add callbacks for are:
22294     * - @c "changed" - When the selected index item changes. @c
22295     *      event_info is the selected item's data pointer.
22296     * - @c "delay,changed" - When the selected index item changes, but
22297     *      after a small idling period. @c event_info is the selected
22298     *      item's data pointer.
22299     * - @c "selected" - When the user releases a mouse button and
22300     *      selects an item. @c event_info is the selected item's data
22301     *      pointer.
22302     * - @c "level,up" - when the user moves a finger from the first
22303     *      level to the second level
22304     * - @c "level,down" - when the user moves a finger from the second
22305     *      level to the first level
22306     *
22307     * The @c "delay,changed" event is so that it'll wait a small time
22308     * before actually reporting those events and, moreover, just the
22309     * last event happening on those time frames will actually be
22310     * reported.
22311     *
22312     * Here are some examples on its usage:
22313     * @li @ref index_example_01
22314     * @li @ref index_example_02
22315     */
22316
22317    /**
22318     * @addtogroup Index
22319     * @{
22320     */
22321
22322    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
22323
22324    /**
22325     * Add a new index widget to the given parent Elementary
22326     * (container) object
22327     *
22328     * @param parent The parent object
22329     * @return a new index widget handle or @c NULL, on errors
22330     *
22331     * This function inserts a new index widget on the canvas.
22332     *
22333     * @ingroup Index
22334     */
22335    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22336
22337    /**
22338     * Set whether a given index widget is or not visible,
22339     * programatically.
22340     *
22341     * @param obj The index object
22342     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
22343     *
22344     * Not to be confused with visible as in @c evas_object_show() --
22345     * visible with regard to the widget's auto hiding feature.
22346     *
22347     * @see elm_index_active_get()
22348     *
22349     * @ingroup Index
22350     */
22351    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
22352
22353    /**
22354     * Get whether a given index widget is currently visible or not.
22355     *
22356     * @param obj The index object
22357     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
22358     *
22359     * @see elm_index_active_set() for more details
22360     *
22361     * @ingroup Index
22362     */
22363    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22364
22365    /**
22366     * Set the items level for a given index widget.
22367     *
22368     * @param obj The index object.
22369     * @param level @c 0 or @c 1, the currently implemented levels.
22370     *
22371     * @see elm_index_item_level_get()
22372     *
22373     * @ingroup Index
22374     */
22375    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22376
22377    /**
22378     * Get the items level set for a given index widget.
22379     *
22380     * @param obj The index object.
22381     * @return @c 0 or @c 1, which are the levels @p obj might be at.
22382     *
22383     * @see elm_index_item_level_set() for more information
22384     *
22385     * @ingroup Index
22386     */
22387    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22388
22389    /**
22390     * Returns the last selected item's data, for a given index widget.
22391     *
22392     * @param obj The index object.
22393     * @return The item @b data associated to the last selected item on
22394     * @p obj (or @c NULL, on errors).
22395     *
22396     * @warning The returned value is @b not an #Elm_Index_Item item
22397     * handle, but the data associated to it (see the @c item parameter
22398     * in elm_index_item_append(), as an example).
22399     *
22400     * @ingroup Index
22401     */
22402    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22403
22404    /**
22405     * Append a new item on a given index widget.
22406     *
22407     * @param obj The index object.
22408     * @param letter Letter under which the item should be indexed
22409     * @param item The item data to set for the index's item
22410     *
22411     * Despite the most common usage of the @p letter argument is for
22412     * single char strings, one could use arbitrary strings as index
22413     * entries.
22414     *
22415     * @c item will be the pointer returned back on @c "changed", @c
22416     * "delay,changed" and @c "selected" smart events.
22417     *
22418     * @ingroup Index
22419     */
22420    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22421
22422    /**
22423     * Prepend a new item on a given index widget.
22424     *
22425     * @param obj The index object.
22426     * @param letter Letter under which the item should be indexed
22427     * @param item The item data to set for the index's item
22428     *
22429     * Despite the most common usage of the @p letter argument is for
22430     * single char strings, one could use arbitrary strings as index
22431     * entries.
22432     *
22433     * @c item will be the pointer returned back on @c "changed", @c
22434     * "delay,changed" and @c "selected" smart events.
22435     *
22436     * @ingroup Index
22437     */
22438    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22439
22440    /**
22441     * Append a new item, on a given index widget, <b>after the item
22442     * having @p relative as data</b>.
22443     *
22444     * @param obj The index object.
22445     * @param letter Letter under which the item should be indexed
22446     * @param item The item data to set for the index's item
22447     * @param relative The item data of the index item to be the
22448     * predecessor of this new one
22449     *
22450     * Despite the most common usage of the @p letter argument is for
22451     * single char strings, one could use arbitrary strings as index
22452     * entries.
22453     *
22454     * @c item will be the pointer returned back on @c "changed", @c
22455     * "delay,changed" and @c "selected" smart events.
22456     *
22457     * @note If @p relative is @c NULL or if it's not found to be data
22458     * set on any previous item on @p obj, this function will behave as
22459     * elm_index_item_append().
22460     *
22461     * @ingroup Index
22462     */
22463    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22464
22465    /**
22466     * Prepend a new item, on a given index widget, <b>after the item
22467     * having @p relative as data</b>.
22468     *
22469     * @param obj The index object.
22470     * @param letter Letter under which the item should be indexed
22471     * @param item The item data to set for the index's item
22472     * @param relative The item data of the index item to be the
22473     * successor of this new one
22474     *
22475     * Despite the most common usage of the @p letter argument is for
22476     * single char strings, one could use arbitrary strings as index
22477     * entries.
22478     *
22479     * @c item will be the pointer returned back on @c "changed", @c
22480     * "delay,changed" and @c "selected" smart events.
22481     *
22482     * @note If @p relative is @c NULL or if it's not found to be data
22483     * set on any previous item on @p obj, this function will behave as
22484     * elm_index_item_prepend().
22485     *
22486     * @ingroup Index
22487     */
22488    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22489
22490    /**
22491     * Insert a new item into the given index widget, using @p cmp_func
22492     * function to sort items (by item handles).
22493     *
22494     * @param obj The index object.
22495     * @param letter Letter under which the item should be indexed
22496     * @param item The item data to set for the index's item
22497     * @param cmp_func The comparing function to be used to sort index
22498     * items <b>by #Elm_Index_Item item handles</b>
22499     * @param cmp_data_func A @b fallback function to be called for the
22500     * sorting of index items <b>by item data</b>). It will be used
22501     * when @p cmp_func returns @c 0 (equality), which means an index
22502     * item with provided item data already exists. To decide which
22503     * data item should be pointed to by the index item in question, @p
22504     * cmp_data_func will be used. If @p cmp_data_func returns a
22505     * non-negative value, the previous index item data will be
22506     * replaced by the given @p item pointer. If the previous data need
22507     * to be freed, it should be done by the @p cmp_data_func function,
22508     * because all references to it will be lost. If this function is
22509     * not provided (@c NULL is given), index items will be @b
22510     * duplicated, if @p cmp_func returns @c 0.
22511     *
22512     * Despite the most common usage of the @p letter argument is for
22513     * single char strings, one could use arbitrary strings as index
22514     * entries.
22515     *
22516     * @c item will be the pointer returned back on @c "changed", @c
22517     * "delay,changed" and @c "selected" smart events.
22518     *
22519     * @ingroup Index
22520     */
22521    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);
22522
22523    /**
22524     * Remove an item from a given index widget, <b>to be referenced by
22525     * it's data value</b>.
22526     *
22527     * @param obj The index object
22528     * @param item The item's data pointer for the item to be removed
22529     * from @p obj
22530     *
22531     * If a deletion callback is set, via elm_index_item_del_cb_set(),
22532     * that callback function will be called by this one.
22533     *
22534     * @warning The item to be removed from @p obj will be found via
22535     * its item data pointer, and not by an #Elm_Index_Item handle.
22536     *
22537     * @ingroup Index
22538     */
22539    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22540
22541    /**
22542     * Find a given index widget's item, <b>using item data</b>.
22543     *
22544     * @param obj The index object
22545     * @param item The item data pointed to by the desired index item
22546     * @return The index item handle, if found, or @c NULL otherwise
22547     *
22548     * @ingroup Index
22549     */
22550    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22551
22552    /**
22553     * Removes @b all items from a given index widget.
22554     *
22555     * @param obj The index object.
22556     *
22557     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22558     * that callback function will be called for each item in @p obj.
22559     *
22560     * @ingroup Index
22561     */
22562    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22563
22564    /**
22565     * Go to a given items level on a index widget
22566     *
22567     * @param obj The index object
22568     * @param level The index level (one of @c 0 or @c 1)
22569     *
22570     * @ingroup Index
22571     */
22572    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22573
22574    /**
22575     * Return the data associated with a given index widget item
22576     *
22577     * @param it The index widget item handle
22578     * @return The data associated with @p it
22579     *
22580     * @see elm_index_item_data_set()
22581     *
22582     * @ingroup Index
22583     */
22584    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22585
22586    /**
22587     * Set the data associated with a given index widget item
22588     *
22589     * @param it The index widget item handle
22590     * @param data The new data pointer to set to @p it
22591     *
22592     * This sets new item data on @p it.
22593     *
22594     * @warning The old data pointer won't be touched by this function, so
22595     * the user had better to free that old data himself/herself.
22596     *
22597     * @ingroup Index
22598     */
22599    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22600
22601    /**
22602     * Set the function to be called when a given index widget item is freed.
22603     *
22604     * @param it The item to set the callback on
22605     * @param func The function to call on the item's deletion
22606     *
22607     * When called, @p func will have both @c data and @c event_info
22608     * arguments with the @p it item's data value and, naturally, the
22609     * @c obj argument with a handle to the parent index widget.
22610     *
22611     * @ingroup Index
22612     */
22613    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22614
22615    /**
22616     * Get the letter (string) set on a given index widget item.
22617     *
22618     * @param it The index item handle
22619     * @return The letter string set on @p it
22620     *
22621     * @ingroup Index
22622     */
22623    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22624
22625    /**
22626     * @}
22627     */
22628
22629    /**
22630     * @defgroup Photocam Photocam
22631     *
22632     * @image html img/widget/photocam/preview-00.png
22633     * @image latex img/widget/photocam/preview-00.eps
22634     *
22635     * This is a widget specifically for displaying high-resolution digital
22636     * camera photos giving speedy feedback (fast load), low memory footprint
22637     * and zooming and panning as well as fitting logic. It is entirely focused
22638     * on jpeg images, and takes advantage of properties of the jpeg format (via
22639     * evas loader features in the jpeg loader).
22640     *
22641     * Signals that you can add callbacks for are:
22642     * @li "clicked" - This is called when a user has clicked the photo without
22643     *                 dragging around.
22644     * @li "press" - This is called when a user has pressed down on the photo.
22645     * @li "longpressed" - This is called when a user has pressed down on the
22646     *                     photo for a long time without dragging around.
22647     * @li "clicked,double" - This is called when a user has double-clicked the
22648     *                        photo.
22649     * @li "load" - Photo load begins.
22650     * @li "loaded" - This is called when the image file load is complete for the
22651     *                first view (low resolution blurry version).
22652     * @li "load,detail" - Photo detailed data load begins.
22653     * @li "loaded,detail" - This is called when the image file load is complete
22654     *                      for the detailed image data (full resolution needed).
22655     * @li "zoom,start" - Zoom animation started.
22656     * @li "zoom,stop" - Zoom animation stopped.
22657     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22658     * @li "scroll" - the content has been scrolled (moved)
22659     * @li "scroll,anim,start" - scrolling animation has started
22660     * @li "scroll,anim,stop" - scrolling animation has stopped
22661     * @li "scroll,drag,start" - dragging the contents around has started
22662     * @li "scroll,drag,stop" - dragging the contents around has stopped
22663     *
22664     * @ref tutorial_photocam shows the API in action.
22665     * @{
22666     */
22667    /**
22668     * @brief Types of zoom available.
22669     */
22670    typedef enum _Elm_Photocam_Zoom_Mode
22671      {
22672         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_photocam_zoom_set */
22673         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22674         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22675         ELM_PHOTOCAM_ZOOM_MODE_LAST
22676      } Elm_Photocam_Zoom_Mode;
22677    /**
22678     * @brief Add a new Photocam object
22679     *
22680     * @param parent The parent object
22681     * @return The new object or NULL if it cannot be created
22682     */
22683    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22684    /**
22685     * @brief Set the photo file to be shown
22686     *
22687     * @param obj The photocam object
22688     * @param file The photo file
22689     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22690     *
22691     * This sets (and shows) the specified file (with a relative or absolute
22692     * path) and will return a load error (same error that
22693     * evas_object_image_load_error_get() will return). The image will change and
22694     * adjust its size at this point and begin a background load process for this
22695     * photo that at some time in the future will be displayed at the full
22696     * quality needed.
22697     */
22698    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22699    /**
22700     * @brief Returns the path of the current image file
22701     *
22702     * @param obj The photocam object
22703     * @return Returns the path
22704     *
22705     * @see elm_photocam_file_set()
22706     */
22707    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22708    /**
22709     * @brief Set the zoom level of the photo
22710     *
22711     * @param obj The photocam object
22712     * @param zoom The zoom level to set
22713     *
22714     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22715     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22716     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22717     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22718     * 16, 32, etc.).
22719     */
22720    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22721    /**
22722     * @brief Get the zoom level of the photo
22723     *
22724     * @param obj The photocam object
22725     * @return The current zoom level
22726     *
22727     * This returns the current zoom level of the photocam object. Note that if
22728     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22729     * (which is the default), the zoom level may be changed at any time by the
22730     * photocam object itself to account for photo size and photocam viewpoer
22731     * size.
22732     *
22733     * @see elm_photocam_zoom_set()
22734     * @see elm_photocam_zoom_mode_set()
22735     */
22736    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22737    /**
22738     * @brief Set the zoom mode
22739     *
22740     * @param obj The photocam object
22741     * @param mode The desired mode
22742     *
22743     * This sets the zoom mode to manual or one of several automatic levels.
22744     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22745     * elm_photocam_zoom_set() and will stay at that level until changed by code
22746     * or until zoom mode is changed. This is the default mode. The Automatic
22747     * modes will allow the photocam object to automatically adjust zoom mode
22748     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22749     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22750     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22751     * pixels within the frame are left unfilled.
22752     */
22753    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22754    /**
22755     * @brief Get the zoom mode
22756     *
22757     * @param obj The photocam object
22758     * @return The current zoom mode
22759     *
22760     * This gets the current zoom mode of the photocam object.
22761     *
22762     * @see elm_photocam_zoom_mode_set()
22763     */
22764    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22765    /**
22766     * @brief Get the current image pixel width and height
22767     *
22768     * @param obj The photocam object
22769     * @param w A pointer to the width return
22770     * @param h A pointer to the height return
22771     *
22772     * This gets the current photo pixel width and height (for the original).
22773     * The size will be returned in the integers @p w and @p h that are pointed
22774     * to.
22775     */
22776    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22777    /**
22778     * @brief Get the area of the image that is currently shown
22779     *
22780     * @param obj
22781     * @param x A pointer to the X-coordinate of region
22782     * @param y A pointer to the Y-coordinate of region
22783     * @param w A pointer to the width
22784     * @param h A pointer to the height
22785     *
22786     * @see elm_photocam_image_region_show()
22787     * @see elm_photocam_image_region_bring_in()
22788     */
22789    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22790    /**
22791     * @brief Set the viewed portion of the image
22792     *
22793     * @param obj The photocam object
22794     * @param x X-coordinate of region in image original pixels
22795     * @param y Y-coordinate of region in image original pixels
22796     * @param w Width of region in image original pixels
22797     * @param h Height of region in image original pixels
22798     *
22799     * This shows the region of the image without using animation.
22800     */
22801    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22802    /**
22803     * @brief Bring in the viewed portion of the image
22804     *
22805     * @param obj The photocam object
22806     * @param x X-coordinate of region in image original pixels
22807     * @param y Y-coordinate of region in image original pixels
22808     * @param w Width of region in image original pixels
22809     * @param h Height of region in image original pixels
22810     *
22811     * This shows the region of the image using animation.
22812     */
22813    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22814    /**
22815     * @brief Set the paused state for photocam
22816     *
22817     * @param obj The photocam object
22818     * @param paused The pause state to set
22819     *
22820     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22821     * photocam. The default is off. This will stop zooming using animation on
22822     * zoom levels changes and change instantly. This will stop any existing
22823     * animations that are running.
22824     */
22825    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22826    /**
22827     * @brief Get the paused state for photocam
22828     *
22829     * @param obj The photocam object
22830     * @return The current paused state
22831     *
22832     * This gets the current paused state for the photocam object.
22833     *
22834     * @see elm_photocam_paused_set()
22835     */
22836    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22837    /**
22838     * @brief Get the internal low-res image used for photocam
22839     *
22840     * @param obj The photocam object
22841     * @return The internal image object handle, or NULL if none exists
22842     *
22843     * This gets the internal image object inside photocam. Do not modify it. It
22844     * is for inspection only, and hooking callbacks to. Nothing else. It may be
22845     * deleted at any time as well.
22846     */
22847    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22848    /**
22849     * @brief Set the photocam scrolling bouncing.
22850     *
22851     * @param obj The photocam object
22852     * @param h_bounce bouncing for horizontal
22853     * @param v_bounce bouncing for vertical
22854     */
22855    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22856    /**
22857     * @brief Get the photocam scrolling bouncing.
22858     *
22859     * @param obj The photocam object
22860     * @param h_bounce bouncing for horizontal
22861     * @param v_bounce bouncing for vertical
22862     *
22863     * @see elm_photocam_bounce_set()
22864     */
22865    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22866    /**
22867     * @}
22868     */
22869
22870    /**
22871     * @defgroup Map Map
22872     * @ingroup Elementary
22873     *
22874     * @image html img/widget/map/preview-00.png
22875     * @image latex img/widget/map/preview-00.eps
22876     *
22877     * This is a widget specifically for displaying a map. It uses basically
22878     * OpenStreetMap provider http://www.openstreetmap.org/,
22879     * but custom providers can be added.
22880     *
22881     * It supports some basic but yet nice features:
22882     * @li zoom and scroll
22883     * @li markers with content to be displayed when user clicks over it
22884     * @li group of markers
22885     * @li routes
22886     *
22887     * Smart callbacks one can listen to:
22888     *
22889     * - "clicked" - This is called when a user has clicked the map without
22890     *   dragging around.
22891     * - "press" - This is called when a user has pressed down on the map.
22892     * - "longpressed" - This is called when a user has pressed down on the map
22893     *   for a long time without dragging around.
22894     * - "clicked,double" - This is called when a user has double-clicked
22895     *   the map.
22896     * - "load,detail" - Map detailed data load begins.
22897     * - "loaded,detail" - This is called when all currently visible parts of
22898     *   the map are loaded.
22899     * - "zoom,start" - Zoom animation started.
22900     * - "zoom,stop" - Zoom animation stopped.
22901     * - "zoom,change" - Zoom changed when using an auto zoom mode.
22902     * - "scroll" - the content has been scrolled (moved).
22903     * - "scroll,anim,start" - scrolling animation has started.
22904     * - "scroll,anim,stop" - scrolling animation has stopped.
22905     * - "scroll,drag,start" - dragging the contents around has started.
22906     * - "scroll,drag,stop" - dragging the contents around has stopped.
22907     * - "downloaded" - This is called when all currently required map images
22908     *   are downloaded.
22909     * - "route,load" - This is called when route request begins.
22910     * - "route,loaded" - This is called when route request ends.
22911     * - "name,load" - This is called when name request begins.
22912     * - "name,loaded- This is called when name request ends.
22913     *
22914     * Available style for map widget:
22915     * - @c "default"
22916     *
22917     * Available style for markers:
22918     * - @c "radio"
22919     * - @c "radio2"
22920     * - @c "empty"
22921     *
22922     * Available style for marker bubble:
22923     * - @c "default"
22924     *
22925     * List of examples:
22926     * @li @ref map_example_01
22927     * @li @ref map_example_02
22928     * @li @ref map_example_03
22929     */
22930
22931    /**
22932     * @addtogroup Map
22933     * @{
22934     */
22935
22936    /**
22937     * @enum _Elm_Map_Zoom_Mode
22938     * @typedef Elm_Map_Zoom_Mode
22939     *
22940     * Set map's zoom behavior. It can be set to manual or automatic.
22941     *
22942     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22943     *
22944     * Values <b> don't </b> work as bitmask, only one can be choosen.
22945     *
22946     * @note Valid sizes are 2^zoom, consequently the map may be smaller
22947     * than the scroller view.
22948     *
22949     * @see elm_map_zoom_mode_set()
22950     * @see elm_map_zoom_mode_get()
22951     *
22952     * @ingroup Map
22953     */
22954    typedef enum _Elm_Map_Zoom_Mode
22955      {
22956         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controlled manually by elm_map_zoom_set(). It's set by default. */
22957         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22958         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22959         ELM_MAP_ZOOM_MODE_LAST
22960      } Elm_Map_Zoom_Mode;
22961
22962    /**
22963     * @enum _Elm_Map_Route_Sources
22964     * @typedef Elm_Map_Route_Sources
22965     *
22966     * Set route service to be used. By default used source is
22967     * #ELM_MAP_ROUTE_SOURCE_YOURS.
22968     *
22969     * @see elm_map_route_source_set()
22970     * @see elm_map_route_source_get()
22971     *
22972     * @ingroup Map
22973     */
22974    typedef enum _Elm_Map_Route_Sources
22975      {
22976         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22977         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. */
22978         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22979         ELM_MAP_ROUTE_SOURCE_LAST
22980      } Elm_Map_Route_Sources;
22981
22982    typedef enum _Elm_Map_Name_Sources
22983      {
22984         ELM_MAP_NAME_SOURCE_NOMINATIM,
22985         ELM_MAP_NAME_SOURCE_LAST
22986      } Elm_Map_Name_Sources;
22987
22988    /**
22989     * @enum _Elm_Map_Route_Type
22990     * @typedef Elm_Map_Route_Type
22991     *
22992     * Set type of transport used on route.
22993     *
22994     * @see elm_map_route_add()
22995     *
22996     * @ingroup Map
22997     */
22998    typedef enum _Elm_Map_Route_Type
22999      {
23000         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
23001         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
23002         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
23003         ELM_MAP_ROUTE_TYPE_LAST
23004      } Elm_Map_Route_Type;
23005
23006    /**
23007     * @enum _Elm_Map_Route_Method
23008     * @typedef Elm_Map_Route_Method
23009     *
23010     * Set the routing method, what should be priorized, time or distance.
23011     *
23012     * @see elm_map_route_add()
23013     *
23014     * @ingroup Map
23015     */
23016    typedef enum _Elm_Map_Route_Method
23017      {
23018         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
23019         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
23020         ELM_MAP_ROUTE_METHOD_LAST
23021      } Elm_Map_Route_Method;
23022
23023    typedef enum _Elm_Map_Name_Method
23024      {
23025         ELM_MAP_NAME_METHOD_SEARCH,
23026         ELM_MAP_NAME_METHOD_REVERSE,
23027         ELM_MAP_NAME_METHOD_LAST
23028      } Elm_Map_Name_Method;
23029
23030    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(). */
23031    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(). */
23032    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(). */
23033    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(). */
23034    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
23035    typedef struct _Elm_Map_Track           Elm_Map_Track;
23036
23037    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. */
23038    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
23039    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
23040    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
23041
23042    typedef char        *(*ElmMapModuleSourceFunc) (void);
23043    typedef int          (*ElmMapModuleZoomMinFunc) (void);
23044    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
23045    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
23046    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
23047    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
23048    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
23049    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
23050    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
23051
23052    /**
23053     * Add a new map widget to the given parent Elementary (container) object.
23054     *
23055     * @param parent The parent object.
23056     * @return a new map widget handle or @c NULL, on errors.
23057     *
23058     * This function inserts a new map widget on the canvas.
23059     *
23060     * @ingroup Map
23061     */
23062    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23063
23064    /**
23065     * Set the zoom level of the map.
23066     *
23067     * @param obj The map object.
23068     * @param zoom The zoom level to set.
23069     *
23070     * This sets the zoom level.
23071     *
23072     * It will respect limits defined by elm_map_source_zoom_min_set() and
23073     * elm_map_source_zoom_max_set().
23074     *
23075     * By default these values are 0 (world map) and 18 (maximum zoom).
23076     *
23077     * This function should be used when zoom mode is set to
23078     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
23079     * with elm_map_zoom_mode_set().
23080     *
23081     * @see elm_map_zoom_mode_set().
23082     * @see elm_map_zoom_get().
23083     *
23084     * @ingroup Map
23085     */
23086    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23087
23088    /**
23089     * Get the zoom level of the map.
23090     *
23091     * @param obj The map object.
23092     * @return The current zoom level.
23093     *
23094     * This returns the current zoom level of the map object.
23095     *
23096     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
23097     * (which is the default), the zoom level may be changed at any time by the
23098     * map object itself to account for map size and map viewport size.
23099     *
23100     * @see elm_map_zoom_set() for details.
23101     *
23102     * @ingroup Map
23103     */
23104    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23105
23106    /**
23107     * Set the zoom mode used by the map object.
23108     *
23109     * @param obj The map object.
23110     * @param mode The zoom mode of the map, being it one of
23111     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
23112     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
23113     *
23114     * This sets the zoom mode to manual or one of the automatic levels.
23115     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
23116     * elm_map_zoom_set() and will stay at that level until changed by code
23117     * or until zoom mode is changed. This is the default mode.
23118     *
23119     * The Automatic modes will allow the map object to automatically
23120     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
23121     * adjust zoom so the map fits inside the scroll frame with no pixels
23122     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
23123     * ensure no pixels within the frame are left unfilled. Do not forget that
23124     * the valid sizes are 2^zoom, consequently the map may be smaller than
23125     * the scroller view.
23126     *
23127     * @see elm_map_zoom_set()
23128     *
23129     * @ingroup Map
23130     */
23131    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
23132
23133    /**
23134     * Get the zoom mode used by the map object.
23135     *
23136     * @param obj The map object.
23137     * @return The zoom mode of the map, being it one of
23138     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
23139     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
23140     *
23141     * This function returns the current zoom mode used by the map object.
23142     *
23143     * @see elm_map_zoom_mode_set() for more details.
23144     *
23145     * @ingroup Map
23146     */
23147    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23148
23149    /**
23150     * Get the current coordinates of the map.
23151     *
23152     * @param obj The map object.
23153     * @param lon Pointer where to store longitude.
23154     * @param lat Pointer where to store latitude.
23155     *
23156     * This gets the current center coordinates of the map object. It can be
23157     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
23158     *
23159     * @see elm_map_geo_region_bring_in()
23160     * @see elm_map_geo_region_show()
23161     *
23162     * @ingroup Map
23163     */
23164    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
23165
23166    /**
23167     * Animatedly bring in given coordinates to the center of the map.
23168     *
23169     * @param obj The map object.
23170     * @param lon Longitude to center at.
23171     * @param lat Latitude to center at.
23172     *
23173     * This causes map to jump to the given @p lat and @p lon coordinates
23174     * and show it (by scrolling) in the center of the viewport, if it is not
23175     * already centered. This will use animation to do so and take a period
23176     * of time to complete.
23177     *
23178     * @see elm_map_geo_region_show() for a function to avoid animation.
23179     * @see elm_map_geo_region_get()
23180     *
23181     * @ingroup Map
23182     */
23183    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23184
23185    /**
23186     * Show the given coordinates at the center of the map, @b immediately.
23187     *
23188     * @param obj The map object.
23189     * @param lon Longitude to center at.
23190     * @param lat Latitude to center at.
23191     *
23192     * This causes map to @b redraw its viewport's contents to the
23193     * region contining the given @p lat and @p lon, that will be moved to the
23194     * center of the map.
23195     *
23196     * @see elm_map_geo_region_bring_in() for a function to move with animation.
23197     * @see elm_map_geo_region_get()
23198     *
23199     * @ingroup Map
23200     */
23201    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23202
23203    /**
23204     * Pause or unpause the map.
23205     *
23206     * @param obj The map object.
23207     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
23208     * to unpause it.
23209     *
23210     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23211     * for map.
23212     *
23213     * The default is off.
23214     *
23215     * This will stop zooming using animation, changing zoom levels will
23216     * change instantly. This will stop any existing animations that are running.
23217     *
23218     * @see elm_map_paused_get()
23219     *
23220     * @ingroup Map
23221     */
23222    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23223
23224    /**
23225     * Get a value whether map is paused or not.
23226     *
23227     * @param obj The map object.
23228     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
23229     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
23230     *
23231     * This gets the current paused state for the map object.
23232     *
23233     * @see elm_map_paused_set() for details.
23234     *
23235     * @ingroup Map
23236     */
23237    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23238
23239    /**
23240     * Set to show markers during zoom level changes or not.
23241     *
23242     * @param obj The map object.
23243     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
23244     * to show them.
23245     *
23246     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23247     * for map.
23248     *
23249     * The default is off.
23250     *
23251     * This will stop zooming using animation, changing zoom levels will
23252     * change instantly. This will stop any existing animations that are running.
23253     *
23254     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23255     * for the markers.
23256     *
23257     * The default  is off.
23258     *
23259     * Enabling it will force the map to stop displaying the markers during
23260     * zoom level changes. Set to on if you have a large number of markers.
23261     *
23262     * @see elm_map_paused_markers_get()
23263     *
23264     * @ingroup Map
23265     */
23266    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23267
23268    /**
23269     * Get a value whether markers will be displayed on zoom level changes or not
23270     *
23271     * @param obj The map object.
23272     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
23273     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
23274     *
23275     * This gets the current markers paused state for the map object.
23276     *
23277     * @see elm_map_paused_markers_set() for details.
23278     *
23279     * @ingroup Map
23280     */
23281    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23282
23283    /**
23284     * Get the information of downloading status.
23285     *
23286     * @param obj The map object.
23287     * @param try_num Pointer where to store number of tiles being downloaded.
23288     * @param finish_num Pointer where to store number of tiles successfully
23289     * downloaded.
23290     *
23291     * This gets the current downloading status for the map object, the number
23292     * of tiles being downloaded and the number of tiles already downloaded.
23293     *
23294     * @ingroup Map
23295     */
23296    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
23297
23298    /**
23299     * Convert a pixel coordinate (x,y) into a geographic coordinate
23300     * (longitude, latitude).
23301     *
23302     * @param obj The map object.
23303     * @param x the coordinate.
23304     * @param y the coordinate.
23305     * @param size the size in pixels of the map.
23306     * The map is a square and generally his size is : pow(2.0, zoom)*256.
23307     * @param lon Pointer where to store the longitude that correspond to x.
23308     * @param lat Pointer where to store the latitude that correspond to y.
23309     *
23310     * @note Origin pixel point is the top left corner of the viewport.
23311     * Map zoom and size are taken on account.
23312     *
23313     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
23314     *
23315     * @ingroup Map
23316     */
23317    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);
23318
23319    /**
23320     * Convert a geographic coordinate (longitude, latitude) into a pixel
23321     * coordinate (x, y).
23322     *
23323     * @param obj The map object.
23324     * @param lon the longitude.
23325     * @param lat the latitude.
23326     * @param size the size in pixels of the map. The map is a square
23327     * and generally his size is : pow(2.0, zoom)*256.
23328     * @param x Pointer where to store the horizontal pixel coordinate that
23329     * correspond to the longitude.
23330     * @param y Pointer where to store the vertical pixel coordinate that
23331     * correspond to the latitude.
23332     *
23333     * @note Origin pixel point is the top left corner of the viewport.
23334     * Map zoom and size are taken on account.
23335     *
23336     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
23337     *
23338     * @ingroup Map
23339     */
23340    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);
23341
23342    /**
23343     * Convert a geographic coordinate (longitude, latitude) into a name
23344     * (address).
23345     *
23346     * @param obj The map object.
23347     * @param lon the longitude.
23348     * @param lat the latitude.
23349     * @return name A #Elm_Map_Name handle for this coordinate.
23350     *
23351     * To get the string for this address, elm_map_name_address_get()
23352     * should be used.
23353     *
23354     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23355     *
23356     * @ingroup Map
23357     */
23358    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23359
23360    /**
23361     * Convert a name (address) into a geographic coordinate
23362     * (longitude, latitude).
23363     *
23364     * @param obj The map object.
23365     * @param name The address.
23366     * @return name A #Elm_Map_Name handle for this address.
23367     *
23368     * To get the longitude and latitude, elm_map_name_region_get()
23369     * should be used.
23370     *
23371     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23372     *
23373     * @ingroup Map
23374     */
23375    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23376
23377    /**
23378     * Convert a pixel coordinate into a rotated pixel coordinate.
23379     *
23380     * @param obj The map object.
23381     * @param x horizontal coordinate of the point to rotate.
23382     * @param y vertical coordinate of the point to rotate.
23383     * @param cx rotation's center horizontal position.
23384     * @param cy rotation's center vertical position.
23385     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23386     * @param xx Pointer where to store rotated x.
23387     * @param yy Pointer where to store rotated y.
23388     *
23389     * @ingroup Map
23390     */
23391    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);
23392
23393    /**
23394     * Add a new marker to the map object.
23395     *
23396     * @param obj The map object.
23397     * @param lon The longitude of the marker.
23398     * @param lat The latitude of the marker.
23399     * @param clas The class, to use when marker @b isn't grouped to others.
23400     * @param clas_group The class group, to use when marker is grouped to others
23401     * @param data The data passed to the callbacks.
23402     *
23403     * @return The created marker or @c NULL upon failure.
23404     *
23405     * A marker will be created and shown in a specific point of the map, defined
23406     * by @p lon and @p lat.
23407     *
23408     * It will be displayed using style defined by @p class when this marker
23409     * is displayed alone (not grouped). A new class can be created with
23410     * elm_map_marker_class_new().
23411     *
23412     * If the marker is grouped to other markers, it will be displayed with
23413     * style defined by @p class_group. Markers with the same group are grouped
23414     * if they are close. A new group class can be created with
23415     * elm_map_marker_group_class_new().
23416     *
23417     * Markers created with this method can be deleted with
23418     * elm_map_marker_remove().
23419     *
23420     * A marker can have associated content to be displayed by a bubble,
23421     * when a user click over it, as well as an icon. These objects will
23422     * be fetch using class' callback functions.
23423     *
23424     * @see elm_map_marker_class_new()
23425     * @see elm_map_marker_group_class_new()
23426     * @see elm_map_marker_remove()
23427     *
23428     * @ingroup Map
23429     */
23430    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);
23431
23432    /**
23433     * Set the maximum numbers of markers' content to be displayed in a group.
23434     *
23435     * @param obj The map object.
23436     * @param max The maximum numbers of items displayed in a bubble.
23437     *
23438     * A bubble will be displayed when the user clicks over the group,
23439     * and will place the content of markers that belong to this group
23440     * inside it.
23441     *
23442     * A group can have a long list of markers, consequently the creation
23443     * of the content of the bubble can be very slow.
23444     *
23445     * In order to avoid this, a maximum number of items is displayed
23446     * in a bubble.
23447     *
23448     * By default this number is 30.
23449     *
23450     * Marker with the same group class are grouped if they are close.
23451     *
23452     * @see elm_map_marker_add()
23453     *
23454     * @ingroup Map
23455     */
23456    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23457
23458    /**
23459     * Remove a marker from the map.
23460     *
23461     * @param marker The marker to remove.
23462     *
23463     * @see elm_map_marker_add()
23464     *
23465     * @ingroup Map
23466     */
23467    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23468
23469    /**
23470     * Get the current coordinates of the marker.
23471     *
23472     * @param marker marker.
23473     * @param lat Pointer where to store the marker's latitude.
23474     * @param lon Pointer where to store the marker's longitude.
23475     *
23476     * These values are set when adding markers, with function
23477     * elm_map_marker_add().
23478     *
23479     * @see elm_map_marker_add()
23480     *
23481     * @ingroup Map
23482     */
23483    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23484
23485    /**
23486     * Animatedly bring in given marker to the center of the map.
23487     *
23488     * @param marker The marker to center at.
23489     *
23490     * This causes map to jump to the given @p marker's coordinates
23491     * and show it (by scrolling) in the center of the viewport, if it is not
23492     * already centered. This will use animation to do so and take a period
23493     * of time to complete.
23494     *
23495     * @see elm_map_marker_show() for a function to avoid animation.
23496     * @see elm_map_marker_region_get()
23497     *
23498     * @ingroup Map
23499     */
23500    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23501
23502    /**
23503     * Show the given marker at the center of the map, @b immediately.
23504     *
23505     * @param marker The marker to center at.
23506     *
23507     * This causes map to @b redraw its viewport's contents to the
23508     * region contining the given @p marker's coordinates, that will be
23509     * moved to the center of the map.
23510     *
23511     * @see elm_map_marker_bring_in() for a function to move with animation.
23512     * @see elm_map_markers_list_show() if more than one marker need to be
23513     * displayed.
23514     * @see elm_map_marker_region_get()
23515     *
23516     * @ingroup Map
23517     */
23518    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23519
23520    /**
23521     * Move and zoom the map to display a list of markers.
23522     *
23523     * @param markers A list of #Elm_Map_Marker handles.
23524     *
23525     * The map will be centered on the center point of the markers in the list.
23526     * Then the map will be zoomed in order to fit the markers using the maximum
23527     * zoom which allows display of all the markers.
23528     *
23529     * @warning All the markers should belong to the same map object.
23530     *
23531     * @see elm_map_marker_show() to show a single marker.
23532     * @see elm_map_marker_bring_in()
23533     *
23534     * @ingroup Map
23535     */
23536    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23537
23538    /**
23539     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23540     *
23541     * @param marker The marker wich content should be returned.
23542     * @return Return the evas object if it exists, else @c NULL.
23543     *
23544     * To set callback function #ElmMapMarkerGetFunc for the marker class,
23545     * elm_map_marker_class_get_cb_set() should be used.
23546     *
23547     * This content is what will be inside the bubble that will be displayed
23548     * when an user clicks over the marker.
23549     *
23550     * This returns the actual Evas object used to be placed inside
23551     * the bubble. This may be @c NULL, as it may
23552     * not have been created or may have been deleted, at any time, by
23553     * the map. <b>Do not modify this object</b> (move, resize,
23554     * show, hide, etc.), as the map is controlling it. This
23555     * function is for querying, emitting custom signals or hooking
23556     * lower level callbacks for events on that object. Do not delete
23557     * this object under any circumstances.
23558     *
23559     * @ingroup Map
23560     */
23561    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23562
23563    /**
23564     * Update the marker
23565     *
23566     * @param marker The marker to be updated.
23567     *
23568     * If a content is set to this marker, it will call function to delete it,
23569     * #ElmMapMarkerDelFunc, and then will fetch the content again with
23570     * #ElmMapMarkerGetFunc.
23571     *
23572     * These functions are set for the marker class with
23573     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23574     *
23575     * @ingroup Map
23576     */
23577    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23578
23579    /**
23580     * Close all the bubbles opened by the user.
23581     *
23582     * @param obj The map object.
23583     *
23584     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23585     * when the user clicks on a marker.
23586     *
23587     * This functions is set for the marker class with
23588     * elm_map_marker_class_get_cb_set().
23589     *
23590     * @ingroup Map
23591     */
23592    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23593
23594    /**
23595     * Create a new group class.
23596     *
23597     * @param obj The map object.
23598     * @return Returns the new group class.
23599     *
23600     * Each marker must be associated to a group class. Markers in the same
23601     * group are grouped if they are close.
23602     *
23603     * The group class defines the style of the marker when a marker is grouped
23604     * to others markers. When it is alone, another class will be used.
23605     *
23606     * A group class will need to be provided when creating a marker with
23607     * elm_map_marker_add().
23608     *
23609     * Some properties and functions can be set by class, as:
23610     * - style, with elm_map_group_class_style_set()
23611     * - data - to be associated to the group class. It can be set using
23612     *   elm_map_group_class_data_set().
23613     * - min zoom to display markers, set with
23614     *   elm_map_group_class_zoom_displayed_set().
23615     * - max zoom to group markers, set using
23616     *   elm_map_group_class_zoom_grouped_set().
23617     * - visibility - set if markers will be visible or not, set with
23618     *   elm_map_group_class_hide_set().
23619     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23620     *   It can be set using elm_map_group_class_icon_cb_set().
23621     *
23622     * @see elm_map_marker_add()
23623     * @see elm_map_group_class_style_set()
23624     * @see elm_map_group_class_data_set()
23625     * @see elm_map_group_class_zoom_displayed_set()
23626     * @see elm_map_group_class_zoom_grouped_set()
23627     * @see elm_map_group_class_hide_set()
23628     * @see elm_map_group_class_icon_cb_set()
23629     *
23630     * @ingroup Map
23631     */
23632    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23633
23634    /**
23635     * Set the marker's style of a group class.
23636     *
23637     * @param clas The group class.
23638     * @param style The style to be used by markers.
23639     *
23640     * Each marker must be associated to a group class, and will use the style
23641     * defined by such class when grouped to other markers.
23642     *
23643     * The following styles are provided by default theme:
23644     * @li @c radio - blue circle
23645     * @li @c radio2 - green circle
23646     * @li @c empty
23647     *
23648     * @see elm_map_group_class_new() for more details.
23649     * @see elm_map_marker_add()
23650     *
23651     * @ingroup Map
23652     */
23653    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23654
23655    /**
23656     * Set the icon callback function of a group class.
23657     *
23658     * @param clas The group class.
23659     * @param icon_get The callback function that will return the icon.
23660     *
23661     * Each marker must be associated to a group class, and it can display a
23662     * custom icon. The function @p icon_get must return this icon.
23663     *
23664     * @see elm_map_group_class_new() for more details.
23665     * @see elm_map_marker_add()
23666     *
23667     * @ingroup Map
23668     */
23669    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23670
23671    /**
23672     * Set the data associated to the group class.
23673     *
23674     * @param clas The group class.
23675     * @param data The new user data.
23676     *
23677     * This data will be passed for callback functions, like icon get callback,
23678     * that can be set with elm_map_group_class_icon_cb_set().
23679     *
23680     * If a data was previously set, the object will lose the pointer for it,
23681     * so if needs to be freed, you must do it yourself.
23682     *
23683     * @see elm_map_group_class_new() for more details.
23684     * @see elm_map_group_class_icon_cb_set()
23685     * @see elm_map_marker_add()
23686     *
23687     * @ingroup Map
23688     */
23689    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23690
23691    /**
23692     * Set the minimum zoom from where the markers are displayed.
23693     *
23694     * @param clas The group class.
23695     * @param zoom The minimum zoom.
23696     *
23697     * Markers only will be displayed when the map is displayed at @p zoom
23698     * or bigger.
23699     *
23700     * @see elm_map_group_class_new() for more details.
23701     * @see elm_map_marker_add()
23702     *
23703     * @ingroup Map
23704     */
23705    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23706
23707    /**
23708     * Set the zoom from where the markers are no more grouped.
23709     *
23710     * @param clas The group class.
23711     * @param zoom The maximum zoom.
23712     *
23713     * Markers only will be grouped when the map is displayed at
23714     * less than @p zoom.
23715     *
23716     * @see elm_map_group_class_new() for more details.
23717     * @see elm_map_marker_add()
23718     *
23719     * @ingroup Map
23720     */
23721    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23722
23723    /**
23724     * Set if the markers associated to the group class @clas are hidden or not.
23725     *
23726     * @param clas The group class.
23727     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23728     * to show them.
23729     *
23730     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23731     * is to show them.
23732     *
23733     * @ingroup Map
23734     */
23735    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23736
23737    /**
23738     * Create a new marker class.
23739     *
23740     * @param obj The map object.
23741     * @return Returns the new group class.
23742     *
23743     * Each marker must be associated to a class.
23744     *
23745     * The marker class defines the style of the marker when a marker is
23746     * displayed alone, i.e., not grouped to to others markers. When grouped
23747     * it will use group class style.
23748     *
23749     * A marker class will need to be provided when creating a marker with
23750     * elm_map_marker_add().
23751     *
23752     * Some properties and functions can be set by class, as:
23753     * - style, with elm_map_marker_class_style_set()
23754     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23755     *   It can be set using elm_map_marker_class_icon_cb_set().
23756     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23757     *   Set using elm_map_marker_class_get_cb_set().
23758     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23759     *   Set using elm_map_marker_class_del_cb_set().
23760     *
23761     * @see elm_map_marker_add()
23762     * @see elm_map_marker_class_style_set()
23763     * @see elm_map_marker_class_icon_cb_set()
23764     * @see elm_map_marker_class_get_cb_set()
23765     * @see elm_map_marker_class_del_cb_set()
23766     *
23767     * @ingroup Map
23768     */
23769    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23770
23771    /**
23772     * Set the marker's style of a marker class.
23773     *
23774     * @param clas The marker class.
23775     * @param style The style to be used by markers.
23776     *
23777     * Each marker must be associated to a marker class, and will use the style
23778     * defined by such class when alone, i.e., @b not grouped to other markers.
23779     *
23780     * The following styles are provided by default theme:
23781     * @li @c radio
23782     * @li @c radio2
23783     * @li @c empty
23784     *
23785     * @see elm_map_marker_class_new() for more details.
23786     * @see elm_map_marker_add()
23787     *
23788     * @ingroup Map
23789     */
23790    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23791
23792    /**
23793     * Set the icon callback function of a marker class.
23794     *
23795     * @param clas The marker class.
23796     * @param icon_get The callback function that will return the icon.
23797     *
23798     * Each marker must be associated to a marker class, and it can display a
23799     * custom icon. The function @p icon_get must return this icon.
23800     *
23801     * @see elm_map_marker_class_new() for more details.
23802     * @see elm_map_marker_add()
23803     *
23804     * @ingroup Map
23805     */
23806    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23807
23808    /**
23809     * Set the bubble content callback function of a marker class.
23810     *
23811     * @param clas The marker class.
23812     * @param get The callback function that will return the content.
23813     *
23814     * Each marker must be associated to a marker class, and it can display a
23815     * a content on a bubble that opens when the user click over the marker.
23816     * The function @p get must return this content object.
23817     *
23818     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23819     * can be used.
23820     *
23821     * @see elm_map_marker_class_new() for more details.
23822     * @see elm_map_marker_class_del_cb_set()
23823     * @see elm_map_marker_add()
23824     *
23825     * @ingroup Map
23826     */
23827    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23828
23829    /**
23830     * Set the callback function used to delete bubble content of a marker class.
23831     *
23832     * @param clas The marker class.
23833     * @param del The callback function that will delete the content.
23834     *
23835     * Each marker must be associated to a marker class, and it can display a
23836     * a content on a bubble that opens when the user click over the marker.
23837     * The function to return such content can be set with
23838     * elm_map_marker_class_get_cb_set().
23839     *
23840     * If this content must be freed, a callback function need to be
23841     * set for that task with this function.
23842     *
23843     * If this callback is defined it will have to delete (or not) the
23844     * object inside, but if the callback is not defined the object will be
23845     * destroyed with evas_object_del().
23846     *
23847     * @see elm_map_marker_class_new() for more details.
23848     * @see elm_map_marker_class_get_cb_set()
23849     * @see elm_map_marker_add()
23850     *
23851     * @ingroup Map
23852     */
23853    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23854
23855    /**
23856     * Get the list of available sources.
23857     *
23858     * @param obj The map object.
23859     * @return The source names list.
23860     *
23861     * It will provide a list with all available sources, that can be set as
23862     * current source with elm_map_source_name_set(), or get with
23863     * elm_map_source_name_get().
23864     *
23865     * Available sources:
23866     * @li "Mapnik"
23867     * @li "Osmarender"
23868     * @li "CycleMap"
23869     * @li "Maplint"
23870     *
23871     * @see elm_map_source_name_set() for more details.
23872     * @see elm_map_source_name_get()
23873     *
23874     * @ingroup Map
23875     */
23876    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23877
23878    /**
23879     * Set the source of the map.
23880     *
23881     * @param obj The map object.
23882     * @param source The source to be used.
23883     *
23884     * Map widget retrieves images that composes the map from a web service.
23885     * This web service can be set with this method.
23886     *
23887     * A different service can return a different maps with different
23888     * information and it can use different zoom values.
23889     *
23890     * The @p source_name need to match one of the names provided by
23891     * elm_map_source_names_get().
23892     *
23893     * The current source can be get using elm_map_source_name_get().
23894     *
23895     * @see elm_map_source_names_get()
23896     * @see elm_map_source_name_get()
23897     *
23898     *
23899     * @ingroup Map
23900     */
23901    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23902
23903    /**
23904     * Get the name of currently used source.
23905     *
23906     * @param obj The map object.
23907     * @return Returns the name of the source in use.
23908     *
23909     * @see elm_map_source_name_set() for more details.
23910     *
23911     * @ingroup Map
23912     */
23913    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23914
23915    /**
23916     * Set the source of the route service to be used by the map.
23917     *
23918     * @param obj The map object.
23919     * @param source The route service to be used, being it one of
23920     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23921     * and #ELM_MAP_ROUTE_SOURCE_ORS.
23922     *
23923     * Each one has its own algorithm, so the route retrieved may
23924     * differ depending on the source route. Now, only the default is working.
23925     *
23926     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23927     * http://www.yournavigation.org/.
23928     *
23929     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23930     * assumptions. Its routing core is based on Contraction Hierarchies.
23931     *
23932     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23933     *
23934     * @see elm_map_route_source_get().
23935     *
23936     * @ingroup Map
23937     */
23938    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23939
23940    /**
23941     * Get the current route source.
23942     *
23943     * @param obj The map object.
23944     * @return The source of the route service used by the map.
23945     *
23946     * @see elm_map_route_source_set() for details.
23947     *
23948     * @ingroup Map
23949     */
23950    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23951
23952    /**
23953     * Set the minimum zoom of the source.
23954     *
23955     * @param obj The map object.
23956     * @param zoom New minimum zoom value to be used.
23957     *
23958     * By default, it's 0.
23959     *
23960     * @ingroup Map
23961     */
23962    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23963
23964    /**
23965     * Get the minimum zoom of the source.
23966     *
23967     * @param obj The map object.
23968     * @return Returns the minimum zoom of the source.
23969     *
23970     * @see elm_map_source_zoom_min_set() for details.
23971     *
23972     * @ingroup Map
23973     */
23974    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23975
23976    /**
23977     * Set the maximum zoom of the source.
23978     *
23979     * @param obj The map object.
23980     * @param zoom New maximum zoom value to be used.
23981     *
23982     * By default, it's 18.
23983     *
23984     * @ingroup Map
23985     */
23986    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23987
23988    /**
23989     * Get the maximum zoom of the source.
23990     *
23991     * @param obj The map object.
23992     * @return Returns the maximum zoom of the source.
23993     *
23994     * @see elm_map_source_zoom_min_set() for details.
23995     *
23996     * @ingroup Map
23997     */
23998    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23999
24000    /**
24001     * Set the user agent used by the map object to access routing services.
24002     *
24003     * @param obj The map object.
24004     * @param user_agent The user agent to be used by the map.
24005     *
24006     * User agent is a client application implementing a network protocol used
24007     * in communications within a clientā€“server distributed computing system
24008     *
24009     * The @p user_agent identification string will transmitted in a header
24010     * field @c User-Agent.
24011     *
24012     * @see elm_map_user_agent_get()
24013     *
24014     * @ingroup Map
24015     */
24016    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
24017
24018    /**
24019     * Get the user agent used by the map object.
24020     *
24021     * @param obj The map object.
24022     * @return The user agent identification string used by the map.
24023     *
24024     * @see elm_map_user_agent_set() for details.
24025     *
24026     * @ingroup Map
24027     */
24028    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24029
24030    /**
24031     * Add a new route to the map object.
24032     *
24033     * @param obj The map object.
24034     * @param type The type of transport to be considered when tracing a route.
24035     * @param method The routing method, what should be priorized.
24036     * @param flon The start longitude.
24037     * @param flat The start latitude.
24038     * @param tlon The destination longitude.
24039     * @param tlat The destination latitude.
24040     *
24041     * @return The created route or @c NULL upon failure.
24042     *
24043     * A route will be traced by point on coordinates (@p flat, @p flon)
24044     * to point on coordinates (@p tlat, @p tlon), using the route service
24045     * set with elm_map_route_source_set().
24046     *
24047     * It will take @p type on consideration to define the route,
24048     * depending if the user will be walking or driving, the route may vary.
24049     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
24050     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
24051     *
24052     * Another parameter is what the route should priorize, the minor distance
24053     * or the less time to be spend on the route. So @p method should be one
24054     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
24055     *
24056     * Routes created with this method can be deleted with
24057     * elm_map_route_remove(), colored with elm_map_route_color_set(),
24058     * and distance can be get with elm_map_route_distance_get().
24059     *
24060     * @see elm_map_route_remove()
24061     * @see elm_map_route_color_set()
24062     * @see elm_map_route_distance_get()
24063     * @see elm_map_route_source_set()
24064     *
24065     * @ingroup Map
24066     */
24067    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);
24068
24069    /**
24070     * Remove a route from the map.
24071     *
24072     * @param route The route to remove.
24073     *
24074     * @see elm_map_route_add()
24075     *
24076     * @ingroup Map
24077     */
24078    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24079
24080    /**
24081     * Set the route color.
24082     *
24083     * @param route The route object.
24084     * @param r Red channel value, from 0 to 255.
24085     * @param g Green channel value, from 0 to 255.
24086     * @param b Blue channel value, from 0 to 255.
24087     * @param a Alpha channel value, from 0 to 255.
24088     *
24089     * It uses an additive color model, so each color channel represents
24090     * how much of each primary colors must to be used. 0 represents
24091     * ausence of this color, so if all of the three are set to 0,
24092     * the color will be black.
24093     *
24094     * These component values should be integers in the range 0 to 255,
24095     * (single 8-bit byte).
24096     *
24097     * This sets the color used for the route. By default, it is set to
24098     * solid red (r = 255, g = 0, b = 0, a = 255).
24099     *
24100     * For alpha channel, 0 represents completely transparent, and 255, opaque.
24101     *
24102     * @see elm_map_route_color_get()
24103     *
24104     * @ingroup Map
24105     */
24106    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24107
24108    /**
24109     * Get the route color.
24110     *
24111     * @param route The route object.
24112     * @param r Pointer where to store the red channel value.
24113     * @param g Pointer where to store the green channel value.
24114     * @param b Pointer where to store the blue channel value.
24115     * @param a Pointer where to store the alpha channel value.
24116     *
24117     * @see elm_map_route_color_set() for details.
24118     *
24119     * @ingroup Map
24120     */
24121    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24122
24123    /**
24124     * Get the route distance in kilometers.
24125     *
24126     * @param route The route object.
24127     * @return The distance of route (unit : km).
24128     *
24129     * @ingroup Map
24130     */
24131    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24132
24133    /**
24134     * Get the information of route nodes.
24135     *
24136     * @param route The route object.
24137     * @return Returns a string with the nodes of route.
24138     *
24139     * @ingroup Map
24140     */
24141    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24142
24143    /**
24144     * Get the information of route waypoint.
24145     *
24146     * @param route the route object.
24147     * @return Returns a string with information about waypoint of route.
24148     *
24149     * @ingroup Map
24150     */
24151    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24152
24153    /**
24154     * Get the address of the name.
24155     *
24156     * @param name The name handle.
24157     * @return Returns the address string of @p name.
24158     *
24159     * This gets the coordinates of the @p name, created with one of the
24160     * conversion functions.
24161     *
24162     * @see elm_map_utils_convert_name_into_coord()
24163     * @see elm_map_utils_convert_coord_into_name()
24164     *
24165     * @ingroup Map
24166     */
24167    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
24168
24169    /**
24170     * Get the current coordinates of the name.
24171     *
24172     * @param name The name handle.
24173     * @param lat Pointer where to store the latitude.
24174     * @param lon Pointer where to store The longitude.
24175     *
24176     * This gets the coordinates of the @p name, created with one of the
24177     * conversion functions.
24178     *
24179     * @see elm_map_utils_convert_name_into_coord()
24180     * @see elm_map_utils_convert_coord_into_name()
24181     *
24182     * @ingroup Map
24183     */
24184    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
24185
24186    /**
24187     * Remove a name from the map.
24188     *
24189     * @param name The name to remove.
24190     *
24191     * Basically the struct handled by @p name will be freed, so convertions
24192     * between address and coordinates will be lost.
24193     *
24194     * @see elm_map_utils_convert_name_into_coord()
24195     * @see elm_map_utils_convert_coord_into_name()
24196     *
24197     * @ingroup Map
24198     */
24199    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
24200
24201    /**
24202     * Rotate the map.
24203     *
24204     * @param obj The map object.
24205     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
24206     * @param cx Rotation's center horizontal position.
24207     * @param cy Rotation's center vertical position.
24208     *
24209     * @see elm_map_rotate_get()
24210     *
24211     * @ingroup Map
24212     */
24213    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
24214
24215    /**
24216     * Get the rotate degree of the map
24217     *
24218     * @param obj The map object
24219     * @param degree Pointer where to store degrees from 0.0 to 360.0
24220     * to rotate arount Z axis.
24221     * @param cx Pointer where to store rotation's center horizontal position.
24222     * @param cy Pointer where to store rotation's center vertical position.
24223     *
24224     * @see elm_map_rotate_set() to set map rotation.
24225     *
24226     * @ingroup Map
24227     */
24228    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);
24229
24230    /**
24231     * Enable or disable mouse wheel to be used to zoom in / out the map.
24232     *
24233     * @param obj The map object.
24234     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
24235     * to enable it.
24236     *
24237     * Mouse wheel can be used for the user to zoom in or zoom out the map.
24238     *
24239     * It's disabled by default.
24240     *
24241     * @see elm_map_wheel_disabled_get()
24242     *
24243     * @ingroup Map
24244     */
24245    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24246
24247    /**
24248     * Get a value whether mouse wheel is enabled or not.
24249     *
24250     * @param obj The map object.
24251     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
24252     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24253     *
24254     * Mouse wheel can be used for the user to zoom in or zoom out the map.
24255     *
24256     * @see elm_map_wheel_disabled_set() for details.
24257     *
24258     * @ingroup Map
24259     */
24260    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24261
24262 #ifdef ELM_EMAP
24263    /**
24264     * Add a track on the map
24265     *
24266     * @param obj The map object.
24267     * @param emap The emap route object.
24268     * @return The route object. This is an elm object of type Route.
24269     *
24270     * @see elm_route_add() for details.
24271     *
24272     * @ingroup Map
24273     */
24274    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
24275 #endif
24276
24277    /**
24278     * Remove a track from the map
24279     *
24280     * @param obj The map object.
24281     * @param route The track to remove.
24282     *
24283     * @ingroup Map
24284     */
24285    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
24286
24287    /**
24288     * @}
24289     */
24290
24291    /* Route */
24292    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
24293 #ifdef ELM_EMAP
24294    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
24295 #endif
24296    EAPI double elm_route_lon_min_get(Evas_Object *obj);
24297    EAPI double elm_route_lat_min_get(Evas_Object *obj);
24298    EAPI double elm_route_lon_max_get(Evas_Object *obj);
24299    EAPI double elm_route_lat_max_get(Evas_Object *obj);
24300
24301
24302    /**
24303     * @defgroup Panel Panel
24304     *
24305     * @image html img/widget/panel/preview-00.png
24306     * @image latex img/widget/panel/preview-00.eps
24307     *
24308     * @brief A panel is a type of animated container that contains subobjects.
24309     * It can be expanded or contracted by clicking the button on it's edge.
24310     *
24311     * Orientations are as follows:
24312     * @li ELM_PANEL_ORIENT_TOP
24313     * @li ELM_PANEL_ORIENT_LEFT
24314     * @li ELM_PANEL_ORIENT_RIGHT
24315     *
24316     * Default contents parts of the panel widget that you can use for are:
24317     * @li "default" - A content of the panel
24318     *
24319     * @ref tutorial_panel shows one way to use this widget.
24320     * @{
24321     */
24322    typedef enum _Elm_Panel_Orient
24323      {
24324         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
24325         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
24326         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
24327         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
24328      } Elm_Panel_Orient;
24329    /**
24330     * @brief Adds a panel object
24331     *
24332     * @param parent The parent object
24333     *
24334     * @return The panel object, or NULL on failure
24335     */
24336    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24337    /**
24338     * @brief Sets the orientation of the panel
24339     *
24340     * @param parent The parent object
24341     * @param orient The panel orientation. Can be one of the following:
24342     * @li ELM_PANEL_ORIENT_TOP
24343     * @li ELM_PANEL_ORIENT_LEFT
24344     * @li ELM_PANEL_ORIENT_RIGHT
24345     *
24346     * Sets from where the panel will (dis)appear.
24347     */
24348    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24349    /**
24350     * @brief Get the orientation of the panel.
24351     *
24352     * @param obj The panel object
24353     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24354     */
24355    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24356    /**
24357     * @brief Set the content of the panel.
24358     *
24359     * @param obj The panel object
24360     * @param content The panel content
24361     *
24362     * Once the content object is set, a previously set one will be deleted.
24363     * If you want to keep that old content object, use the
24364     * elm_panel_content_unset() function.
24365     *
24366     * @deprecated use elm_object_content_set() instead
24367     *
24368     */
24369    EINA_DEPRECATED EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24370    /**
24371     * @brief Get the content of the panel.
24372     *
24373     * @param obj The panel object
24374     * @return The content that is being used
24375     *
24376     * Return the content object which is set for this widget.
24377     *
24378     * @see elm_panel_content_set()
24379     *
24380     * @deprecated use elm_object_content_get() instead
24381     *
24382     */
24383    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24384    /**
24385     * @brief Unset the content of the panel.
24386     *
24387     * @param obj The panel object
24388     * @return The content that was being used
24389     *
24390     * Unparent and return the content object which was set for this widget.
24391     *
24392     * @see elm_panel_content_set()
24393     *
24394     * @deprecated use elm_object_content_unset() instead
24395     *
24396     */
24397    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24398    /**
24399     * @brief Set the state of the panel.
24400     *
24401     * @param obj The panel object
24402     * @param hidden If true, the panel will run the animation to contract
24403     */
24404    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24405    /**
24406     * @brief Get the state of the panel.
24407     *
24408     * @param obj The panel object
24409     * @param hidden If true, the panel is in the "hide" state
24410     */
24411    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24412    /**
24413     * @brief Toggle the hidden state of the panel from code
24414     *
24415     * @param obj The panel object
24416     */
24417    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24418    /**
24419     * @}
24420     */
24421
24422    /**
24423     * @defgroup Panes Panes
24424     * @ingroup Elementary
24425     *
24426     * @image html img/widget/panes/preview-00.png
24427     * @image latex img/widget/panes/preview-00.eps width=\textwidth
24428     *
24429     * @image html img/panes.png
24430     * @image latex img/panes.eps width=\textwidth
24431     *
24432     * The panes adds a dragable bar between two contents. When dragged
24433     * this bar will resize contents size.
24434     *
24435     * Panes can be displayed vertically or horizontally, and contents
24436     * size proportion can be customized (homogeneous by default).
24437     *
24438     * Smart callbacks one can listen to:
24439     * - "press" - The panes has been pressed (button wasn't released yet).
24440     * - "unpressed" - The panes was released after being pressed.
24441     * - "clicked" - The panes has been clicked>
24442     * - "clicked,double" - The panes has been double clicked
24443     *
24444     * Available styles for it:
24445     * - @c "default"
24446     *
24447     * Default contents parts of the panes widget that you can use for are:
24448     * @li "left" - A leftside content of the panes
24449     * @li "right" - A rightside content of the panes
24450     *
24451     * If panes is displayed vertically, left content will be displayed at
24452     * top.
24453     *
24454     * Here is an example on its usage:
24455     * @li @ref panes_example
24456     */
24457
24458    /**
24459     * @addtogroup Panes
24460     * @{
24461     */
24462
24463    /**
24464     * Add a new panes widget to the given parent Elementary
24465     * (container) object.
24466     *
24467     * @param parent The parent object.
24468     * @return a new panes widget handle or @c NULL, on errors.
24469     *
24470     * This function inserts a new panes widget on the canvas.
24471     *
24472     * @ingroup Panes
24473     */
24474    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24475
24476    /**
24477     * Set the left content of the panes widget.
24478     *
24479     * @param obj The panes object.
24480     * @param content The new left content object.
24481     *
24482     * Once the content object is set, a previously set one will be deleted.
24483     * If you want to keep that old content object, use the
24484     * elm_panes_content_left_unset() function.
24485     *
24486     * If panes is displayed vertically, left content will be displayed at
24487     * top.
24488     *
24489     * @see elm_panes_content_left_get()
24490     * @see elm_panes_content_right_set() to set content on the other side.
24491     *
24492     * @deprecated use elm_object_part_content_set() instead
24493     *
24494     * @ingroup Panes
24495     */
24496    EINA_DEPRECATED EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24497
24498    /**
24499     * Set the right content of the panes widget.
24500     *
24501     * @param obj The panes object.
24502     * @param content The new right content object.
24503     *
24504     * Once the content object is set, a previously set one will be deleted.
24505     * If you want to keep that old content object, use the
24506     * elm_panes_content_right_unset() function.
24507     *
24508     * If panes is displayed vertically, left content will be displayed at
24509     * bottom.
24510     *
24511     * @see elm_panes_content_right_get()
24512     * @see elm_panes_content_left_set() to set content on the other side.
24513     *
24514     * @deprecated use elm_object_part_content_set() instead
24515     *
24516     * @ingroup Panes
24517     */
24518    EINA_DEPRECATED EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24519
24520    /**
24521     * Get the left content of the panes.
24522     *
24523     * @param obj The panes object.
24524     * @return The left content object that is being used.
24525     *
24526     * Return the left content object which is set for this widget.
24527     *
24528     * @see elm_panes_content_left_set() for details.
24529     *
24530     * @deprecated use elm_object_part_content_get() instead
24531     *
24532     * @ingroup Panes
24533     */
24534    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24535
24536    /**
24537     * Get the right content of the panes.
24538     *
24539     * @param obj The panes object
24540     * @return The right content object that is being used
24541     *
24542     * Return the right content object which is set for this widget.
24543     *
24544     * @see elm_panes_content_right_set() for details.
24545     *
24546     * @deprecated use elm_object_part_content_get() instead
24547     *
24548     * @ingroup Panes
24549     */
24550    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24551
24552    /**
24553     * Unset the left content used for the panes.
24554     *
24555     * @param obj The panes object.
24556     * @return The left content object that was being used.
24557     *
24558     * Unparent and return the left content object which was set for this widget.
24559     *
24560     * @see elm_panes_content_left_set() for details.
24561     * @see elm_panes_content_left_get().
24562     *
24563     * @deprecated use elm_object_part_content_unset() instead
24564     *
24565     * @ingroup Panes
24566     */
24567    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24568
24569    /**
24570     * Unset the right content used for the panes.
24571     *
24572     * @param obj The panes object.
24573     * @return The right content object that was being used.
24574     *
24575     * Unparent and return the right content object which was set for this
24576     * widget.
24577     *
24578     * @see elm_panes_content_right_set() for details.
24579     * @see elm_panes_content_right_get().
24580     *
24581     * @deprecated use elm_object_part_content_unset() instead
24582     *
24583     * @ingroup Panes
24584     */
24585    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24586
24587    /**
24588     * Get the size proportion of panes widget's left side.
24589     *
24590     * @param obj The panes object.
24591     * @return float value between 0.0 and 1.0 representing size proportion
24592     * of left side.
24593     *
24594     * @see elm_panes_content_left_size_set() for more details.
24595     *
24596     * @ingroup Panes
24597     */
24598    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24599
24600    /**
24601     * Set the size proportion of panes widget's left side.
24602     *
24603     * @param obj The panes object.
24604     * @param size Value between 0.0 and 1.0 representing size proportion
24605     * of left side.
24606     *
24607     * By default it's homogeneous, i.e., both sides have the same size.
24608     *
24609     * If something different is required, it can be set with this function.
24610     * For example, if the left content should be displayed over
24611     * 75% of the panes size, @p size should be passed as @c 0.75.
24612     * This way, right content will be resized to 25% of panes size.
24613     *
24614     * If displayed vertically, left content is displayed at top, and
24615     * right content at bottom.
24616     *
24617     * @note This proportion will change when user drags the panes bar.
24618     *
24619     * @see elm_panes_content_left_size_get()
24620     *
24621     * @ingroup Panes
24622     */
24623    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24624
24625   /**
24626    * Set the orientation of a given panes widget.
24627    *
24628    * @param obj The panes object.
24629    * @param horizontal Use @c EINA_TRUE to make @p obj to be
24630    * @b horizontal, @c EINA_FALSE to make it @b vertical.
24631    *
24632    * Use this function to change how your panes is to be
24633    * disposed: vertically or horizontally.
24634    *
24635    * By default it's displayed horizontally.
24636    *
24637    * @see elm_panes_horizontal_get()
24638    *
24639    * @ingroup Panes
24640    */
24641    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24642
24643    /**
24644     * Retrieve the orientation of a given panes widget.
24645     *
24646     * @param obj The panes object.
24647     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24648     * @c EINA_FALSE if it's @b vertical (and on errors).
24649     *
24650     * @see elm_panes_horizontal_set() for more details.
24651     *
24652     * @ingroup Panes
24653     */
24654    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24655    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24656    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24657
24658    /**
24659     * @}
24660     */
24661
24662    /**
24663     * @defgroup Flip Flip
24664     *
24665     * @image html img/widget/flip/preview-00.png
24666     * @image latex img/widget/flip/preview-00.eps
24667     *
24668     * This widget holds 2 content objects(Evas_Object): one on the front and one
24669     * on the back. It allows you to flip from front to back and vice-versa using
24670     * various animations.
24671     *
24672     * If either the front or back contents are not set the flip will treat that
24673     * as transparent. So if you wore to set the front content but not the back,
24674     * and then call elm_flip_go() you would see whatever is below the flip.
24675     *
24676     * For a list of supported animations see elm_flip_go().
24677     *
24678     * Signals that you can add callbacks for are:
24679     * "animate,begin" - when a flip animation was started
24680     * "animate,done" - when a flip animation is finished
24681     *
24682     * @ref tutorial_flip show how to use most of the API.
24683     *
24684     * @{
24685     */
24686    typedef enum _Elm_Flip_Mode
24687      {
24688         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24689         ELM_FLIP_ROTATE_X_CENTER_AXIS,
24690         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24691         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24692         ELM_FLIP_CUBE_LEFT,
24693         ELM_FLIP_CUBE_RIGHT,
24694         ELM_FLIP_CUBE_UP,
24695         ELM_FLIP_CUBE_DOWN,
24696         ELM_FLIP_PAGE_LEFT,
24697         ELM_FLIP_PAGE_RIGHT,
24698         ELM_FLIP_PAGE_UP,
24699         ELM_FLIP_PAGE_DOWN
24700      } Elm_Flip_Mode;
24701    typedef enum _Elm_Flip_Interaction
24702      {
24703         ELM_FLIP_INTERACTION_NONE,
24704         ELM_FLIP_INTERACTION_ROTATE,
24705         ELM_FLIP_INTERACTION_CUBE,
24706         ELM_FLIP_INTERACTION_PAGE
24707      } Elm_Flip_Interaction;
24708    typedef enum _Elm_Flip_Direction
24709      {
24710         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24711         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24712         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24713         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24714      } Elm_Flip_Direction;
24715    /**
24716     * @brief Add a new flip to the parent
24717     *
24718     * @param parent The parent object
24719     * @return The new object or NULL if it cannot be created
24720     */
24721    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24722    /**
24723     * @brief Set the front content of the flip widget.
24724     *
24725     * @param obj The flip object
24726     * @param content The new front content object
24727     *
24728     * Once the content object is set, a previously set one will be deleted.
24729     * If you want to keep that old content object, use the
24730     * elm_flip_content_front_unset() function.
24731     */
24732    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24733    /**
24734     * @brief Set the back content of the flip widget.
24735     *
24736     * @param obj The flip object
24737     * @param content The new back content object
24738     *
24739     * Once the content object is set, a previously set one will be deleted.
24740     * If you want to keep that old content object, use the
24741     * elm_flip_content_back_unset() function.
24742     */
24743    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24744    /**
24745     * @brief Get the front content used for the flip
24746     *
24747     * @param obj The flip object
24748     * @return The front content object that is being used
24749     *
24750     * Return the front content object which is set for this widget.
24751     */
24752    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24753    /**
24754     * @brief Get the back content used for the flip
24755     *
24756     * @param obj The flip object
24757     * @return The back content object that is being used
24758     *
24759     * Return the back content object which is set for this widget.
24760     */
24761    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24762    /**
24763     * @brief Unset the front content used for the flip
24764     *
24765     * @param obj The flip object
24766     * @return The front content object that was being used
24767     *
24768     * Unparent and return the front content object which was set for this widget.
24769     */
24770    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24771    /**
24772     * @brief Unset the back content used for the flip
24773     *
24774     * @param obj The flip object
24775     * @return The back content object that was being used
24776     *
24777     * Unparent and return the back content object which was set for this widget.
24778     */
24779    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24780    /**
24781     * @brief Get flip front visibility state
24782     *
24783     * @param obj The flip objct
24784     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24785     * showing.
24786     */
24787    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24788    /**
24789     * @brief Set flip perspective
24790     *
24791     * @param obj The flip object
24792     * @param foc The coordinate to set the focus on
24793     * @param x The X coordinate
24794     * @param y The Y coordinate
24795     *
24796     * @warning This function currently does nothing.
24797     */
24798    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24799    /**
24800     * @brief Runs the flip animation
24801     *
24802     * @param obj The flip object
24803     * @param mode The mode type
24804     *
24805     * Flips the front and back contents using the @p mode animation. This
24806     * efectively hides the currently visible content and shows the hidden one.
24807     *
24808     * There a number of possible animations to use for the flipping:
24809     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24810     * around a horizontal axis in the middle of its height, the other content
24811     * is shown as the other side of the flip.
24812     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24813     * around a vertical axis in the middle of its width, the other content is
24814     * shown as the other side of the flip.
24815     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24816     * around a diagonal axis in the middle of its width, the other content is
24817     * shown as the other side of the flip.
24818     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24819     * around a diagonal axis in the middle of its height, the other content is
24820     * shown as the other side of the flip.
24821     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24822     * as if the flip was a cube, the other content is show as the right face of
24823     * the cube.
24824     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24825     * right as if the flip was a cube, the other content is show as the left
24826     * face of the cube.
24827     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24828     * flip was a cube, the other content is show as the bottom face of the cube.
24829     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24830     * the flip was a cube, the other content is show as the upper face of the
24831     * cube.
24832     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24833     * if the flip was a book, the other content is shown as the page below that.
24834     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24835     * as if the flip was a book, the other content is shown as the page below
24836     * that.
24837     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24838     * flip was a book, the other content is shown as the page below that.
24839     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24840     * flip was a book, the other content is shown as the page below that.
24841     *
24842     * @image html elm_flip.png
24843     * @image latex elm_flip.eps width=\textwidth
24844     */
24845    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24846    /**
24847     * @brief Set the interactive flip mode
24848     *
24849     * @param obj The flip object
24850     * @param mode The interactive flip mode to use
24851     *
24852     * This sets if the flip should be interactive (allow user to click and
24853     * drag a side of the flip to reveal the back page and cause it to flip).
24854     * By default a flip is not interactive. You may also need to set which
24855     * sides of the flip are "active" for flipping and how much space they use
24856     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24857     * and elm_flip_interacton_direction_hitsize_set()
24858     *
24859     * The four avilable mode of interaction are:
24860     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24861     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24862     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24863     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24864     *
24865     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24866     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24867     * happen, those can only be acheived with elm_flip_go();
24868     */
24869    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24870    /**
24871     * @brief Get the interactive flip mode
24872     *
24873     * @param obj The flip object
24874     * @return The interactive flip mode
24875     *
24876     * Returns the interactive flip mode set by elm_flip_interaction_set()
24877     */
24878    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24879    /**
24880     * @brief Set which directions of the flip respond to interactive flip
24881     *
24882     * @param obj The flip object
24883     * @param dir The direction to change
24884     * @param enabled If that direction is enabled or not
24885     *
24886     * By default all directions are disabled, so you may want to enable the
24887     * desired directions for flipping if you need interactive flipping. You must
24888     * call this function once for each direction that should be enabled.
24889     *
24890     * @see elm_flip_interaction_set()
24891     */
24892    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24893    /**
24894     * @brief Get the enabled state of that flip direction
24895     *
24896     * @param obj The flip object
24897     * @param dir The direction to check
24898     * @return If that direction is enabled or not
24899     *
24900     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24901     *
24902     * @see elm_flip_interaction_set()
24903     */
24904    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24905    /**
24906     * @brief Set the amount of the flip that is sensitive to interactive flip
24907     *
24908     * @param obj The flip object
24909     * @param dir The direction to modify
24910     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24911     *
24912     * Set the amount of the flip that is sensitive to interactive flip, with 0
24913     * representing no area in the flip and 1 representing the entire flip. There
24914     * is however a consideration to be made in that the area will never be
24915     * smaller than the finger size set(as set in your Elementary configuration).
24916     *
24917     * @see elm_flip_interaction_set()
24918     */
24919    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24920    /**
24921     * @brief Get the amount of the flip that is sensitive to interactive flip
24922     *
24923     * @param obj The flip object
24924     * @param dir The direction to check
24925     * @return The size set for that direction
24926     *
24927     * Returns the amount os sensitive area set by
24928     * elm_flip_interacton_direction_hitsize_set().
24929     */
24930    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24931    /**
24932     * @}
24933     */
24934
24935    /* scrolledentry */
24936    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24937    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24938    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24939    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24940    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24941    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24942    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24943    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24944    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24945    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24946    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24947    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24948    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24949    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24950    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24951    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24952    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24953    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24954    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24955    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24956    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24957    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24958    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24959    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24960    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24961    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24962    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24963    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24964    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24965    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24966    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24967    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24968    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24969    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24970    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24971    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);
24972    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24973    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24974    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);
24975    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24976    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);
24977    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24978    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24979    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24980    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24981    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24982    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24983    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24984    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24985    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);
24986    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);
24987    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);
24988    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);
24989    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);
24990    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);
24991    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24992    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24993    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24994    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24995    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24996    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24997    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24998
24999    /**
25000     * @defgroup Conformant Conformant
25001     * @ingroup Elementary
25002     *
25003     * @image html img/widget/conformant/preview-00.png
25004     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
25005     *
25006     * @image html img/conformant.png
25007     * @image latex img/conformant.eps width=\textwidth
25008     *
25009     * The aim is to provide a widget that can be used in elementary apps to
25010     * account for space taken up by the indicator, virtual keypad & softkey
25011     * windows when running the illume2 module of E17.
25012     *
25013     * So conformant content will be sized and positioned considering the
25014     * space required for such stuff, and when they popup, as a keyboard
25015     * shows when an entry is selected, conformant content won't change.
25016     *
25017     * Available styles for it:
25018     * - @c "default"
25019     *
25020     * Default contents parts of the conformant widget that you can use for are:
25021     * @li "default" - A content of the conformant
25022     *
25023     * See how to use this widget in this example:
25024     * @ref conformant_example
25025     */
25026
25027    /**
25028     * @addtogroup Conformant
25029     * @{
25030     */
25031
25032    /**
25033     * Add a new conformant widget to the given parent Elementary
25034     * (container) object.
25035     *
25036     * @param parent The parent object.
25037     * @return A new conformant widget handle or @c NULL, on errors.
25038     *
25039     * This function inserts a new conformant widget on the canvas.
25040     *
25041     * @ingroup Conformant
25042     */
25043    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25044
25045    /**
25046     * Set the content of the conformant widget.
25047     *
25048     * @param obj The conformant object.
25049     * @param content The content to be displayed by the conformant.
25050     *
25051     * Content will be sized and positioned considering the space required
25052     * to display a virtual keyboard. So it won't fill all the conformant
25053     * size. This way is possible to be sure that content won't resize
25054     * or be re-positioned after the keyboard is displayed.
25055     *
25056     * Once the content object is set, a previously set one will be deleted.
25057     * If you want to keep that old content object, use the
25058     * elm_object_content_unset() function.
25059     *
25060     * @see elm_object_content_unset()
25061     * @see elm_object_content_get()
25062     *
25063     * @deprecated use elm_object_content_set() instead
25064     *
25065     * @ingroup Conformant
25066     */
25067    EINA_DEPRECATED EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25068
25069    /**
25070     * Get the content of the conformant widget.
25071     *
25072     * @param obj The conformant object.
25073     * @return The content that is being used.
25074     *
25075     * Return the content object which is set for this widget.
25076     * It won't be unparent from conformant. For that, use
25077     * elm_object_content_unset().
25078     *
25079     * @see elm_object_content_set().
25080     * @see elm_object_content_unset()
25081     *
25082     * @deprecated use elm_object_content_get() instead
25083     *
25084     * @ingroup Conformant
25085     */
25086    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25087
25088    /**
25089     * Unset the content of the conformant widget.
25090     *
25091     * @param obj The conformant object.
25092     * @return The content that was being used.
25093     *
25094     * Unparent and return the content object which was set for this widget.
25095     *
25096     * @see elm_object_content_set().
25097     *
25098     * @deprecated use elm_object_content_unset() instead
25099     *
25100     * @ingroup Conformant
25101     */
25102    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25103
25104    /**
25105     * Returns the Evas_Object that represents the content area.
25106     *
25107     * @param obj The conformant object.
25108     * @return The content area of the widget.
25109     *
25110     * @ingroup Conformant
25111     */
25112    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25113
25114    /**
25115     * @}
25116     */
25117
25118    /**
25119     * @defgroup Mapbuf Mapbuf
25120     * @ingroup Elementary
25121     *
25122     * @image html img/widget/mapbuf/preview-00.png
25123     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
25124     *
25125     * This holds one content object and uses an Evas Map of transformation
25126     * points to be later used with this content. So the content will be
25127     * moved, resized, etc as a single image. So it will improve performance
25128     * when you have a complex interafce, with a lot of elements, and will
25129     * need to resize or move it frequently (the content object and its
25130     * children).
25131     *
25132     * Default contents parts of the mapbuf widget that you can use for are:
25133     * @li "default" - A content of the mapbuf
25134     *
25135     * To enable map, elm_mapbuf_enabled_set() should be used.
25136     *
25137     * See how to use this widget in this example:
25138     * @ref mapbuf_example
25139     */
25140
25141    /**
25142     * @addtogroup Mapbuf
25143     * @{
25144     */
25145
25146    /**
25147     * Add a new mapbuf widget to the given parent Elementary
25148     * (container) object.
25149     *
25150     * @param parent The parent object.
25151     * @return A new mapbuf widget handle or @c NULL, on errors.
25152     *
25153     * This function inserts a new mapbuf widget on the canvas.
25154     *
25155     * @ingroup Mapbuf
25156     */
25157    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25158
25159    /**
25160     * Set the content of the mapbuf.
25161     *
25162     * @param obj The mapbuf object.
25163     * @param content The content that will be filled in this mapbuf object.
25164     *
25165     * Once the content object is set, a previously set one will be deleted.
25166     * If you want to keep that old content object, use the
25167     * elm_mapbuf_content_unset() function.
25168     *
25169     * To enable map, elm_mapbuf_enabled_set() should be used.
25170     *
25171     * @deprecated use elm_object_content_set() instead
25172     *
25173     * @ingroup Mapbuf
25174     */
25175    EINA_DEPRECATED EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25176
25177    /**
25178     * Get the content of the mapbuf.
25179     *
25180     * @param obj The mapbuf object.
25181     * @return The content that is being used.
25182     *
25183     * Return the content object which is set for this widget.
25184     *
25185     * @see elm_mapbuf_content_set() for details.
25186     *
25187     * @deprecated use elm_object_content_get() instead
25188     *
25189     * @ingroup Mapbuf
25190     */
25191    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25192
25193    /**
25194     * Unset the content of the mapbuf.
25195     *
25196     * @param obj The mapbuf object.
25197     * @return The content that was being used.
25198     *
25199     * Unparent and return the content object which was set for this widget.
25200     *
25201     * @see elm_mapbuf_content_set() for details.
25202     *
25203     * @deprecated use elm_object_content_unset() instead
25204     *
25205     * @ingroup Mapbuf
25206     */
25207    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25208
25209    /**
25210     * Enable or disable the map.
25211     *
25212     * @param obj The mapbuf object.
25213     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
25214     *
25215     * This enables the map that is set or disables it. On enable, the object
25216     * geometry will be saved, and the new geometry will change (position and
25217     * size) to reflect the map geometry set.
25218     *
25219     * Also, when enabled, alpha and smooth states will be used, so if the
25220     * content isn't solid, alpha should be enabled, for example, otherwise
25221     * a black retangle will fill the content.
25222     *
25223     * When disabled, the stored map will be freed and geometry prior to
25224     * enabling the map will be restored.
25225     *
25226     * It's disabled by default.
25227     *
25228     * @see elm_mapbuf_alpha_set()
25229     * @see elm_mapbuf_smooth_set()
25230     *
25231     * @ingroup Mapbuf
25232     */
25233    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25234
25235    /**
25236     * Get a value whether map is enabled or not.
25237     *
25238     * @param obj The mapbuf object.
25239     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
25240     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25241     *
25242     * @see elm_mapbuf_enabled_set() for details.
25243     *
25244     * @ingroup Mapbuf
25245     */
25246    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25247
25248    /**
25249     * Enable or disable smooth map rendering.
25250     *
25251     * @param obj The mapbuf object.
25252     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
25253     * to disable it.
25254     *
25255     * This sets smoothing for map rendering. If the object is a type that has
25256     * its own smoothing settings, then both the smooth settings for this object
25257     * and the map must be turned off.
25258     *
25259     * By default smooth maps are enabled.
25260     *
25261     * @ingroup Mapbuf
25262     */
25263    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
25264
25265    /**
25266     * Get a value whether smooth map rendering is enabled or not.
25267     *
25268     * @param obj The mapbuf object.
25269     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
25270     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25271     *
25272     * @see elm_mapbuf_smooth_set() for details.
25273     *
25274     * @ingroup Mapbuf
25275     */
25276    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25277
25278    /**
25279     * Set or unset alpha flag for map rendering.
25280     *
25281     * @param obj The mapbuf object.
25282     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
25283     * to disable it.
25284     *
25285     * This sets alpha flag for map rendering. If the object is a type that has
25286     * its own alpha settings, then this will take precedence. Only image objects
25287     * have this currently. It stops alpha blending of the map area, and is
25288     * useful if you know the object and/or all sub-objects is 100% solid.
25289     *
25290     * Alpha is enabled by default.
25291     *
25292     * @ingroup Mapbuf
25293     */
25294    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
25295
25296    /**
25297     * Get a value whether alpha blending is enabled or not.
25298     *
25299     * @param obj The mapbuf object.
25300     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
25301     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25302     *
25303     * @see elm_mapbuf_alpha_set() for details.
25304     *
25305     * @ingroup Mapbuf
25306     */
25307    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25308
25309    /**
25310     * @}
25311     */
25312
25313    /**
25314     * @defgroup Flipselector Flip Selector
25315     *
25316     * @image html img/widget/flipselector/preview-00.png
25317     * @image latex img/widget/flipselector/preview-00.eps
25318     *
25319     * A flip selector is a widget to show a set of @b text items, one
25320     * at a time, with the same sheet switching style as the @ref Clock
25321     * "clock" widget, when one changes the current displaying sheet
25322     * (thus, the "flip" in the name).
25323     *
25324     * User clicks to flip sheets which are @b held for some time will
25325     * make the flip selector to flip continuosly and automatically for
25326     * the user. The interval between flips will keep growing in time,
25327     * so that it helps the user to reach an item which is distant from
25328     * the current selection.
25329     *
25330     * Smart callbacks one can register to:
25331     * - @c "selected" - when the widget's selected text item is changed
25332     * - @c "overflowed" - when the widget's current selection is changed
25333     *   from the first item in its list to the last
25334     * - @c "underflowed" - when the widget's current selection is changed
25335     *   from the last item in its list to the first
25336     *
25337     * Available styles for it:
25338     * - @c "default"
25339     *
25340          * To set/get the label of the flipselector item, you can use
25341          * elm_object_item_text_set/get APIs.
25342          * Once the text is set, a previously set one will be deleted.
25343          *
25344     * Here is an example on its usage:
25345     * @li @ref flipselector_example
25346     */
25347
25348    /**
25349     * @addtogroup Flipselector
25350     * @{
25351     */
25352
25353    /**
25354     * Add a new flip selector widget to the given parent Elementary
25355     * (container) widget
25356     *
25357     * @param parent The parent object
25358     * @return a new flip selector widget handle or @c NULL, on errors
25359     *
25360     * This function inserts a new flip selector widget on the canvas.
25361     *
25362     * @ingroup Flipselector
25363     */
25364    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25365
25366    /**
25367     * Programmatically select the next item of a flip selector widget
25368     *
25369     * @param obj The flipselector object
25370     *
25371     * @note The selection will be animated. Also, if it reaches the
25372     * end of its list of member items, it will continue with the first
25373     * one onwards.
25374     *
25375     * @ingroup Flipselector
25376     */
25377    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25378
25379    /**
25380     * Programmatically select the previous item of a flip selector
25381     * widget
25382     *
25383     * @param obj The flipselector object
25384     *
25385     * @note The selection will be animated.  Also, if it reaches the
25386     * beginning of its list of member items, it will continue with the
25387     * last one backwards.
25388     *
25389     * @ingroup Flipselector
25390     */
25391    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25392
25393    /**
25394     * Append a (text) item to a flip selector widget
25395     *
25396     * @param obj The flipselector object
25397     * @param label The (text) label of the new item
25398     * @param func Convenience callback function to take place when
25399     * item is selected
25400     * @param data Data passed to @p func, above
25401     * @return A handle to the item added or @c NULL, on errors
25402     *
25403     * The widget's list of labels to show will be appended with the
25404     * given value. If the user wishes so, a callback function pointer
25405     * can be passed, which will get called when this same item is
25406     * selected.
25407     *
25408     * @note The current selection @b won't be modified by appending an
25409     * element to the list.
25410     *
25411     * @note The maximum length of the text label is going to be
25412     * determined <b>by the widget's theme</b>. Strings larger than
25413     * that value are going to be @b truncated.
25414     *
25415     * @ingroup Flipselector
25416     */
25417    EAPI Elm_Object_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25418
25419    /**
25420     * Prepend a (text) item to a flip selector widget
25421     *
25422     * @param obj The flipselector object
25423     * @param label The (text) label of the new item
25424     * @param func Convenience callback function to take place when
25425     * item is selected
25426     * @param data Data passed to @p func, above
25427     * @return A handle to the item added or @c NULL, on errors
25428     *
25429     * The widget's list of labels to show will be prepended with the
25430     * given value. If the user wishes so, a callback function pointer
25431     * can be passed, which will get called when this same item is
25432     * selected.
25433     *
25434     * @note The current selection @b won't be modified by prepending
25435     * an element to the list.
25436     *
25437     * @note The maximum length of the text label is going to be
25438     * determined <b>by the widget's theme</b>. Strings larger than
25439     * that value are going to be @b truncated.
25440     *
25441     * @ingroup Flipselector
25442     */
25443    EAPI Elm_Object_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25444
25445    /**
25446     * Get the internal list of items in a given flip selector widget.
25447     *
25448     * @param obj The flipselector object
25449     * @return The list of items (#Elm_Object_Item as data) or
25450     * @c NULL on errors.
25451     *
25452     * This list is @b not to be modified in any way and must not be
25453     * freed. Use the list members with functions like
25454     * elm_object_item_text_set(),
25455     * elm_object_item_text_get(),
25456     * elm_flipselector_item_del(),
25457     * elm_flipselector_item_selected_get(),
25458     * elm_flipselector_item_selected_set().
25459     *
25460     * @warning This list is only valid until @p obj object's internal
25461     * items list is changed. It should be fetched again with another
25462     * call to this function when changes happen.
25463     *
25464     * @ingroup Flipselector
25465     */
25466    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25467
25468    /**
25469     * Get the first item in the given flip selector widget's list of
25470     * items.
25471     *
25472     * @param obj The flipselector object
25473     * @return The first item or @c NULL, if it has no items (and on
25474     * errors)
25475     *
25476     * @see elm_flipselector_item_append()
25477     * @see elm_flipselector_last_item_get()
25478     *
25479     * @ingroup Flipselector
25480     */
25481    EAPI Elm_Object_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25482
25483    /**
25484     * Get the last item in the given flip selector widget's list of
25485     * items.
25486     *
25487     * @param obj The flipselector object
25488     * @return The last item or @c NULL, if it has no items (and on
25489     * errors)
25490     *
25491     * @see elm_flipselector_item_prepend()
25492     * @see elm_flipselector_first_item_get()
25493     *
25494     * @ingroup Flipselector
25495     */
25496    EAPI Elm_Object_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25497
25498    /**
25499     * Get the currently selected item in a flip selector widget.
25500     *
25501     * @param obj The flipselector object
25502     * @return The selected item or @c NULL, if the widget has no items
25503     * (and on erros)
25504     *
25505     * @ingroup Flipselector
25506     */
25507    EAPI Elm_Object_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25508
25509    /**
25510     * Set whether a given flip selector widget's item should be the
25511     * currently selected one.
25512     *
25513     * @param it The flip selector item
25514     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25515     *
25516     * This sets whether @p item is or not the selected (thus, under
25517     * display) one. If @p item is different than one under display,
25518     * the latter will be unselected. If the @p item is set to be
25519     * unselected, on the other hand, the @b first item in the widget's
25520     * internal members list will be the new selected one.
25521     *
25522     * @see elm_flipselector_item_selected_get()
25523     *
25524     * @ingroup Flipselector
25525     */
25526    EAPI void                       elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25527
25528    /**
25529     * Get whether a given flip selector widget's item is the currently
25530     * selected one.
25531     *
25532     * @param it The flip selector item
25533     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25534     * (or on errors).
25535     *
25536     * @see elm_flipselector_item_selected_set()
25537     *
25538     * @ingroup Flipselector
25539     */
25540    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25541
25542    /**
25543     * Delete a given item from a flip selector widget.
25544     *
25545     * @param it The item to delete
25546     *
25547     * @ingroup Flipselector
25548     */
25549    EAPI void                       elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25550
25551    /**
25552     * Get the label of a given flip selector widget's item.
25553     *
25554     * @param it The item to get label from
25555     * @return The text label of @p item or @c NULL, on errors
25556     *
25557     * @see elm_object_item_text_set()
25558     *
25559     * @deprecated see elm_object_item_text_get() instead
25560     * @ingroup Flipselector
25561     */
25562    EINA_DEPRECATED EAPI const char                *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25563
25564    /**
25565     * Set the label of a given flip selector widget's item.
25566     *
25567     * @param it The item to set label on
25568     * @param label The text label string, in UTF-8 encoding
25569     *
25570     * @see elm_object_item_text_get()
25571     *
25572          * @deprecated see elm_object_item_text_set() instead
25573     * @ingroup Flipselector
25574     */
25575    EINA_DEPRECATED EAPI void                       elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25576
25577    /**
25578     * Gets the item before @p item in a flip selector widget's
25579     * internal list of items.
25580     *
25581     * @param it The item to fetch previous from
25582     * @return The item before the @p item, in its parent's list. If
25583     *         there is no previous item for @p item or there's an
25584     *         error, @c NULL is returned.
25585     *
25586     * @see elm_flipselector_item_next_get()
25587     *
25588     * @ingroup Flipselector
25589     */
25590    EAPI Elm_Object_Item     *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25591
25592    /**
25593     * Gets the item after @p item in a flip selector widget's
25594     * internal list of items.
25595     *
25596     * @param it The item to fetch next from
25597     * @return The item after the @p item, in its parent's list. If
25598     *         there is no next item for @p item or there's an
25599     *         error, @c NULL is returned.
25600     *
25601     * @see elm_flipselector_item_next_get()
25602     *
25603     * @ingroup Flipselector
25604     */
25605    EAPI Elm_Object_Item     *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25606
25607    /**
25608     * Set the interval on time updates for an user mouse button hold
25609     * on a flip selector widget.
25610     *
25611     * @param obj The flip selector object
25612     * @param interval The (first) interval value in seconds
25613     *
25614     * This interval value is @b decreased while the user holds the
25615     * mouse pointer either flipping up or flipping doww a given flip
25616     * selector.
25617     *
25618     * This helps the user to get to a given item distant from the
25619     * current one easier/faster, as it will start to flip quicker and
25620     * quicker on mouse button holds.
25621     *
25622     * The calculation for the next flip interval value, starting from
25623     * the one set with this call, is the previous interval divided by
25624     * 1.05, so it decreases a little bit.
25625     *
25626     * The default starting interval value for automatic flips is
25627     * @b 0.85 seconds.
25628     *
25629     * @see elm_flipselector_interval_get()
25630     *
25631     * @ingroup Flipselector
25632     */
25633    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25634
25635    /**
25636     * Get the interval on time updates for an user mouse button hold
25637     * on a flip selector widget.
25638     *
25639     * @param obj The flip selector object
25640     * @return The (first) interval value, in seconds, set on it
25641     *
25642     * @see elm_flipselector_interval_set() for more details
25643     *
25644     * @ingroup Flipselector
25645     */
25646    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25647    /**
25648     * @}
25649     */
25650
25651    /**
25652     * @addtogroup Calendar
25653     * @{
25654     */
25655
25656    /**
25657     * @enum _Elm_Calendar_Mark_Repeat
25658     * @typedef Elm_Calendar_Mark_Repeat
25659     *
25660     * Event periodicity, used to define if a mark should be repeated
25661     * @b beyond event's day. It's set when a mark is added.
25662     *
25663     * So, for a mark added to 13th May with periodicity set to WEEKLY,
25664     * there will be marks every week after this date. Marks will be displayed
25665     * at 13th, 20th, 27th, 3rd June ...
25666     *
25667     * Values don't work as bitmask, only one can be choosen.
25668     *
25669     * @see elm_calendar_mark_add()
25670     *
25671     * @ingroup Calendar
25672     */
25673    typedef enum _Elm_Calendar_Mark_Repeat
25674      {
25675         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25676         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25677         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25678         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*/
25679         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. */
25680      } Elm_Calendar_Mark_Repeat;
25681
25682    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(). */
25683
25684    /**
25685     * Add a new calendar widget to the given parent Elementary
25686     * (container) object.
25687     *
25688     * @param parent The parent object.
25689     * @return a new calendar widget handle or @c NULL, on errors.
25690     *
25691     * This function inserts a new calendar widget on the canvas.
25692     *
25693     * @ref calendar_example_01
25694     *
25695     * @ingroup Calendar
25696     */
25697    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25698
25699    /**
25700     * Get weekdays names displayed by the calendar.
25701     *
25702     * @param obj The calendar object.
25703     * @return Array of seven strings to be used as weekday names.
25704     *
25705     * By default, weekdays abbreviations get from system are displayed:
25706     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25707     * The first string is related to Sunday, the second to Monday...
25708     *
25709     * @see elm_calendar_weekdays_name_set()
25710     *
25711     * @ref calendar_example_05
25712     *
25713     * @ingroup Calendar
25714     */
25715    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25716
25717    /**
25718     * Set weekdays names to be displayed by the calendar.
25719     *
25720     * @param obj The calendar object.
25721     * @param weekdays Array of seven strings to be used as weekday names.
25722     * @warning It must have 7 elements, or it will access invalid memory.
25723     * @warning The strings must be NULL terminated ('@\0').
25724     *
25725     * By default, weekdays abbreviations get from system are displayed:
25726     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25727     *
25728     * The first string should be related to Sunday, the second to Monday...
25729     *
25730     * The usage should be like this:
25731     * @code
25732     *   const char *weekdays[] =
25733     *   {
25734     *      "Sunday", "Monday", "Tuesday", "Wednesday",
25735     *      "Thursday", "Friday", "Saturday"
25736     *   };
25737     *   elm_calendar_weekdays_names_set(calendar, weekdays);
25738     * @endcode
25739     *
25740     * @see elm_calendar_weekdays_name_get()
25741     *
25742     * @ref calendar_example_02
25743     *
25744     * @ingroup Calendar
25745     */
25746    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25747
25748    /**
25749     * Set the minimum and maximum values for the year
25750     *
25751     * @param obj The calendar object
25752     * @param min The minimum year, greater than 1901;
25753     * @param max The maximum year;
25754     *
25755     * Maximum must be greater than minimum, except if you don't wan't to set
25756     * maximum year.
25757     * Default values are 1902 and -1.
25758     *
25759     * If the maximum year is a negative value, it will be limited depending
25760     * on the platform architecture (year 2037 for 32 bits);
25761     *
25762     * @see elm_calendar_min_max_year_get()
25763     *
25764     * @ref calendar_example_03
25765     *
25766     * @ingroup Calendar
25767     */
25768    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25769
25770    /**
25771     * Get the minimum and maximum values for the year
25772     *
25773     * @param obj The calendar object.
25774     * @param min The minimum year.
25775     * @param max The maximum year.
25776     *
25777     * Default values are 1902 and -1.
25778     *
25779     * @see elm_calendar_min_max_year_get() for more details.
25780     *
25781     * @ref calendar_example_05
25782     *
25783     * @ingroup Calendar
25784     */
25785    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25786
25787    /**
25788     * Enable or disable day selection
25789     *
25790     * @param obj The calendar object.
25791     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25792     * disable it.
25793     *
25794     * Enabled by default. If disabled, the user still can select months,
25795     * but not days. Selected days are highlighted on calendar.
25796     * It should be used if you won't need such selection for the widget usage.
25797     *
25798     * When a day is selected, or month is changed, smart callbacks for
25799     * signal "changed" will be called.
25800     *
25801     * @see elm_calendar_day_selection_enable_get()
25802     *
25803     * @ref calendar_example_04
25804     *
25805     * @ingroup Calendar
25806     */
25807    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25808
25809    /**
25810     * Get a value whether day selection is enabled or not.
25811     *
25812     * @see elm_calendar_day_selection_enable_set() for details.
25813     *
25814     * @param obj The calendar object.
25815     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25816     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25817     *
25818     * @ref calendar_example_05
25819     *
25820     * @ingroup Calendar
25821     */
25822    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25823
25824
25825    /**
25826     * Set selected date to be highlighted on calendar.
25827     *
25828     * @param obj The calendar object.
25829     * @param selected_time A @b tm struct to represent the selected date.
25830     *
25831     * Set the selected date, changing the displayed month if needed.
25832     * Selected date changes when the user goes to next/previous month or
25833     * select a day pressing over it on calendar.
25834     *
25835     * @see elm_calendar_selected_time_get()
25836     *
25837     * @ref calendar_example_04
25838     *
25839     * @ingroup Calendar
25840     */
25841    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25842
25843    /**
25844     * Get selected date.
25845     *
25846     * @param obj The calendar object
25847     * @param selected_time A @b tm struct to point to selected date
25848     * @return EINA_FALSE means an error ocurred and returned time shouldn't
25849     * be considered.
25850     *
25851     * Get date selected by the user or set by function
25852     * elm_calendar_selected_time_set().
25853     * Selected date changes when the user goes to next/previous month or
25854     * select a day pressing over it on calendar.
25855     *
25856     * @see elm_calendar_selected_time_get()
25857     *
25858     * @ref calendar_example_05
25859     *
25860     * @ingroup Calendar
25861     */
25862    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25863
25864    /**
25865     * Set a function to format the string that will be used to display
25866     * month and year;
25867     *
25868     * @param obj The calendar object
25869     * @param format_function Function to set the month-year string given
25870     * the selected date
25871     *
25872     * By default it uses strftime with "%B %Y" format string.
25873     * It should allocate the memory that will be used by the string,
25874     * that will be freed by the widget after usage.
25875     * A pointer to the string and a pointer to the time struct will be provided.
25876     *
25877     * Example:
25878     * @code
25879     * static char *
25880     * _format_month_year(struct tm *selected_time)
25881     * {
25882     *    char buf[32];
25883     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25884     *    return strdup(buf);
25885     * }
25886     *
25887     * elm_calendar_format_function_set(calendar, _format_month_year);
25888     * @endcode
25889     *
25890     * @ref calendar_example_02
25891     *
25892     * @ingroup Calendar
25893     */
25894    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25895
25896    /**
25897     * Add a new mark to the calendar
25898     *
25899     * @param obj The calendar object
25900     * @param mark_type A string used to define the type of mark. It will be
25901     * emitted to the theme, that should display a related modification on these
25902     * days representation.
25903     * @param mark_time A time struct to represent the date of inclusion of the
25904     * mark. For marks that repeats it will just be displayed after the inclusion
25905     * date in the calendar.
25906     * @param repeat Repeat the event following this periodicity. Can be a unique
25907     * mark (that don't repeat), daily, weekly, monthly or annually.
25908     * @return The created mark or @p NULL upon failure.
25909     *
25910     * Add a mark that will be drawn in the calendar respecting the insertion
25911     * time and periodicity. It will emit the type as signal to the widget theme.
25912     * Default theme supports "holiday" and "checked", but it can be extended.
25913     *
25914     * It won't immediately update the calendar, drawing the marks.
25915     * For this, call elm_calendar_marks_draw(). However, when user selects
25916     * next or previous month calendar forces marks drawn.
25917     *
25918     * Marks created with this method can be deleted with
25919     * elm_calendar_mark_del().
25920     *
25921     * Example
25922     * @code
25923     * struct tm selected_time;
25924     * time_t current_time;
25925     *
25926     * current_time = time(NULL) + 5 * 84600;
25927     * localtime_r(&current_time, &selected_time);
25928     * elm_calendar_mark_add(cal, "holiday", selected_time,
25929     *     ELM_CALENDAR_ANNUALLY);
25930     *
25931     * current_time = time(NULL) + 1 * 84600;
25932     * localtime_r(&current_time, &selected_time);
25933     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25934     *
25935     * elm_calendar_marks_draw(cal);
25936     * @endcode
25937     *
25938     * @see elm_calendar_marks_draw()
25939     * @see elm_calendar_mark_del()
25940     *
25941     * @ref calendar_example_06
25942     *
25943     * @ingroup Calendar
25944     */
25945    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);
25946
25947    /**
25948     * Delete mark from the calendar.
25949     *
25950     * @param mark The mark to be deleted.
25951     *
25952     * If deleting all calendar marks is required, elm_calendar_marks_clear()
25953     * should be used instead of getting marks list and deleting each one.
25954     *
25955     * @see elm_calendar_mark_add()
25956     *
25957     * @ref calendar_example_06
25958     *
25959     * @ingroup Calendar
25960     */
25961    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25962
25963    /**
25964     * Remove all calendar's marks
25965     *
25966     * @param obj The calendar object.
25967     *
25968     * @see elm_calendar_mark_add()
25969     * @see elm_calendar_mark_del()
25970     *
25971     * @ingroup Calendar
25972     */
25973    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25974
25975
25976    /**
25977     * Get a list of all the calendar marks.
25978     *
25979     * @param obj The calendar object.
25980     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25981     *
25982     * @see elm_calendar_mark_add()
25983     * @see elm_calendar_mark_del()
25984     * @see elm_calendar_marks_clear()
25985     *
25986     * @ingroup Calendar
25987     */
25988    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25989
25990    /**
25991     * Draw calendar marks.
25992     *
25993     * @param obj The calendar object.
25994     *
25995     * Should be used after adding, removing or clearing marks.
25996     * It will go through the entire marks list updating the calendar.
25997     * If lots of marks will be added, add all the marks and then call
25998     * this function.
25999     *
26000     * When the month is changed, i.e. user selects next or previous month,
26001     * marks will be drawed.
26002     *
26003     * @see elm_calendar_mark_add()
26004     * @see elm_calendar_mark_del()
26005     * @see elm_calendar_marks_clear()
26006     *
26007     * @ref calendar_example_06
26008     *
26009     * @ingroup Calendar
26010     */
26011    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
26012
26013    /**
26014     * Set a day text color to the same that represents Saturdays.
26015     *
26016     * @param obj The calendar object.
26017     * @param pos The text position. Position is the cell counter, from left
26018     * to right, up to down. It starts on 0 and ends on 41.
26019     *
26020     * @deprecated use elm_calendar_mark_add() instead like:
26021     *
26022     * @code
26023     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
26024     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
26025     * @endcode
26026     *
26027     * @see elm_calendar_mark_add()
26028     *
26029     * @ingroup Calendar
26030     */
26031    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26032
26033    /**
26034     * Set a day text color to the same that represents Sundays.
26035     *
26036     * @param obj The calendar object.
26037     * @param pos The text position. Position is the cell counter, from left
26038     * to right, up to down. It starts on 0 and ends on 41.
26039
26040     * @deprecated use elm_calendar_mark_add() instead like:
26041     *
26042     * @code
26043     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
26044     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
26045     * @endcode
26046     *
26047     * @see elm_calendar_mark_add()
26048     *
26049     * @ingroup Calendar
26050     */
26051    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26052
26053    /**
26054     * Set a day text color to the same that represents Weekdays.
26055     *
26056     * @param obj The calendar object
26057     * @param pos The text position. Position is the cell counter, from left
26058     * to right, up to down. It starts on 0 and ends on 41.
26059     *
26060     * @deprecated use elm_calendar_mark_add() instead like:
26061     *
26062     * @code
26063     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
26064     *
26065     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
26066     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26067     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
26068     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26069     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
26070     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26071     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
26072     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26073     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
26074     * @endcode
26075     *
26076     * @see elm_calendar_mark_add()
26077     *
26078     * @ingroup Calendar
26079     */
26080    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26081
26082    /**
26083     * Set the interval on time updates for an user mouse button hold
26084     * on calendar widgets' month selection.
26085     *
26086     * @param obj The calendar object
26087     * @param interval The (first) interval value in seconds
26088     *
26089     * This interval value is @b decreased while the user holds the
26090     * mouse pointer either selecting next or previous month.
26091     *
26092     * This helps the user to get to a given month distant from the
26093     * current one easier/faster, as it will start to change quicker and
26094     * quicker on mouse button holds.
26095     *
26096     * The calculation for the next change interval value, starting from
26097     * the one set with this call, is the previous interval divided by
26098     * 1.05, so it decreases a little bit.
26099     *
26100     * The default starting interval value for automatic changes is
26101     * @b 0.85 seconds.
26102     *
26103     * @see elm_calendar_interval_get()
26104     *
26105     * @ingroup Calendar
26106     */
26107    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
26108
26109    /**
26110     * Get the interval on time updates for an user mouse button hold
26111     * on calendar widgets' month selection.
26112     *
26113     * @param obj The calendar object
26114     * @return The (first) interval value, in seconds, set on it
26115     *
26116     * @see elm_calendar_interval_set() for more details
26117     *
26118     * @ingroup Calendar
26119     */
26120    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26121
26122    /**
26123     * @}
26124     */
26125
26126    /**
26127     * @defgroup Diskselector Diskselector
26128     * @ingroup Elementary
26129     *
26130     * @image html img/widget/diskselector/preview-00.png
26131     * @image latex img/widget/diskselector/preview-00.eps
26132     *
26133     * A diskselector is a kind of list widget. It scrolls horizontally,
26134     * and can contain label and icon objects. Three items are displayed
26135     * with the selected one in the middle.
26136     *
26137     * It can act like a circular list with round mode and labels can be
26138     * reduced for a defined length for side items.
26139     *
26140     * Smart callbacks one can listen to:
26141     * - "selected" - when item is selected, i.e. scroller stops.
26142     *
26143     * Available styles for it:
26144     * - @c "default"
26145     *
26146     * List of examples:
26147     * @li @ref diskselector_example_01
26148     * @li @ref diskselector_example_02
26149     */
26150
26151    /**
26152     * @addtogroup Diskselector
26153     * @{
26154     */
26155
26156    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(). */
26157
26158    /**
26159     * Add a new diskselector widget to the given parent Elementary
26160     * (container) object.
26161     *
26162     * @param parent The parent object.
26163     * @return a new diskselector widget handle or @c NULL, on errors.
26164     *
26165     * This function inserts a new diskselector widget on the canvas.
26166     *
26167     * @ingroup Diskselector
26168     */
26169    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26170
26171    /**
26172     * Enable or disable round mode.
26173     *
26174     * @param obj The diskselector object.
26175     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
26176     * disable it.
26177     *
26178     * Disabled by default. If round mode is enabled the items list will
26179     * work like a circle list, so when the user reaches the last item,
26180     * the first one will popup.
26181     *
26182     * @see elm_diskselector_round_get()
26183     *
26184     * @ingroup Diskselector
26185     */
26186    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
26187
26188    /**
26189     * Get a value whether round mode is enabled or not.
26190     *
26191     * @see elm_diskselector_round_set() for details.
26192     *
26193     * @param obj The diskselector object.
26194     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
26195     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26196     *
26197     * @ingroup Diskselector
26198     */
26199    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26200
26201    /**
26202     * Get the side labels max length.
26203     *
26204     * @deprecated use elm_diskselector_side_label_length_get() instead:
26205     *
26206     * @param obj The diskselector object.
26207     * @return The max length defined for side labels, or 0 if not a valid
26208     * diskselector.
26209     *
26210     * @ingroup Diskselector
26211     */
26212    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26213
26214    /**
26215     * Set the side labels max length.
26216     *
26217     * @deprecated use elm_diskselector_side_label_length_set() instead:
26218     *
26219     * @param obj The diskselector object.
26220     * @param len The max length defined for side labels.
26221     *
26222     * @ingroup Diskselector
26223     */
26224    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26225
26226    /**
26227     * Get the side labels max length.
26228     *
26229     * @see elm_diskselector_side_label_length_set() for details.
26230     *
26231     * @param obj The diskselector object.
26232     * @return The max length defined for side labels, or 0 if not a valid
26233     * diskselector.
26234     *
26235     * @ingroup Diskselector
26236     */
26237    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26238
26239    /**
26240     * Set the side labels max length.
26241     *
26242     * @param obj The diskselector object.
26243     * @param len The max length defined for side labels.
26244     *
26245     * Length is the number of characters of items' label that will be
26246     * visible when it's set on side positions. It will just crop
26247     * the string after defined size. E.g.:
26248     *
26249     * An item with label "January" would be displayed on side position as
26250     * "Jan" if max length is set to 3, or "Janu", if this property
26251     * is set to 4.
26252     *
26253     * When it's selected, the entire label will be displayed, except for
26254     * width restrictions. In this case label will be cropped and "..."
26255     * will be concatenated.
26256     *
26257     * Default side label max length is 3.
26258     *
26259     * This property will be applyed over all items, included before or
26260     * later this function call.
26261     *
26262     * @ingroup Diskselector
26263     */
26264    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26265
26266    /**
26267     * Set the number of items to be displayed.
26268     *
26269     * @param obj The diskselector object.
26270     * @param num The number of items the diskselector will display.
26271     *
26272     * Default value is 3, and also it's the minimun. If @p num is less
26273     * than 3, it will be set to 3.
26274     *
26275     * Also, it can be set on theme, using data item @c display_item_num
26276     * on group "elm/diskselector/item/X", where X is style set.
26277     * E.g.:
26278     *
26279     * group { name: "elm/diskselector/item/X";
26280     * data {
26281     *     item: "display_item_num" "5";
26282     *     }
26283     *
26284     * @ingroup Diskselector
26285     */
26286    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
26287
26288    /**
26289     * Get the number of items in the diskselector object.
26290     *
26291     * @param obj The diskselector object.
26292     *
26293     * @ingroup Diskselector
26294     */
26295    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26296
26297    /**
26298     * Set bouncing behaviour when the scrolled content reaches an edge.
26299     *
26300     * Tell the internal scroller object whether it should bounce or not
26301     * when it reaches the respective edges for each axis.
26302     *
26303     * @param obj The diskselector object.
26304     * @param h_bounce Whether to bounce or not in the horizontal axis.
26305     * @param v_bounce Whether to bounce or not in the vertical axis.
26306     *
26307     * @see elm_scroller_bounce_set()
26308     *
26309     * @ingroup Diskselector
26310     */
26311    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
26312
26313    /**
26314     * Get the bouncing behaviour of the internal scroller.
26315     *
26316     * Get whether the internal scroller should bounce when the edge of each
26317     * axis is reached scrolling.
26318     *
26319     * @param obj The diskselector object.
26320     * @param h_bounce Pointer where to store the bounce state of the horizontal
26321     * axis.
26322     * @param v_bounce Pointer where to store the bounce state of the vertical
26323     * axis.
26324     *
26325     * @see elm_scroller_bounce_get()
26326     * @see elm_diskselector_bounce_set()
26327     *
26328     * @ingroup Diskselector
26329     */
26330    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
26331
26332    /**
26333     * Get the scrollbar policy.
26334     *
26335     * @see elm_diskselector_scroller_policy_get() for details.
26336     *
26337     * @param obj The diskselector object.
26338     * @param policy_h Pointer where to store horizontal scrollbar policy.
26339     * @param policy_v Pointer where to store vertical scrollbar policy.
26340     *
26341     * @ingroup Diskselector
26342     */
26343    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);
26344
26345    /**
26346     * Set the scrollbar policy.
26347     *
26348     * @param obj The diskselector object.
26349     * @param policy_h Horizontal scrollbar policy.
26350     * @param policy_v Vertical scrollbar policy.
26351     *
26352     * This sets the scrollbar visibility policy for the given scroller.
26353     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26354     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26355     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26356     * This applies respectively for the horizontal and vertical scrollbars.
26357     *
26358     * The both are disabled by default, i.e., are set to
26359     * #ELM_SCROLLER_POLICY_OFF.
26360     *
26361     * @ingroup Diskselector
26362     */
26363    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26364
26365    /**
26366     * Remove all diskselector's items.
26367     *
26368     * @param obj The diskselector object.
26369     *
26370     * @see elm_diskselector_item_del()
26371     * @see elm_diskselector_item_append()
26372     *
26373     * @ingroup Diskselector
26374     */
26375    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26376
26377    /**
26378     * Get a list of all the diskselector items.
26379     *
26380     * @param obj The diskselector object.
26381     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26382     * or @c NULL on failure.
26383     *
26384     * @see elm_diskselector_item_append()
26385     * @see elm_diskselector_item_del()
26386     * @see elm_diskselector_clear()
26387     *
26388     * @ingroup Diskselector
26389     */
26390    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26391
26392    /**
26393     * Appends a new item to the diskselector object.
26394     *
26395     * @param obj The diskselector object.
26396     * @param label The label of the diskselector item.
26397     * @param icon The icon object to use at left side of the item. An
26398     * icon can be any Evas object, but usually it is an icon created
26399     * with elm_icon_add().
26400     * @param func The function to call when the item is selected.
26401     * @param data The data to associate with the item for related callbacks.
26402     *
26403     * @return The created item or @c NULL upon failure.
26404     *
26405     * A new item will be created and appended to the diskselector, i.e., will
26406     * be set as last item. Also, if there is no selected item, it will
26407     * be selected. This will always happens for the first appended item.
26408     *
26409     * If no icon is set, label will be centered on item position, otherwise
26410     * the icon will be placed at left of the label, that will be shifted
26411     * to the right.
26412     *
26413     * Items created with this method can be deleted with
26414     * elm_diskselector_item_del().
26415     *
26416     * Associated @p data can be properly freed when item is deleted if a
26417     * callback function is set with elm_diskselector_item_del_cb_set().
26418     *
26419     * If a function is passed as argument, it will be called everytime this item
26420     * is selected, i.e., the user stops the diskselector with this
26421     * item on center position. If such function isn't needed, just passing
26422     * @c NULL as @p func is enough. The same should be done for @p data.
26423     *
26424     * Simple example (with no function callback or data associated):
26425     * @code
26426     * disk = elm_diskselector_add(win);
26427     * ic = elm_icon_add(win);
26428     * elm_icon_file_set(ic, "path/to/image", NULL);
26429     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26430     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26431     * @endcode
26432     *
26433     * @see elm_diskselector_item_del()
26434     * @see elm_diskselector_item_del_cb_set()
26435     * @see elm_diskselector_clear()
26436     * @see elm_icon_add()
26437     *
26438     * @ingroup Diskselector
26439     */
26440    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);
26441
26442
26443    /**
26444     * Delete them item from the diskselector.
26445     *
26446     * @param it The item of diskselector to be deleted.
26447     *
26448     * If deleting all diskselector items is required, elm_diskselector_clear()
26449     * should be used instead of getting items list and deleting each one.
26450     *
26451     * @see elm_diskselector_clear()
26452     * @see elm_diskselector_item_append()
26453     * @see elm_diskselector_item_del_cb_set()
26454     *
26455     * @ingroup Diskselector
26456     */
26457    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26458
26459    /**
26460     * Set the function called when a diskselector item is freed.
26461     *
26462     * @param it The item to set the callback on
26463     * @param func The function called
26464     *
26465     * If there is a @p func, then it will be called prior item's memory release.
26466     * That will be called with the following arguments:
26467     * @li item's data;
26468     * @li item's Evas object;
26469     * @li item itself;
26470     *
26471     * This way, a data associated to a diskselector item could be properly
26472     * freed.
26473     *
26474     * @ingroup Diskselector
26475     */
26476    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26477
26478    /**
26479     * Get the data associated to the item.
26480     *
26481     * @param it The diskselector item
26482     * @return The data associated to @p it
26483     *
26484     * The return value is a pointer to data associated to @p item when it was
26485     * created, with function elm_diskselector_item_append(). If no data
26486     * was passed as argument, it will return @c NULL.
26487     *
26488     * @see elm_diskselector_item_append()
26489     *
26490     * @ingroup Diskselector
26491     */
26492    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26493
26494    /**
26495     * Set the icon associated to the item.
26496     *
26497     * @param it The diskselector item
26498     * @param icon The icon object to associate with @p it
26499     *
26500     * The icon object to use at left side of the item. An
26501     * icon can be any Evas object, but usually it is an icon created
26502     * with elm_icon_add().
26503     *
26504     * Once the icon object is set, a previously set one will be deleted.
26505     * @warning Setting the same icon for two items will cause the icon to
26506     * dissapear from the first item.
26507     *
26508     * If an icon was passed as argument on item creation, with function
26509     * elm_diskselector_item_append(), it will be already
26510     * associated to the item.
26511     *
26512     * @see elm_diskselector_item_append()
26513     * @see elm_diskselector_item_icon_get()
26514     *
26515     * @ingroup Diskselector
26516     */
26517    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26518
26519    /**
26520     * Get the icon associated to the item.
26521     *
26522     * @param it The diskselector item
26523     * @return The icon associated to @p it
26524     *
26525     * The return value is a pointer to the icon associated to @p item when it was
26526     * created, with function elm_diskselector_item_append(), or later
26527     * with function elm_diskselector_item_icon_set. If no icon
26528     * was passed as argument, it will return @c NULL.
26529     *
26530     * @see elm_diskselector_item_append()
26531     * @see elm_diskselector_item_icon_set()
26532     *
26533     * @ingroup Diskselector
26534     */
26535    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26536
26537    /**
26538     * Set the label of item.
26539     *
26540     * @param it The item of diskselector.
26541     * @param label The label of item.
26542     *
26543     * The label to be displayed by the item.
26544     *
26545     * If no icon is set, label will be centered on item position, otherwise
26546     * the icon will be placed at left of the label, that will be shifted
26547     * to the right.
26548     *
26549     * An item with label "January" would be displayed on side position as
26550     * "Jan" if max length is set to 3 with function
26551     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26552     * is set to 4.
26553     *
26554     * When this @p item is selected, the entire label will be displayed,
26555     * except for width restrictions.
26556     * In this case label will be cropped and "..." will be concatenated,
26557     * but only for display purposes. It will keep the entire string, so
26558     * if diskselector is resized the remaining characters will be displayed.
26559     *
26560     * If a label was passed as argument on item creation, with function
26561     * elm_diskselector_item_append(), it will be already
26562     * displayed by the item.
26563     *
26564     * @see elm_diskselector_side_label_lenght_set()
26565     * @see elm_diskselector_item_label_get()
26566     * @see elm_diskselector_item_append()
26567     *
26568     * @ingroup Diskselector
26569     */
26570    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26571
26572    /**
26573     * Get the label of item.
26574     *
26575     * @param it The item of diskselector.
26576     * @return The label of item.
26577     *
26578     * The return value is a pointer to the label associated to @p item when it was
26579     * created, with function elm_diskselector_item_append(), or later
26580     * with function elm_diskselector_item_label_set. If no label
26581     * was passed as argument, it will return @c NULL.
26582     *
26583     * @see elm_diskselector_item_label_set() for more details.
26584     * @see elm_diskselector_item_append()
26585     *
26586     * @ingroup Diskselector
26587     */
26588    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26589
26590    /**
26591     * Get the selected item.
26592     *
26593     * @param obj The diskselector object.
26594     * @return The selected diskselector item.
26595     *
26596     * The selected item can be unselected with function
26597     * elm_diskselector_item_selected_set(), and the first item of
26598     * diskselector will be selected.
26599     *
26600     * The selected item always will be centered on diskselector, with
26601     * full label displayed, i.e., max lenght set to side labels won't
26602     * apply on the selected item. More details on
26603     * elm_diskselector_side_label_length_set().
26604     *
26605     * @ingroup Diskselector
26606     */
26607    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26608
26609    /**
26610     * Set the selected state of an item.
26611     *
26612     * @param it The diskselector item
26613     * @param selected The selected state
26614     *
26615     * This sets the selected state of the given item @p it.
26616     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26617     *
26618     * If a new item is selected the previosly selected will be unselected.
26619     * Previoulsy selected item can be get with function
26620     * elm_diskselector_selected_item_get().
26621     *
26622     * If the item @p it is unselected, the first item of diskselector will
26623     * be selected.
26624     *
26625     * Selected items will be visible on center position of diskselector.
26626     * So if it was on another position before selected, or was invisible,
26627     * diskselector will animate items until the selected item reaches center
26628     * position.
26629     *
26630     * @see elm_diskselector_item_selected_get()
26631     * @see elm_diskselector_selected_item_get()
26632     *
26633     * @ingroup Diskselector
26634     */
26635    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26636
26637    /*
26638     * Get whether the @p item is selected or not.
26639     *
26640     * @param it The diskselector item.
26641     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26642     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26643     *
26644     * @see elm_diskselector_selected_item_set() for details.
26645     * @see elm_diskselector_item_selected_get()
26646     *
26647     * @ingroup Diskselector
26648     */
26649    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26650
26651    /**
26652     * Get the first item of the diskselector.
26653     *
26654     * @param obj The diskselector object.
26655     * @return The first item, or @c NULL if none.
26656     *
26657     * The list of items follows append order. So it will return the first
26658     * item appended to the widget that wasn't deleted.
26659     *
26660     * @see elm_diskselector_item_append()
26661     * @see elm_diskselector_items_get()
26662     *
26663     * @ingroup Diskselector
26664     */
26665    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26666
26667    /**
26668     * Get the last item of the diskselector.
26669     *
26670     * @param obj The diskselector object.
26671     * @return The last item, or @c NULL if none.
26672     *
26673     * The list of items follows append order. So it will return last first
26674     * item appended to the widget that wasn't deleted.
26675     *
26676     * @see elm_diskselector_item_append()
26677     * @see elm_diskselector_items_get()
26678     *
26679     * @ingroup Diskselector
26680     */
26681    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26682
26683    /**
26684     * Get the item before @p item in diskselector.
26685     *
26686     * @param it The diskselector item.
26687     * @return The item before @p item, or @c NULL if none or on failure.
26688     *
26689     * The list of items follows append order. So it will return item appended
26690     * just before @p item and that wasn't deleted.
26691     *
26692     * If it is the first item, @c NULL will be returned.
26693     * First item can be get by elm_diskselector_first_item_get().
26694     *
26695     * @see elm_diskselector_item_append()
26696     * @see elm_diskselector_items_get()
26697     *
26698     * @ingroup Diskselector
26699     */
26700    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26701
26702    /**
26703     * Get the item after @p item in diskselector.
26704     *
26705     * @param it The diskselector item.
26706     * @return The item after @p item, or @c NULL if none or on failure.
26707     *
26708     * The list of items follows append order. So it will return item appended
26709     * just after @p item and that wasn't deleted.
26710     *
26711     * If it is the last item, @c NULL will be returned.
26712     * Last item can be get by elm_diskselector_last_item_get().
26713     *
26714     * @see elm_diskselector_item_append()
26715     * @see elm_diskselector_items_get()
26716     *
26717     * @ingroup Diskselector
26718     */
26719    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26720
26721    /**
26722     * Set the text to be shown in the diskselector item.
26723     *
26724     * @param item Target item
26725     * @param text The text to set in the content
26726     *
26727     * Setup the text as tooltip to object. The item can have only one tooltip,
26728     * so any previous tooltip data is removed.
26729     *
26730     * @see elm_object_tooltip_text_set() for more details.
26731     *
26732     * @ingroup Diskselector
26733     */
26734    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26735
26736    /**
26737     * Set the content to be shown in the tooltip item.
26738     *
26739     * Setup the tooltip to item. The item can have only one tooltip,
26740     * so any previous tooltip data is removed. @p func(with @p data) will
26741     * be called every time that need show the tooltip and it should
26742     * return a valid Evas_Object. This object is then managed fully by
26743     * tooltip system and is deleted when the tooltip is gone.
26744     *
26745     * @param item the diskselector item being attached a tooltip.
26746     * @param func the function used to create the tooltip contents.
26747     * @param data what to provide to @a func as callback data/context.
26748     * @param del_cb called when data is not needed anymore, either when
26749     *        another callback replaces @p func, the tooltip is unset with
26750     *        elm_diskselector_item_tooltip_unset() or the owner @a item
26751     *        dies. This callback receives as the first parameter the
26752     *        given @a data, and @c event_info is the item.
26753     *
26754     * @see elm_object_tooltip_content_cb_set() for more details.
26755     *
26756     * @ingroup Diskselector
26757     */
26758    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);
26759
26760    /**
26761     * Unset tooltip from item.
26762     *
26763     * @param item diskselector item to remove previously set tooltip.
26764     *
26765     * Remove tooltip from item. The callback provided as del_cb to
26766     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26767     * it is not used anymore.
26768     *
26769     * @see elm_object_tooltip_unset() for more details.
26770     * @see elm_diskselector_item_tooltip_content_cb_set()
26771     *
26772     * @ingroup Diskselector
26773     */
26774    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26775
26776
26777    /**
26778     * Sets a different style for this item tooltip.
26779     *
26780     * @note before you set a style you should define a tooltip with
26781     *       elm_diskselector_item_tooltip_content_cb_set() or
26782     *       elm_diskselector_item_tooltip_text_set()
26783     *
26784     * @param item diskselector item with tooltip already set.
26785     * @param style the theme style to use (default, transparent, ...)
26786     *
26787     * @see elm_object_tooltip_style_set() for more details.
26788     *
26789     * @ingroup Diskselector
26790     */
26791    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26792
26793    /**
26794     * Get the style for this item tooltip.
26795     *
26796     * @param item diskselector item with tooltip already set.
26797     * @return style the theme style in use, defaults to "default". If the
26798     *         object does not have a tooltip set, then NULL is returned.
26799     *
26800     * @see elm_object_tooltip_style_get() for more details.
26801     * @see elm_diskselector_item_tooltip_style_set()
26802     *
26803     * @ingroup Diskselector
26804     */
26805    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26806
26807    /**
26808     * Set the cursor to be shown when mouse is over the diskselector item
26809     *
26810     * @param item Target item
26811     * @param cursor the cursor name to be used.
26812     *
26813     * @see elm_object_cursor_set() for more details.
26814     *
26815     * @ingroup Diskselector
26816     */
26817    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26818
26819    /**
26820     * Get the cursor to be shown when mouse is over the diskselector item
26821     *
26822     * @param item diskselector item with cursor already set.
26823     * @return the cursor name.
26824     *
26825     * @see elm_object_cursor_get() for more details.
26826     * @see elm_diskselector_cursor_set()
26827     *
26828     * @ingroup Diskselector
26829     */
26830    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26831
26832
26833    /**
26834     * Unset the cursor to be shown when mouse is over the diskselector item
26835     *
26836     * @param item Target item
26837     *
26838     * @see elm_object_cursor_unset() for more details.
26839     * @see elm_diskselector_cursor_set()
26840     *
26841     * @ingroup Diskselector
26842     */
26843    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26844
26845    /**
26846     * Sets a different style for this item cursor.
26847     *
26848     * @note before you set a style you should define a cursor with
26849     *       elm_diskselector_item_cursor_set()
26850     *
26851     * @param item diskselector item with cursor already set.
26852     * @param style the theme style to use (default, transparent, ...)
26853     *
26854     * @see elm_object_cursor_style_set() for more details.
26855     *
26856     * @ingroup Diskselector
26857     */
26858    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26859
26860
26861    /**
26862     * Get the style for this item cursor.
26863     *
26864     * @param item diskselector item with cursor already set.
26865     * @return style the theme style in use, defaults to "default". If the
26866     *         object does not have a cursor set, then @c NULL is returned.
26867     *
26868     * @see elm_object_cursor_style_get() for more details.
26869     * @see elm_diskselector_item_cursor_style_set()
26870     *
26871     * @ingroup Diskselector
26872     */
26873    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26874
26875
26876    /**
26877     * Set if the cursor set should be searched on the theme or should use
26878     * the provided by the engine, only.
26879     *
26880     * @note before you set if should look on theme you should define a cursor
26881     * with elm_diskselector_item_cursor_set().
26882     * By default it will only look for cursors provided by the engine.
26883     *
26884     * @param item widget item with cursor already set.
26885     * @param engine_only boolean to define if cursors set with
26886     * elm_diskselector_item_cursor_set() should be searched only
26887     * between cursors provided by the engine or searched on widget's
26888     * theme as well.
26889     *
26890     * @see elm_object_cursor_engine_only_set() for more details.
26891     *
26892     * @ingroup Diskselector
26893     */
26894    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26895
26896    /**
26897     * Get the cursor engine only usage for this item cursor.
26898     *
26899     * @param item widget item with cursor already set.
26900     * @return engine_only boolean to define it cursors should be looked only
26901     * between the provided by the engine or searched on widget's theme as well.
26902     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26903     *
26904     * @see elm_object_cursor_engine_only_get() for more details.
26905     * @see elm_diskselector_item_cursor_engine_only_set()
26906     *
26907     * @ingroup Diskselector
26908     */
26909    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26910
26911    /**
26912     * @}
26913     */
26914
26915    /**
26916     * @defgroup Colorselector Colorselector
26917     *
26918     * @{
26919     *
26920     * @image html img/widget/colorselector/preview-00.png
26921     * @image latex img/widget/colorselector/preview-00.eps
26922     *
26923     * @brief Widget for user to select a color.
26924     *
26925     * Signals that you can add callbacks for are:
26926     * "changed" - When the color value changes(event_info is NULL).
26927     *
26928     * See @ref tutorial_colorselector.
26929     */
26930    /**
26931     * @brief Add a new colorselector to the parent
26932     *
26933     * @param parent The parent object
26934     * @return The new object or NULL if it cannot be created
26935     *
26936     * @ingroup Colorselector
26937     */
26938    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26939    /**
26940     * Set a color for the colorselector
26941     *
26942     * @param obj   Colorselector object
26943     * @param r     r-value of color
26944     * @param g     g-value of color
26945     * @param b     b-value of color
26946     * @param a     a-value of color
26947     *
26948     * @ingroup Colorselector
26949     */
26950    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26951    /**
26952     * Get a color from the colorselector
26953     *
26954     * @param obj   Colorselector object
26955     * @param r     integer pointer for r-value of color
26956     * @param g     integer pointer for g-value of color
26957     * @param b     integer pointer for b-value of color
26958     * @param a     integer pointer for a-value of color
26959     *
26960     * @ingroup Colorselector
26961     */
26962    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26963    /**
26964     * @}
26965     */
26966
26967    /**
26968     * @defgroup Ctxpopup Ctxpopup
26969     *
26970     * @image html img/widget/ctxpopup/preview-00.png
26971     * @image latex img/widget/ctxpopup/preview-00.eps
26972     *
26973     * @brief Context popup widet.
26974     *
26975     * A ctxpopup is a widget that, when shown, pops up a list of items.
26976     * It automatically chooses an area inside its parent object's view
26977     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26978     * optimally fit into it. In the default theme, it will also point an
26979     * arrow to it's top left position at the time one shows it. Ctxpopup
26980     * items have a label and/or an icon. It is intended for a small
26981     * number of items (hence the use of list, not genlist).
26982     *
26983     * @note Ctxpopup is a especialization of @ref Hover.
26984     *
26985     * Signals that you can add callbacks for are:
26986     * "dismissed" - the ctxpopup was dismissed
26987     *
26988     * Default contents parts of the ctxpopup widget that you can use for are:
26989     * @li "default" - A content of the ctxpopup
26990     *
26991     * Default contents parts of the naviframe items that you can use for are:
26992     * @li "icon" - An icon in the title area
26993     *
26994     * Default text parts of the naviframe items that you can use for are:
26995     * @li "default" - Title label in the title area
26996     *
26997     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26998     * @{
26999     */
27000    typedef enum _Elm_Ctxpopup_Direction
27001      {
27002         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
27003                                           area */
27004         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
27005                                            the clicked area */
27006         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
27007                                           the clicked area */
27008         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
27009                                         area */
27010         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
27011      } Elm_Ctxpopup_Direction;
27012
27013    /**
27014     * @brief Add a new Ctxpopup object to the parent.
27015     *
27016     * @param parent Parent object
27017     * @return New object or @c NULL, if it cannot be created
27018     */
27019    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27020    /**
27021     * @brief Set the Ctxpopup's parent
27022     *
27023     * @param obj The ctxpopup object
27024     * @param area The parent to use
27025     *
27026     * Set the parent object.
27027     *
27028     * @note elm_ctxpopup_add() will automatically call this function
27029     * with its @c parent argument.
27030     *
27031     * @see elm_ctxpopup_add()
27032     * @see elm_hover_parent_set()
27033     */
27034    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
27035    /**
27036     * @brief Get the Ctxpopup's parent
27037     *
27038     * @param obj The ctxpopup object
27039     *
27040     * @see elm_ctxpopup_hover_parent_set() for more information
27041     */
27042    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27043    /**
27044     * @brief Clear all items in the given ctxpopup object.
27045     *
27046     * @param obj Ctxpopup object
27047     */
27048    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
27049    /**
27050     * @brief Change the ctxpopup's orientation to horizontal or vertical.
27051     *
27052     * @param obj Ctxpopup object
27053     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
27054     */
27055    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
27056    /**
27057     * @brief Get the value of current ctxpopup object's orientation.
27058     *
27059     * @param obj Ctxpopup object
27060     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
27061     *
27062     * @see elm_ctxpopup_horizontal_set()
27063     */
27064    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27065    /**
27066     * @brief Add a new item to a ctxpopup object.
27067     *
27068     * @param obj Ctxpopup object
27069     * @param icon Icon to be set on new item
27070     * @param label The Label of the new item
27071     * @param func Convenience function called when item selected
27072     * @param data Data passed to @p func
27073     * @return A handle to the item added or @c NULL, on errors
27074     *
27075     * @warning Ctxpopup can't hold both an item list and a content at the same
27076     * time. When an item is added, any previous content will be removed.
27077     *
27078     * @see elm_ctxpopup_content_set()
27079     */
27080    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);
27081    /**
27082     * @brief Delete the given item in a ctxpopup object.
27083     *
27084     * @param it Ctxpopup item to be deleted
27085     *
27086     * @see elm_ctxpopup_item_append()
27087     */
27088    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27089    /**
27090     * @brief Set the ctxpopup item's state as disabled or enabled.
27091     *
27092     * @param it Ctxpopup item to be enabled/disabled
27093     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
27094     *
27095     * When disabled the item is greyed out to indicate it's state.
27096     * @deprecated use elm_object_item_disabled_set() instead
27097     */
27098    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
27099    /**
27100     * @brief Get the ctxpopup item's disabled/enabled state.
27101     *
27102     * @param it Ctxpopup item to be enabled/disabled
27103     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
27104     *
27105     * @see elm_ctxpopup_item_disabled_set()
27106     * @deprecated use elm_object_item_disabled_get() instead
27107     */
27108    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27109    /**
27110     * @brief Get the icon object for the given ctxpopup item.
27111     *
27112     * @param it Ctxpopup item
27113     * @return icon object or @c NULL, if the item does not have icon or an error
27114     * occurred
27115     *
27116     * @see elm_ctxpopup_item_append()
27117     * @see elm_ctxpopup_item_icon_set()
27118     *
27119     * @deprecated use elm_object_item_part_content_get() instead
27120     */
27121    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27122    /**
27123     * @brief Sets the side icon associated with the ctxpopup item
27124     *
27125     * @param it Ctxpopup item
27126     * @param icon Icon object to be set
27127     *
27128     * Once the icon object is set, a previously set one will be deleted.
27129     * @warning Setting the same icon for two items will cause the icon to
27130     * dissapear from the first item.
27131     *
27132     * @see elm_ctxpopup_item_append()
27133     *
27134     * @deprecated use elm_object_item_part_content_set() instead
27135     *
27136     */
27137    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27138    /**
27139     * @brief Get the label for the given ctxpopup item.
27140     *
27141     * @param it Ctxpopup item
27142     * @return label string or @c NULL, if the item does not have label or an
27143     * error occured
27144     *
27145     * @see elm_ctxpopup_item_append()
27146     * @see elm_ctxpopup_item_label_set()
27147     *
27148     * @deprecated use elm_object_item_text_get() instead
27149     */
27150    EINA_DEPRECATED EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27151    /**
27152     * @brief (Re)set the label on the given ctxpopup item.
27153     *
27154     * @param it Ctxpopup item
27155     * @param label String to set as label
27156     *
27157     * @deprecated use elm_object_item_text_set() instead
27158     */
27159    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
27160    /**
27161     * @brief Set an elm widget as the content of the ctxpopup.
27162     *
27163     * @param obj Ctxpopup object
27164     * @param content Content to be swallowed
27165     *
27166     * If the content object is already set, a previous one will bedeleted. If
27167     * you want to keep that old content object, use the
27168     * elm_ctxpopup_content_unset() function.
27169     *
27170     * @warning Ctxpopup can't hold both a item list and a content at the same
27171     * time. When a content is set, any previous items will be removed.
27172     *
27173     * @deprecated use elm_object_content_set() instead
27174     *
27175     */
27176    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
27177    /**
27178     * @brief Unset the ctxpopup content
27179     *
27180     * @param obj Ctxpopup object
27181     * @return The content that was being used
27182     *
27183     * Unparent and return the content object which was set for this widget.
27184     *
27185     * @deprecated use elm_object_content_unset()
27186     *
27187     * @see elm_ctxpopup_content_set()
27188     *
27189     * @deprecated use elm_object_content_unset() instead
27190     *
27191     */
27192    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
27193    /**
27194     * @brief Set the direction priority of a ctxpopup.
27195     *
27196     * @param obj Ctxpopup object
27197     * @param first 1st priority of direction
27198     * @param second 2nd priority of direction
27199     * @param third 3th priority of direction
27200     * @param fourth 4th priority of direction
27201     *
27202     * This functions gives a chance to user to set the priority of ctxpopup
27203     * showing direction. This doesn't guarantee the ctxpopup will appear in the
27204     * requested direction.
27205     *
27206     * @see Elm_Ctxpopup_Direction
27207     */
27208    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);
27209    /**
27210     * @brief Get the direction priority of a ctxpopup.
27211     *
27212     * @param obj Ctxpopup object
27213     * @param first 1st priority of direction to be returned
27214     * @param second 2nd priority of direction to be returned
27215     * @param third 3th priority of direction to be returned
27216     * @param fourth 4th priority of direction to be returned
27217     *
27218     * @see elm_ctxpopup_direction_priority_set() for more information.
27219     */
27220    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);
27221
27222    /**
27223     * @brief Get the current direction of a ctxpopup.
27224     *
27225     * @param obj Ctxpopup object
27226     * @return current direction of a ctxpopup
27227     *
27228     * @warning Once the ctxpopup showed up, the direction would be determined
27229     */
27230    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27231
27232    /**
27233     * @}
27234     */
27235
27236    /* transit */
27237    /**
27238     *
27239     * @defgroup Transit Transit
27240     * @ingroup Elementary
27241     *
27242     * Transit is designed to apply various animated transition effects to @c
27243     * Evas_Object, such like translation, rotation, etc. For using these
27244     * effects, create an @ref Elm_Transit and add the desired transition effects.
27245     *
27246     * Once the effects are added into transit, they will be automatically
27247     * managed (their callback will be called until the duration is ended, and
27248     * they will be deleted on completion).
27249     *
27250     * Example:
27251     * @code
27252     * Elm_Transit *trans = elm_transit_add();
27253     * elm_transit_object_add(trans, obj);
27254     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
27255     * elm_transit_duration_set(transit, 1);
27256     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
27257     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
27258     * elm_transit_repeat_times_set(transit, 3);
27259     * @endcode
27260     *
27261     * Some transition effects are used to change the properties of objects. They
27262     * are:
27263     * @li @ref elm_transit_effect_translation_add
27264     * @li @ref elm_transit_effect_color_add
27265     * @li @ref elm_transit_effect_rotation_add
27266     * @li @ref elm_transit_effect_wipe_add
27267     * @li @ref elm_transit_effect_zoom_add
27268     * @li @ref elm_transit_effect_resizing_add
27269     *
27270     * Other transition effects are used to make one object disappear and another
27271     * object appear on its old place. These effects are:
27272     *
27273     * @li @ref elm_transit_effect_flip_add
27274     * @li @ref elm_transit_effect_resizable_flip_add
27275     * @li @ref elm_transit_effect_fade_add
27276     * @li @ref elm_transit_effect_blend_add
27277     *
27278     * It's also possible to make a transition chain with @ref
27279     * elm_transit_chain_transit_add.
27280     *
27281     * @warning We strongly recommend to use elm_transit just when edje can not do
27282     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
27283     * animations can be manipulated inside the theme.
27284     *
27285     * List of examples:
27286     * @li @ref transit_example_01_explained
27287     * @li @ref transit_example_02_explained
27288     * @li @ref transit_example_03_c
27289     * @li @ref transit_example_04_c
27290     *
27291     * @{
27292     */
27293
27294    /**
27295     * @enum Elm_Transit_Tween_Mode
27296     *
27297     * The type of acceleration used in the transition.
27298     */
27299    typedef enum
27300      {
27301         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
27302         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
27303                                              over time, then decrease again
27304                                              and stop slowly */
27305         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
27306                                              speed over time */
27307         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
27308                                             over time */
27309      } Elm_Transit_Tween_Mode;
27310
27311    /**
27312     * @enum Elm_Transit_Effect_Flip_Axis
27313     *
27314     * The axis where flip effect should be applied.
27315     */
27316    typedef enum
27317      {
27318         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
27319         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
27320      } Elm_Transit_Effect_Flip_Axis;
27321    /**
27322     * @enum Elm_Transit_Effect_Wipe_Dir
27323     *
27324     * The direction where the wipe effect should occur.
27325     */
27326    typedef enum
27327      {
27328         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
27329         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
27330         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
27331         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
27332      } Elm_Transit_Effect_Wipe_Dir;
27333    /** @enum Elm_Transit_Effect_Wipe_Type
27334     *
27335     * Whether the wipe effect should show or hide the object.
27336     */
27337    typedef enum
27338      {
27339         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
27340                                              animation */
27341         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
27342                                             animation */
27343      } Elm_Transit_Effect_Wipe_Type;
27344
27345    /**
27346     * @typedef Elm_Transit
27347     *
27348     * The Transit created with elm_transit_add(). This type has the information
27349     * about the objects which the transition will be applied, and the
27350     * transition effects that will be used. It also contains info about
27351     * duration, number of repetitions, auto-reverse, etc.
27352     */
27353    typedef struct _Elm_Transit Elm_Transit;
27354    typedef void Elm_Transit_Effect;
27355    /**
27356     * @typedef Elm_Transit_Effect_Transition_Cb
27357     *
27358     * Transition callback called for this effect on each transition iteration.
27359     */
27360    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27361    /**
27362     * Elm_Transit_Effect_End_Cb
27363     *
27364     * Transition callback called for this effect when the transition is over.
27365     */
27366    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27367
27368    /**
27369     * Elm_Transit_Del_Cb
27370     *
27371     * A callback called when the transit is deleted.
27372     */
27373    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27374
27375    /**
27376     * Add new transit.
27377     *
27378     * @note Is not necessary to delete the transit object, it will be deleted at
27379     * the end of its operation.
27380     * @note The transit will start playing when the program enter in the main loop, is not
27381     * necessary to give a start to the transit.
27382     *
27383     * @return The transit object.
27384     *
27385     * @ingroup Transit
27386     */
27387    EAPI Elm_Transit                *elm_transit_add(void);
27388
27389    /**
27390     * Stops the animation and delete the @p transit object.
27391     *
27392     * Call this function if you wants to stop the animation before the duration
27393     * time. Make sure the @p transit object is still alive with
27394     * elm_transit_del_cb_set() function.
27395     * All added effects will be deleted, calling its repective data_free_cb
27396     * functions. The function setted by elm_transit_del_cb_set() will be called.
27397     *
27398     * @see elm_transit_del_cb_set()
27399     *
27400     * @param transit The transit object to be deleted.
27401     *
27402     * @ingroup Transit
27403     * @warning Just call this function if you are sure the transit is alive.
27404     */
27405    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27406
27407    /**
27408     * Add a new effect to the transit.
27409     *
27410     * @note The cb function and the data are the key to the effect. If you try to
27411     * add an already added effect, nothing is done.
27412     * @note After the first addition of an effect in @p transit, if its
27413     * effect list become empty again, the @p transit will be killed by
27414     * elm_transit_del(transit) function.
27415     *
27416     * Exemple:
27417     * @code
27418     * Elm_Transit *transit = elm_transit_add();
27419     * elm_transit_effect_add(transit,
27420     *                        elm_transit_effect_blend_op,
27421     *                        elm_transit_effect_blend_context_new(),
27422     *                        elm_transit_effect_blend_context_free);
27423     * @endcode
27424     *
27425     * @param transit The transit object.
27426     * @param transition_cb The operation function. It is called when the
27427     * animation begins, it is the function that actually performs the animation.
27428     * It is called with the @p data, @p transit and the time progression of the
27429     * animation (a double value between 0.0 and 1.0).
27430     * @param effect The context data of the effect.
27431     * @param end_cb The function to free the context data, it will be called
27432     * at the end of the effect, it must finalize the animation and free the
27433     * @p data.
27434     *
27435     * @ingroup Transit
27436     * @warning The transit free the context data at the and of the transition with
27437     * the data_free_cb function, do not use the context data in another transit.
27438     */
27439    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);
27440
27441    /**
27442     * Delete an added effect.
27443     *
27444     * This function will remove the effect from the @p transit, calling the
27445     * data_free_cb to free the @p data.
27446     *
27447     * @see elm_transit_effect_add()
27448     *
27449     * @note If the effect is not found, nothing is done.
27450     * @note If the effect list become empty, this function will call
27451     * elm_transit_del(transit), that is, it will kill the @p transit.
27452     *
27453     * @param transit The transit object.
27454     * @param transition_cb The operation function.
27455     * @param effect The context data of the effect.
27456     *
27457     * @ingroup Transit
27458     */
27459    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);
27460
27461    /**
27462     * Add new object to apply the effects.
27463     *
27464     * @note After the first addition of an object in @p transit, if its
27465     * object list become empty again, the @p transit will be killed by
27466     * elm_transit_del(transit) function.
27467     * @note If the @p obj belongs to another transit, the @p obj will be
27468     * removed from it and it will only belong to the @p transit. If the old
27469     * transit stays without objects, it will die.
27470     * @note When you add an object into the @p transit, its state from
27471     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27472     * transit ends, if you change this state whith evas_object_pass_events_set()
27473     * after add the object, this state will change again when @p transit stops to
27474     * run.
27475     *
27476     * @param transit The transit object.
27477     * @param obj Object to be animated.
27478     *
27479     * @ingroup Transit
27480     * @warning It is not allowed to add a new object after transit begins to go.
27481     */
27482    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27483
27484    /**
27485     * Removes an added object from the transit.
27486     *
27487     * @note If the @p obj is not in the @p transit, nothing is done.
27488     * @note If the list become empty, this function will call
27489     * elm_transit_del(transit), that is, it will kill the @p transit.
27490     *
27491     * @param transit The transit object.
27492     * @param obj Object to be removed from @p transit.
27493     *
27494     * @ingroup Transit
27495     * @warning It is not allowed to remove objects after transit begins to go.
27496     */
27497    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27498
27499    /**
27500     * Get the objects of the transit.
27501     *
27502     * @param transit The transit object.
27503     * @return a Eina_List with the objects from the transit.
27504     *
27505     * @ingroup Transit
27506     */
27507    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27508
27509    /**
27510     * Enable/disable keeping up the objects states.
27511     * If it is not kept, the objects states will be reset when transition ends.
27512     *
27513     * @note @p transit can not be NULL.
27514     * @note One state includes geometry, color, map data.
27515     *
27516     * @param transit The transit object.
27517     * @param state_keep Keeping or Non Keeping.
27518     *
27519     * @ingroup Transit
27520     */
27521    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27522
27523    /**
27524     * Get a value whether the objects states will be reset or not.
27525     *
27526     * @note @p transit can not be NULL
27527     *
27528     * @see elm_transit_objects_final_state_keep_set()
27529     *
27530     * @param transit The transit object.
27531     * @return EINA_TRUE means the states of the objects will be reset.
27532     * If @p transit is NULL, EINA_FALSE is returned
27533     *
27534     * @ingroup Transit
27535     */
27536    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27537
27538    /**
27539     * Set the event enabled when transit is operating.
27540     *
27541     * If @p enabled is EINA_TRUE, the objects of the transit will receives
27542     * events from mouse and keyboard during the animation.
27543     * @note When you add an object with elm_transit_object_add(), its state from
27544     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27545     * transit ends, if you change this state with evas_object_pass_events_set()
27546     * after adding the object, this state will change again when @p transit stops
27547     * to run.
27548     *
27549     * @param transit The transit object.
27550     * @param enabled Events are received when enabled is @c EINA_TRUE, and
27551     * ignored otherwise.
27552     *
27553     * @ingroup Transit
27554     */
27555    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27556
27557    /**
27558     * Get the value of event enabled status.
27559     *
27560     * @see elm_transit_event_enabled_set()
27561     *
27562     * @param transit The Transit object
27563     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27564     * EINA_FALSE is returned
27565     *
27566     * @ingroup Transit
27567     */
27568    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27569
27570    /**
27571     * Set the user-callback function when the transit is deleted.
27572     *
27573     * @note Using this function twice will overwrite the first function setted.
27574     * @note the @p transit object will be deleted after call @p cb function.
27575     *
27576     * @param transit The transit object.
27577     * @param cb Callback function pointer. This function will be called before
27578     * the deletion of the transit.
27579     * @param data Callback funtion user data. It is the @p op parameter.
27580     *
27581     * @ingroup Transit
27582     */
27583    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27584
27585    /**
27586     * Set reverse effect automatically.
27587     *
27588     * If auto reverse is setted, after running the effects with the progress
27589     * parameter from 0 to 1, it will call the effecs again with the progress
27590     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27591     * where the duration was setted with the function elm_transit_add and
27592     * the repeat with the function elm_transit_repeat_times_set().
27593     *
27594     * @param transit The transit object.
27595     * @param reverse EINA_TRUE means the auto_reverse is on.
27596     *
27597     * @ingroup Transit
27598     */
27599    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27600
27601    /**
27602     * Get if the auto reverse is on.
27603     *
27604     * @see elm_transit_auto_reverse_set()
27605     *
27606     * @param transit The transit object.
27607     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27608     * EINA_FALSE is returned
27609     *
27610     * @ingroup Transit
27611     */
27612    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27613
27614    /**
27615     * Set the transit repeat count. Effect will be repeated by repeat count.
27616     *
27617     * This function sets the number of repetition the transit will run after
27618     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27619     * If the @p repeat is a negative number, it will repeat infinite times.
27620     *
27621     * @note If this function is called during the transit execution, the transit
27622     * will run @p repeat times, ignoring the times it already performed.
27623     *
27624     * @param transit The transit object
27625     * @param repeat Repeat count
27626     *
27627     * @ingroup Transit
27628     */
27629    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27630
27631    /**
27632     * Get the transit repeat count.
27633     *
27634     * @see elm_transit_repeat_times_set()
27635     *
27636     * @param transit The Transit object.
27637     * @return The repeat count. If @p transit is NULL
27638     * 0 is returned
27639     *
27640     * @ingroup Transit
27641     */
27642    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27643
27644    /**
27645     * Set the transit animation acceleration type.
27646     *
27647     * This function sets the tween mode of the transit that can be:
27648     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27649     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27650     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27651     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27652     *
27653     * @param transit The transit object.
27654     * @param tween_mode The tween type.
27655     *
27656     * @ingroup Transit
27657     */
27658    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27659
27660    /**
27661     * Get the transit animation acceleration type.
27662     *
27663     * @note @p transit can not be NULL
27664     *
27665     * @param transit The transit object.
27666     * @return The tween type. If @p transit is NULL
27667     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27668     *
27669     * @ingroup Transit
27670     */
27671    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27672
27673    /**
27674     * Set the transit animation time
27675     *
27676     * @note @p transit can not be NULL
27677     *
27678     * @param transit The transit object.
27679     * @param duration The animation time.
27680     *
27681     * @ingroup Transit
27682     */
27683    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27684
27685    /**
27686     * Get the transit animation time
27687     *
27688     * @note @p transit can not be NULL
27689     *
27690     * @param transit The transit object.
27691     *
27692     * @return The transit animation time.
27693     *
27694     * @ingroup Transit
27695     */
27696    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27697
27698    /**
27699     * Starts the transition.
27700     * Once this API is called, the transit begins to measure the time.
27701     *
27702     * @note @p transit can not be NULL
27703     *
27704     * @param transit The transit object.
27705     *
27706     * @ingroup Transit
27707     */
27708    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27709
27710    /**
27711     * Pause/Resume the transition.
27712     *
27713     * If you call elm_transit_go again, the transit will be started from the
27714     * beginning, and will be unpaused.
27715     *
27716     * @note @p transit can not be NULL
27717     *
27718     * @param transit The transit object.
27719     * @param paused Whether the transition should be paused or not.
27720     *
27721     * @ingroup Transit
27722     */
27723    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27724
27725    /**
27726     * Get the value of paused status.
27727     *
27728     * @see elm_transit_paused_set()
27729     *
27730     * @note @p transit can not be NULL
27731     *
27732     * @param transit The transit object.
27733     * @return EINA_TRUE means transition is paused. If @p transit is NULL
27734     * EINA_FALSE is returned
27735     *
27736     * @ingroup Transit
27737     */
27738    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27739
27740    /**
27741     * Get the time progression of the animation (a double value between 0.0 and 1.0).
27742     *
27743     * The value returned is a fraction (current time / total time). It
27744     * represents the progression position relative to the total.
27745     *
27746     * @note @p transit can not be NULL
27747     *
27748     * @param transit The transit object.
27749     *
27750     * @return The time progression value. If @p transit is NULL
27751     * 0 is returned
27752     *
27753     * @ingroup Transit
27754     */
27755    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27756
27757    /**
27758     * Makes the chain relationship between two transits.
27759     *
27760     * @note @p transit can not be NULL. Transit would have multiple chain transits.
27761     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27762     *
27763     * @param transit The transit object.
27764     * @param chain_transit The chain transit object. This transit will be operated
27765     *        after transit is done.
27766     *
27767     * This function adds @p chain_transit transition to a chain after the @p
27768     * transit, and will be started as soon as @p transit ends. See @ref
27769     * transit_example_02_explained for a full example.
27770     *
27771     * @ingroup Transit
27772     */
27773    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27774
27775    /**
27776     * Cut off the chain relationship between two transits.
27777     *
27778     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27779     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27780     *
27781     * @param transit The transit object.
27782     * @param chain_transit The chain transit object.
27783     *
27784     * This function remove the @p chain_transit transition from the @p transit.
27785     *
27786     * @ingroup Transit
27787     */
27788    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27789
27790    /**
27791     * Get the current chain transit list.
27792     *
27793     * @note @p transit can not be NULL.
27794     *
27795     * @param transit The transit object.
27796     * @return chain transit list.
27797     *
27798     * @ingroup Transit
27799     */
27800    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
27801
27802    /**
27803     * Add the Resizing Effect to Elm_Transit.
27804     *
27805     * @note This API is one of the facades. It creates resizing effect context
27806     * and add it's required APIs to elm_transit_effect_add.
27807     *
27808     * @see elm_transit_effect_add()
27809     *
27810     * @param transit Transit object.
27811     * @param from_w Object width size when effect begins.
27812     * @param from_h Object height size when effect begins.
27813     * @param to_w Object width size when effect ends.
27814     * @param to_h Object height size when effect ends.
27815     * @return Resizing effect context data.
27816     *
27817     * @ingroup Transit
27818     */
27819    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);
27820
27821    /**
27822     * Add the Translation Effect to Elm_Transit.
27823     *
27824     * @note This API is one of the facades. It creates translation effect context
27825     * and add it's required APIs to elm_transit_effect_add.
27826     *
27827     * @see elm_transit_effect_add()
27828     *
27829     * @param transit Transit object.
27830     * @param from_dx X Position variation when effect begins.
27831     * @param from_dy Y Position variation when effect begins.
27832     * @param to_dx X Position variation when effect ends.
27833     * @param to_dy Y Position variation when effect ends.
27834     * @return Translation effect context data.
27835     *
27836     * @ingroup Transit
27837     * @warning It is highly recommended just create a transit with this effect when
27838     * the window that the objects of the transit belongs has already been created.
27839     * This is because this effect needs the geometry information about the objects,
27840     * and if the window was not created yet, it can get a wrong information.
27841     */
27842    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);
27843
27844    /**
27845     * Add the Zoom Effect to Elm_Transit.
27846     *
27847     * @note This API is one of the facades. It creates zoom effect context
27848     * and add it's required APIs to elm_transit_effect_add.
27849     *
27850     * @see elm_transit_effect_add()
27851     *
27852     * @param transit Transit object.
27853     * @param from_rate Scale rate when effect begins (1 is current rate).
27854     * @param to_rate Scale rate when effect ends.
27855     * @return Zoom effect context data.
27856     *
27857     * @ingroup Transit
27858     * @warning It is highly recommended just create a transit with this effect when
27859     * the window that the objects of the transit belongs has already been created.
27860     * This is because this effect needs the geometry information about the objects,
27861     * and if the window was not created yet, it can get a wrong information.
27862     */
27863    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27864
27865    /**
27866     * Add the Flip Effect to Elm_Transit.
27867     *
27868     * @note This API is one of the facades. It creates flip effect context
27869     * and add it's required APIs to elm_transit_effect_add.
27870     * @note This effect is applied to each pair of objects in the order they are listed
27871     * in the transit list of objects. The first object in the pair will be the
27872     * "front" object and the second will be the "back" object.
27873     *
27874     * @see elm_transit_effect_add()
27875     *
27876     * @param transit Transit object.
27877     * @param axis Flipping Axis(X or Y).
27878     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27879     * @return Flip effect context data.
27880     *
27881     * @ingroup Transit
27882     * @warning It is highly recommended just create a transit with this effect when
27883     * the window that the objects of the transit belongs has already been created.
27884     * This is because this effect needs the geometry information about the objects,
27885     * and if the window was not created yet, it can get a wrong information.
27886     */
27887    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27888
27889    /**
27890     * Add the Resizable Flip Effect to Elm_Transit.
27891     *
27892     * @note This API is one of the facades. It creates resizable flip effect context
27893     * and add it's required APIs to elm_transit_effect_add.
27894     * @note This effect is applied to each pair of objects in the order they are listed
27895     * in the transit list of objects. The first object in the pair will be the
27896     * "front" object and the second will be the "back" object.
27897     *
27898     * @see elm_transit_effect_add()
27899     *
27900     * @param transit Transit object.
27901     * @param axis Flipping Axis(X or Y).
27902     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27903     * @return Resizable flip effect context data.
27904     *
27905     * @ingroup Transit
27906     * @warning It is highly recommended just create a transit with this effect when
27907     * the window that the objects of the transit belongs has already been created.
27908     * This is because this effect needs the geometry information about the objects,
27909     * and if the window was not created yet, it can get a wrong information.
27910     */
27911    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27912
27913    /**
27914     * Add the Wipe Effect to Elm_Transit.
27915     *
27916     * @note This API is one of the facades. It creates wipe effect context
27917     * and add it's required APIs to elm_transit_effect_add.
27918     *
27919     * @see elm_transit_effect_add()
27920     *
27921     * @param transit Transit object.
27922     * @param type Wipe type. Hide or show.
27923     * @param dir Wipe Direction.
27924     * @return Wipe effect context data.
27925     *
27926     * @ingroup Transit
27927     * @warning It is highly recommended just create a transit with this effect when
27928     * the window that the objects of the transit belongs has already been created.
27929     * This is because this effect needs the geometry information about the objects,
27930     * and if the window was not created yet, it can get a wrong information.
27931     */
27932    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27933
27934    /**
27935     * Add the Color Effect to Elm_Transit.
27936     *
27937     * @note This API is one of the facades. It creates color effect context
27938     * and add it's required APIs to elm_transit_effect_add.
27939     *
27940     * @see elm_transit_effect_add()
27941     *
27942     * @param transit        Transit object.
27943     * @param  from_r        RGB R when effect begins.
27944     * @param  from_g        RGB G when effect begins.
27945     * @param  from_b        RGB B when effect begins.
27946     * @param  from_a        RGB A when effect begins.
27947     * @param  to_r          RGB R when effect ends.
27948     * @param  to_g          RGB G when effect ends.
27949     * @param  to_b          RGB B when effect ends.
27950     * @param  to_a          RGB A when effect ends.
27951     * @return               Color effect context data.
27952     *
27953     * @ingroup Transit
27954     */
27955    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);
27956
27957    /**
27958     * Add the Fade Effect to Elm_Transit.
27959     *
27960     * @note This API is one of the facades. It creates fade effect context
27961     * and add it's required APIs to elm_transit_effect_add.
27962     * @note This effect is applied to each pair of objects in the order they are listed
27963     * in the transit list of objects. The first object in the pair will be the
27964     * "before" object and the second will be the "after" object.
27965     *
27966     * @see elm_transit_effect_add()
27967     *
27968     * @param transit Transit object.
27969     * @return Fade effect context data.
27970     *
27971     * @ingroup Transit
27972     * @warning It is highly recommended just create a transit with this effect when
27973     * the window that the objects of the transit belongs has already been created.
27974     * This is because this effect needs the color information about the objects,
27975     * and if the window was not created yet, it can get a wrong information.
27976     */
27977    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27978
27979    /**
27980     * Add the Blend Effect to Elm_Transit.
27981     *
27982     * @note This API is one of the facades. It creates blend effect context
27983     * and add it's required APIs to elm_transit_effect_add.
27984     * @note This effect is applied to each pair of objects in the order they are listed
27985     * in the transit list of objects. The first object in the pair will be the
27986     * "before" object and the second will be the "after" object.
27987     *
27988     * @see elm_transit_effect_add()
27989     *
27990     * @param transit Transit object.
27991     * @return Blend effect context data.
27992     *
27993     * @ingroup Transit
27994     * @warning It is highly recommended just create a transit with this effect when
27995     * the window that the objects of the transit belongs has already been created.
27996     * This is because this effect needs the color information about the objects,
27997     * and if the window was not created yet, it can get a wrong information.
27998     */
27999    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
28000
28001    /**
28002     * Add the Rotation Effect to Elm_Transit.
28003     *
28004     * @note This API is one of the facades. It creates rotation effect context
28005     * and add it's required APIs to elm_transit_effect_add.
28006     *
28007     * @see elm_transit_effect_add()
28008     *
28009     * @param transit Transit object.
28010     * @param from_degree Degree when effect begins.
28011     * @param to_degree Degree when effect is ends.
28012     * @return Rotation effect context data.
28013     *
28014     * @ingroup Transit
28015     * @warning It is highly recommended just create a transit with this effect when
28016     * the window that the objects of the transit belongs has already been created.
28017     * This is because this effect needs the geometry information about the objects,
28018     * and if the window was not created yet, it can get a wrong information.
28019     */
28020    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
28021
28022    /**
28023     * Add the ImageAnimation Effect to Elm_Transit.
28024     *
28025     * @note This API is one of the facades. It creates image animation effect context
28026     * and add it's required APIs to elm_transit_effect_add.
28027     * The @p images parameter is a list images paths. This list and
28028     * its contents will be deleted at the end of the effect by
28029     * elm_transit_effect_image_animation_context_free() function.
28030     *
28031     * Example:
28032     * @code
28033     * char buf[PATH_MAX];
28034     * Eina_List *images = NULL;
28035     * Elm_Transit *transi = elm_transit_add();
28036     *
28037     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
28038     * images = eina_list_append(images, eina_stringshare_add(buf));
28039     *
28040     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
28041     * images = eina_list_append(images, eina_stringshare_add(buf));
28042     * elm_transit_effect_image_animation_add(transi, images);
28043     *
28044     * @endcode
28045     *
28046     * @see elm_transit_effect_add()
28047     *
28048     * @param transit Transit object.
28049     * @param images Eina_List of images file paths. This list and
28050     * its contents will be deleted at the end of the effect by
28051     * elm_transit_effect_image_animation_context_free() function.
28052     * @return Image Animation effect context data.
28053     *
28054     * @ingroup Transit
28055     */
28056    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
28057    /**
28058     * @}
28059     */
28060
28061    typedef struct _Elm_Store                      Elm_Store;
28062    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
28063    typedef struct _Elm_Store_Item                 Elm_Store_Item;
28064    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
28065    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
28066    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
28067    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
28068    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
28069    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
28070    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
28071    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
28072
28073    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
28074    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
28075    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
28076    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
28077
28078    typedef enum
28079      {
28080         ELM_STORE_ITEM_MAPPING_NONE = 0,
28081         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
28082         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
28083         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
28084         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
28085         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
28086         // can add more here as needed by common apps
28087         ELM_STORE_ITEM_MAPPING_LAST
28088      } Elm_Store_Item_Mapping_Type;
28089
28090    struct _Elm_Store_Item_Mapping_Icon
28091      {
28092         // FIXME: allow edje file icons
28093         int                   w, h;
28094         Elm_Icon_Lookup_Order lookup_order;
28095         Eina_Bool             standard_name : 1;
28096         Eina_Bool             no_scale : 1;
28097         Eina_Bool             smooth : 1;
28098         Eina_Bool             scale_up : 1;
28099         Eina_Bool             scale_down : 1;
28100      };
28101
28102    struct _Elm_Store_Item_Mapping_Empty
28103      {
28104         Eina_Bool             dummy;
28105      };
28106
28107    struct _Elm_Store_Item_Mapping_Photo
28108      {
28109         int                   size;
28110      };
28111
28112    struct _Elm_Store_Item_Mapping_Custom
28113      {
28114         Elm_Store_Item_Mapping_Cb func;
28115      };
28116
28117    struct _Elm_Store_Item_Mapping
28118      {
28119         Elm_Store_Item_Mapping_Type     type;
28120         const char                     *part;
28121         int                             offset;
28122         union
28123           {
28124              Elm_Store_Item_Mapping_Empty  empty;
28125              Elm_Store_Item_Mapping_Icon   icon;
28126              Elm_Store_Item_Mapping_Photo  photo;
28127              Elm_Store_Item_Mapping_Custom custom;
28128              // add more types here
28129           } details;
28130      };
28131
28132    struct _Elm_Store_Item_Info
28133      {
28134         Elm_Genlist_Item_Class       *item_class;
28135         const Elm_Store_Item_Mapping *mapping;
28136         void                         *data;
28137         char                         *sort_id;
28138      };
28139
28140    struct _Elm_Store_Item_Info_Filesystem
28141      {
28142         Elm_Store_Item_Info  base;
28143         char                *path;
28144      };
28145
28146 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
28147 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
28148
28149    EAPI void                    elm_store_free(Elm_Store *st);
28150
28151    EAPI Elm_Store              *elm_store_filesystem_new(void);
28152    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
28153    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28154    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28155
28156    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
28157
28158    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
28159    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28160    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28161    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28162    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
28163    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28164
28165    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28166    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
28167    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28168    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
28169    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28170    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28171    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28172
28173    /**
28174     * @defgroup SegmentControl SegmentControl
28175     * @ingroup Elementary
28176     *
28177     * @image html img/widget/segment_control/preview-00.png
28178     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
28179     *
28180     * @image html img/segment_control.png
28181     * @image latex img/segment_control.eps width=\textwidth
28182     *
28183     * Segment control widget is a horizontal control made of multiple segment
28184     * items, each segment item functioning similar to discrete two state button.
28185     * A segment control groups the items together and provides compact
28186     * single button with multiple equal size segments.
28187     *
28188     * Segment item size is determined by base widget
28189     * size and the number of items added.
28190     * Only one segment item can be at selected state. A segment item can display
28191     * combination of Text and any Evas_Object like Images or other widget.
28192     *
28193     * Smart callbacks one can listen to:
28194     * - "changed" - When the user clicks on a segment item which is not
28195     *   previously selected and get selected. The event_info parameter is the
28196     *   segment item pointer.
28197     *
28198     * Available styles for it:
28199     * - @c "default"
28200     *
28201     * Here is an example on its usage:
28202     * @li @ref segment_control_example
28203     */
28204
28205    /**
28206     * @addtogroup SegmentControl
28207     * @{
28208     */
28209
28210    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
28211
28212    /**
28213     * Add a new segment control widget to the given parent Elementary
28214     * (container) object.
28215     *
28216     * @param parent The parent object.
28217     * @return a new segment control widget handle or @c NULL, on errors.
28218     *
28219     * This function inserts a new segment control widget on the canvas.
28220     *
28221     * @ingroup SegmentControl
28222     */
28223    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28224
28225    /**
28226     * Append a new item to the segment control object.
28227     *
28228     * @param obj The segment control object.
28229     * @param icon The icon object to use for the left side of the item. An
28230     * icon can be any Evas object, but usually it is an icon created
28231     * with elm_icon_add().
28232     * @param label The label of the item.
28233     *        Note that, NULL is different from empty string "".
28234     * @return The created item or @c NULL upon failure.
28235     *
28236     * A new item will be created and appended to the segment control, i.e., will
28237     * be set as @b last item.
28238     *
28239     * If it should be inserted at another position,
28240     * elm_segment_control_item_insert_at() should be used instead.
28241     *
28242     * Items created with this function can be deleted with function
28243     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28244     *
28245     * @note @p label set to @c NULL is different from empty string "".
28246     * If an item
28247     * only has icon, it will be displayed bigger and centered. If it has
28248     * icon and label, even that an empty string, icon will be smaller and
28249     * positioned at left.
28250     *
28251     * Simple example:
28252     * @code
28253     * sc = elm_segment_control_add(win);
28254     * ic = elm_icon_add(win);
28255     * elm_icon_file_set(ic, "path/to/image", NULL);
28256     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
28257     * elm_segment_control_item_add(sc, ic, "label");
28258     * evas_object_show(sc);
28259     * @endcode
28260     *
28261     * @see elm_segment_control_item_insert_at()
28262     * @see elm_segment_control_item_del()
28263     *
28264     * @ingroup SegmentControl
28265     */
28266    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
28267
28268    /**
28269     * Insert a new item to the segment control object at specified position.
28270     *
28271     * @param obj The segment control object.
28272     * @param icon The icon object to use for the left side of the item. An
28273     * icon can be any Evas object, but usually it is an icon created
28274     * with elm_icon_add().
28275     * @param label The label of the item.
28276     * @param index Item position. Value should be between 0 and items count.
28277     * @return The created item or @c NULL upon failure.
28278
28279     * Index values must be between @c 0, when item will be prepended to
28280     * segment control, and items count, that can be get with
28281     * elm_segment_control_item_count_get(), case when item will be appended
28282     * to segment control, just like elm_segment_control_item_add().
28283     *
28284     * Items created with this function can be deleted with function
28285     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28286     *
28287     * @note @p label set to @c NULL is different from empty string "".
28288     * If an item
28289     * only has icon, it will be displayed bigger and centered. If it has
28290     * icon and label, even that an empty string, icon will be smaller and
28291     * positioned at left.
28292     *
28293     * @see elm_segment_control_item_add()
28294     * @see elm_segment_control_item_count_get()
28295     * @see elm_segment_control_item_del()
28296     *
28297     * @ingroup SegmentControl
28298     */
28299    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);
28300
28301    /**
28302     * Remove a segment control item from its parent, deleting it.
28303     *
28304     * @param it The item to be removed.
28305     *
28306     * Items can be added with elm_segment_control_item_add() or
28307     * elm_segment_control_item_insert_at().
28308     *
28309     * @ingroup SegmentControl
28310     */
28311    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28312
28313    /**
28314     * Remove a segment control item at given index from its parent,
28315     * deleting it.
28316     *
28317     * @param obj The segment control object.
28318     * @param index The position of the segment control item to be deleted.
28319     *
28320     * Items can be added with elm_segment_control_item_add() or
28321     * elm_segment_control_item_insert_at().
28322     *
28323     * @ingroup SegmentControl
28324     */
28325    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28326
28327    /**
28328     * Get the Segment items count from segment control.
28329     *
28330     * @param obj The segment control object.
28331     * @return Segment items count.
28332     *
28333     * It will just return the number of items added to segment control @p obj.
28334     *
28335     * @ingroup SegmentControl
28336     */
28337    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28338
28339    /**
28340     * Get the item placed at specified index.
28341     *
28342     * @param obj The segment control object.
28343     * @param index The index of the segment item.
28344     * @return The segment control item or @c NULL on failure.
28345     *
28346     * Index is the position of an item in segment control widget. Its
28347     * range is from @c 0 to <tt> count - 1 </tt>.
28348     * Count is the number of items, that can be get with
28349     * elm_segment_control_item_count_get().
28350     *
28351     * @ingroup SegmentControl
28352     */
28353    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28354
28355    /**
28356     * Get the label of item.
28357     *
28358     * @param obj The segment control object.
28359     * @param index The index of the segment item.
28360     * @return The label of the item at @p index.
28361     *
28362     * The return value is a pointer to the label associated to the item when
28363     * it was created, with function elm_segment_control_item_add(), or later
28364     * with function elm_segment_control_item_label_set. If no label
28365     * was passed as argument, it will return @c NULL.
28366     *
28367     * @see elm_segment_control_item_label_set() for more details.
28368     * @see elm_segment_control_item_add()
28369     *
28370     * @ingroup SegmentControl
28371     */
28372    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28373
28374    /**
28375     * Set the label of item.
28376     *
28377     * @param it The item of segment control.
28378     * @param text The label of item.
28379     *
28380     * The label to be displayed by the item.
28381     * Label will be at right of the icon (if set).
28382     *
28383     * If a label was passed as argument on item creation, with function
28384     * elm_control_segment_item_add(), it will be already
28385     * displayed by the item.
28386     *
28387     * @see elm_segment_control_item_label_get()
28388     * @see elm_segment_control_item_add()
28389     *
28390     * @ingroup SegmentControl
28391     */
28392    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28393
28394    /**
28395     * Get the icon associated to the item.
28396     *
28397     * @param obj The segment control object.
28398     * @param index The index of the segment item.
28399     * @return The left side icon associated to the item at @p index.
28400     *
28401     * The return value is a pointer to the icon associated to the item when
28402     * it was created, with function elm_segment_control_item_add(), or later
28403     * with function elm_segment_control_item_icon_set(). If no icon
28404     * was passed as argument, it will return @c NULL.
28405     *
28406     * @see elm_segment_control_item_add()
28407     * @see elm_segment_control_item_icon_set()
28408     *
28409     * @ingroup SegmentControl
28410     */
28411    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28412
28413    /**
28414     * Set the icon associated to the item.
28415     *
28416     * @param it The segment control item.
28417     * @param icon The icon object to associate with @p it.
28418     *
28419     * The icon object to use at left side of the item. An
28420     * icon can be any Evas object, but usually it is an icon created
28421     * with elm_icon_add().
28422     *
28423     * Once the icon object is set, a previously set one will be deleted.
28424     * @warning Setting the same icon for two items will cause the icon to
28425     * dissapear from the first item.
28426     *
28427     * If an icon was passed as argument on item creation, with function
28428     * elm_segment_control_item_add(), it will be already
28429     * associated to the item.
28430     *
28431     * @see elm_segment_control_item_add()
28432     * @see elm_segment_control_item_icon_get()
28433     *
28434     * @ingroup SegmentControl
28435     */
28436    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28437
28438    /**
28439     * Get the index of an item.
28440     *
28441     * @param it The segment control item.
28442     * @return The position of item in segment control widget.
28443     *
28444     * Index is the position of an item in segment control widget. Its
28445     * range is from @c 0 to <tt> count - 1 </tt>.
28446     * Count is the number of items, that can be get with
28447     * elm_segment_control_item_count_get().
28448     *
28449     * @ingroup SegmentControl
28450     */
28451    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28452
28453    /**
28454     * Get the base object of the item.
28455     *
28456     * @param it The segment control item.
28457     * @return The base object associated with @p it.
28458     *
28459     * Base object is the @c Evas_Object that represents that item.
28460     *
28461     * @ingroup SegmentControl
28462     */
28463    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28464
28465    /**
28466     * Get the selected item.
28467     *
28468     * @param obj The segment control object.
28469     * @return The selected item or @c NULL if none of segment items is
28470     * selected.
28471     *
28472     * The selected item can be unselected with function
28473     * elm_segment_control_item_selected_set().
28474     *
28475     * The selected item always will be highlighted on segment control.
28476     *
28477     * @ingroup SegmentControl
28478     */
28479    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28480
28481    /**
28482     * Set the selected state of an item.
28483     *
28484     * @param it The segment control item
28485     * @param select The selected state
28486     *
28487     * This sets the selected state of the given item @p it.
28488     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28489     *
28490     * If a new item is selected the previosly selected will be unselected.
28491     * Previoulsy selected item can be get with function
28492     * elm_segment_control_item_selected_get().
28493     *
28494     * The selected item always will be highlighted on segment control.
28495     *
28496     * @see elm_segment_control_item_selected_get()
28497     *
28498     * @ingroup SegmentControl
28499     */
28500    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28501
28502    /**
28503     * @}
28504     */
28505
28506    /**
28507     * @defgroup Grid Grid
28508     *
28509     * The grid is a grid layout widget that lays out a series of children as a
28510     * fixed "grid" of widgets using a given percentage of the grid width and
28511     * height each using the child object.
28512     *
28513     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28514     * widgets size itself. The default is 100 x 100, so that means the
28515     * position and sizes of children will effectively be percentages (0 to 100)
28516     * of the width or height of the grid widget
28517     *
28518     * @{
28519     */
28520
28521    /**
28522     * Add a new grid to the parent
28523     *
28524     * @param parent The parent object
28525     * @return The new object or NULL if it cannot be created
28526     *
28527     * @ingroup Grid
28528     */
28529    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28530
28531    /**
28532     * Set the virtual size of the grid
28533     *
28534     * @param obj The grid object
28535     * @param w The virtual width of the grid
28536     * @param h The virtual height of the grid
28537     *
28538     * @ingroup Grid
28539     */
28540    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
28541
28542    /**
28543     * Get the virtual size of the grid
28544     *
28545     * @param obj The grid object
28546     * @param w Pointer to integer to store the virtual width of the grid
28547     * @param h Pointer to integer to store the virtual height of the grid
28548     *
28549     * @ingroup Grid
28550     */
28551    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28552
28553    /**
28554     * Pack child at given position and size
28555     *
28556     * @param obj The grid object
28557     * @param subobj The child to pack
28558     * @param x The virtual x coord at which to pack it
28559     * @param y The virtual y coord at which to pack it
28560     * @param w The virtual width at which to pack it
28561     * @param h The virtual height at which to pack it
28562     *
28563     * @ingroup Grid
28564     */
28565    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28566
28567    /**
28568     * Unpack a child from a grid object
28569     *
28570     * @param obj The grid object
28571     * @param subobj The child to unpack
28572     *
28573     * @ingroup Grid
28574     */
28575    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28576
28577    /**
28578     * Faster way to remove all child objects from a grid object.
28579     *
28580     * @param obj The grid object
28581     * @param clear If true, it will delete just removed children
28582     *
28583     * @ingroup Grid
28584     */
28585    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28586
28587    /**
28588     * Set packing of an existing child at to position and size
28589     *
28590     * @param subobj The child to set packing of
28591     * @param x The virtual x coord at which to pack it
28592     * @param y The virtual y coord at which to pack it
28593     * @param w The virtual width at which to pack it
28594     * @param h The virtual height at which to pack it
28595     *
28596     * @ingroup Grid
28597     */
28598    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28599
28600    /**
28601     * get packing of a child
28602     *
28603     * @param subobj The child to query
28604     * @param x Pointer to integer to store the virtual x coord
28605     * @param y Pointer to integer to store the virtual y coord
28606     * @param w Pointer to integer to store the virtual width
28607     * @param h Pointer to integer to store the virtual height
28608     *
28609     * @ingroup Grid
28610     */
28611    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28612
28613    /**
28614     * @}
28615     */
28616
28617    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28618    EINA_DEPRECATED EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28619    EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28620    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28621    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
28622    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
28623
28624    /**
28625     * @defgroup Video Video
28626     *
28627     * @addtogroup Video
28628     * @{
28629     *
28630     * Elementary comes with two object that help design application that need
28631     * to display video. The main one, Elm_Video, display a video by using Emotion.
28632     * It does embedded the video inside an Edje object, so you can do some
28633     * animation depending on the video state change. It does also implement a
28634     * ressource management policy to remove this burden from the application writer.
28635     *
28636     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28637     * It take care of updating its content according to Emotion event and provide a
28638     * way to theme itself. It also does automatically raise the priority of the
28639     * linked Elm_Video so it will use the video decoder if available. It also does
28640     * activate the remember function on the linked Elm_Video object.
28641     *
28642     * Signals that you can add callback for are :
28643     *
28644     * "forward,clicked" - the user clicked the forward button.
28645     * "info,clicked" - the user clicked the info button.
28646     * "next,clicked" - the user clicked the next button.
28647     * "pause,clicked" - the user clicked the pause button.
28648     * "play,clicked" - the user clicked the play button.
28649     * "prev,clicked" - the user clicked the prev button.
28650     * "rewind,clicked" - the user clicked the rewind button.
28651     * "stop,clicked" - the user clicked the stop button.
28652     *
28653     * Default contents parts of the player widget that you can use for are:
28654     * @li "video" - A video of the player
28655     *
28656     */
28657
28658    /**
28659     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28660     *
28661     * @param parent The parent object
28662     * @return a new player widget handle or @c NULL, on errors.
28663     *
28664     * This function inserts a new player widget on the canvas.
28665     *
28666     * @see elm_object_part_content_set()
28667     *
28668     * @ingroup Video
28669     */
28670    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28671
28672    /**
28673     * @brief Link a Elm_Payer with an Elm_Video object.
28674     *
28675     * @param player the Elm_Player object.
28676     * @param video The Elm_Video object.
28677     *
28678     * This mean that action on the player widget will affect the
28679     * video object and the state of the video will be reflected in
28680     * the player itself.
28681     *
28682     * @see elm_player_add()
28683     * @see elm_video_add()
28684     * @deprecated use elm_object_part_content_set() instead
28685     *
28686     * @ingroup Video
28687     */
28688    EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28689
28690    /**
28691     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28692     *
28693     * @param parent The parent object
28694     * @return a new video widget handle or @c NULL, on errors.
28695     *
28696     * This function inserts a new video widget on the canvas.
28697     *
28698     * @seeelm_video_file_set()
28699     * @see elm_video_uri_set()
28700     *
28701     * @ingroup Video
28702     */
28703    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28704
28705    /**
28706     * @brief Define the file that will be the video source.
28707     *
28708     * @param video The video object to define the file for.
28709     * @param filename The file to target.
28710     *
28711     * This function will explicitly define a filename as a source
28712     * for the video of the Elm_Video object.
28713     *
28714     * @see elm_video_uri_set()
28715     * @see elm_video_add()
28716     * @see elm_player_add()
28717     *
28718     * @ingroup Video
28719     */
28720    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28721
28722    /**
28723     * @brief Define the uri that will be the video source.
28724     *
28725     * @param video The video object to define the file for.
28726     * @param uri The uri to target.
28727     *
28728     * This function will define an uri as a source for the video of the
28729     * Elm_Video object. URI could be remote source of video, like http:// or local source
28730     * like for example WebCam who are most of the time v4l2:// (but that depend and
28731     * you should use Emotion API to request and list the available Webcam on your system).
28732     *
28733     * @see elm_video_file_set()
28734     * @see elm_video_add()
28735     * @see elm_player_add()
28736     *
28737     * @ingroup Video
28738     */
28739    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28740
28741    /**
28742     * @brief Get the underlying Emotion object.
28743     *
28744     * @param video The video object to proceed the request on.
28745     * @return the underlying Emotion object.
28746     *
28747     * @ingroup Video
28748     */
28749    EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28750
28751    /**
28752     * @brief Start to play the video
28753     *
28754     * @param video The video object to proceed the request on.
28755     *
28756     * Start to play the video and cancel all suspend state.
28757     *
28758     * @ingroup Video
28759     */
28760    EAPI void elm_video_play(Evas_Object *video);
28761
28762    /**
28763     * @brief Pause the video
28764     *
28765     * @param video The video object to proceed the request on.
28766     *
28767     * Pause the video and start a timer to trigger suspend mode.
28768     *
28769     * @ingroup Video
28770     */
28771    EAPI void elm_video_pause(Evas_Object *video);
28772
28773    /**
28774     * @brief Stop the video
28775     *
28776     * @param video The video object to proceed the request on.
28777     *
28778     * Stop the video and put the emotion in deep sleep mode.
28779     *
28780     * @ingroup Video
28781     */
28782    EAPI void elm_video_stop(Evas_Object *video);
28783
28784    /**
28785     * @brief Is the video actually playing.
28786     *
28787     * @param video The video object to proceed the request on.
28788     * @return EINA_TRUE if the video is actually playing.
28789     *
28790     * You should consider watching event on the object instead of polling
28791     * the object state.
28792     *
28793     * @ingroup Video
28794     */
28795    EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28796
28797    /**
28798     * @brief Is it possible to seek inside the video.
28799     *
28800     * @param video The video object to proceed the request on.
28801     * @return EINA_TRUE if is possible to seek inside the video.
28802     *
28803     * @ingroup Video
28804     */
28805    EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28806
28807    /**
28808     * @brief Is the audio muted.
28809     *
28810     * @param video The video object to proceed the request on.
28811     * @return EINA_TRUE if the audio is muted.
28812     *
28813     * @ingroup Video
28814     */
28815    EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28816
28817    /**
28818     * @brief Change the mute state of the Elm_Video object.
28819     *
28820     * @param video The video object to proceed the request on.
28821     * @param mute The new mute state.
28822     *
28823     * @ingroup Video
28824     */
28825    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28826
28827    /**
28828     * @brief Get the audio level of the current video.
28829     *
28830     * @param video The video object to proceed the request on.
28831     * @return the current audio level.
28832     *
28833     * @ingroup Video
28834     */
28835    EAPI double elm_video_audio_level_get(const Evas_Object *video);
28836
28837    /**
28838     * @brief Set the audio level of anElm_Video object.
28839     *
28840     * @param video The video object to proceed the request on.
28841     * @param volume The new audio volume.
28842     *
28843     * @ingroup Video
28844     */
28845    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28846
28847    EAPI double elm_video_play_position_get(const Evas_Object *video);
28848    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28849    EAPI double elm_video_play_length_get(const Evas_Object *video);
28850    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28851    EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28852    EAPI const char *elm_video_title_get(const Evas_Object *video);
28853    /**
28854     * @}
28855     */
28856
28857    /**
28858     * @defgroup Naviframe Naviframe
28859     * @ingroup Elementary
28860     *
28861     * @brief Naviframe is a kind of view manager for the applications.
28862     *
28863     * Naviframe provides functions to switch different pages with stack
28864     * mechanism. It means if one page(item) needs to be changed to the new one,
28865     * then naviframe would push the new page to it's internal stack. Of course,
28866     * it can be back to the previous page by popping the top page. Naviframe
28867     * provides some transition effect while the pages are switching (same as
28868     * pager).
28869     *
28870     * Since each item could keep the different styles, users could keep the
28871     * same look & feel for the pages or different styles for the items in it's
28872     * application.
28873     *
28874     * Signals that you can add callback for are:
28875     * @li "transition,finished" - When the transition is finished in changing
28876     *     the item
28877     * @li "title,clicked" - User clicked title area
28878     *
28879     * Default contents parts of the naviframe items that you can use for are:
28880     * @li "default" - A main content of the page
28881     * @li "icon" - An icon in the title area
28882     * @li "prev_btn" - A button to go to the previous page
28883     * @li "next_btn" - A button to go to the next page
28884     *
28885     * Default text parts of the naviframe items that you can use for are:
28886     * @li "default" - Title label in the title area
28887     * @li "subtitle" - Sub-title label in the title area
28888     *
28889     * @ref tutorial_naviframe gives a good overview of the usage of the API.
28890     */
28891
28892    /**
28893     * @addtogroup Naviframe
28894     * @{
28895     */
28896
28897    /**
28898     * @brief Add a new Naviframe object to the parent.
28899     *
28900     * @param parent Parent object
28901     * @return New object or @c NULL, if it cannot be created
28902     *
28903     * @ingroup Naviframe
28904     */
28905    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28906    /**
28907     * @brief Push a new item to the top of the naviframe stack (and show it).
28908     *
28909     * @param obj The naviframe object
28910     * @param title_label The label in the title area. The name of the title
28911     *        label part is "elm.text.title"
28912     * @param prev_btn The button to go to the previous item. If it is NULL,
28913     *        then naviframe will create a back button automatically. The name of
28914     *        the prev_btn part is "elm.swallow.prev_btn"
28915     * @param next_btn The button to go to the next item. Or It could be just an
28916     *        extra function button. The name of the next_btn part is
28917     *        "elm.swallow.next_btn"
28918     * @param content The main content object. The name of content part is
28919     *        "elm.swallow.content"
28920     * @param item_style The current item style name. @c NULL would be default.
28921     * @return The created item or @c NULL upon failure.
28922     *
28923     * The item pushed becomes one page of the naviframe, this item will be
28924     * deleted when it is popped.
28925     *
28926     * @see also elm_naviframe_item_style_set()
28927     * @see also elm_naviframe_item_insert_before()
28928     * @see also elm_naviframe_item_insert_after()
28929     *
28930     * The following styles are available for this item:
28931     * @li @c "default"
28932     *
28933     * @ingroup Naviframe
28934     */
28935    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);
28936     /**
28937     * @brief Insert a new item into the naviframe before item @p before.
28938     *
28939     * @param before The naviframe item to insert before.
28940     * @param title_label The label in the title area. The name of the title
28941     *        label part is "elm.text.title"
28942     * @param prev_btn The button to go to the previous item. If it is NULL,
28943     *        then naviframe will create a back button automatically. The name of
28944     *        the prev_btn part is "elm.swallow.prev_btn"
28945     * @param next_btn The button to go to the next item. Or It could be just an
28946     *        extra function button. The name of the next_btn part is
28947     *        "elm.swallow.next_btn"
28948     * @param content The main content object. The name of content part is
28949     *        "elm.swallow.content"
28950     * @param item_style The current item style name. @c NULL would be default.
28951     * @return The created item or @c NULL upon failure.
28952     *
28953     * The item is inserted into the naviframe straight away without any
28954     * transition operations. This item will be deleted when it is popped.
28955     *
28956     * @see also elm_naviframe_item_style_set()
28957     * @see also elm_naviframe_item_push()
28958     * @see also elm_naviframe_item_insert_after()
28959     *
28960     * The following styles are available for this item:
28961     * @li @c "default"
28962     *
28963     * @ingroup Naviframe
28964     */
28965    EAPI Elm_Object_Item    *elm_naviframe_item_insert_before(Elm_Object_Item *before, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
28966    /**
28967     * @brief Insert a new item into the naviframe after item @p after.
28968     *
28969     * @param after The naviframe item to insert after.
28970     * @param title_label The label in the title area. The name of the title
28971     *        label part is "elm.text.title"
28972     * @param prev_btn The button to go to the previous item. If it is NULL,
28973     *        then naviframe will create a back button automatically. The name of
28974     *        the prev_btn part is "elm.swallow.prev_btn"
28975     * @param next_btn The button to go to the next item. Or It could be just an
28976     *        extra function button. The name of the next_btn part is
28977     *        "elm.swallow.next_btn"
28978     * @param content The main content object. The name of content part is
28979     *        "elm.swallow.content"
28980     * @param item_style The current item style name. @c NULL would be default.
28981     * @return The created item or @c NULL upon failure.
28982     *
28983     * The item is inserted into the naviframe straight away without any
28984     * transition operations. This item will be deleted when it is popped.
28985     *
28986     * @see also elm_naviframe_item_style_set()
28987     * @see also elm_naviframe_item_push()
28988     * @see also elm_naviframe_item_insert_before()
28989     *
28990     * The following styles are available for this item:
28991     * @li @c "default"
28992     *
28993     * @ingroup Naviframe
28994     */
28995    EAPI Elm_Object_Item    *elm_naviframe_item_insert_after(Elm_Object_Item *after, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
28996    /**
28997     * @brief Pop an item that is on top of the stack
28998     *
28999     * @param obj The naviframe object
29000     * @return @c NULL or the content object(if the
29001     *         elm_naviframe_content_preserve_on_pop_get is true).
29002     *
29003     * This pops an item that is on the top(visible) of the naviframe, makes it
29004     * disappear, then deletes the item. The item that was underneath it on the
29005     * stack will become visible.
29006     *
29007     * @see also elm_naviframe_content_preserve_on_pop_get()
29008     *
29009     * @ingroup Naviframe
29010     */
29011    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
29012    /**
29013     * @brief Pop the items between the top and the above one on the given item.
29014     *
29015     * @param it The naviframe item
29016     *
29017     * @ingroup Naviframe
29018     */
29019    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29020    /**
29021    * Promote an item already in the naviframe stack to the top of the stack
29022    *
29023    * @param it The naviframe item
29024    *
29025    * This will take the indicated item and promote it to the top of the stack
29026    * as if it had been pushed there. The item must already be inside the
29027    * naviframe stack to work.
29028    *
29029    */
29030    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29031    /**
29032     * @brief Delete the given item instantly.
29033     *
29034     * @param it The naviframe item
29035     *
29036     * This just deletes the given item from the naviframe item list instantly.
29037     * So this would not emit any signals for view transitions but just change
29038     * the current view if the given item is a top one.
29039     *
29040     * @ingroup Naviframe
29041     */
29042    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29043    /**
29044     * @brief preserve the content objects when items are popped.
29045     *
29046     * @param obj The naviframe object
29047     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
29048     *
29049     * @see also elm_naviframe_content_preserve_on_pop_get()
29050     *
29051     * @ingroup Naviframe
29052     */
29053    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
29054    /**
29055     * @brief Get a value whether preserve mode is enabled or not.
29056     *
29057     * @param obj The naviframe object
29058     * @return If @c EINA_TRUE, preserve mode is enabled
29059     *
29060     * @see also elm_naviframe_content_preserve_on_pop_set()
29061     *
29062     * @ingroup Naviframe
29063     */
29064    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29065    /**
29066     * @brief Get a top item on the naviframe stack
29067     *
29068     * @param obj The naviframe object
29069     * @return The top item on the naviframe stack or @c NULL, if the stack is
29070     *         empty
29071     *
29072     * @ingroup Naviframe
29073     */
29074    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29075    /**
29076     * @brief Get a bottom item on the naviframe stack
29077     *
29078     * @param obj The naviframe object
29079     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
29080     *         empty
29081     *
29082     * @ingroup Naviframe
29083     */
29084    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29085    /**
29086     * @brief Set an item style
29087     *
29088     * @param obj The naviframe item
29089     * @param item_style The current item style name. @c NULL would be default
29090     *
29091     * The following styles are available for this item:
29092     * @li @c "default"
29093     *
29094     * @see also elm_naviframe_item_style_get()
29095     *
29096     * @ingroup Naviframe
29097     */
29098    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
29099    /**
29100     * @brief Get an item style
29101     *
29102     * @param obj The naviframe item
29103     * @return The current item style name
29104     *
29105     * @see also elm_naviframe_item_style_set()
29106     *
29107     * @ingroup Naviframe
29108     */
29109    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29110    /**
29111     * @brief Show/Hide the title area
29112     *
29113     * @param it The naviframe item
29114     * @param visible If @c EINA_TRUE, title area will be visible, hidden
29115     *        otherwise
29116     *
29117     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
29118     *
29119     * @see also elm_naviframe_item_title_visible_get()
29120     *
29121     * @ingroup Naviframe
29122     */
29123    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
29124    /**
29125     * @brief Get a value whether title area is visible or not.
29126     *
29127     * @param it The naviframe item
29128     * @return If @c EINA_TRUE, title area is visible
29129     *
29130     * @see also elm_naviframe_item_title_visible_set()
29131     *
29132     * @ingroup Naviframe
29133     */
29134    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29135
29136    /**
29137     * @brief Set creating prev button automatically or not
29138     *
29139     * @param obj The naviframe object
29140     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
29141     *        be created internally when you pass the @c NULL to the prev_btn
29142     *        parameter in elm_naviframe_item_push
29143     *
29144     * @see also elm_naviframe_item_push()
29145     */
29146    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
29147    /**
29148     * @brief Get a value whether prev button(back button) will be auto pushed or
29149     *        not.
29150     *
29151     * @param obj The naviframe object
29152     * @return If @c EINA_TRUE, prev button will be auto pushed.
29153     *
29154     * @see also elm_naviframe_item_push()
29155     *           elm_naviframe_prev_btn_auto_pushed_set()
29156     */
29157    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29158    /**
29159     * @brief Get a list of all the naviframe items.
29160     *
29161     * @param obj The naviframe object
29162     * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
29163     * or @c NULL on failure.
29164     */
29165    EAPI Eina_Inlist        *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29166
29167     /**
29168     * @}
29169     */
29170
29171    /**
29172     * @defgroup Multibuttonentry Multibuttonentry
29173     *
29174     * A Multibuttonentry is a widget to allow a user enter text and manage it as a number of buttons
29175     * Each text button is inserted by pressing the "return" key. If there is no space in the current row,
29176     * a new button is added to the next row. When a text button is pressed, it will become focused.
29177     * Backspace removes the focus.
29178     * When the Multibuttonentry loses focus items longer than 1 lines are shrunk to one line.
29179     *
29180     * Smart callbacks one can register:
29181     * - @c "item,selected" - when item is selected. May be called on backspace key.
29182     * - @c "item,added" - when a new multibuttonentry item is added.
29183     * - @c "item,deleted" - when a multibuttonentry item is deleted.
29184     * - @c "item,clicked" - selected item of multibuttonentry is clicked.
29185     * - @c "clicked" - when multibuttonentry is clicked.
29186     * - @c "focused" - when multibuttonentry is focused.
29187     * - @c "unfocused" - when multibuttonentry is unfocused.
29188     * - @c "expanded" - when multibuttonentry is expanded.
29189     * - @c "shrank" - when multibuttonentry is shrank.
29190     * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed.
29191     *
29192     * Here is an example on its usage:
29193     * @li @ref multibuttonentry_example
29194     */
29195     /**
29196     * @addtogroup Multibuttonentry
29197     * @{
29198     */
29199
29200    typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
29201    typedef Eina_Bool (*Elm_Multibuttonentry_Item_Filter_callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
29202
29203    /**
29204     * @brief Add a new multibuttonentry to the parent
29205     *
29206     * @param parent The parent object
29207     * @return The new object or NULL if it cannot be created
29208     *
29209     */
29210    EAPI Evas_Object               *elm_multibuttonentry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29211    /**
29212     * Get the label
29213     *
29214     * @param obj The multibuttonentry object
29215     * @return The label, or NULL if none
29216     *
29217     */
29218    EAPI const char                *elm_multibuttonentry_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29219    /**
29220     * Set the label
29221     *
29222     * @param obj The multibuttonentry object
29223     * @param label The text label string
29224     *
29225     */
29226    EAPI void                       elm_multibuttonentry_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29227    /**
29228     * Get the entry of the multibuttonentry object
29229     *
29230     * @param obj The multibuttonentry object
29231     * @return The entry object, or NULL if none
29232     *
29233     */
29234    EAPI Evas_Object               *elm_multibuttonentry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29235    /**
29236     * Get the guide text
29237     *
29238     * @param obj The multibuttonentry object
29239     * @return The guide text, or NULL if none
29240     *
29241     */
29242    EAPI const char *               elm_multibuttonentry_guide_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29243    /**
29244     * Set the guide text
29245     *
29246     * @param obj The multibuttonentry object
29247     * @param label The guide text string
29248     *
29249     */
29250    EAPI void                       elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext) EINA_ARG_NONNULL(1);
29251    /**
29252     * Get the value of shrink_mode state.
29253     *
29254     * @param obj The multibuttonentry object
29255     * @param the value of shrink mode state.
29256     *
29257     */
29258    EAPI int                        elm_multibuttonentry_shrink_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29259    /**
29260     * Set/Unset the multibuttonentry to shrink mode state of single line
29261     *
29262     * @param obj The multibuttonentry object
29263     * @param the value of shrink_mode state. set this to 1 to set the multibuttonentry to shrink state of single line. set this to 0 to unset the contracted state.
29264     *
29265     */
29266    EAPI void                       elm_multibuttonentry_shrink_mode_set(Evas_Object *obj, int shrink) EINA_ARG_NONNULL(1);
29267    /**
29268     * Prepend a new item to the multibuttonentry
29269     *
29270     * @param obj The multibuttonentry object
29271     * @param label The label of new item
29272     * @param data The ponter to the data to be attached
29273     * @return A handle to the item added or NULL if not possible
29274     *
29275     */
29276    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prepend(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
29277    /**
29278     * Append a new item to the multibuttonentry
29279     *
29280     * @param obj The multibuttonentry object
29281     * @param label The label of new item
29282     * @param data The ponter to the data to be attached
29283     * @return A handle to the item added or NULL if not possible
29284     *
29285     */
29286    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_append(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
29287    /**
29288     * Add a new item to the multibuttonentry before the indicated object
29289     *
29290     * reference.
29291     * @param obj The multibuttonentry object
29292     * @param before The item before which to add it
29293     * @param label The label of new item
29294     * @param data The ponter to the data to be attached
29295     * @return A handle to the item added or NULL if not possible
29296     *
29297     */
29298    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_insert_before(Evas_Object *obj, Elm_Multibuttonentry_Item *before, const char *label, void *data) EINA_ARG_NONNULL(1);
29299    /**
29300     * Add a new item to the multibuttonentry after the indicated object
29301     *
29302     * @param obj The multibuttonentry object
29303     * @param after The item after which to add it
29304     * @param label The label of new item
29305     * @param data The ponter to the data to be attached
29306     * @return A handle to the item added or NULL if not possible
29307     *
29308     */
29309    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_insert_after(Evas_Object *obj, Elm_Multibuttonentry_Item *after, const char *label, void *data) EINA_ARG_NONNULL(1);
29310    /**
29311     * Get a list of items in the multibuttonentry
29312     *
29313     * @param obj The multibuttonentry object
29314     * @return The list of items, or NULL if none
29315     *
29316     */
29317    EAPI const Eina_List           *elm_multibuttonentry_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29318    /**
29319     * Get the first item in the multibuttonentry
29320     *
29321     * @param obj The multibuttonentry object
29322     * @return The first item, or NULL if none
29323     *
29324     */
29325    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29326    /**
29327     * Get the last item in the multibuttonentry
29328     *
29329     * @param obj The multibuttonentry object
29330     * @return The last item, or NULL if none
29331     *
29332     */
29333    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29334    /**
29335     * Get the selected item in the multibuttonentry
29336     *
29337     * @param obj The multibuttonentry object
29338     * @return The selected item, or NULL if none
29339     *
29340     */
29341    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29342    /**
29343     * Set the selected state of an item
29344     *
29345     * @param item The item
29346     * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
29347     *
29348     */
29349    EAPI void                       elm_multibuttonentry_item_select(Elm_Multibuttonentry_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
29350    /**
29351    * unselect all items.
29352    *
29353    * @param obj The multibuttonentry object
29354    *
29355    */
29356    EAPI void                       elm_multibuttonentry_item_unselect_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
29357   /**
29358    * Delete a given item
29359    *
29360    * @param item The item
29361    *
29362    */
29363    EAPI void                       elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29364   /**
29365    * Remove all items in the multibuttonentry.
29366    *
29367    * @param obj The multibuttonentry object
29368    *
29369    */
29370    EAPI void                       elm_multibuttonentry_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
29371   /**
29372    * Get the label of a given item
29373    *
29374    * @param item The item
29375    * @return The label of a given item, or NULL if none
29376    *
29377    */
29378    EAPI const char                *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29379   /**
29380    * Set the label of a given item
29381    *
29382    * @param item The item
29383    * @param label The text label string
29384    *
29385    */
29386    EAPI void                       elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str) EINA_ARG_NONNULL(1);
29387   /**
29388    * Get the previous item in the multibuttonentry
29389    *
29390    * @param item The item
29391    * @return The item before the item @p item
29392    *
29393    */
29394    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29395   /**
29396    * Get the next item in the multibuttonentry
29397    *
29398    * @param item The item
29399    * @return The item after the item @p item
29400    *
29401    */
29402    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29403   /**
29404    * Append a item filter function for text inserted in the Multibuttonentry
29405    *
29406    * Append the given callback to the list. This functions will be called
29407    * whenever any text is inserted into the Multibuttonentry, with the text to be inserted
29408    * as a parameter. The callback function is free to alter the text in any way
29409    * it wants, but it must remember to free the given pointer and update it.
29410    * If the new text is to be discarded, the function can free it and set it text
29411    * parameter to NULL. This will also prevent any following filters from being
29412    * called.
29413    *
29414    * @param obj The multibuttonentryentry object
29415    * @param func The function to use as item filter
29416    * @param data User data to pass to @p func
29417    *
29418    */
29419    EAPI void elm_multibuttonentry_item_filter_append(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
29420   /**
29421    * Prepend a filter function for text inserted in the Multibuttentry
29422    *
29423    * Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
29424    * for more information
29425    *
29426    * @param obj The multibuttonentry object
29427    * @param func The function to use as text filter
29428    * @param data User data to pass to @p func
29429    *
29430    */
29431    EAPI void elm_multibuttonentry_item_filter_prepend(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
29432   /**
29433    * Remove a filter from the list
29434    *
29435    * Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
29436    * for more information.
29437    *
29438    * @param obj The multibuttonentry object
29439    * @param func The filter function to remove
29440    * @param data The user data passed when adding the function
29441    *
29442    */
29443    EAPI void elm_multibuttonentry_item_filter_remove(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
29444
29445    /**
29446     * @}
29447     */
29448
29449 #ifdef __cplusplus
29450 }
29451 #endif
29452
29453 #endif