elm Elementary.h.in: Fix more documentation.
[framework/uifw/elementary.git] / src / lib / Elementary.h.in
1 /*
2  *
3  * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
4  */
5
6 /**
7 @file Elementary.h.in
8 @brief Elementary Widget Library
9 */
10
11 /**
12 @mainpage Elementary
13 @image html  elementary.png
14 @version 0.8.0
15 @date 2008-2011
16
17 @section intro What is Elementary?
18
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
21
22 It is meant to make the programmers work almost brainless but give them lots
23 of flexibility.
24
25 @li @ref Start - Go here to quickly get started with writing Apps
26
27 @section organization Organization
28
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
33
34 @section license License
35
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
38
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
44 */
45
46
47 /**
48  * @defgroup Start Getting Started
49  *
50  * To write an Elementary app, you can get started with the following:
51  *
52 @code
53 #include <Elementary.h>
54 EAPI_MAIN int
55 elm_main(int argc, char **argv)
56 {
57    // create window(s) here and do any application init
58    elm_run(); // run main loop
59    elm_shutdown(); // after mainloop finishes running, shutdown
60    return 0; // exit 0 for exit code
61 }
62 ELM_MAIN()
63 @endcode
64  *
65  * To use autotools (which helps in many ways in the long run, like being able
66  * to immediately create releases of your software directly from your tree
67  * and ensure everything needed to build it is there) you will need a
68  * configure.ac, Makefile.am and autogen.sh file.
69  *
70  * configure.ac:
71  *
72 @verbatim
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
74 AC_PREREQ(2.52)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
77 AC_PROG_CC
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
80 AC_OUTPUT(Makefile)
81 @endverbatim
82  *
83  * Makefile.am:
84  *
85 @verbatim
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
88
89 INCLUDES = -I$(top_srcdir)
90
91 bin_PROGRAMS = myapp
92
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
96 @endverbatim
97  *
98  * autogen.sh:
99  *
100 @verbatim
101 #!/bin/sh
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
106 ./configure "$@"
107 @endverbatim
108  *
109  * To generate all the things needed to bootstrap just run:
110  *
111 @verbatim
112 ./autogen.sh
113 @endverbatim
114  *
115  * This will generate Makefile.in's, the confgure script and everything else.
116  * After this it works like all normal autotools projects:
117 @verbatim
118 ./configure
119 make
120 sudo make install
121 @endverbatim
122  *
123  * Note sudo was assumed to get root permissions, as this would install in
124  * /usr/local which is system-owned. Use any way you like to gain root, or
125  * specify a different prefix with configure:
126  *
127 @verbatim
128 ./confiugre --prefix=$HOME/mysoftware
129 @endverbatim
130  *
131  * Also remember that autotools buys you some useful commands like:
132 @verbatim
133 make uninstall
134 @endverbatim
135  *
136  * This uninstalls the software after it was installed with "make install".
137  * It is very useful to clear up what you built if you wish to clean the
138  * system.
139  *
140 @verbatim
141 make distcheck
142 @endverbatim
143  *
144  * This firstly checks if your build tree is "clean" and ready for
145  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146  * ready to upload and distribute to the world, that contains the generated
147  * Makefile.in's and configure script. The users do not need to run
148  * autogen.sh - just configure and on. They don't need autotools installed.
149  * This tarball also builds cleanly, has all the sources it needs to build
150  * included (that is sources for your application, not libraries it depends
151  * on like Elementary). It builds cleanly in a buildroot and does not
152  * contain any files that are temporarily generated like binaries and other
153  * build-generated files, so the tarball is clean, and no need to worry
154  * about cleaning up your tree before packaging.
155  *
156 @verbatim
157 make clean
158 @endverbatim
159  *
160  * This cleans up all build files (binaries, objects etc.) from the tree.
161  *
162 @verbatim
163 make distclean
164 @endverbatim
165  *
166  * This cleans out all files from the build and from configure's output too.
167  *
168 @verbatim
169 make maintainer-clean
170 @endverbatim
171  *
172  * This deletes all the files autogen.sh will produce so the tree is clean
173  * to be put into a revision-control system (like CVS, SVN or GIT for example).
174  *
175  * There is a more advanced way of making use of the quicklaunch infrastructure
176  * in Elementary (which will not be covered here due to its more advanced
177  * nature).
178  *
179  * Now let's actually create an interactive "Hello World" gui that you can
180  * click the ok button to exit. It's more code because this now does something
181  * much more significant, but it's still very simple:
182  *
183 @code
184 #include <Elementary.h>
185
186 static void
187 on_done(void *data, Evas_Object *obj, void *event_info)
188 {
189    // quit the mainloop (elm_run function will return)
190    elm_exit();
191 }
192
193 EAPI_MAIN int
194 elm_main(int argc, char **argv)
195 {
196    Evas_Object *win, *bg, *box, *lab, *btn;
197
198    // new window - do the usual and give it a name (hello) and title (Hello)
199    win = elm_win_util_standard_add("hello", "Hello");
200    // when the user clicks "close" on a window there is a request to delete
201    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
202
203    // add a box object - default is vertical. a box holds children in a row,
204    // either horizontally or vertically. nothing more.
205    box = elm_box_add(win);
206    // make the box hotizontal
207    elm_box_horizontal_set(box, EINA_TRUE);
208    // add object as a resize object for the window (controls window minimum
209    // size as well as gets resized if window is resized)
210    elm_win_resize_object_add(win, box);
211    evas_object_show(box);
212
213    // add a label widget, set the text and put it in the pad frame
214    lab = elm_label_add(win);
215    // set default text of the label
216    elm_object_text_set(lab, "Hello out there world!");
217    // pack the label at the end of the box
218    elm_box_pack_end(box, lab);
219    evas_object_show(lab);
220
221    // add an ok button
222    btn = elm_button_add(win);
223    // set default text of button to "OK"
224    elm_object_text_set(btn, "OK");
225    // pack the button at the end of the box
226    elm_box_pack_end(box, btn);
227    evas_object_show(btn);
228    // call on_done when button is clicked
229    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
230
231    // now we are done, show the window
232    evas_object_show(win);
233
234    // run the mainloop and process events and callbacks
235    elm_run();
236    return 0;
237 }
238 ELM_MAIN()
239 @endcode
240    *
241    */
242
243 /**
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (discomfitor/zmike) <michael.blumenkrantz@@gmail.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
271 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@@gmail.com>
288 @author Thierry el Borgi <thierry@@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@@samsung.com> <shilpasingh.o@@gmail.com>
290 @author Chanwook Jung <joey.jung@@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@@asp64.com>
293 @author Kim Yunhan <spbear@@gmail.com>
294 @author Bluezery <ohpowel@@gmail.com>
295 @author Nicolas Aguirre <aguirre.nicolas@@gmail.com>
296 @author Sanjeev BA <iamsanjeev@@gmail.com>
297
298 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
299 contact with the developers and maintainers.
300  */
301
302 #ifndef ELEMENTARY_H
303 #define ELEMENTARY_H
304
305 /**
306  * @file Elementary.h
307  * @brief Elementary's API
308  *
309  * Elementary API.
310  */
311
312 @ELM_UNIX_DEF@ ELM_UNIX
313 @ELM_WIN32_DEF@ ELM_WIN32
314 @ELM_WINCE_DEF@ ELM_WINCE
315 @ELM_EDBUS_DEF@ ELM_EDBUS
316 @ELM_EFREET_DEF@ ELM_EFREET
317 @ELM_ETHUMB_DEF@ ELM_ETHUMB
318 @ELM_WEB_DEF@ ELM_WEB
319 @ELM_EMAP_DEF@ ELM_EMAP
320 @ELM_DEBUG_DEF@ ELM_DEBUG
321 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
322 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
323 @ELM_DIRENT_H_DEF@ ELM_DIRENT_H
324
325 /* Standard headers for standard system calls etc. */
326 #include <stdio.h>
327 #include <stdlib.h>
328 #include <unistd.h>
329 #include <string.h>
330 #include <sys/types.h>
331 #include <sys/stat.h>
332 #include <sys/time.h>
333 #include <sys/param.h>
334 #include <math.h>
335 #include <fnmatch.h>
336 #include <limits.h>
337 #include <ctype.h>
338 #include <time.h>
339 #ifdef ELM_DIRENT_H
340 # include <dirent.h>
341 #endif
342 #include <pwd.h>
343 #include <errno.h>
344
345 #ifdef ELM_UNIX
346 # include <locale.h>
347 # ifdef ELM_LIBINTL_H
348 #  include <libintl.h>
349 # endif
350 # include <signal.h>
351 # include <grp.h>
352 # include <glob.h>
353 #endif
354
355 #ifdef ELM_ALLOCA_H
356 # include <alloca.h>
357 #endif
358
359 #if defined (ELM_WIN32) || defined (ELM_WINCE)
360 # include <malloc.h>
361 # ifndef alloca
362 #  define alloca _alloca
363 # endif
364 #endif
365
366
367 /* EFL headers */
368 #include <Eina.h>
369 #include <Eet.h>
370 #include <Evas.h>
371 // disabled - evas 1.1 won't have this.
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     * Get screen geometry details for the screen that a window is on
4550     * @param obj The window to query
4551     * @param x where to return the horizontal offset value. May be NULL.
4552     * @param y  where to return the vertical offset value. May be NULL.
4553     * @param w  where to return the width value. May be NULL.
4554     * @param h  where to return the height value. May be NULL.
4555     */
4556    EAPI void         elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4557    /**
4558     * Set the enabled status for the focus highlight in a window
4559     *
4560     * This function will enable or disable the focus highlight only for the
4561     * given window, regardless of the global setting for it
4562     *
4563     * @param obj The window where to enable the highlight
4564     * @param enabled The enabled value for the highlight
4565     */
4566    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4567    /**
4568     * Get the enabled value of the focus highlight for this window
4569     *
4570     * @param obj The window in which to check if the focus highlight is enabled
4571     *
4572     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4573     */
4574    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4575    /**
4576     * Set the style for the focus highlight on this window
4577     *
4578     * Sets the style to use for theming the highlight of focused objects on
4579     * the given window. If @p style is NULL, the default will be used.
4580     *
4581     * @param obj The window where to set the style
4582     * @param style The style to set
4583     */
4584    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4585    /**
4586     * Get the style set for the focus highlight object
4587     *
4588     * Gets the style set for this windows highilght object, or NULL if none
4589     * is set.
4590     *
4591     * @param obj The window to retrieve the highlights style from
4592     *
4593     * @return The style set or NULL if none was. Default is used in that case.
4594     */
4595    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4596    /*...
4597     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4598     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4599     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4600     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4601     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4602     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4603     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4604     *
4605     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4606     * (blank mouse, private mouse obj, defaultmouse)
4607     *
4608     */
4609    /**
4610     * Sets the keyboard mode of the window.
4611     *
4612     * @param obj The window object
4613     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4614     */
4615    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4616    /**
4617     * Gets the keyboard mode of the window.
4618     *
4619     * @param obj The window object
4620     * @return The mode, one of #Elm_Win_Keyboard_Mode
4621     */
4622    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4623    /**
4624     * Sets whether the window is a keyboard.
4625     *
4626     * @param obj The window object
4627     * @param is_keyboard If true, the window is a virtual keyboard
4628     */
4629    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4630    /**
4631     * Gets whether the window is a keyboard.
4632     *
4633     * @param obj The window object
4634     * @return If the window is a virtual keyboard
4635     */
4636    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4637
4638    /**
4639     * Get the screen position of a window.
4640     *
4641     * @param obj The window object
4642     * @param x The int to store the x coordinate to
4643     * @param y The int to store the y coordinate to
4644     */
4645    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4646    /**
4647     * @}
4648     */
4649
4650    /**
4651     * @defgroup Inwin Inwin
4652     *
4653     * @image html img/widget/inwin/preview-00.png
4654     * @image latex img/widget/inwin/preview-00.eps
4655     * @image html img/widget/inwin/preview-01.png
4656     * @image latex img/widget/inwin/preview-01.eps
4657     * @image html img/widget/inwin/preview-02.png
4658     * @image latex img/widget/inwin/preview-02.eps
4659     *
4660     * An inwin is a window inside a window that is useful for a quick popup.
4661     * It does not hover.
4662     *
4663     * It works by creating an object that will occupy the entire window, so it
4664     * must be created using an @ref Win "elm_win" as parent only. The inwin
4665     * object can be hidden or restacked below every other object if it's
4666     * needed to show what's behind it without destroying it. If this is done,
4667     * the elm_win_inwin_activate() function can be used to bring it back to
4668     * full visibility again.
4669     *
4670     * There are three styles available in the default theme. These are:
4671     * @li default: The inwin is sized to take over most of the window it's
4672     * placed in.
4673     * @li minimal: The size of the inwin will be the minimum necessary to show
4674     * its contents.
4675     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4676     * possible, but it's sized vertically the most it needs to fit its\
4677     * contents.
4678     *
4679     * Some examples of Inwin can be found in the following:
4680     * @li @ref inwin_example_01
4681     *
4682     * @{
4683     */
4684    /**
4685     * Adds an inwin to the current window
4686     *
4687     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4688     * Never call this function with anything other than the top-most window
4689     * as its parameter, unless you are fond of undefined behavior.
4690     *
4691     * After creating the object, the widget will set itself as resize object
4692     * for the window with elm_win_resize_object_add(), so when shown it will
4693     * appear to cover almost the entire window (how much of it depends on its
4694     * content and the style used). It must not be added into other container
4695     * objects and it needs not be moved or resized manually.
4696     *
4697     * @param parent The parent object
4698     * @return The new object or NULL if it cannot be created
4699     */
4700    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4701    /**
4702     * Activates an inwin object, ensuring its visibility
4703     *
4704     * This function will make sure that the inwin @p obj is completely visible
4705     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4706     * to the front. It also sets the keyboard focus to it, which will be passed
4707     * onto its content.
4708     *
4709     * The object's theme will also receive the signal "elm,action,show" with
4710     * source "elm".
4711     *
4712     * @param obj The inwin to activate
4713     */
4714    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4715    /**
4716     * Set the content of an inwin object.
4717     *
4718     * Once the content object is set, a previously set one will be deleted.
4719     * If you want to keep that old content object, use the
4720     * elm_win_inwin_content_unset() function.
4721     *
4722     * @param obj The inwin object
4723     * @param content The object to set as content
4724     */
4725    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4726    /**
4727     * Get the content of an inwin object.
4728     *
4729     * Return the content object which is set for this widget.
4730     *
4731     * The returned object is valid as long as the inwin is still alive and no
4732     * other content is set on it. Deleting the object will notify the inwin
4733     * about it and this one will be left empty.
4734     *
4735     * If you need to remove an inwin's content to be reused somewhere else,
4736     * see elm_win_inwin_content_unset().
4737     *
4738     * @param obj The inwin object
4739     * @return The content that is being used
4740     */
4741    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4742    /**
4743     * Unset the content of an inwin object.
4744     *
4745     * Unparent and return the content object which was set for this widget.
4746     *
4747     * @param obj The inwin object
4748     * @return The content that was being used
4749     */
4750    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4751    /**
4752     * @}
4753     */
4754    /* X specific calls - won't work on non-x engines (return 0) */
4755
4756    /**
4757     * Get the Ecore_X_Window of an Evas_Object
4758     *
4759     * @param obj The object
4760     *
4761     * @return The Ecore_X_Window of @p obj
4762     *
4763     * @ingroup Win
4764     */
4765    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4766
4767    /* smart callbacks called:
4768     * "delete,request" - the user requested to delete the window
4769     * "focus,in" - window got focus
4770     * "focus,out" - window lost focus
4771     * "moved" - window that holds the canvas was moved
4772     */
4773
4774    /**
4775     * @defgroup Bg Bg
4776     *
4777     * @image html img/widget/bg/preview-00.png
4778     * @image latex img/widget/bg/preview-00.eps
4779     *
4780     * @brief Background object, used for setting a solid color, image or Edje
4781     * group as background to a window or any container object.
4782     *
4783     * The bg object is used for setting a solid background to a window or
4784     * packing into any container object. It works just like an image, but has
4785     * some properties useful to a background, like setting it to tiled,
4786     * centered, scaled or stretched.
4787     *
4788     * Default contents parts of the bg widget that you can use for are:
4789     * @li "overlay" - overlay of the bg
4790     *
4791     * Here is some sample code using it:
4792     * @li @ref bg_01_example_page
4793     * @li @ref bg_02_example_page
4794     * @li @ref bg_03_example_page
4795     */
4796
4797    /* bg */
4798    typedef enum _Elm_Bg_Option
4799      {
4800         ELM_BG_OPTION_CENTER,  /**< center the background */
4801         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4802         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4803         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4804      } Elm_Bg_Option;
4805
4806    /**
4807     * Add a new background to the parent
4808     *
4809     * @param parent The parent object
4810     * @return The new object or NULL if it cannot be created
4811     *
4812     * @ingroup Bg
4813     */
4814    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4815
4816    /**
4817     * Set the file (image or edje) used for the background
4818     *
4819     * @param obj The bg object
4820     * @param file The file path
4821     * @param group Optional key (group in Edje) within the file
4822     *
4823     * This sets the image file used in the background object. The image (or edje)
4824     * will be stretched (retaining aspect if its an image file) to completely fill
4825     * the bg object. This may mean some parts are not visible.
4826     *
4827     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4828     * even if @p file is NULL.
4829     *
4830     * @ingroup Bg
4831     */
4832    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4833
4834    /**
4835     * Get the file (image or edje) used for the background
4836     *
4837     * @param obj The bg object
4838     * @param file The file path
4839     * @param group Optional key (group in Edje) within the file
4840     *
4841     * @ingroup Bg
4842     */
4843    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4844
4845    /**
4846     * Set the option used for the background image
4847     *
4848     * @param obj The bg object
4849     * @param option The desired background option (TILE, SCALE)
4850     *
4851     * This sets the option used for manipulating the display of the background
4852     * image. The image can be tiled or scaled.
4853     *
4854     * @ingroup Bg
4855     */
4856    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4857
4858    /**
4859     * Get the option used for the background image
4860     *
4861     * @param obj The bg object
4862     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4863     *
4864     * @ingroup Bg
4865     */
4866    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4867    /**
4868     * Set the option used for the background color
4869     *
4870     * @param obj The bg object
4871     * @param r
4872     * @param g
4873     * @param b
4874     *
4875     * This sets the color used for the background rectangle. Its range goes
4876     * from 0 to 255.
4877     *
4878     * @ingroup Bg
4879     */
4880    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4881    /**
4882     * Get the option used for the background color
4883     *
4884     * @param obj The bg object
4885     * @param r
4886     * @param g
4887     * @param b
4888     *
4889     * @ingroup Bg
4890     */
4891    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4892
4893    /**
4894     * Set the overlay object used for the background object.
4895     *
4896     * @param obj The bg object
4897     * @param overlay The overlay object
4898     *
4899     * This provides a way for elm_bg to have an 'overlay' that will be on top
4900     * of the bg. Once the over object is set, a previously set one will be
4901     * deleted, even if you set the new one to NULL. If you want to keep that
4902     * old content object, use the elm_bg_overlay_unset() function.
4903     *
4904     * @deprecated use elm_object_part_content_set() instead
4905     *
4906     * @ingroup Bg
4907     */
4908
4909    EINA_DEPRECATED EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4910
4911    /**
4912     * Get the overlay object used for the background object.
4913     *
4914     * @param obj The bg object
4915     * @return The content that is being used
4916     *
4917     * Return the content object which is set for this widget
4918     *
4919     * @deprecated use elm_object_part_content_get() instead
4920     *
4921     * @ingroup Bg
4922     */
4923    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4924
4925    /**
4926     * Get the overlay object used for the background object.
4927     *
4928     * @param obj The bg object
4929     * @return The content that was being used
4930     *
4931     * Unparent and return the overlay object which was set for this widget
4932     *
4933     * @deprecated use elm_object_part_content_unset() instead
4934     *
4935     * @ingroup Bg
4936     */
4937    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4938
4939    /**
4940     * Set the size of the pixmap representation of the image.
4941     *
4942     * This option just makes sense if an image is going to be set in the bg.
4943     *
4944     * @param obj The bg object
4945     * @param w The new width of the image pixmap representation.
4946     * @param h The new height of the image pixmap representation.
4947     *
4948     * This function sets a new size for pixmap representation of the given bg
4949     * image. It allows the image to be loaded already in the specified size,
4950     * reducing the memory usage and load time when loading a big image with load
4951     * size set to a smaller size.
4952     *
4953     * NOTE: this is just a hint, the real size of the pixmap may differ
4954     * depending on the type of image being loaded, being bigger than requested.
4955     *
4956     * @ingroup Bg
4957     */
4958    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4959    /* smart callbacks called:
4960     */
4961
4962    /**
4963     * @defgroup Icon Icon
4964     *
4965     * @image html img/widget/icon/preview-00.png
4966     * @image latex img/widget/icon/preview-00.eps
4967     *
4968     * An object that provides standard icon images (delete, edit, arrows, etc.)
4969     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4970     *
4971     * The icon image requested can be in the elementary theme, or in the
4972     * freedesktop.org paths. It's possible to set the order of preference from
4973     * where the image will be used.
4974     *
4975     * This API is very similar to @ref Image, but with ready to use images.
4976     *
4977     * Default images provided by the theme are described below.
4978     *
4979     * The first list contains icons that were first intended to be used in
4980     * toolbars, but can be used in many other places too:
4981     * @li home
4982     * @li close
4983     * @li apps
4984     * @li arrow_up
4985     * @li arrow_down
4986     * @li arrow_left
4987     * @li arrow_right
4988     * @li chat
4989     * @li clock
4990     * @li delete
4991     * @li edit
4992     * @li refresh
4993     * @li folder
4994     * @li file
4995     *
4996     * Now some icons that were designed to be used in menus (but again, you can
4997     * use them anywhere else):
4998     * @li menu/home
4999     * @li menu/close
5000     * @li menu/apps
5001     * @li menu/arrow_up
5002     * @li menu/arrow_down
5003     * @li menu/arrow_left
5004     * @li menu/arrow_right
5005     * @li menu/chat
5006     * @li menu/clock
5007     * @li menu/delete
5008     * @li menu/edit
5009     * @li menu/refresh
5010     * @li menu/folder
5011     * @li menu/file
5012     *
5013     * And here we have some media player specific icons:
5014     * @li media_player/forward
5015     * @li media_player/info
5016     * @li media_player/next
5017     * @li media_player/pause
5018     * @li media_player/play
5019     * @li media_player/prev
5020     * @li media_player/rewind
5021     * @li media_player/stop
5022     *
5023     * Signals that you can add callbacks for are:
5024     *
5025     * "clicked" - This is called when a user has clicked the icon
5026     *
5027     * An example of usage for this API follows:
5028     * @li @ref tutorial_icon
5029     */
5030
5031    /**
5032     * @addtogroup Icon
5033     * @{
5034     */
5035
5036    typedef enum _Elm_Icon_Type
5037      {
5038         ELM_ICON_NONE,
5039         ELM_ICON_FILE,
5040         ELM_ICON_STANDARD
5041      } Elm_Icon_Type;
5042    /**
5043     * @enum _Elm_Icon_Lookup_Order
5044     * @typedef Elm_Icon_Lookup_Order
5045     *
5046     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
5047     * theme, FDO paths, or both?
5048     *
5049     * @ingroup Icon
5050     */
5051    typedef enum _Elm_Icon_Lookup_Order
5052      {
5053         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
5054         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
5055         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
5056         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
5057      } Elm_Icon_Lookup_Order;
5058
5059    /**
5060     * Add a new icon object to the parent.
5061     *
5062     * @param parent The parent object
5063     * @return The new object or NULL if it cannot be created
5064     *
5065     * @see elm_icon_file_set()
5066     *
5067     * @ingroup Icon
5068     */
5069    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5070    /**
5071     * Set the file that will be used as icon.
5072     *
5073     * @param obj The icon object
5074     * @param file The path to file that will be used as icon image
5075     * @param group The group that the icon belongs to an edje file
5076     *
5077     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5078     *
5079     * @note The icon image set by this function can be changed by
5080     * elm_icon_standard_set().
5081     *
5082     * @see elm_icon_file_get()
5083     *
5084     * @ingroup Icon
5085     */
5086    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5087    /**
5088     * Set a location in memory to be used as an icon
5089     *
5090     * @param obj The icon object
5091     * @param img The binary data that will be used as an image
5092     * @param size The size of binary data @p img
5093     * @param format Optional format of @p img to pass to the image loader
5094     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5095     *
5096     * The @p format string should be something like "png", "jpg", "tga",
5097     * "tiff", "bmp" etc. if it is provided (NULL if not). This improves
5098     * the loader performance as it tries the "correct" loader first before
5099     * trying a range of other possible loaders until one succeeds.
5100     * 
5101     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5102     *
5103     * @note The icon image set by this function can be changed by
5104     * elm_icon_standard_set().
5105     *
5106     * @ingroup Icon
5107     */
5108    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);
5109    /**
5110     * Get the file that will be used as icon.
5111     *
5112     * @param obj The icon object
5113     * @param file The path to file that will be used as the icon image
5114     * @param group The group that the icon belongs to, in edje file
5115     *
5116     * @see elm_icon_file_set()
5117     *
5118     * @ingroup Icon
5119     */
5120    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5121    /**
5122     * Set the file that will be used, but use a generated thumbnail.
5123     *
5124     * @param obj The icon object
5125     * @param file The path to file that will be used as icon image
5126     * @param group The group that the icon belongs to an edje file
5127     *
5128     * This functions like elm_icon_file_set() but requires the Ethumb library
5129     * support to be enabled successfully with elm_need_ethumb(). When set
5130     * the file indicated has a thumbnail generated and cached on disk for
5131     * future use or will directly use an existing cached thumbnail if it
5132     * is valid.
5133     * 
5134     * @see elm_icon_file_set()
5135     *
5136     * @ingroup Icon
5137     */
5138    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5139    /**
5140     * Set the icon by icon standards names.
5141     *
5142     * @param obj The icon object
5143     * @param name The icon name
5144     *
5145     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5146     *
5147     * For example, freedesktop.org defines standard icon names such as "home",
5148     * "network", etc. There can be different icon sets to match those icon
5149     * keys. The @p name given as parameter is one of these "keys", and will be
5150     * used to look in the freedesktop.org paths and elementary theme. One can
5151     * change the lookup order with elm_icon_order_lookup_set().
5152     *
5153     * If name is not found in any of the expected locations and it is the
5154     * absolute path of an image file, this image will be used.
5155     *
5156     * @note The icon image set by this function can be changed by
5157     * elm_icon_file_set().
5158     *
5159     * @see elm_icon_standard_get()
5160     * @see elm_icon_file_set()
5161     *
5162     * @ingroup Icon
5163     */
5164    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5165    /**
5166     * Get the icon name set by icon standard names.
5167     *
5168     * @param obj The icon object
5169     * @return The icon name
5170     *
5171     * If the icon image was set using elm_icon_file_set() instead of
5172     * elm_icon_standard_set(), then this function will return @c NULL.
5173     *
5174     * @see elm_icon_standard_set()
5175     *
5176     * @ingroup Icon
5177     */
5178    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5179    /**
5180     * Set the smooth scaling for an icon object.
5181     *
5182     * @param obj The icon object
5183     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5184     * otherwise. Default is @c EINA_TRUE.
5185     *
5186     * Set the scaling algorithm to be used when scaling the icon image. Smooth
5187     * scaling provides a better resulting image, but is slower.
5188     *
5189     * The smooth scaling should be disabled when making animations that change
5190     * the icon size, since they will be faster. Animations that don't require
5191     * resizing of the icon can keep the smooth scaling enabled (even if the icon
5192     * is already scaled, since the scaled icon image will be cached).
5193     *
5194     * @see elm_icon_smooth_get()
5195     *
5196     * @ingroup Icon
5197     */
5198    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5199    /**
5200     * Get whether smooth scaling is enabled for an icon object.
5201     *
5202     * @param obj The icon object
5203     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5204     *
5205     * @see elm_icon_smooth_set()
5206     *
5207     * @ingroup Icon
5208     */
5209    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5210    /**
5211     * Disable scaling of this object.
5212     *
5213     * @param obj The icon object.
5214     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5215     * otherwise. Default is @c EINA_FALSE.
5216     *
5217     * This function disables scaling of the icon object through the function
5218     * elm_object_scale_set(). However, this does not affect the object
5219     * size/resize in any way. For that effect, take a look at
5220     * elm_icon_scale_set().
5221     *
5222     * @see elm_icon_no_scale_get()
5223     * @see elm_icon_scale_set()
5224     * @see elm_object_scale_set()
5225     *
5226     * @ingroup Icon
5227     */
5228    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5229    /**
5230     * Get whether scaling is disabled on the object.
5231     *
5232     * @param obj The icon object
5233     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5234     *
5235     * @see elm_icon_no_scale_set()
5236     *
5237     * @ingroup Icon
5238     */
5239    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5240    /**
5241     * Set if the object is (up/down) resizable.
5242     *
5243     * @param obj The icon object
5244     * @param scale_up A bool to set if the object is resizable up. Default is
5245     * @c EINA_TRUE.
5246     * @param scale_down A bool to set if the object is resizable down. Default
5247     * is @c EINA_TRUE.
5248     *
5249     * This function limits the icon object resize ability. If @p scale_up is set to
5250     * @c EINA_FALSE, the object can't have its height or width resized to a value
5251     * higher than the original icon size. Same is valid for @p scale_down.
5252     *
5253     * @see elm_icon_scale_get()
5254     *
5255     * @ingroup Icon
5256     */
5257    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5258    /**
5259     * Get if the object is (up/down) resizable.
5260     *
5261     * @param obj The icon object
5262     * @param scale_up A bool to set if the object is resizable up
5263     * @param scale_down A bool to set if the object is resizable down
5264     *
5265     * @see elm_icon_scale_set()
5266     *
5267     * @ingroup Icon
5268     */
5269    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5270    /**
5271     * Get the object's image size
5272     *
5273     * @param obj The icon object
5274     * @param w A pointer to store the width in
5275     * @param h A pointer to store the height in
5276     *
5277     * @ingroup Icon
5278     */
5279    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5280    /**
5281     * Set if the icon fill the entire object area.
5282     *
5283     * @param obj The icon object
5284     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5285     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5286     *
5287     * When the icon object is resized to a different aspect ratio from the
5288     * original icon image, the icon image will still keep its aspect. This flag
5289     * tells how the image should fill the object's area. They are: keep the
5290     * entire icon inside the limits of height and width of the object (@p
5291     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5292     * of the object, and the icon will fill the entire object (@p fill_outside
5293     * is @c EINA_TRUE).
5294     *
5295     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5296     * retain property to false. Thus, the icon image will always keep its
5297     * original aspect ratio.
5298     *
5299     * @see elm_icon_fill_outside_get()
5300     * @see elm_image_fill_outside_set()
5301     *
5302     * @ingroup Icon
5303     */
5304    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5305    /**
5306     * Get if the object is filled outside.
5307     *
5308     * @param obj The icon object
5309     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5310     *
5311     * @see elm_icon_fill_outside_set()
5312     *
5313     * @ingroup Icon
5314     */
5315    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5316    /**
5317     * Set the prescale size for the icon.
5318     *
5319     * @param obj The icon object
5320     * @param size The prescale size. This value is used for both width and
5321     * height.
5322     *
5323     * This function sets a new size for pixmap representation of the given
5324     * icon. It allows the icon to be loaded already in the specified size,
5325     * reducing the memory usage and load time when loading a big icon with load
5326     * size set to a smaller size.
5327     *
5328     * It's equivalent to the elm_bg_load_size_set() function for bg.
5329     *
5330     * @note this is just a hint, the real size of the pixmap may differ
5331     * depending on the type of icon being loaded, being bigger than requested.
5332     *
5333     * @see elm_icon_prescale_get()
5334     * @see elm_bg_load_size_set()
5335     *
5336     * @ingroup Icon
5337     */
5338    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5339    /**
5340     * Get the prescale size for the icon.
5341     *
5342     * @param obj The icon object
5343     * @return The prescale size
5344     *
5345     * @see elm_icon_prescale_set()
5346     *
5347     * @ingroup Icon
5348     */
5349    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5350    /**
5351     * Gets the image object of the icon. DO NOT MODIFY THIS.
5352     *
5353     * @param obj The icon object
5354     * @return The internal icon object
5355     *
5356     * @ingroup Icon
5357     */
5358    EAPI Evas_Object          *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5359    /**
5360     * Sets the icon lookup order used by elm_icon_standard_set().
5361     *
5362     * @param obj The icon object
5363     * @param order The icon lookup order (can be one of
5364     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5365     * or ELM_ICON_LOOKUP_THEME)
5366     *
5367     * @see elm_icon_order_lookup_get()
5368     * @see Elm_Icon_Lookup_Order
5369     *
5370     * @ingroup Icon
5371     */
5372    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5373    /**
5374     * Gets the icon lookup order.
5375     *
5376     * @param obj The icon object
5377     * @return The icon lookup order
5378     *
5379     * @see elm_icon_order_lookup_set()
5380     * @see Elm_Icon_Lookup_Order
5381     *
5382     * @ingroup Icon
5383     */
5384    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5385    /**
5386     * Enable or disable preloading of the icon
5387     *
5388     * @param obj The icon object
5389     * @param disable If EINA_TRUE, preloading will be disabled
5390     * @ingroup Icon
5391     */
5392    EAPI void                  elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5393    /**
5394     * Get if the icon supports animation or not.
5395     *
5396     * @param obj The icon object
5397     * @return @c EINA_TRUE if the icon supports animation,
5398     *         @c EINA_FALSE otherwise.
5399     *
5400     * Return if this elm icon's image can be animated. Currently Evas only
5401     * supports gif animation. If the return value is EINA_FALSE, other
5402     * elm_icon_animated_XXX APIs won't work.
5403     * @ingroup Icon
5404     */
5405    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5406    /**
5407     * Set animation mode of the icon.
5408     *
5409     * @param obj The icon object
5410     * @param anim @c EINA_TRUE if the object do animation job,
5411     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5412     *
5413     * Since the default animation mode is set to EINA_FALSE,
5414     * the icon is shown without animation. Files like animated GIF files
5415     * can animate, and this is supported if you enable animated support
5416     * on the icon.
5417     * Set it to EINA_TRUE when the icon needs to be animated.
5418     * @ingroup Icon
5419     */
5420    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5421    /**
5422     * Get animation mode of the icon.
5423     *
5424     * @param obj The icon object
5425     * @return The animation mode of the icon object
5426     * @see elm_icon_animated_set
5427     * @ingroup Icon
5428     */
5429    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5430    /**
5431     * Set animation play mode of the icon.
5432     *
5433     * @param obj The icon object
5434     * @param play @c EINA_TRUE the object play animation images,
5435     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5436     *
5437     * To play elm icon's animation, set play to EINA_TURE.
5438     * For example, you make gif player using this set/get API and click event.
5439     * This literally lets you control current play or paused state. To have
5440     * this work with animated GIF files for example, you first, before
5441     * setting the file have to use elm_icon_animated_set() to enable animation
5442     * at all on the icon.
5443     *
5444     * 1. Click event occurs
5445     * 2. Check play flag using elm_icon_animaged_play_get
5446     * 3. If elm icon was playing, set play to EINA_FALSE.
5447     *    Then animation will be stopped and vice versa
5448     * @ingroup Icon
5449     */
5450    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5451    /**
5452     * Get animation play mode of the icon.
5453     *
5454     * @param obj The icon object
5455     * @return The play mode of the icon object
5456     *
5457     * @see elm_icon_animated_play_get
5458     * @ingroup Icon
5459     */
5460    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5461
5462    /**
5463     * @}
5464     */
5465
5466    /**
5467     * @defgroup Image Image
5468     *
5469     * @image html img/widget/image/preview-00.png
5470     * @image latex img/widget/image/preview-00.eps
5471
5472     *
5473     * An object that allows one to load an image file to it. It can be used
5474     * anywhere like any other elementary widget.
5475     *
5476     * This widget provides most of the functionality provided from @ref Bg or @ref
5477     * Icon, but with a slightly different API (use the one that fits better your
5478     * needs).
5479     *
5480     * The features not provided by those two other image widgets are:
5481     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5482     * @li change the object orientation with elm_image_orient_set();
5483     * @li and turning the image editable with elm_image_editable_set().
5484     *
5485     * Signals that you can add callbacks for are:
5486     *
5487     * @li @c "clicked" - This is called when a user has clicked the image
5488     *
5489     * An example of usage for this API follows:
5490     * @li @ref tutorial_image
5491     */
5492
5493    /**
5494     * @addtogroup Image
5495     * @{
5496     */
5497
5498    /**
5499     * @enum _Elm_Image_Orient
5500     * @typedef Elm_Image_Orient
5501     *
5502     * Possible orientation options for elm_image_orient_set().
5503     *
5504     * @image html elm_image_orient_set.png
5505     * @image latex elm_image_orient_set.eps width=\textwidth
5506     *
5507     * @ingroup Image
5508     */
5509    typedef enum _Elm_Image_Orient
5510      {
5511         ELM_IMAGE_ORIENT_NONE = 0, /**< no orientation change */
5512         ELM_IMAGE_ORIENT_0 = 0, /**< no orientation change */
5513         ELM_IMAGE_ROTATE_90 = 1, /**< rotate 90 degrees clockwise */
5514         ELM_IMAGE_ROTATE_180 = 2, /**< rotate 180 degrees clockwise */
5515         ELM_IMAGE_ROTATE_270 = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5516         /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CW = 1, /**< rotate 90 degrees clockwise */
5517         /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_180_CW = 2, /**< rotate 180 degrees clockwise */
5518         /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CCW = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5519         ELM_IMAGE_FLIP_HORIZONTAL = 4, /**< flip image horizontally */
5520         ELM_IMAGE_FLIP_VERTICAL = 5, /**< flip image vertically */
5521         ELM_IMAGE_FLIP_TRANSPOSE = 6, /**< flip the image along the y = (width - x) line (bottom-left to top-right) */
5522         ELM_IMAGE_FLIP_TRANSVERSE = 7 /**< flip the image along the y = x line (top-left to bottom-right) */
5523      } Elm_Image_Orient;
5524
5525    /**
5526     * Add a new image to the parent.
5527     *
5528     * @param parent The parent object
5529     * @return The new object or NULL if it cannot be created
5530     *
5531     * @see elm_image_file_set()
5532     *
5533     * @ingroup Image
5534     */
5535    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5536    /**
5537     * Set the file that will be used as image.
5538     *
5539     * @param obj The image object
5540     * @param file The path to file that will be used as image
5541     * @param group The group that the image belongs in edje file (if it's an
5542     * edje image)
5543     *
5544     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5545     *
5546     * @see elm_image_file_get()
5547     *
5548     * @ingroup Image
5549     */
5550    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5551    /**
5552     * Get the file that will be used as image.
5553     *
5554     * @param obj The image object
5555     * @param file The path to file
5556     * @param group The group that the image belongs in edje file
5557     *
5558     * @see elm_image_file_set()
5559     *
5560     * @ingroup Image
5561     */
5562    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5563    /**
5564     * Set the smooth effect for an image.
5565     *
5566     * @param obj The image object
5567     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5568     * otherwise. Default is @c EINA_TRUE.
5569     *
5570     * Set the scaling algorithm to be used when scaling the image. Smooth
5571     * scaling provides a better resulting image, but is slower.
5572     *
5573     * The smooth scaling should be disabled when making animations that change
5574     * the image size, since it will be faster. Animations that don't require
5575     * resizing of the image can keep the smooth scaling enabled (even if the
5576     * image is already scaled, since the scaled image will be cached).
5577     *
5578     * @see elm_image_smooth_get()
5579     *
5580     * @ingroup Image
5581     */
5582    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5583    /**
5584     * Get the smooth effect for an image.
5585     *
5586     * @param obj The image object
5587     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5588     *
5589     * @see elm_image_smooth_get()
5590     *
5591     * @ingroup Image
5592     */
5593    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5594
5595    /**
5596     * Gets the current size of the image.
5597     *
5598     * @param obj The image object.
5599     * @param w Pointer to store width, or NULL.
5600     * @param h Pointer to store height, or NULL.
5601     *
5602     * This is the real size of the image, not the size of the object.
5603     *
5604     * On error, neither w and h will be fileld with 0.
5605     *
5606     * @ingroup Image
5607     */
5608    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5609    /**
5610     * Disable scaling of this object.
5611     *
5612     * @param obj The image object.
5613     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5614     * otherwise. Default is @c EINA_FALSE.
5615     *
5616     * This function disables scaling of the elm_image widget through the
5617     * function elm_object_scale_set(). However, this does not affect the widget
5618     * size/resize in any way. For that effect, take a look at
5619     * elm_image_scale_set().
5620     *
5621     * @see elm_image_no_scale_get()
5622     * @see elm_image_scale_set()
5623     * @see elm_object_scale_set()
5624     *
5625     * @ingroup Image
5626     */
5627    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5628    /**
5629     * Get whether scaling is disabled on the object.
5630     *
5631     * @param obj The image object
5632     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5633     *
5634     * @see elm_image_no_scale_set()
5635     *
5636     * @ingroup Image
5637     */
5638    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5639    /**
5640     * Set if the object is (up/down) resizable.
5641     *
5642     * @param obj The image object
5643     * @param scale_up A bool to set if the object is resizable up. Default is
5644     * @c EINA_TRUE.
5645     * @param scale_down A bool to set if the object is resizable down. Default
5646     * is @c EINA_TRUE.
5647     *
5648     * This function limits the image resize ability. If @p scale_up is set to
5649     * @c EINA_FALSE, the object can't have its height or width resized to a value
5650     * higher than the original image size. Same is valid for @p scale_down.
5651     *
5652     * @see elm_image_scale_get()
5653     *
5654     * @ingroup Image
5655     */
5656    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5657    /**
5658     * Get if the object is (up/down) resizable.
5659     *
5660     * @param obj The image object
5661     * @param scale_up A bool to set if the object is resizable up
5662     * @param scale_down A bool to set if the object is resizable down
5663     *
5664     * @see elm_image_scale_set()
5665     *
5666     * @ingroup Image
5667     */
5668    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5669    /**
5670     * Set if the image fills the entire object area, when keeping the aspect ratio.
5671     *
5672     * @param obj The image object
5673     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5674     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5675     *
5676     * When the image should keep its aspect ratio even if resized to another
5677     * aspect ratio, there are two possibilities to resize it: keep the entire
5678     * image inside the limits of height and width of the object (@p fill_outside
5679     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5680     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5681     *
5682     * @note This option will have no effect if
5683     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5684     *
5685     * @see elm_image_fill_outside_get()
5686     * @see elm_image_aspect_ratio_retained_set()
5687     *
5688     * @ingroup Image
5689     */
5690    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5691    /**
5692     * Get if the object is filled outside
5693     *
5694     * @param obj The image object
5695     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5696     *
5697     * @see elm_image_fill_outside_set()
5698     *
5699     * @ingroup Image
5700     */
5701    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5702    /**
5703     * Set the prescale size for the image
5704     *
5705     * @param obj The image object
5706     * @param size The prescale size. This value is used for both width and
5707     * height.
5708     *
5709     * This function sets a new size for pixmap representation of the given
5710     * image. It allows the image to be loaded already in the specified size,
5711     * reducing the memory usage and load time when loading a big image with load
5712     * size set to a smaller size.
5713     *
5714     * It's equivalent to the elm_bg_load_size_set() function for bg.
5715     *
5716     * @note this is just a hint, the real size of the pixmap may differ
5717     * depending on the type of image being loaded, being bigger than requested.
5718     *
5719     * @see elm_image_prescale_get()
5720     * @see elm_bg_load_size_set()
5721     *
5722     * @ingroup Image
5723     */
5724    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5725    /**
5726     * Get the prescale size for the image
5727     *
5728     * @param obj The image object
5729     * @return The prescale size
5730     *
5731     * @see elm_image_prescale_set()
5732     *
5733     * @ingroup Image
5734     */
5735    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5736    /**
5737     * Set the image orientation.
5738     *
5739     * @param obj The image object
5740     * @param orient The image orientation @ref Elm_Image_Orient
5741     *  Default is #ELM_IMAGE_ORIENT_NONE.
5742     *
5743     * This function allows to rotate or flip the given image.
5744     *
5745     * @see elm_image_orient_get()
5746     * @see @ref Elm_Image_Orient
5747     *
5748     * @ingroup Image
5749     */
5750    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5751    /**
5752     * Get the image orientation.
5753     *
5754     * @param obj The image object
5755     * @return The image orientation @ref Elm_Image_Orient
5756     *
5757     * @see elm_image_orient_set()
5758     * @see @ref Elm_Image_Orient
5759     *
5760     * @ingroup Image
5761     */
5762    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5763    /**
5764     * Make the image 'editable'.
5765     *
5766     * @param obj Image object.
5767     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5768     *
5769     * This means the image is a valid drag target for drag and drop, and can be
5770     * cut or pasted too.
5771     *
5772     * @ingroup Image
5773     */
5774    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5775    /**
5776     * Check if the image 'editable'.
5777     *
5778     * @param obj Image object.
5779     * @return Editability.
5780     *
5781     * A return value of EINA_TRUE means the image is a valid drag target
5782     * for drag and drop, and can be cut or pasted too.
5783     *
5784     * @ingroup Image
5785     */
5786    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5787    /**
5788     * Get the basic Evas_Image object from this object (widget).
5789     *
5790     * @param obj The image object to get the inlined image from
5791     * @return The inlined image object, or NULL if none exists
5792     *
5793     * This function allows one to get the underlying @c Evas_Object of type
5794     * Image from this elementary widget. It can be useful to do things like get
5795     * the pixel data, save the image to a file, etc.
5796     *
5797     * @note Be careful to not manipulate it, as it is under control of
5798     * elementary.
5799     *
5800     * @ingroup Image
5801     */
5802    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5803    /**
5804     * Set whether the original aspect ratio of the image should be kept on resize.
5805     *
5806     * @param obj The image object.
5807     * @param retained @c EINA_TRUE if the image should retain the aspect,
5808     * @c EINA_FALSE otherwise.
5809     *
5810     * The original aspect ratio (width / height) of the image is usually
5811     * distorted to match the object's size. Enabling this option will retain
5812     * this original aspect, and the way that the image is fit into the object's
5813     * area depends on the option set by elm_image_fill_outside_set().
5814     *
5815     * @see elm_image_aspect_ratio_retained_get()
5816     * @see elm_image_fill_outside_set()
5817     *
5818     * @ingroup Image
5819     */
5820    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5821    /**
5822     * Get if the object retains the original aspect ratio.
5823     *
5824     * @param obj The image object.
5825     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5826     * otherwise.
5827     *
5828     * @ingroup Image
5829     */
5830    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5831
5832    /**
5833     * @}
5834     */
5835
5836    /* box */
5837    /**
5838     * @defgroup Box Box
5839     *
5840     * @image html img/widget/box/preview-00.png
5841     * @image latex img/widget/box/preview-00.eps width=\textwidth
5842     *
5843     * @image html img/box.png
5844     * @image latex img/box.eps width=\textwidth
5845     *
5846     * A box arranges objects in a linear fashion, governed by a layout function
5847     * that defines the details of this arrangement.
5848     *
5849     * By default, the box will use an internal function to set the layout to
5850     * a single row, either vertical or horizontal. This layout is affected
5851     * by a number of parameters, such as the homogeneous flag set by
5852     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5853     * elm_box_align_set() and the hints set to each object in the box.
5854     *
5855     * For this default layout, it's possible to change the orientation with
5856     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5857     * placing its elements ordered from top to bottom. When horizontal is set,
5858     * the order will go from left to right. If the box is set to be
5859     * homogeneous, every object in it will be assigned the same space, that
5860     * of the largest object. Padding can be used to set some spacing between
5861     * the cell given to each object. The alignment of the box, set with
5862     * elm_box_align_set(), determines how the bounding box of all the elements
5863     * will be placed within the space given to the box widget itself.
5864     *
5865     * The size hints of each object also affect how they are placed and sized
5866     * within the box. evas_object_size_hint_min_set() will give the minimum
5867     * size the object can have, and the box will use it as the basis for all
5868     * latter calculations. Elementary widgets set their own minimum size as
5869     * needed, so there's rarely any need to use it manually.
5870     *
5871     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5872     * used to tell whether the object will be allocated the minimum size it
5873     * needs or if the space given to it should be expanded. It's important
5874     * to realize that expanding the size given to the object is not the same
5875     * thing as resizing the object. It could very well end being a small
5876     * widget floating in a much larger empty space. If not set, the weight
5877     * for objects will normally be 0.0 for both axis, meaning the widget will
5878     * not be expanded. To take as much space possible, set the weight to
5879     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5880     *
5881     * Besides how much space each object is allocated, it's possible to control
5882     * how the widget will be placed within that space using
5883     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5884     * for both axis, meaning the object will be centered, but any value from
5885     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5886     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5887     * is -1.0, means the object will be resized to fill the entire space it
5888     * was allocated.
5889     *
5890     * In addition, customized functions to define the layout can be set, which
5891     * allow the application developer to organize the objects within the box
5892     * in any number of ways.
5893     *
5894     * The special elm_box_layout_transition() function can be used
5895     * to switch from one layout to another, animating the motion of the
5896     * children of the box.
5897     *
5898     * @note Objects should not be added to box objects using _add() calls.
5899     *
5900     * Some examples on how to use boxes follow:
5901     * @li @ref box_example_01
5902     * @li @ref box_example_02
5903     *
5904     * @{
5905     */
5906    /**
5907     * @typedef Elm_Box_Transition
5908     *
5909     * Opaque handler containing the parameters to perform an animated
5910     * transition of the layout the box uses.
5911     *
5912     * @see elm_box_transition_new()
5913     * @see elm_box_layout_set()
5914     * @see elm_box_layout_transition()
5915     */
5916    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5917
5918    /**
5919     * Add a new box to the parent
5920     *
5921     * By default, the box will be in vertical mode and non-homogeneous.
5922     *
5923     * @param parent The parent object
5924     * @return The new object or NULL if it cannot be created
5925     */
5926    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5927    /**
5928     * Set the horizontal orientation
5929     *
5930     * By default, box object arranges their contents vertically from top to
5931     * bottom.
5932     * By calling this function with @p horizontal as EINA_TRUE, the box will
5933     * become horizontal, arranging contents from left to right.
5934     *
5935     * @note This flag is ignored if a custom layout function is set.
5936     *
5937     * @param obj The box object
5938     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5939     * EINA_FALSE = vertical)
5940     */
5941    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5942    /**
5943     * Get the horizontal orientation
5944     *
5945     * @param obj The box object
5946     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5947     */
5948    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5949    /**
5950     * Set the box to arrange its children homogeneously
5951     *
5952     * If enabled, homogeneous layout makes all items the same size, according
5953     * to the size of the largest of its children.
5954     *
5955     * @note This flag is ignored if a custom layout function is set.
5956     *
5957     * @param obj The box object
5958     * @param homogeneous The homogeneous flag
5959     */
5960    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5961    /**
5962     * Get whether the box is using homogeneous mode or not
5963     *
5964     * @param obj The box object
5965     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5966     */
5967    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5968    /**
5969     * Add an object to the beginning of the pack list
5970     *
5971     * Pack @p subobj into the box @p obj, placing it first in the list of
5972     * children objects. The actual position the object will get on screen
5973     * depends on the layout used. If no custom layout is set, it will be at
5974     * the top or left, depending if the box is vertical or horizontal,
5975     * respectively.
5976     *
5977     * @param obj The box object
5978     * @param subobj The object to add to the box
5979     *
5980     * @see elm_box_pack_end()
5981     * @see elm_box_pack_before()
5982     * @see elm_box_pack_after()
5983     * @see elm_box_unpack()
5984     * @see elm_box_unpack_all()
5985     * @see elm_box_clear()
5986     */
5987    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5988    /**
5989     * Add an object at the end of the pack list
5990     *
5991     * Pack @p subobj into the box @p obj, placing it last in the list of
5992     * children objects. The actual position the object will get on screen
5993     * depends on the layout used. If no custom layout is set, it will be at
5994     * the bottom or right, depending if the box is vertical or horizontal,
5995     * respectively.
5996     *
5997     * @param obj The box object
5998     * @param subobj The object to add to the box
5999     *
6000     * @see elm_box_pack_start()
6001     * @see elm_box_pack_before()
6002     * @see elm_box_pack_after()
6003     * @see elm_box_unpack()
6004     * @see elm_box_unpack_all()
6005     * @see elm_box_clear()
6006     */
6007    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6008    /**
6009     * Adds an object to the box before the indicated object
6010     *
6011     * This will add the @p subobj to the box indicated before the object
6012     * indicated with @p before. If @p before is not already in the box, results
6013     * are undefined. Before means either to the left of the indicated object or
6014     * above it depending on orientation.
6015     *
6016     * @param obj The box object
6017     * @param subobj The object to add to the box
6018     * @param before The object before which to add it
6019     *
6020     * @see elm_box_pack_start()
6021     * @see elm_box_pack_end()
6022     * @see elm_box_pack_after()
6023     * @see elm_box_unpack()
6024     * @see elm_box_unpack_all()
6025     * @see elm_box_clear()
6026     */
6027    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6028    /**
6029     * Adds an object to the box after the indicated object
6030     *
6031     * This will add the @p subobj to the box indicated after the object
6032     * indicated with @p after. If @p after is not already in the box, results
6033     * are undefined. After means either to the right of the indicated object or
6034     * below it depending on orientation.
6035     *
6036     * @param obj The box object
6037     * @param subobj The object to add to the box
6038     * @param after The object after which to add it
6039     *
6040     * @see elm_box_pack_start()
6041     * @see elm_box_pack_end()
6042     * @see elm_box_pack_before()
6043     * @see elm_box_unpack()
6044     * @see elm_box_unpack_all()
6045     * @see elm_box_clear()
6046     */
6047    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6048    /**
6049     * Clear the box of all children
6050     *
6051     * Remove all the elements contained by the box, deleting the respective
6052     * objects.
6053     *
6054     * @param obj The box object
6055     *
6056     * @see elm_box_unpack()
6057     * @see elm_box_unpack_all()
6058     */
6059    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6060    /**
6061     * Unpack a box item
6062     *
6063     * Remove the object given by @p subobj from the box @p obj without
6064     * deleting it.
6065     *
6066     * @param obj The box object
6067     *
6068     * @see elm_box_unpack_all()
6069     * @see elm_box_clear()
6070     */
6071    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6072    /**
6073     * Remove all items from the box, without deleting them
6074     *
6075     * Clear the box from all children, but don't delete the respective objects.
6076     * If no other references of the box children exist, the objects will never
6077     * be deleted, and thus the application will leak the memory. Make sure
6078     * when using this function that you hold a reference to all the objects
6079     * in the box @p obj.
6080     *
6081     * @param obj The box object
6082     *
6083     * @see elm_box_clear()
6084     * @see elm_box_unpack()
6085     */
6086    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6087    /**
6088     * Retrieve a list of the objects packed into the box
6089     *
6090     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6091     * The order of the list corresponds to the packing order the box uses.
6092     *
6093     * You must free this list with eina_list_free() once you are done with it.
6094     *
6095     * @param obj The box object
6096     */
6097    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6098    /**
6099     * Set the space (padding) between the box's elements.
6100     *
6101     * Extra space in pixels that will be added between a box child and its
6102     * neighbors after its containing cell has been calculated. This padding
6103     * is set for all elements in the box, besides any possible padding that
6104     * individual elements may have through their size hints.
6105     *
6106     * @param obj The box object
6107     * @param horizontal The horizontal space between elements
6108     * @param vertical The vertical space between elements
6109     */
6110    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6111    /**
6112     * Get the space (padding) between the box's elements.
6113     *
6114     * @param obj The box object
6115     * @param horizontal The horizontal space between elements
6116     * @param vertical The vertical space between elements
6117     *
6118     * @see elm_box_padding_set()
6119     */
6120    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6121    /**
6122     * Set the alignment of the whole bouding box of contents.
6123     *
6124     * Sets how the bounding box containing all the elements of the box, after
6125     * their sizes and position has been calculated, will be aligned within
6126     * the space given for the whole box widget.
6127     *
6128     * @param obj The box object
6129     * @param horizontal The horizontal alignment of elements
6130     * @param vertical The vertical alignment of elements
6131     */
6132    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6133    /**
6134     * Get the alignment of the whole bouding box of contents.
6135     *
6136     * @param obj The box object
6137     * @param horizontal The horizontal alignment of elements
6138     * @param vertical The vertical alignment of elements
6139     *
6140     * @see elm_box_align_set()
6141     */
6142    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6143
6144    /**
6145     * Force the box to recalculate its children packing.
6146     *
6147     * If any children was added or removed, box will not calculate the
6148     * values immediately rather leaving it to the next main loop
6149     * iteration. While this is great as it would save lots of
6150     * recalculation, whenever you need to get the position of a just
6151     * added item you must force recalculate before doing so.
6152     *
6153     * @param obj The box object.
6154     */
6155    EAPI void                 elm_box_recalculate(Evas_Object *obj);
6156
6157    /**
6158     * Set the layout defining function to be used by the box
6159     *
6160     * Whenever anything changes that requires the box in @p obj to recalculate
6161     * the size and position of its elements, the function @p cb will be called
6162     * to determine what the layout of the children will be.
6163     *
6164     * Once a custom function is set, everything about the children layout
6165     * is defined by it. The flags set by elm_box_horizontal_set() and
6166     * elm_box_homogeneous_set() no longer have any meaning, and the values
6167     * given by elm_box_padding_set() and elm_box_align_set() are up to this
6168     * layout function to decide if they are used and how. These last two
6169     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6170     * passed to @p cb. The @c Evas_Object the function receives is not the
6171     * Elementary widget, but the internal Evas Box it uses, so none of the
6172     * functions described here can be used on it.
6173     *
6174     * Any of the layout functions in @c Evas can be used here, as well as the
6175     * special elm_box_layout_transition().
6176     *
6177     * The final @p data argument received by @p cb is the same @p data passed
6178     * here, and the @p free_data function will be called to free it
6179     * whenever the box is destroyed or another layout function is set.
6180     *
6181     * Setting @p cb to NULL will revert back to the default layout function.
6182     *
6183     * @param obj The box object
6184     * @param cb The callback function used for layout
6185     * @param data Data that will be passed to layout function
6186     * @param free_data Function called to free @p data
6187     *
6188     * @see elm_box_layout_transition()
6189     */
6190    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);
6191    /**
6192     * Special layout function that animates the transition from one layout to another
6193     *
6194     * Normally, when switching the layout function for a box, this will be
6195     * reflected immediately on screen on the next render, but it's also
6196     * possible to do this through an animated transition.
6197     *
6198     * This is done by creating an ::Elm_Box_Transition and setting the box
6199     * layout to this function.
6200     *
6201     * For example:
6202     * @code
6203     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6204     *                            evas_object_box_layout_vertical, // start
6205     *                            NULL, // data for initial layout
6206     *                            NULL, // free function for initial data
6207     *                            evas_object_box_layout_horizontal, // end
6208     *                            NULL, // data for final layout
6209     *                            NULL, // free function for final data
6210     *                            anim_end, // will be called when animation ends
6211     *                            NULL); // data for anim_end function\
6212     * elm_box_layout_set(box, elm_box_layout_transition, t,
6213     *                    elm_box_transition_free);
6214     * @endcode
6215     *
6216     * @note This function can only be used with elm_box_layout_set(). Calling
6217     * it directly will not have the expected results.
6218     *
6219     * @see elm_box_transition_new
6220     * @see elm_box_transition_free
6221     * @see elm_box_layout_set
6222     */
6223    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6224    /**
6225     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6226     *
6227     * If you want to animate the change from one layout to another, you need
6228     * to set the layout function of the box to elm_box_layout_transition(),
6229     * passing as user data to it an instance of ::Elm_Box_Transition with the
6230     * necessary information to perform this animation. The free function to
6231     * set for the layout is elm_box_transition_free().
6232     *
6233     * The parameters to create an ::Elm_Box_Transition sum up to how long
6234     * will it be, in seconds, a layout function to describe the initial point,
6235     * another for the final position of the children and one function to be
6236     * called when the whole animation ends. This last function is useful to
6237     * set the definitive layout for the box, usually the same as the end
6238     * layout for the animation, but could be used to start another transition.
6239     *
6240     * @param start_layout The layout function that will be used to start the animation
6241     * @param start_layout_data The data to be passed the @p start_layout function
6242     * @param start_layout_free_data Function to free @p start_layout_data
6243     * @param end_layout The layout function that will be used to end the animation
6244     * @param end_layout_free_data The data to be passed the @p end_layout function
6245     * @param end_layout_free_data Function to free @p end_layout_data
6246     * @param transition_end_cb Callback function called when animation ends
6247     * @param transition_end_data Data to be passed to @p transition_end_cb
6248     * @return An instance of ::Elm_Box_Transition
6249     *
6250     * @see elm_box_transition_new
6251     * @see elm_box_layout_transition
6252     */
6253    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);
6254    /**
6255     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6256     *
6257     * This function is mostly useful as the @c free_data parameter in
6258     * elm_box_layout_set() when elm_box_layout_transition().
6259     *
6260     * @param data The Elm_Box_Transition instance to be freed.
6261     *
6262     * @see elm_box_transition_new
6263     * @see elm_box_layout_transition
6264     */
6265    EAPI void                elm_box_transition_free(void *data);
6266    /**
6267     * @}
6268     */
6269
6270    /* button */
6271    /**
6272     * @defgroup Button Button
6273     *
6274     * @image html img/widget/button/preview-00.png
6275     * @image latex img/widget/button/preview-00.eps
6276     * @image html img/widget/button/preview-01.png
6277     * @image latex img/widget/button/preview-01.eps
6278     * @image html img/widget/button/preview-02.png
6279     * @image latex img/widget/button/preview-02.eps
6280     *
6281     * This is a push-button. Press it and run some function. It can contain
6282     * a simple label and icon object and it also has an autorepeat feature.
6283     *
6284     * This widgets emits the following signals:
6285     * @li "clicked": the user clicked the button (press/release).
6286     * @li "repeated": the user pressed the button without releasing it.
6287     * @li "pressed": button was pressed.
6288     * @li "unpressed": button was released after being pressed.
6289     * In all three cases, the @c event parameter of the callback will be
6290     * @c NULL.
6291     *
6292     * Also, defined in the default theme, the button has the following styles
6293     * available:
6294     * @li default: a normal button.
6295     * @li anchor: Like default, but the button fades away when the mouse is not
6296     * over it, leaving only the text or icon.
6297     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6298     * continuous look across its options.
6299     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6300     *
6301     * Default contents parts of the button widget that you can use for are:
6302     * @li "icon" - An icon of the button
6303     *
6304     * Default text parts of the button widget that you can use for are:
6305     * @li "default" - Label of the button
6306     *
6307     * Follow through a complete example @ref button_example_01 "here".
6308     * @{
6309     */
6310    /**
6311     * Add a new button to the parent's canvas
6312     *
6313     * @param parent The parent object
6314     * @return The new object or NULL if it cannot be created
6315     */
6316    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6317    /**
6318     * Set the label used in the button
6319     *
6320     * The passed @p label can be NULL to clean any existing text in it and
6321     * leave the button as an icon only object.
6322     *
6323     * @param obj The button object
6324     * @param label The text will be written on the button
6325     * @deprecated use elm_object_text_set() instead.
6326     */
6327    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6328    /**
6329     * Get the label set for the button
6330     *
6331     * The string returned is an internal pointer and should not be freed or
6332     * altered. It will also become invalid when the button is destroyed.
6333     * The string returned, if not NULL, is a stringshare, so if you need to
6334     * keep it around even after the button is destroyed, you can use
6335     * eina_stringshare_ref().
6336     *
6337     * @param obj The button object
6338     * @return The text set to the label, or NULL if nothing is set
6339     * @deprecated use elm_object_text_set() instead.
6340     */
6341    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6342    /**
6343     * Set the icon used for the button
6344     *
6345     * Setting a new icon will delete any other that was previously set, making
6346     * any reference to them invalid. If you need to maintain the previous
6347     * object alive, unset it first with elm_button_icon_unset().
6348     *
6349     * @param obj The button object
6350     * @param icon The icon object for the button
6351     * @deprecated use elm_object_part_content_set() instead.
6352     */
6353    EINA_DEPRECATED EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6354    /**
6355     * Get the icon used for the button
6356     *
6357     * Return the icon object which is set for this widget. If the button is
6358     * destroyed or another icon is set, the returned object will be deleted
6359     * and any reference to it will be invalid.
6360     *
6361     * @param obj The button object
6362     * @return The icon object that is being used
6363     *
6364     * @deprecated use elm_object_part_content_get() instead
6365     */
6366    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6367    /**
6368     * Remove the icon set without deleting it and return the object
6369     *
6370     * This function drops the reference the button holds of the icon object
6371     * and returns this last object. It is used in case you want to remove any
6372     * icon, or set another one, without deleting the actual object. The button
6373     * will be left without an icon set.
6374     *
6375     * @param obj The button object
6376     * @return The icon object that was being used
6377     * @deprecated use elm_object_part_content_unset() instead.
6378     */
6379    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6380    /**
6381     * Turn on/off the autorepeat event generated when the button is kept pressed
6382     *
6383     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6384     * signal when they are clicked.
6385     *
6386     * When on, keeping a button pressed will continuously emit a @c repeated
6387     * signal until the button is released. The time it takes until it starts
6388     * emitting the signal is given by
6389     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6390     * new emission by elm_button_autorepeat_gap_timeout_set().
6391     *
6392     * @param obj The button object
6393     * @param on  A bool to turn on/off the event
6394     */
6395    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6396    /**
6397     * Get whether the autorepeat feature is enabled
6398     *
6399     * @param obj The button object
6400     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6401     *
6402     * @see elm_button_autorepeat_set()
6403     */
6404    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6405    /**
6406     * Set the initial timeout before the autorepeat event is generated
6407     *
6408     * Sets the timeout, in seconds, since the button is pressed until the
6409     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6410     * won't be any delay and the even will be fired the moment the button is
6411     * pressed.
6412     *
6413     * @param obj The button object
6414     * @param t   Timeout in seconds
6415     *
6416     * @see elm_button_autorepeat_set()
6417     * @see elm_button_autorepeat_gap_timeout_set()
6418     */
6419    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6420    /**
6421     * Get the initial timeout before the autorepeat event is generated
6422     *
6423     * @param obj The button object
6424     * @return Timeout in seconds
6425     *
6426     * @see elm_button_autorepeat_initial_timeout_set()
6427     */
6428    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6429    /**
6430     * Set the interval between each generated autorepeat event
6431     *
6432     * After the first @c repeated event is fired, all subsequent ones will
6433     * follow after a delay of @p t seconds for each.
6434     *
6435     * @param obj The button object
6436     * @param t   Interval in seconds
6437     *
6438     * @see elm_button_autorepeat_initial_timeout_set()
6439     */
6440    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6441    /**
6442     * Get the interval between each generated autorepeat event
6443     *
6444     * @param obj The button object
6445     * @return Interval in seconds
6446     */
6447    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6448    /**
6449     * @}
6450     */
6451
6452    /**
6453     * @defgroup File_Selector_Button File Selector Button
6454     *
6455     * @image html img/widget/fileselector_button/preview-00.png
6456     * @image latex img/widget/fileselector_button/preview-00.eps
6457     * @image html img/widget/fileselector_button/preview-01.png
6458     * @image latex img/widget/fileselector_button/preview-01.eps
6459     * @image html img/widget/fileselector_button/preview-02.png
6460     * @image latex img/widget/fileselector_button/preview-02.eps
6461     *
6462     * This is a button that, when clicked, creates an Elementary
6463     * window (or inner window) <b> with a @ref Fileselector "file
6464     * selector widget" within</b>. When a file is chosen, the (inner)
6465     * window is closed and the button emits a signal having the
6466     * selected file as it's @c event_info.
6467     *
6468     * This widget encapsulates operations on its internal file
6469     * selector on its own API. There is less control over its file
6470     * selector than that one would have instatiating one directly.
6471     *
6472     * The following styles are available for this button:
6473     * @li @c "default"
6474     * @li @c "anchor"
6475     * @li @c "hoversel_vertical"
6476     * @li @c "hoversel_vertical_entry"
6477     *
6478     * Smart callbacks one can register to:
6479     * - @c "file,chosen" - the user has selected a path, whose string
6480     *   pointer comes as the @c event_info data (a stringshared
6481     *   string)
6482     *
6483     * Here is an example on its usage:
6484     * @li @ref fileselector_button_example
6485     *
6486     * @see @ref File_Selector_Entry for a similar widget.
6487     * @{
6488     */
6489
6490    /**
6491     * Add a new file selector button widget to the given parent
6492     * Elementary (container) object
6493     *
6494     * @param parent The parent object
6495     * @return a new file selector button widget handle or @c NULL, on
6496     * errors
6497     */
6498    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6499
6500    /**
6501     * Set the label for a given file selector button widget
6502     *
6503     * @param obj The file selector button widget
6504     * @param label The text label to be displayed on @p obj
6505     *
6506     * @deprecated use elm_object_text_set() instead.
6507     */
6508    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6509
6510    /**
6511     * Get the label set for a given file selector button widget
6512     *
6513     * @param obj The file selector button widget
6514     * @return The button label
6515     *
6516     * @deprecated use elm_object_text_set() instead.
6517     */
6518    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6519
6520    /**
6521     * Set the icon on a given file selector button widget
6522     *
6523     * @param obj The file selector button widget
6524     * @param icon The icon object for the button
6525     *
6526     * Once the icon object is set, a previously set one will be
6527     * deleted. If you want to keep the latter, use the
6528     * elm_fileselector_button_icon_unset() function.
6529     *
6530     * @see elm_fileselector_button_icon_get()
6531     */
6532    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6533
6534    /**
6535     * Get the icon set for a given file selector button widget
6536     *
6537     * @param obj The file selector button widget
6538     * @return The icon object currently set on @p obj or @c NULL, if
6539     * none is
6540     *
6541     * @see elm_fileselector_button_icon_set()
6542     */
6543    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6544
6545    /**
6546     * Unset the icon used in a given file selector button widget
6547     *
6548     * @param obj The file selector button widget
6549     * @return The icon object that was being used on @p obj or @c
6550     * NULL, on errors
6551     *
6552     * Unparent and return the icon object which was set for this
6553     * widget.
6554     *
6555     * @see elm_fileselector_button_icon_set()
6556     */
6557    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6558
6559    /**
6560     * Set the title for a given file selector button widget's window
6561     *
6562     * @param obj The file selector button widget
6563     * @param title The title string
6564     *
6565     * This will change the window's title, when the file selector pops
6566     * out after a click on the button. Those windows have the default
6567     * (unlocalized) value of @c "Select a file" as titles.
6568     *
6569     * @note It will only take any effect if the file selector
6570     * button widget is @b not under "inwin mode".
6571     *
6572     * @see elm_fileselector_button_window_title_get()
6573     */
6574    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6575
6576    /**
6577     * Get the title set for a given file selector button widget's
6578     * window
6579     *
6580     * @param obj The file selector button widget
6581     * @return Title of the file selector button's window
6582     *
6583     * @see elm_fileselector_button_window_title_get() for more details
6584     */
6585    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6586
6587    /**
6588     * Set the size of a given file selector button widget's window,
6589     * holding the file selector itself.
6590     *
6591     * @param obj The file selector button widget
6592     * @param width The window's width
6593     * @param height The window's height
6594     *
6595     * @note it will only take any effect if the file selector button
6596     * widget is @b not under "inwin mode". The default size for the
6597     * window (when applicable) is 400x400 pixels.
6598     *
6599     * @see elm_fileselector_button_window_size_get()
6600     */
6601    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6602
6603    /**
6604     * Get the size of a given file selector button widget's window,
6605     * holding the file selector itself.
6606     *
6607     * @param obj The file selector button widget
6608     * @param width Pointer into which to store the width value
6609     * @param height Pointer into which to store the height value
6610     *
6611     * @note Use @c NULL pointers on the size values you're not
6612     * interested in: they'll be ignored by the function.
6613     *
6614     * @see elm_fileselector_button_window_size_set(), for more details
6615     */
6616    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6617
6618    /**
6619     * Set the initial file system path for a given file selector
6620     * button widget
6621     *
6622     * @param obj The file selector button widget
6623     * @param path The path string
6624     *
6625     * It must be a <b>directory</b> path, which will have the contents
6626     * displayed initially in the file selector's view, when invoked
6627     * from @p obj. The default initial path is the @c "HOME"
6628     * environment variable's value.
6629     *
6630     * @see elm_fileselector_button_path_get()
6631     */
6632    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6633
6634    /**
6635     * Get the initial file system path set for a given file selector
6636     * button widget
6637     *
6638     * @param obj The file selector button widget
6639     * @return path The path string
6640     *
6641     * @see elm_fileselector_button_path_set() for more details
6642     */
6643    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6644
6645    /**
6646     * Enable/disable a tree view in the given file selector button
6647     * widget's internal file selector
6648     *
6649     * @param obj The file selector button widget
6650     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6651     * disable
6652     *
6653     * This has the same effect as elm_fileselector_expandable_set(),
6654     * but now applied to a file selector button's internal file
6655     * selector.
6656     *
6657     * @note There's no way to put a file selector button's internal
6658     * file selector in "grid mode", as one may do with "pure" file
6659     * selectors.
6660     *
6661     * @see elm_fileselector_expandable_get()
6662     */
6663    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6664
6665    /**
6666     * Get whether tree view is enabled for the given file selector
6667     * button widget's internal file selector
6668     *
6669     * @param obj The file selector button widget
6670     * @return @c EINA_TRUE if @p obj widget's internal file selector
6671     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6672     *
6673     * @see elm_fileselector_expandable_set() for more details
6674     */
6675    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6676
6677    /**
6678     * Set whether a given file selector button widget's internal file
6679     * selector is to display folders only or the directory contents,
6680     * as well.
6681     *
6682     * @param obj The file selector button widget
6683     * @param only @c EINA_TRUE to make @p obj widget's internal file
6684     * selector only display directories, @c EINA_FALSE to make files
6685     * to be displayed in it too
6686     *
6687     * This has the same effect as elm_fileselector_folder_only_set(),
6688     * but now applied to a file selector button's internal file
6689     * selector.
6690     *
6691     * @see elm_fileselector_folder_only_get()
6692     */
6693    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6694
6695    /**
6696     * Get whether a given file selector button widget's internal file
6697     * selector is displaying folders only or the directory contents,
6698     * as well.
6699     *
6700     * @param obj The file selector button widget
6701     * @return @c EINA_TRUE if @p obj widget's internal file
6702     * selector is only displaying directories, @c EINA_FALSE if files
6703     * are being displayed in it too (and on errors)
6704     *
6705     * @see elm_fileselector_button_folder_only_set() for more details
6706     */
6707    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6708
6709    /**
6710     * Enable/disable the file name entry box where the user can type
6711     * in a name for a file, in a given file selector button widget's
6712     * internal file selector.
6713     *
6714     * @param obj The file selector button widget
6715     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6716     * file selector a "saving dialog", @c EINA_FALSE otherwise
6717     *
6718     * This has the same effect as elm_fileselector_is_save_set(),
6719     * but now applied to a file selector button's internal file
6720     * selector.
6721     *
6722     * @see elm_fileselector_is_save_get()
6723     */
6724    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6725
6726    /**
6727     * Get whether the given file selector button widget's internal
6728     * file selector is in "saving dialog" mode
6729     *
6730     * @param obj The file selector button widget
6731     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6732     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6733     * errors)
6734     *
6735     * @see elm_fileselector_button_is_save_set() for more details
6736     */
6737    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6738
6739    /**
6740     * Set whether a given file selector button widget's internal file
6741     * selector will raise an Elementary "inner window", instead of a
6742     * dedicated Elementary window. By default, it won't.
6743     *
6744     * @param obj The file selector button widget
6745     * @param value @c EINA_TRUE to make it use an inner window, @c
6746     * EINA_TRUE to make it use a dedicated window
6747     *
6748     * @see elm_win_inwin_add() for more information on inner windows
6749     * @see elm_fileselector_button_inwin_mode_get()
6750     */
6751    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6752
6753    /**
6754     * Get whether a given file selector button widget's internal file
6755     * selector will raise an Elementary "inner window", instead of a
6756     * dedicated Elementary window.
6757     *
6758     * @param obj The file selector button widget
6759     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6760     * if it will use a dedicated window
6761     *
6762     * @see elm_fileselector_button_inwin_mode_set() for more details
6763     */
6764    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6765
6766    /**
6767     * @}
6768     */
6769
6770     /**
6771     * @defgroup File_Selector_Entry File Selector Entry
6772     *
6773     * @image html img/widget/fileselector_entry/preview-00.png
6774     * @image latex img/widget/fileselector_entry/preview-00.eps
6775     *
6776     * This is an entry made to be filled with or display a <b>file
6777     * system path string</b>. Besides the entry itself, the widget has
6778     * a @ref File_Selector_Button "file selector button" on its side,
6779     * which will raise an internal @ref Fileselector "file selector widget",
6780     * when clicked, for path selection aided by file system
6781     * navigation.
6782     *
6783     * This file selector may appear in an Elementary window or in an
6784     * inner window. When a file is chosen from it, the (inner) window
6785     * is closed and the selected file's path string is exposed both as
6786     * an smart event and as the new text on the entry.
6787     *
6788     * This widget encapsulates operations on its internal file
6789     * selector on its own API. There is less control over its file
6790     * selector than that one would have instatiating one directly.
6791     *
6792     * Smart callbacks one can register to:
6793     * - @c "changed" - The text within the entry was changed
6794     * - @c "activated" - The entry has had editing finished and
6795     *   changes are to be "committed"
6796     * - @c "press" - The entry has been clicked
6797     * - @c "longpressed" - The entry has been clicked (and held) for a
6798     *   couple seconds
6799     * - @c "clicked" - The entry has been clicked
6800     * - @c "clicked,double" - The entry has been double clicked
6801     * - @c "focused" - The entry has received focus
6802     * - @c "unfocused" - The entry has lost focus
6803     * - @c "selection,paste" - A paste action has occurred on the
6804     *   entry
6805     * - @c "selection,copy" - A copy action has occurred on the entry
6806     * - @c "selection,cut" - A cut action has occurred on the entry
6807     * - @c "unpressed" - The file selector entry's button was released
6808     *   after being pressed.
6809     * - @c "file,chosen" - The user has selected a path via the file
6810     *   selector entry's internal file selector, whose string pointer
6811     *   comes as the @c event_info data (a stringshared string)
6812     *
6813     * Here is an example on its usage:
6814     * @li @ref fileselector_entry_example
6815     *
6816     * @see @ref File_Selector_Button for a similar widget.
6817     * @{
6818     */
6819
6820    /**
6821     * Add a new file selector entry widget to the given parent
6822     * Elementary (container) object
6823     *
6824     * @param parent The parent object
6825     * @return a new file selector entry widget handle or @c NULL, on
6826     * errors
6827     */
6828    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6829
6830    /**
6831     * Set the label for a given file selector entry widget's button
6832     *
6833     * @param obj The file selector entry widget
6834     * @param label The text label to be displayed on @p obj widget's
6835     * button
6836     *
6837     * @deprecated use elm_object_text_set() instead.
6838     */
6839    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6840
6841    /**
6842     * Get the label set for a given file selector entry widget's button
6843     *
6844     * @param obj The file selector entry widget
6845     * @return The widget button's label
6846     *
6847     * @deprecated use elm_object_text_set() instead.
6848     */
6849    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6850
6851    /**
6852     * Set the icon on a given file selector entry widget's button
6853     *
6854     * @param obj The file selector entry widget
6855     * @param icon The icon object for the entry's button
6856     *
6857     * Once the icon object is set, a previously set one will be
6858     * deleted. If you want to keep the latter, use the
6859     * elm_fileselector_entry_button_icon_unset() function.
6860     *
6861     * @see elm_fileselector_entry_button_icon_get()
6862     */
6863    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6864
6865    /**
6866     * Get the icon set for a given file selector entry widget's button
6867     *
6868     * @param obj The file selector entry widget
6869     * @return The icon object currently set on @p obj widget's button
6870     * or @c NULL, if none is
6871     *
6872     * @see elm_fileselector_entry_button_icon_set()
6873     */
6874    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6875
6876    /**
6877     * Unset the icon used in a given file selector entry widget's
6878     * button
6879     *
6880     * @param obj The file selector entry widget
6881     * @return The icon object that was being used on @p obj widget's
6882     * button or @c NULL, on errors
6883     *
6884     * Unparent and return the icon object which was set for this
6885     * widget's button.
6886     *
6887     * @see elm_fileselector_entry_button_icon_set()
6888     */
6889    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6890
6891    /**
6892     * Set the title for a given file selector entry widget's window
6893     *
6894     * @param obj The file selector entry widget
6895     * @param title The title string
6896     *
6897     * This will change the window's title, when the file selector pops
6898     * out after a click on the entry's button. Those windows have the
6899     * default (unlocalized) value of @c "Select a file" as titles.
6900     *
6901     * @note It will only take any effect if the file selector
6902     * entry widget is @b not under "inwin mode".
6903     *
6904     * @see elm_fileselector_entry_window_title_get()
6905     */
6906    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6907
6908    /**
6909     * Get the title set for a given file selector entry widget's
6910     * window
6911     *
6912     * @param obj The file selector entry widget
6913     * @return Title of the file selector entry's window
6914     *
6915     * @see elm_fileselector_entry_window_title_get() for more details
6916     */
6917    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6918
6919    /**
6920     * Set the size of a given file selector entry widget's window,
6921     * holding the file selector itself.
6922     *
6923     * @param obj The file selector entry widget
6924     * @param width The window's width
6925     * @param height The window's height
6926     *
6927     * @note it will only take any effect if the file selector entry
6928     * widget is @b not under "inwin mode". The default size for the
6929     * window (when applicable) is 400x400 pixels.
6930     *
6931     * @see elm_fileselector_entry_window_size_get()
6932     */
6933    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6934
6935    /**
6936     * Get the size of a given file selector entry widget's window,
6937     * holding the file selector itself.
6938     *
6939     * @param obj The file selector entry widget
6940     * @param width Pointer into which to store the width value
6941     * @param height Pointer into which to store the height value
6942     *
6943     * @note Use @c NULL pointers on the size values you're not
6944     * interested in: they'll be ignored by the function.
6945     *
6946     * @see elm_fileselector_entry_window_size_set(), for more details
6947     */
6948    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6949
6950    /**
6951     * Set the initial file system path and the entry's path string for
6952     * a given file selector entry widget
6953     *
6954     * @param obj The file selector entry widget
6955     * @param path The path string
6956     *
6957     * It must be a <b>directory</b> path, which will have the contents
6958     * displayed initially in the file selector's view, when invoked
6959     * from @p obj. The default initial path is the @c "HOME"
6960     * environment variable's value.
6961     *
6962     * @see elm_fileselector_entry_path_get()
6963     */
6964    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6965
6966    /**
6967     * Get the entry's path string for a given file selector entry
6968     * widget
6969     *
6970     * @param obj The file selector entry widget
6971     * @return path The path string
6972     *
6973     * @see elm_fileselector_entry_path_set() for more details
6974     */
6975    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6976
6977    /**
6978     * Enable/disable a tree view in the given file selector entry
6979     * widget's internal file selector
6980     *
6981     * @param obj The file selector entry widget
6982     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6983     * disable
6984     *
6985     * This has the same effect as elm_fileselector_expandable_set(),
6986     * but now applied to a file selector entry's internal file
6987     * selector.
6988     *
6989     * @note There's no way to put a file selector entry's internal
6990     * file selector in "grid mode", as one may do with "pure" file
6991     * selectors.
6992     *
6993     * @see elm_fileselector_expandable_get()
6994     */
6995    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6996
6997    /**
6998     * Get whether tree view is enabled for the given file selector
6999     * entry widget's internal file selector
7000     *
7001     * @param obj The file selector entry widget
7002     * @return @c EINA_TRUE if @p obj widget's internal file selector
7003     * is in tree view, @c EINA_FALSE otherwise (and or errors)
7004     *
7005     * @see elm_fileselector_expandable_set() for more details
7006     */
7007    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7008
7009    /**
7010     * Set whether a given file selector entry widget's internal file
7011     * selector is to display folders only or the directory contents,
7012     * as well.
7013     *
7014     * @param obj The file selector entry widget
7015     * @param only @c EINA_TRUE to make @p obj widget's internal file
7016     * selector only display directories, @c EINA_FALSE to make files
7017     * to be displayed in it too
7018     *
7019     * This has the same effect as elm_fileselector_folder_only_set(),
7020     * but now applied to a file selector entry's internal file
7021     * selector.
7022     *
7023     * @see elm_fileselector_folder_only_get()
7024     */
7025    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7026
7027    /**
7028     * Get whether a given file selector entry widget's internal file
7029     * selector is displaying folders only or the directory contents,
7030     * as well.
7031     *
7032     * @param obj The file selector entry widget
7033     * @return @c EINA_TRUE if @p obj widget's internal file
7034     * selector is only displaying directories, @c EINA_FALSE if files
7035     * are being displayed in it too (and on errors)
7036     *
7037     * @see elm_fileselector_entry_folder_only_set() for more details
7038     */
7039    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7040
7041    /**
7042     * Enable/disable the file name entry box where the user can type
7043     * in a name for a file, in a given file selector entry widget's
7044     * internal file selector.
7045     *
7046     * @param obj The file selector entry widget
7047     * @param is_save @c EINA_TRUE to make @p obj widget's internal
7048     * file selector a "saving dialog", @c EINA_FALSE otherwise
7049     *
7050     * This has the same effect as elm_fileselector_is_save_set(),
7051     * but now applied to a file selector entry's internal file
7052     * selector.
7053     *
7054     * @see elm_fileselector_is_save_get()
7055     */
7056    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7057
7058    /**
7059     * Get whether the given file selector entry widget's internal
7060     * file selector is in "saving dialog" mode
7061     *
7062     * @param obj The file selector entry widget
7063     * @return @c EINA_TRUE, if @p obj widget's internal file selector
7064     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7065     * errors)
7066     *
7067     * @see elm_fileselector_entry_is_save_set() for more details
7068     */
7069    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7070
7071    /**
7072     * Set whether a given file selector entry widget's internal file
7073     * selector will raise an Elementary "inner window", instead of a
7074     * dedicated Elementary window. By default, it won't.
7075     *
7076     * @param obj The file selector entry widget
7077     * @param value @c EINA_TRUE to make it use an inner window, @c
7078     * EINA_TRUE to make it use a dedicated window
7079     *
7080     * @see elm_win_inwin_add() for more information on inner windows
7081     * @see elm_fileselector_entry_inwin_mode_get()
7082     */
7083    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7084
7085    /**
7086     * Get whether a given file selector entry widget's internal file
7087     * selector will raise an Elementary "inner window", instead of a
7088     * dedicated Elementary window.
7089     *
7090     * @param obj The file selector entry widget
7091     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7092     * if it will use a dedicated window
7093     *
7094     * @see elm_fileselector_entry_inwin_mode_set() for more details
7095     */
7096    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7097
7098    /**
7099     * Set the initial file system path for a given file selector entry
7100     * widget
7101     *
7102     * @param obj The file selector entry widget
7103     * @param path The path string
7104     *
7105     * It must be a <b>directory</b> path, which will have the contents
7106     * displayed initially in the file selector's view, when invoked
7107     * from @p obj. The default initial path is the @c "HOME"
7108     * environment variable's value.
7109     *
7110     * @see elm_fileselector_entry_path_get()
7111     */
7112    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7113
7114    /**
7115     * Get the parent directory's path to the latest file selection on
7116     * a given filer selector entry widget
7117     *
7118     * @param obj The file selector object
7119     * @return The (full) path of the directory of the last selection
7120     * on @p obj widget, a @b stringshared string
7121     *
7122     * @see elm_fileselector_entry_path_set()
7123     */
7124    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7125
7126    /**
7127     * @}
7128     */
7129
7130    /**
7131     * @defgroup Scroller Scroller
7132     *
7133     * A scroller holds a single object and "scrolls it around". This means that
7134     * it allows the user to use a scrollbar (or a finger) to drag the viewable
7135     * region around, allowing to move through a much larger object that is
7136     * contained in the scroller. The scroller will always have a small minimum
7137     * size by default as it won't be limited by the contents of the scroller.
7138     *
7139     * Signals that you can add callbacks for are:
7140     * @li "edge,left" - the left edge of the content has been reached
7141     * @li "edge,right" - the right edge of the content has been reached
7142     * @li "edge,top" - the top edge of the content has been reached
7143     * @li "edge,bottom" - the bottom edge of the content has been reached
7144     * @li "scroll" - the content has been scrolled (moved)
7145     * @li "scroll,anim,start" - scrolling animation has started
7146     * @li "scroll,anim,stop" - scrolling animation has stopped
7147     * @li "scroll,drag,start" - dragging the contents around has started
7148     * @li "scroll,drag,stop" - dragging the contents around has stopped
7149     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7150     * user intervetion.
7151     *
7152     * @note When Elemementary is in embedded mode the scrollbars will not be
7153     * dragable, they appear merely as indicators of how much has been scrolled.
7154     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7155     * fingerscroll) won't work.
7156     *
7157     * Default contents parts of the scroller widget that you can use for are:
7158     * @li "default" - A content of the scroller
7159     *
7160     * In @ref tutorial_scroller you'll find an example of how to use most of
7161     * this API.
7162     * @{
7163     */
7164    /**
7165     * @brief Type that controls when scrollbars should appear.
7166     *
7167     * @see elm_scroller_policy_set()
7168     */
7169    typedef enum _Elm_Scroller_Policy
7170      {
7171         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7172         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7173         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7174         ELM_SCROLLER_POLICY_LAST
7175      } Elm_Scroller_Policy;
7176    /**
7177     * @brief Add a new scroller to the parent
7178     *
7179     * @param parent The parent object
7180     * @return The new object or NULL if it cannot be created
7181     */
7182    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7183    /**
7184     * @brief Set the content of the scroller widget (the object to be scrolled around).
7185     *
7186     * @param obj The scroller object
7187     * @param content The new content object
7188     *
7189     * Once the content object is set, a previously set one will be deleted.
7190     * If you want to keep that old content object, use the
7191     * elm_scroller_content_unset() function.
7192     * @deprecated use elm_object_content_set() instead
7193     */
7194    EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7195    /**
7196     * @brief Get the content of the scroller widget
7197     *
7198     * @param obj The slider object
7199     * @return The content that is being used
7200     *
7201     * Return the content object which is set for this widget
7202     *
7203     * @see elm_scroller_content_set()
7204     * @deprecated use elm_object_content_get() instead.
7205     */
7206    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7207    /**
7208     * @brief Unset the content of the scroller widget
7209     *
7210     * @param obj The slider object
7211     * @return The content that was being used
7212     *
7213     * Unparent and return the content object which was set for this widget
7214     *
7215     * @see elm_scroller_content_set()
7216     * @deprecated use elm_object_content_unset() instead.
7217     */
7218    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7219    /**
7220     * @brief Set custom theme elements for the scroller
7221     *
7222     * @param obj The scroller object
7223     * @param widget The widget name to use (default is "scroller")
7224     * @param base The base name to use (default is "base")
7225     */
7226    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7227    /**
7228     * @brief Make the scroller minimum size limited to the minimum size of the content
7229     *
7230     * @param obj The scroller object
7231     * @param w Enable limiting minimum size horizontally
7232     * @param h Enable limiting minimum size vertically
7233     *
7234     * By default the scroller will be as small as its design allows,
7235     * irrespective of its content. This will make the scroller minimum size the
7236     * right size horizontally and/or vertically to perfectly fit its content in
7237     * that direction.
7238     */
7239    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7240    /**
7241     * @brief Show a specific virtual region within the scroller content object
7242     *
7243     * @param obj The scroller object
7244     * @param x X coordinate of the region
7245     * @param y Y coordinate of the region
7246     * @param w Width of the region
7247     * @param h Height of the region
7248     *
7249     * This will ensure all (or part if it does not fit) of the designated
7250     * region in the virtual content object (0, 0 starting at the top-left of the
7251     * virtual content object) is shown within the scroller.
7252     */
7253    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);
7254    /**
7255     * @brief Set the scrollbar visibility policy
7256     *
7257     * @param obj The scroller object
7258     * @param policy_h Horizontal scrollbar policy
7259     * @param policy_v Vertical scrollbar policy
7260     *
7261     * This sets the scrollbar visibility policy for the given scroller.
7262     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7263     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7264     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7265     * respectively for the horizontal and vertical scrollbars.
7266     */
7267    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7268    /**
7269     * @brief Gets scrollbar visibility policy
7270     *
7271     * @param obj The scroller object
7272     * @param policy_h Horizontal scrollbar policy
7273     * @param policy_v Vertical scrollbar policy
7274     *
7275     * @see elm_scroller_policy_set()
7276     */
7277    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7278    /**
7279     * @brief Get the currently visible content region
7280     *
7281     * @param obj The scroller object
7282     * @param x X coordinate of the region
7283     * @param y Y coordinate of the region
7284     * @param w Width of the region
7285     * @param h Height of the region
7286     *
7287     * This gets the current region in the content object that is visible through
7288     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7289     * w, @p h values pointed to.
7290     *
7291     * @note All coordinates are relative to the content.
7292     *
7293     * @see elm_scroller_region_show()
7294     */
7295    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);
7296    /**
7297     * @brief Get the size of the content object
7298     *
7299     * @param obj The scroller object
7300     * @param w Width of the content object.
7301     * @param h Height of the content object.
7302     *
7303     * This gets the size of the content object of the scroller.
7304     */
7305    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7306    /**
7307     * @brief Set bouncing behavior
7308     *
7309     * @param obj The scroller object
7310     * @param h_bounce Allow bounce horizontally
7311     * @param v_bounce Allow bounce vertically
7312     *
7313     * When scrolling, the scroller may "bounce" when reaching an edge of the
7314     * content object. This is a visual way to indicate the end has been reached.
7315     * This is enabled by default for both axis. This API will set if it is enabled
7316     * for the given axis with the boolean parameters for each axis.
7317     */
7318    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7319    /**
7320     * @brief Get the bounce behaviour
7321     *
7322     * @param obj The Scroller object
7323     * @param h_bounce Will the scroller bounce horizontally or not
7324     * @param v_bounce Will the scroller bounce vertically or not
7325     *
7326     * @see elm_scroller_bounce_set()
7327     */
7328    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7329    /**
7330     * @brief Set scroll page size relative to viewport size.
7331     *
7332     * @param obj The scroller object
7333     * @param h_pagerel The horizontal page relative size
7334     * @param v_pagerel The vertical page relative size
7335     *
7336     * The scroller is capable of limiting scrolling by the user to "pages". That
7337     * is to jump by and only show a "whole page" at a time as if the continuous
7338     * area of the scroller content is split into page sized pieces. This sets
7339     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7340     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7341     * axis. This is mutually exclusive with page size
7342     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7343     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7344     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7345     * the other axis.
7346     */
7347    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7348    /**
7349     * @brief Set scroll page size.
7350     *
7351     * @param obj The scroller object
7352     * @param h_pagesize The horizontal page size
7353     * @param v_pagesize The vertical page size
7354     *
7355     * This sets the page size to an absolute fixed value, with 0 turning it off
7356     * for that axis.
7357     *
7358     * @see elm_scroller_page_relative_set()
7359     */
7360    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7361    /**
7362     * @brief Get scroll current page number.
7363     *
7364     * @param obj The scroller object
7365     * @param h_pagenumber The horizontal page number
7366     * @param v_pagenumber The vertical page number
7367     *
7368     * The page number starts from 0. 0 is the first page.
7369     * Current page means the page which meets the top-left of the viewport.
7370     * If there are two or more pages in the viewport, it returns the number of the page
7371     * which meets the top-left of the viewport.
7372     *
7373     * @see elm_scroller_last_page_get()
7374     * @see elm_scroller_page_show()
7375     * @see elm_scroller_page_brint_in()
7376     */
7377    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7378    /**
7379     * @brief Get scroll last page number.
7380     *
7381     * @param obj The scroller object
7382     * @param h_pagenumber The horizontal page number
7383     * @param v_pagenumber The vertical page number
7384     *
7385     * The page number starts from 0. 0 is the first page.
7386     * This returns the last page number among the pages.
7387     *
7388     * @see elm_scroller_current_page_get()
7389     * @see elm_scroller_page_show()
7390     * @see elm_scroller_page_brint_in()
7391     */
7392    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7393    /**
7394     * Show a specific virtual region within the scroller content object by page number.
7395     *
7396     * @param obj The scroller object
7397     * @param h_pagenumber The horizontal page number
7398     * @param v_pagenumber The vertical page number
7399     *
7400     * 0, 0 of the indicated page is located at the top-left of the viewport.
7401     * This will jump to the page directly without animation.
7402     *
7403     * Example of usage:
7404     *
7405     * @code
7406     * sc = elm_scroller_add(win);
7407     * elm_scroller_content_set(sc, content);
7408     * elm_scroller_page_relative_set(sc, 1, 0);
7409     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7410     * elm_scroller_page_show(sc, h_page + 1, v_page);
7411     * @endcode
7412     *
7413     * @see elm_scroller_page_bring_in()
7414     */
7415    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7416    /**
7417     * Show a specific virtual region within the scroller content object by page number.
7418     *
7419     * @param obj The scroller object
7420     * @param h_pagenumber The horizontal page number
7421     * @param v_pagenumber The vertical page number
7422     *
7423     * 0, 0 of the indicated page is located at the top-left of the viewport.
7424     * This will slide to the page with animation.
7425     *
7426     * Example of usage:
7427     *
7428     * @code
7429     * sc = elm_scroller_add(win);
7430     * elm_scroller_content_set(sc, content);
7431     * elm_scroller_page_relative_set(sc, 1, 0);
7432     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7433     * elm_scroller_page_bring_in(sc, h_page, v_page);
7434     * @endcode
7435     *
7436     * @see elm_scroller_page_show()
7437     */
7438    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7439    /**
7440     * @brief Show a specific virtual region within the scroller content object.
7441     *
7442     * @param obj The scroller object
7443     * @param x X coordinate of the region
7444     * @param y Y coordinate of the region
7445     * @param w Width of the region
7446     * @param h Height of the region
7447     *
7448     * This will ensure all (or part if it does not fit) of the designated
7449     * region in the virtual content object (0, 0 starting at the top-left of the
7450     * virtual content object) is shown within the scroller. Unlike
7451     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7452     * to this location (if configuration in general calls for transitions). It
7453     * may not jump immediately to the new location and make take a while and
7454     * show other content along the way.
7455     *
7456     * @see elm_scroller_region_show()
7457     */
7458    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);
7459    /**
7460     * @brief Set event propagation on a scroller
7461     *
7462     * @param obj The scroller object
7463     * @param propagation If propagation is enabled or not
7464     *
7465     * This enables or disabled event propagation from the scroller content to
7466     * the scroller and its parent. By default event propagation is disabled.
7467     */
7468    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7469    /**
7470     * @brief Get event propagation for a scroller
7471     *
7472     * @param obj The scroller object
7473     * @return The propagation state
7474     *
7475     * This gets the event propagation for a scroller.
7476     *
7477     * @see elm_scroller_propagate_events_set()
7478     */
7479    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7480    /**
7481     * @brief Set scrolling gravity on a scroller
7482     *
7483     * @param obj The scroller object
7484     * @param x The scrolling horizontal gravity
7485     * @param y The scrolling vertical gravity
7486     *
7487     * The gravity, defines how the scroller will adjust its view
7488     * when the size of the scroller contents increase.
7489     *
7490     * The scroller will adjust the view to glue itself as follows.
7491     *
7492     *  x=0.0, for showing the left most region of the content.
7493     *  x=1.0, for showing the right most region of the content.
7494     *  y=0.0, for showing the bottom most region of the content.
7495     *  y=1.0, for showing the top most region of the content.
7496     *
7497     * Default values for x and y are 0.0
7498     */
7499    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7500    /**
7501     * @brief Get scrolling gravity values for a scroller
7502     *
7503     * @param obj The scroller object
7504     * @param x The scrolling horizontal gravity
7505     * @param y The scrolling vertical gravity
7506     *
7507     * This gets gravity values for a scroller.
7508     *
7509     * @see elm_scroller_gravity_set()
7510     *
7511     */
7512    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7513    /**
7514     * @}
7515     */
7516
7517    /**
7518     * @defgroup Label Label
7519     *
7520     * @image html img/widget/label/preview-00.png
7521     * @image latex img/widget/label/preview-00.eps
7522     *
7523     * @brief Widget to display text, with simple html-like markup.
7524     *
7525     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7526     * text doesn't fit the geometry of the label it will be ellipsized or be
7527     * cut. Elementary provides several styles for this widget:
7528     * @li default - No animation
7529     * @li marker - Centers the text in the label and make it bold by default
7530     * @li slide_long - The entire text appears from the right of the screen and
7531     * slides until it disappears in the left of the screen(reappering on the
7532     * right again).
7533     * @li slide_short - The text appears in the left of the label and slides to
7534     * the right to show the overflow. When all of the text has been shown the
7535     * position is reset.
7536     * @li slide_bounce - The text appears in the left of the label and slides to
7537     * the right to show the overflow. When all of the text has been shown the
7538     * animation reverses, moving the text to the left.
7539     *
7540     * Custom themes can of course invent new markup tags and style them any way
7541     * they like.
7542     *
7543     * The following signals may be emitted by the label widget:
7544     * @li "language,changed": The program's language changed.
7545     *
7546     * See @ref tutorial_label for a demonstration of how to use a label widget.
7547     * @{
7548     */
7549    /**
7550     * @brief Add a new label to the parent
7551     *
7552     * @param parent The parent object
7553     * @return The new object or NULL if it cannot be created
7554     */
7555    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7556    /**
7557     * @brief Set the label on the label object
7558     *
7559     * @param obj The label object
7560     * @param label The label will be used on the label object
7561     * @deprecated See elm_object_text_set()
7562     */
7563    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 */
7564    /**
7565     * @brief Get the label used on the label object
7566     *
7567     * @param obj The label object
7568     * @return The string inside the label
7569     * @deprecated See elm_object_text_get()
7570     */
7571    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7572    /**
7573     * @brief Set the wrapping behavior of the label
7574     *
7575     * @param obj The label object
7576     * @param wrap To wrap text or not
7577     *
7578     * By default no wrapping is done. Possible values for @p wrap are:
7579     * @li ELM_WRAP_NONE - No wrapping
7580     * @li ELM_WRAP_CHAR - wrap between characters
7581     * @li ELM_WRAP_WORD - wrap between words
7582     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7583     */
7584    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7585    /**
7586     * @brief Get the wrapping behavior of the label
7587     *
7588     * @param obj The label object
7589     * @return Wrap type
7590     *
7591     * @see elm_label_line_wrap_set()
7592     */
7593    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7594    /**
7595     * @brief Set wrap width of the label
7596     *
7597     * @param obj The label object
7598     * @param w The wrap width in pixels at a minimum where words need to wrap
7599     *
7600     * This function sets the maximum width size hint of the label.
7601     *
7602     * @warning This is only relevant if the label is inside a container.
7603     */
7604    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7605    /**
7606     * @brief Get wrap width of the label
7607     *
7608     * @param obj The label object
7609     * @return The wrap width in pixels at a minimum where words need to wrap
7610     *
7611     * @see elm_label_wrap_width_set()
7612     */
7613    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7614    /**
7615     * @brief Set wrap height of the label
7616     *
7617     * @param obj The label object
7618     * @param h The wrap height in pixels at a minimum where words need to wrap
7619     *
7620     * This function sets the maximum height size hint of the label.
7621     *
7622     * @warning This is only relevant if the label is inside a container.
7623     */
7624    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7625    /**
7626     * @brief get wrap width of the label
7627     *
7628     * @param obj The label object
7629     * @return The wrap height in pixels at a minimum where words need to wrap
7630     */
7631    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7632    /**
7633     * @brief Set the font size on the label object.
7634     *
7635     * @param obj The label object
7636     * @param size font size
7637     *
7638     * @warning NEVER use this. It is for hyper-special cases only. use styles
7639     * instead. e.g. "default", "marker", "slide_long" etc.
7640     */
7641    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7642    /**
7643     * @brief Set the text color on the label object
7644     *
7645     * @param obj The label object
7646     * @param r Red property background color of The label object
7647     * @param g Green property background color of The label object
7648     * @param b Blue property background color of The label object
7649     * @param a Alpha property background color of The label object
7650     *
7651     * @warning NEVER use this. It is for hyper-special cases only. use styles
7652     * instead. e.g. "default", "marker", "slide_long" etc.
7653     */
7654    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);
7655    /**
7656     * @brief Set the text align on the label object
7657     *
7658     * @param obj The label object
7659     * @param align align mode ("left", "center", "right")
7660     *
7661     * @warning NEVER use this. It is for hyper-special cases only. use styles
7662     * instead. e.g. "default", "marker", "slide_long" etc.
7663     */
7664    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7665    /**
7666     * @brief Set background color of the label
7667     *
7668     * @param obj The label object
7669     * @param r Red property background color of The label object
7670     * @param g Green property background color of The label object
7671     * @param b Blue property background color of The label object
7672     * @param a Alpha property background alpha of The label object
7673     *
7674     * @warning NEVER use this. It is for hyper-special cases only. use styles
7675     * instead. e.g. "default", "marker", "slide_long" etc.
7676     */
7677    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);
7678    /**
7679     * @brief Set the ellipsis behavior of the label
7680     *
7681     * @param obj The label object
7682     * @param ellipsis To ellipsis text or not
7683     *
7684     * If set to true and the text doesn't fit in the label an ellipsis("...")
7685     * will be shown at the end of the widget.
7686     *
7687     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7688     * choosen wrap method was ELM_WRAP_WORD.
7689     */
7690    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7691    /**
7692     * @brief Set the text slide of the label
7693     *
7694     * @param obj The label object
7695     * @param slide To start slide or stop
7696     *
7697     * If set to true, the text of the label will slide/scroll through the length of
7698     * label.
7699     *
7700     * @warning This only works with the themes "slide_short", "slide_long" and
7701     * "slide_bounce".
7702     */
7703    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7704    /**
7705     * @brief Get the text slide mode of the label
7706     *
7707     * @param obj The label object
7708     * @return slide slide mode value
7709     *
7710     * @see elm_label_slide_set()
7711     */
7712    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7713    /**
7714     * @brief Set the slide duration(speed) of the label
7715     *
7716     * @param obj The label object
7717     * @return The duration in seconds in moving text from slide begin position
7718     * to slide end position
7719     */
7720    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7721    /**
7722     * @brief Get the slide duration(speed) of the label
7723     *
7724     * @param obj The label object
7725     * @return The duration time in moving text from slide begin position to slide end position
7726     *
7727     * @see elm_label_slide_duration_set()
7728     */
7729    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7730    /**
7731     * @}
7732     */
7733
7734    /**
7735     * @defgroup Toggle Toggle
7736     *
7737     * @image html img/widget/toggle/preview-00.png
7738     * @image latex img/widget/toggle/preview-00.eps
7739     *
7740     * @brief A toggle is a slider which can be used to toggle between
7741     * two values.  It has two states: on and off.
7742     *
7743     * This widget is deprecated. Please use elm_check_add() instead using the
7744     * toggle style like:
7745     *
7746     * @code
7747     * obj = elm_check_add(parent);
7748     * elm_object_style_set(obj, "toggle");
7749     * elm_object_part_text_set(obj, "on", "ON");
7750     * elm_object_part_text_set(obj, "off", "OFF");
7751     * @endcode
7752     *
7753     * Signals that you can add callbacks for are:
7754     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7755     *                 until the toggle is released by the cursor (assuming it
7756     *                 has been triggered by the cursor in the first place).
7757     *
7758     * Default contents parts of the toggle widget that you can use for are:
7759     * @li "icon" - An icon of the toggle
7760     *
7761     * Default text parts of the toggle widget that you can use for are:
7762     * @li "elm.text" - Label of the toggle
7763     *
7764     * @ref tutorial_toggle show how to use a toggle.
7765     * @{
7766     */
7767    /**
7768     * @brief Add a toggle to @p parent.
7769     *
7770     * @param parent The parent object
7771     *
7772     * @return The toggle object
7773     */
7774    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7775    /**
7776     * @brief Sets the label to be displayed with the toggle.
7777     *
7778     * @param obj The toggle object
7779     * @param label The label to be displayed
7780     *
7781     * @deprecated use elm_object_text_set() instead.
7782     */
7783    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7784    /**
7785     * @brief Gets the label of the toggle
7786     *
7787     * @param obj  toggle object
7788     * @return The label of the toggle
7789     *
7790     * @deprecated use elm_object_text_get() instead.
7791     */
7792    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7793    /**
7794     * @brief Set the icon used for the toggle
7795     *
7796     * @param obj The toggle object
7797     * @param icon The icon object for the button
7798     *
7799     * Once the icon object is set, a previously set one will be deleted
7800     * If you want to keep that old content object, use the
7801     * elm_toggle_icon_unset() function.
7802     *
7803     * @deprecated use elm_object_part_content_set() instead.
7804     */
7805    EINA_DEPRECATED EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7806    /**
7807     * @brief Get the icon used for the toggle
7808     *
7809     * @param obj The toggle object
7810     * @return The icon object that is being used
7811     *
7812     * Return the icon object which is set for this widget.
7813     *
7814     * @see elm_toggle_icon_set()
7815     *
7816     * @deprecated use elm_object_part_content_get() instead.
7817     */
7818    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7819    /**
7820     * @brief Unset the icon used for the toggle
7821     *
7822     * @param obj The toggle object
7823     * @return The icon object that was being used
7824     *
7825     * Unparent and return the icon object which was set for this widget.
7826     *
7827     * @see elm_toggle_icon_set()
7828     *
7829     * @deprecated use elm_object_part_content_unset() instead.
7830     */
7831    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7832    /**
7833     * @brief Sets the labels to be associated with the on and off states of the toggle.
7834     *
7835     * @param obj The toggle object
7836     * @param onlabel The label displayed when the toggle is in the "on" state
7837     * @param offlabel The label displayed when the toggle is in the "off" state
7838     *
7839     * @deprecated use elm_object_part_text_set() for "on" and "off" parts
7840     * instead.
7841     */
7842    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7843    /**
7844     * @brief Gets the labels associated with the on and off states of the
7845     * toggle.
7846     *
7847     * @param obj The toggle object
7848     * @param onlabel A char** to place the onlabel of @p obj into
7849     * @param offlabel A char** to place the offlabel of @p obj into
7850     *
7851     * @deprecated use elm_object_part_text_get() for "on" and "off" parts
7852     * instead.
7853     */
7854    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7855    /**
7856     * @brief Sets the state of the toggle to @p state.
7857     *
7858     * @param obj The toggle object
7859     * @param state The state of @p obj
7860     *
7861     * @deprecated use elm_check_state_set() instead.
7862     */
7863    EINA_DEPRECATED EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7864    /**
7865     * @brief Gets the state of the toggle to @p state.
7866     *
7867     * @param obj The toggle object
7868     * @return The state of @p obj
7869     *
7870     * @deprecated use elm_check_state_get() instead.
7871     */
7872    EINA_DEPRECATED EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7873    /**
7874     * @brief Sets the state pointer of the toggle to @p statep.
7875     *
7876     * @param obj The toggle object
7877     * @param statep The state pointer of @p obj
7878     *
7879     * @deprecated use elm_check_state_pointer_set() instead.
7880     */
7881    EINA_DEPRECATED EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7882    /**
7883     * @}
7884     */
7885
7886    /**
7887     * @defgroup Frame Frame
7888     *
7889     * @image html img/widget/frame/preview-00.png
7890     * @image latex img/widget/frame/preview-00.eps
7891     *
7892     * @brief Frame is a widget that holds some content and has a title.
7893     *
7894     * The default look is a frame with a title, but Frame supports multple
7895     * styles:
7896     * @li default
7897     * @li pad_small
7898     * @li pad_medium
7899     * @li pad_large
7900     * @li pad_huge
7901     * @li outdent_top
7902     * @li outdent_bottom
7903     *
7904     * Of all this styles only default shows the title. Frame emits no signals.
7905     *
7906     * Default contents parts of the frame widget that you can use for are:
7907     * @li "default" - A content of the frame
7908     *
7909     * Default text parts of the frame widget that you can use for are:
7910     * @li "elm.text" - Label of the frame
7911     *
7912     * For a detailed example see the @ref tutorial_frame.
7913     *
7914     * @{
7915     */
7916    /**
7917     * @brief Add a new frame to the parent
7918     *
7919     * @param parent The parent object
7920     * @return The new object or NULL if it cannot be created
7921     */
7922    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7923    /**
7924     * @brief Set the frame label
7925     *
7926     * @param obj The frame object
7927     * @param label The label of this frame object
7928     *
7929     * @deprecated use elm_object_text_set() instead.
7930     */
7931    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7932    /**
7933     * @brief Get the frame label
7934     *
7935     * @param obj The frame object
7936     *
7937     * @return The label of this frame objet or NULL if unable to get frame
7938     *
7939     * @deprecated use elm_object_text_get() instead.
7940     */
7941    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7942    /**
7943     * @brief Set the content of the frame widget
7944     *
7945     * Once the content object is set, a previously set one will be deleted.
7946     * If you want to keep that old content object, use the
7947     * elm_frame_content_unset() function.
7948     *
7949     * @param obj The frame object
7950     * @param content The content will be filled in this frame object
7951     *
7952     * @deprecated use elm_object_content_set() instead.
7953     */
7954    EINA_DEPRECATED EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7955    /**
7956     * @brief Get the content of the frame widget
7957     *
7958     * Return the content object which is set for this widget
7959     *
7960     * @param obj The frame object
7961     * @return The content that is being used
7962     *
7963     * @deprecated use elm_object_content_get() instead.
7964     */
7965    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7966    /**
7967     * @brief Unset the content of the frame widget
7968     *
7969     * Unparent and return the content object which was set for this widget
7970     *
7971     * @param obj The frame object
7972     * @return The content that was being used
7973     *
7974     * @deprecated use elm_object_content_unset() instead.
7975     */
7976    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7977    /**
7978     * @}
7979     */
7980
7981    /**
7982     * @defgroup Table Table
7983     *
7984     * A container widget to arrange other widgets in a table where items can
7985     * also span multiple columns or rows - even overlap (and then be raised or
7986     * lowered accordingly to adjust stacking if they do overlap).
7987     *
7988     * For a Table widget the row/column count is not fixed.
7989     * The table widget adjusts itself when subobjects are added to it dynamically.
7990     *
7991     * The followin are examples of how to use a table:
7992     * @li @ref tutorial_table_01
7993     * @li @ref tutorial_table_02
7994     *
7995     * @{
7996     */
7997    /**
7998     * @brief Add a new table to the parent
7999     *
8000     * @param parent The parent object
8001     * @return The new object or NULL if it cannot be created
8002     */
8003    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8004    /**
8005     * @brief Set the homogeneous layout in the table
8006     *
8007     * @param obj The layout object
8008     * @param homogeneous A boolean to set if the layout is homogeneous in the
8009     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
8010     */
8011    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
8012    /**
8013     * @brief Get the current table homogeneous mode.
8014     *
8015     * @param obj The table object
8016     * @return A boolean to indicating if the layout is homogeneous in the table
8017     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
8018     */
8019    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8020    /**
8021     * @brief Set padding between cells.
8022     *
8023     * @param obj The layout object.
8024     * @param horizontal set the horizontal padding.
8025     * @param vertical set the vertical padding.
8026     *
8027     * Default value is 0.
8028     */
8029    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
8030    /**
8031     * @brief Get padding between cells.
8032     *
8033     * @param obj The layout object.
8034     * @param horizontal set the horizontal padding.
8035     * @param vertical set the vertical padding.
8036     */
8037    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
8038    /**
8039     * @brief Add a subobject on the table with the coordinates passed
8040     *
8041     * @param obj The table object
8042     * @param subobj The subobject to be added to the table
8043     * @param x Row number
8044     * @param y Column number
8045     * @param w rowspan
8046     * @param h colspan
8047     *
8048     * @note All positioning inside the table is relative to rows and columns, so
8049     * a value of 0 for x and y, means the top left cell of the table, and a
8050     * value of 1 for w and h means @p subobj only takes that 1 cell.
8051     */
8052    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8053    /**
8054     * @brief Remove child from table.
8055     *
8056     * @param obj The table object
8057     * @param subobj The subobject
8058     */
8059    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8060    /**
8061     * @brief Faster way to remove all child objects from a table object.
8062     *
8063     * @param obj The table object
8064     * @param clear If true, will delete children, else just remove from table.
8065     */
8066    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8067    /**
8068     * @brief Set the packing location of an existing child of the table
8069     *
8070     * @param subobj The subobject to be modified in the table
8071     * @param x Row number
8072     * @param y Column number
8073     * @param w rowspan
8074     * @param h colspan
8075     *
8076     * Modifies the position of an object already in the table.
8077     *
8078     * @note All positioning inside the table is relative to rows and columns, so
8079     * a value of 0 for x and y, means the top left cell of the table, and a
8080     * value of 1 for w and h means @p subobj only takes that 1 cell.
8081     */
8082    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8083    /**
8084     * @brief Get the packing location of an existing child of the table
8085     *
8086     * @param subobj The subobject to be modified in the table
8087     * @param x Row number
8088     * @param y Column number
8089     * @param w rowspan
8090     * @param h colspan
8091     *
8092     * @see elm_table_pack_set()
8093     */
8094    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8095    /**
8096     * @}
8097     */
8098
8099    /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
8100    typedef struct Elm_Gen_Item Elm_Gen_Item;
8101    typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
8102    typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
8103    typedef char        *(*Elm_Gen_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
8104    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. */
8105    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. */
8106    typedef void         (*Elm_Gen_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
8107    struct _Elm_Gen_Item_Class
8108      {
8109         const char             *item_style;
8110         struct _Elm_Gen_Item_Class_Func
8111           {
8112              union /* temporary compatibility code */
8113                {
8114                   Elm_Gen_Item_Text_Get_Cb  label_get EINA_DEPRECATED;
8115                   Elm_Gen_Item_Text_Get_Cb  text_get;
8116                };
8117              Elm_Gen_Item_Content_Get_Cb  content_get;
8118              Elm_Gen_Item_State_Get_Cb state_get;
8119              Elm_Gen_Item_Del_Cb       del;
8120           } func;
8121      };
8122    EINA_DEPRECATED EAPI void elm_gen_clear(Evas_Object *obj);
8123    EINA_DEPRECATED EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8124    EINA_DEPRECATED EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8125    EINA_DEPRECATED EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8126    EINA_DEPRECATED EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8127    EINA_DEPRECATED EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8128    EINA_DEPRECATED EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8129    EINA_DEPRECATED EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8130    EINA_DEPRECATED EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8131    EINA_DEPRECATED EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8132    EINA_DEPRECATED EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8133
8134    EINA_DEPRECATED EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8135    EINA_DEPRECATED EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8136    EINA_DEPRECATED EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8137    EINA_DEPRECATED EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8138    EINA_DEPRECATED EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8139    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8140    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8141    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8142    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8143    EINA_DEPRECATED EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8144
8145    /**
8146     * @defgroup Gengrid Gengrid (Generic grid)
8147     *
8148     * This widget aims to position objects in a grid layout while
8149     * actually creating and rendering only the visible ones, using the
8150     * same idea as the @ref Genlist "genlist": the user defines a @b
8151     * class for each item, specifying functions that will be called at
8152     * object creation, deletion, etc. When those items are selected by
8153     * the user, a callback function is issued. Users may interact with
8154     * a gengrid via the mouse (by clicking on items to select them and
8155     * clicking on the grid's viewport and swiping to pan the whole
8156     * view) or via the keyboard, navigating through item with the
8157     * arrow keys.
8158     *
8159     * @section Gengrid_Layouts Gengrid layouts
8160     *
8161     * Gengrid may layout its items in one of two possible layouts:
8162     * - horizontal or
8163     * - vertical.
8164     *
8165     * When in "horizontal mode", items will be placed in @b columns,
8166     * from top to bottom and, when the space for a column is filled,
8167     * another one is started on the right, thus expanding the grid
8168     * horizontally, making for horizontal scrolling. When in "vertical
8169     * mode" , though, items will be placed in @b rows, from left to
8170     * right and, when the space for a row is filled, another one is
8171     * started below, thus expanding the grid vertically (and making
8172     * for vertical scrolling).
8173     *
8174     * @section Gengrid_Items Gengrid items
8175     *
8176     * An item in a gengrid can have 0 or more texts (they can be
8177     * regular text or textblock Evas objects - that's up to the style
8178     * to determine), 0 or more contents (which are simply objects
8179     * swallowed into the gengrid item's theming Edje object) and 0 or
8180     * more <b>boolean states</b>, which have the behavior left to the
8181     * user to define. The Edje part names for each of these properties
8182     * will be looked up, in the theme file for the gengrid, under the
8183     * Edje (string) data items named @c "texts", @c "contents" and @c
8184     * "states", respectively. For each of those properties, if more
8185     * than one part is provided, they must have names listed separated
8186     * by spaces in the data fields. For the default gengrid item
8187     * theme, we have @b one text part (@c "elm.text"), @b two content 
8188     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8189     * no state parts.
8190     *
8191     * A gengrid item may be at one of several styles. Elementary
8192     * provides one by default - "default", but this can be extended by
8193     * system or application custom themes/overlays/extensions (see
8194     * @ref Theme "themes" for more details).
8195     *
8196     * @section Gengrid_Item_Class Gengrid item classes
8197     *
8198     * In order to have the ability to add and delete items on the fly,
8199     * gengrid implements a class (callback) system where the
8200     * application provides a structure with information about that
8201     * type of item (gengrid may contain multiple different items with
8202     * different classes, states and styles). Gengrid will call the
8203     * functions in this struct (methods) when an item is "realized"
8204     * (i.e., created dynamically, while the user is scrolling the
8205     * grid). All objects will simply be deleted when no longer needed
8206     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8207     * contains the following members:
8208     * - @c item_style - This is a constant string and simply defines
8209     * the name of the item style. It @b must be specified and the
8210     * default should be @c "default".
8211     * - @c func.text_get - This function is called when an item
8212     * object is actually created. The @c data parameter will point to
8213     * the same data passed to elm_gengrid_item_append() and related
8214     * item creation functions. The @c obj parameter is the gengrid
8215     * object itself, while the @c part one is the name string of one
8216     * of the existing text parts in the Edje group implementing the
8217     * item's theme. This function @b must return a strdup'()ed string,
8218     * as the caller will free() it when done. See
8219     * #Elm_Gengrid_Item_Text_Get_Cb.
8220     * - @c func.content_get - This function is called when an item object
8221     * is actually created. The @c data parameter will point to the
8222     * same data passed to elm_gengrid_item_append() and related item
8223     * creation functions. The @c obj parameter is the gengrid object
8224     * itself, while the @c part one is the name string of one of the
8225     * existing (content) swallow parts in the Edje group implementing the
8226     * item's theme. It must return @c NULL, when no content is desired,
8227     * or a valid object handle, otherwise. The object will be deleted
8228     * by the gengrid on its deletion or when the item is "unrealized".
8229     * See #Elm_Gengrid_Item_Content_Get_Cb.
8230     * - @c func.state_get - This function is called when an item
8231     * object is actually created. The @c data parameter will point to
8232     * the same data passed to elm_gengrid_item_append() and related
8233     * item creation functions. The @c obj parameter is the gengrid
8234     * object itself, while the @c part one is the name string of one
8235     * of the state parts in the Edje group implementing the item's
8236     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8237     * true/on. Gengrids will emit a signal to its theming Edje object
8238     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8239     * "source" arguments, respectively, when the state is true (the
8240     * default is false), where @c XXX is the name of the (state) part.
8241     * See #Elm_Gengrid_Item_State_Get_Cb.
8242     * - @c func.del - This is called when elm_gengrid_item_del() is
8243     * called on an item or elm_gengrid_clear() is called on the
8244     * gengrid. This is intended for use when gengrid items are
8245     * deleted, so any data attached to the item (e.g. its data
8246     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8247     *
8248     * @section Gengrid_Usage_Hints Usage hints
8249     *
8250     * If the user wants to have multiple items selected at the same
8251     * time, elm_gengrid_multi_select_set() will permit it. If the
8252     * gengrid is single-selection only (the default), then
8253     * elm_gengrid_select_item_get() will return the selected item or
8254     * @c NULL, if none is selected. If the gengrid is under
8255     * multi-selection, then elm_gengrid_selected_items_get() will
8256     * return a list (that is only valid as long as no items are
8257     * modified (added, deleted, selected or unselected) of child items
8258     * on a gengrid.
8259     *
8260     * If an item changes (internal (boolean) state, text or content
8261     * changes), then use elm_gengrid_item_update() to have gengrid
8262     * update the item with the new state. A gengrid will re-"realize"
8263     * the item, thus calling the functions in the
8264     * #Elm_Gengrid_Item_Class set for that item.
8265     *
8266     * To programmatically (un)select an item, use
8267     * elm_gengrid_item_selected_set(). To get its selected state use
8268     * elm_gengrid_item_selected_get(). To make an item disabled
8269     * (unable to be selected and appear differently) use
8270     * elm_gengrid_item_disabled_set() to set this and
8271     * elm_gengrid_item_disabled_get() to get the disabled state.
8272     *
8273     * Grid cells will only have their selection smart callbacks called
8274     * when firstly getting selected. Any further clicks will do
8275     * nothing, unless you enable the "always select mode", with
8276     * elm_gengrid_always_select_mode_set(), thus making every click to
8277     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8278     * turn off the ability to select items entirely in the widget and
8279     * they will neither appear selected nor call the selection smart
8280     * callbacks.
8281     *
8282     * Remember that you can create new styles and add your own theme
8283     * augmentation per application with elm_theme_extension_add(). If
8284     * you absolutely must have a specific style that overrides any
8285     * theme the user or system sets up you can use
8286     * elm_theme_overlay_add() to add such a file.
8287     *
8288     * @section Gengrid_Smart_Events Gengrid smart events
8289     *
8290     * Smart events that you can add callbacks for are:
8291     * - @c "activated" - The user has double-clicked or pressed
8292     *   (enter|return|spacebar) on an item. The @c event_info parameter
8293     *   is the gengrid item that was activated.
8294     * - @c "clicked,double" - The user has double-clicked an item.
8295     *   The @c event_info parameter is the gengrid item that was double-clicked.
8296     * - @c "longpressed" - This is called when the item is pressed for a certain
8297     *   amount of time. By default it's 1 second.
8298     * - @c "selected" - The user has made an item selected. The
8299     *   @c event_info parameter is the gengrid item that was selected.
8300     * - @c "unselected" - The user has made an item unselected. The
8301     *   @c event_info parameter is the gengrid item that was unselected.
8302     * - @c "realized" - This is called when the item in the gengrid
8303     *   has its implementing Evas object instantiated, de facto. @c
8304     *   event_info is the gengrid item that was created. The object
8305     *   may be deleted at any time, so it is highly advised to the
8306     *   caller @b not to use the object pointer returned from
8307     *   elm_gengrid_item_object_get(), because it may point to freed
8308     *   objects.
8309     * - @c "unrealized" - This is called when the implementing Evas
8310     *   object for this item is deleted. @c event_info is the gengrid
8311     *   item that was deleted.
8312     * - @c "changed" - Called when an item is added, removed, resized
8313     *   or moved and when the gengrid is resized or gets "horizontal"
8314     *   property changes.
8315     * - @c "scroll,anim,start" - This is called when scrolling animation has
8316     *   started.
8317     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8318     *   stopped.
8319     * - @c "drag,start,up" - Called when the item in the gengrid has
8320     *   been dragged (not scrolled) up.
8321     * - @c "drag,start,down" - Called when the item in the gengrid has
8322     *   been dragged (not scrolled) down.
8323     * - @c "drag,start,left" - Called when the item in the gengrid has
8324     *   been dragged (not scrolled) left.
8325     * - @c "drag,start,right" - Called when the item in the gengrid has
8326     *   been dragged (not scrolled) right.
8327     * - @c "drag,stop" - Called when the item in the gengrid has
8328     *   stopped being dragged.
8329     * - @c "drag" - Called when the item in the gengrid is being
8330     *   dragged.
8331     * - @c "scroll" - called when the content has been scrolled
8332     *   (moved).
8333     * - @c "scroll,drag,start" - called when dragging the content has
8334     *   started.
8335     * - @c "scroll,drag,stop" - called when dragging the content has
8336     *   stopped.
8337     * - @c "edge,top" - This is called when the gengrid is scrolled until
8338     *   the top edge.
8339     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8340     *   until the bottom edge.
8341     * - @c "edge,left" - This is called when the gengrid is scrolled
8342     *   until the left edge.
8343     * - @c "edge,right" - This is called when the gengrid is scrolled
8344     *   until the right edge.
8345     *
8346     * List of gengrid examples:
8347     * @li @ref gengrid_example
8348     */
8349
8350    /**
8351     * @addtogroup Gengrid
8352     * @{
8353     */
8354
8355    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8356    #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8357    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8358    #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8359    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8360    /**
8361     * Text fetching class function for Elm_Gen_Item_Class.
8362     * @param data The data passed in the item creation function
8363     * @param obj The base widget object
8364     * @param part The part name of the swallow
8365     * @return The allocated (NOT stringshared) string to set as the text 
8366     */
8367    typedef char        *(*Elm_Gengrid_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8368    /**
8369     * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8370     * @param data The data passed in the item creation function
8371     * @param obj The base widget object
8372     * @param part The part name of the swallow
8373     * @return The content object to swallow
8374     */
8375    typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part);
8376    /**
8377     * State fetching class function for Elm_Gen_Item_Class.
8378     * @param data The data passed in the item creation function
8379     * @param obj The base widget object
8380     * @param part The part name of the swallow
8381     * @return The hell if I know
8382     */
8383    typedef Eina_Bool    (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8384    /**
8385     * Deletion class function for Elm_Gen_Item_Class.
8386     * @param data The data passed in the item creation function
8387     * @param obj The base widget object
8388     */
8389    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj);
8390
8391    /**
8392     * @struct _Elm_Gengrid_Item_Class
8393     *
8394     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8395     * field details.
8396     */
8397    struct _Elm_Gengrid_Item_Class
8398      {
8399         const char             *item_style;
8400         struct _Elm_Gengrid_Item_Class_Func
8401           {
8402              union /* temporary compatibility code */
8403                {
8404                   Elm_Gengrid_Item_Text_Get_Cb  label_get EINA_DEPRECATED;
8405                   Elm_Gengrid_Item_Text_Get_Cb  text_get; /**< Text fetching class function for gengrid item classes.*/
8406                };
8407              Elm_Gengrid_Item_Content_Get_Cb content_get;
8408              Elm_Gengrid_Item_State_Get_Cb state_get;
8409              Elm_Gengrid_Item_Del_Cb       del;
8410           } func;
8411      }; /**< #Elm_Gengrid_Item_Class member definitions */
8412    #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8413    /**
8414     * Add a new gengrid widget to the given parent Elementary
8415     * (container) object
8416     *
8417     * @param parent The parent object
8418     * @return a new gengrid widget handle or @c NULL, on errors
8419     *
8420     * This function inserts a new gengrid widget on the canvas.
8421     *
8422     * @see elm_gengrid_item_size_set()
8423     * @see elm_gengrid_group_item_size_set()
8424     * @see elm_gengrid_horizontal_set()
8425     * @see elm_gengrid_item_append()
8426     * @see elm_gengrid_item_del()
8427     * @see elm_gengrid_clear()
8428     *
8429     * @ingroup Gengrid
8430     */
8431    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8432
8433    /**
8434     * Set the size for the items of a given gengrid widget
8435     *
8436     * @param obj The gengrid object.
8437     * @param w The items' width.
8438     * @param h The items' height;
8439     *
8440     * A gengrid, after creation, has still no information on the size
8441     * to give to each of its cells. So, you most probably will end up
8442     * with squares one @ref Fingers "finger" wide, the default
8443     * size. Use this function to force a custom size for you items,
8444     * making them as big as you wish.
8445     *
8446     * @see elm_gengrid_item_size_get()
8447     *
8448     * @ingroup Gengrid
8449     */
8450    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8451
8452    /**
8453     * Get the size set for the items of a given gengrid widget
8454     *
8455     * @param obj The gengrid object.
8456     * @param w Pointer to a variable where to store the items' width.
8457     * @param h Pointer to a variable where to store the items' height.
8458     *
8459     * @note Use @c NULL pointers on the size values you're not
8460     * interested in: they'll be ignored by the function.
8461     *
8462     * @see elm_gengrid_item_size_get() for more details
8463     *
8464     * @ingroup Gengrid
8465     */
8466    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8467
8468    /**
8469     * Set the size for the group items of a given gengrid widget
8470     *
8471     * @param obj The gengrid object.
8472     * @param w The group items' width.
8473     * @param h The group items' height;
8474     *
8475     * A gengrid, after creation, has still no information on the size
8476     * to give to each of its cells. So, you most probably will end up
8477     * with squares one @ref Fingers "finger" wide, the default
8478     * size. Use this function to force a custom size for you group items,
8479     * making them as big as you wish.
8480     *
8481     * @see elm_gengrid_group_item_size_get()
8482     *
8483     * @ingroup Gengrid
8484     */
8485    EAPI void               elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8486
8487    /**
8488     * Get the size set for the group items of a given gengrid widget
8489     *
8490     * @param obj The gengrid object.
8491     * @param w Pointer to a variable where to store the group items' width.
8492     * @param h Pointer to a variable where to store the group items' height.
8493     *
8494     * @note Use @c NULL pointers on the size values you're not
8495     * interested in: they'll be ignored by the function.
8496     *
8497     * @see elm_gengrid_group_item_size_get() for more details
8498     *
8499     * @ingroup Gengrid
8500     */
8501    EAPI void               elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8502
8503    /**
8504     * Set the items grid's alignment within a given gengrid widget
8505     *
8506     * @param obj The gengrid object.
8507     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8508     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8509     *
8510     * This sets the alignment of the whole grid of items of a gengrid
8511     * within its given viewport. By default, those values are both
8512     * 0.5, meaning that the gengrid will have its items grid placed
8513     * exactly in the middle of its viewport.
8514     *
8515     * @note If given alignment values are out of the cited ranges,
8516     * they'll be changed to the nearest boundary values on the valid
8517     * ranges.
8518     *
8519     * @see elm_gengrid_align_get()
8520     *
8521     * @ingroup Gengrid
8522     */
8523    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8524
8525    /**
8526     * Get the items grid's alignment values within a given gengrid
8527     * widget
8528     *
8529     * @param obj The gengrid object.
8530     * @param align_x Pointer to a variable where to store the
8531     * horizontal alignment.
8532     * @param align_y Pointer to a variable where to store the vertical
8533     * alignment.
8534     *
8535     * @note Use @c NULL pointers on the alignment values you're not
8536     * interested in: they'll be ignored by the function.
8537     *
8538     * @see elm_gengrid_align_set() for more details
8539     *
8540     * @ingroup Gengrid
8541     */
8542    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8543
8544    /**
8545     * Set whether a given gengrid widget is or not able have items
8546     * @b reordered
8547     *
8548     * @param obj The gengrid object
8549     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8550     * @c EINA_FALSE to turn it off
8551     *
8552     * If a gengrid is set to allow reordering, a click held for more
8553     * than 0.5 over a given item will highlight it specially,
8554     * signalling the gengrid has entered the reordering state. From
8555     * that time on, the user will be able to, while still holding the
8556     * mouse button down, move the item freely in the gengrid's
8557     * viewport, replacing to said item to the locations it goes to.
8558     * The replacements will be animated and, whenever the user
8559     * releases the mouse button, the item being replaced gets a new
8560     * definitive place in the grid.
8561     *
8562     * @see elm_gengrid_reorder_mode_get()
8563     *
8564     * @ingroup Gengrid
8565     */
8566    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8567
8568    /**
8569     * Get whether a given gengrid widget is or not able have items
8570     * @b reordered
8571     *
8572     * @param obj The gengrid object
8573     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8574     * off
8575     *
8576     * @see elm_gengrid_reorder_mode_set() for more details
8577     *
8578     * @ingroup Gengrid
8579     */
8580    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8581
8582    /**
8583     * Append a new item in a given gengrid widget.
8584     *
8585     * @param obj The gengrid object.
8586     * @param gic The item class for the item.
8587     * @param data The item data.
8588     * @param func Convenience function called when the item is
8589     * selected.
8590     * @param func_data Data to be passed to @p func.
8591     * @return A handle to the item added or @c NULL, on errors.
8592     *
8593     * This adds an item to the beginning of the gengrid.
8594     *
8595     * @see elm_gengrid_item_prepend()
8596     * @see elm_gengrid_item_insert_before()
8597     * @see elm_gengrid_item_insert_after()
8598     * @see elm_gengrid_item_del()
8599     *
8600     * @ingroup Gengrid
8601     */
8602    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);
8603
8604    /**
8605     * Prepend a new item in a given gengrid widget.
8606     *
8607     * @param obj The gengrid object.
8608     * @param gic The item class for the item.
8609     * @param data The item data.
8610     * @param func Convenience function called when the item is
8611     * selected.
8612     * @param func_data Data to be passed to @p func.
8613     * @return A handle to the item added or @c NULL, on errors.
8614     *
8615     * This adds an item to the end of the gengrid.
8616     *
8617     * @see elm_gengrid_item_append()
8618     * @see elm_gengrid_item_insert_before()
8619     * @see elm_gengrid_item_insert_after()
8620     * @see elm_gengrid_item_del()
8621     *
8622     * @ingroup Gengrid
8623     */
8624    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);
8625
8626    /**
8627     * Insert an item before another in a gengrid widget
8628     *
8629     * @param obj The gengrid object.
8630     * @param gic The item class for the item.
8631     * @param data The item data.
8632     * @param relative The item to place this new one before.
8633     * @param func Convenience function called when the item is
8634     * selected.
8635     * @param func_data Data to be passed to @p func.
8636     * @return A handle to the item added or @c NULL, on errors.
8637     *
8638     * This inserts an item before another in the gengrid.
8639     *
8640     * @see elm_gengrid_item_append()
8641     * @see elm_gengrid_item_prepend()
8642     * @see elm_gengrid_item_insert_after()
8643     * @see elm_gengrid_item_del()
8644     *
8645     * @ingroup Gengrid
8646     */
8647    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);
8648
8649    /**
8650     * Insert an item after another in a gengrid widget
8651     *
8652     * @param obj The gengrid object.
8653     * @param gic The item class for the item.
8654     * @param data The item data.
8655     * @param relative The item to place this new one after.
8656     * @param func Convenience function called when the item is
8657     * selected.
8658     * @param func_data Data to be passed to @p func.
8659     * @return A handle to the item added or @c NULL, on errors.
8660     *
8661     * This inserts an item after another in the gengrid.
8662     *
8663     * @see elm_gengrid_item_append()
8664     * @see elm_gengrid_item_prepend()
8665     * @see elm_gengrid_item_insert_after()
8666     * @see elm_gengrid_item_del()
8667     *
8668     * @ingroup Gengrid
8669     */
8670    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);
8671
8672    /**
8673     * Insert an item in a gengrid widget using a user-defined sort function.
8674     *
8675     * @param obj The gengrid object.
8676     * @param gic The item class for the item.
8677     * @param data The item data.
8678     * @param comp User defined comparison function that defines the sort order based on
8679     * Elm_Gen_Item and its data param.
8680     * @param func Convenience function called when the item is selected.
8681     * @param func_data Data to be passed to @p func.
8682     * @return A handle to the item added or @c NULL, on errors.
8683     *
8684     * This inserts an item in the gengrid based on user defined comparison function.
8685     *
8686     * @see elm_gengrid_item_append()
8687     * @see elm_gengrid_item_prepend()
8688     * @see elm_gengrid_item_insert_after()
8689     * @see elm_gengrid_item_del()
8690     * @see elm_gengrid_item_direct_sorted_insert()
8691     *
8692     * @ingroup Gengrid
8693     */
8694    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);
8695
8696    /**
8697     * Insert an item in a gengrid widget using a user-defined sort function.
8698     *
8699     * @param obj The gengrid object.
8700     * @param gic The item class for the item.
8701     * @param data The item data.
8702     * @param comp User defined comparison function that defines the sort order based on
8703     * Elm_Gen_Item.
8704     * @param func Convenience function called when the item is selected.
8705     * @param func_data Data to be passed to @p func.
8706     * @return A handle to the item added or @c NULL, on errors.
8707     *
8708     * This inserts an item in the gengrid based on user defined comparison function.
8709     *
8710     * @see elm_gengrid_item_append()
8711     * @see elm_gengrid_item_prepend()
8712     * @see elm_gengrid_item_insert_after()
8713     * @see elm_gengrid_item_del()
8714     * @see elm_gengrid_item_sorted_insert()
8715     *
8716     * @ingroup Gengrid
8717     */
8718    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);
8719
8720    /**
8721     * Set whether items on a given gengrid widget are to get their
8722     * selection callbacks issued for @b every subsequent selection
8723     * click on them or just for the first click.
8724     *
8725     * @param obj The gengrid object
8726     * @param always_select @c EINA_TRUE to make items "always
8727     * selected", @c EINA_FALSE, otherwise
8728     *
8729     * By default, grid items will only call their selection callback
8730     * function when firstly getting selected, any subsequent further
8731     * clicks will do nothing. With this call, you make those
8732     * subsequent clicks also to issue the selection callbacks.
8733     *
8734     * @note <b>Double clicks</b> will @b always be reported on items.
8735     *
8736     * @see elm_gengrid_always_select_mode_get()
8737     *
8738     * @ingroup Gengrid
8739     */
8740    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8741
8742    /**
8743     * Get whether items on a given gengrid widget have their selection
8744     * callbacks issued for @b every subsequent selection click on them
8745     * or just for the first click.
8746     *
8747     * @param obj The gengrid object.
8748     * @return @c EINA_TRUE if the gengrid items are "always selected",
8749     * @c EINA_FALSE, otherwise
8750     *
8751     * @see elm_gengrid_always_select_mode_set() for more details
8752     *
8753     * @ingroup Gengrid
8754     */
8755    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8756
8757    /**
8758     * Set whether items on a given gengrid widget can be selected or not.
8759     *
8760     * @param obj The gengrid object
8761     * @param no_select @c EINA_TRUE to make items selectable,
8762     * @c EINA_FALSE otherwise
8763     *
8764     * This will make items in @p obj selectable or not. In the latter
8765     * case, any user interaction on the gengrid items will neither make
8766     * them appear selected nor them call their selection callback
8767     * functions.
8768     *
8769     * @see elm_gengrid_no_select_mode_get()
8770     *
8771     * @ingroup Gengrid
8772     */
8773    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8774
8775    /**
8776     * Get whether items on a given gengrid widget can be selected or
8777     * not.
8778     *
8779     * @param obj The gengrid object
8780     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8781     * otherwise
8782     *
8783     * @see elm_gengrid_no_select_mode_set() for more details
8784     *
8785     * @ingroup Gengrid
8786     */
8787    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8788
8789    /**
8790     * Enable or disable multi-selection in a given gengrid widget
8791     *
8792     * @param obj The gengrid object.
8793     * @param multi @c EINA_TRUE, to enable multi-selection,
8794     * @c EINA_FALSE to disable it.
8795     *
8796     * Multi-selection is the ability to have @b more than one
8797     * item selected, on a given gengrid, simultaneously. When it is
8798     * enabled, a sequence of clicks on different items will make them
8799     * all selected, progressively. A click on an already selected item
8800     * will unselect it. If interacting via the keyboard,
8801     * multi-selection is enabled while holding the "Shift" key.
8802     *
8803     * @note By default, multi-selection is @b disabled on gengrids
8804     *
8805     * @see elm_gengrid_multi_select_get()
8806     *
8807     * @ingroup Gengrid
8808     */
8809    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8810
8811    /**
8812     * Get whether multi-selection is enabled or disabled for a given
8813     * gengrid widget
8814     *
8815     * @param obj The gengrid object.
8816     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8817     * EINA_FALSE otherwise
8818     *
8819     * @see elm_gengrid_multi_select_set() for more details
8820     *
8821     * @ingroup Gengrid
8822     */
8823    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8824
8825    /**
8826     * Enable or disable bouncing effect for a given gengrid widget
8827     *
8828     * @param obj The gengrid object
8829     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8830     * @c EINA_FALSE to disable it
8831     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8832     * @c EINA_FALSE to disable it
8833     *
8834     * The bouncing effect occurs whenever one reaches the gengrid's
8835     * edge's while panning it -- it will scroll past its limits a
8836     * little bit and return to the edge again, in a animated for,
8837     * automatically.
8838     *
8839     * @note By default, gengrids have bouncing enabled on both axis
8840     *
8841     * @see elm_gengrid_bounce_get()
8842     *
8843     * @ingroup Gengrid
8844     */
8845    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8846
8847    /**
8848     * Get whether bouncing effects are enabled or disabled, for a
8849     * given gengrid widget, on each axis
8850     *
8851     * @param obj The gengrid object
8852     * @param h_bounce Pointer to a variable where to store the
8853     * horizontal bouncing flag.
8854     * @param v_bounce Pointer to a variable where to store the
8855     * vertical bouncing flag.
8856     *
8857     * @see elm_gengrid_bounce_set() for more details
8858     *
8859     * @ingroup Gengrid
8860     */
8861    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8862
8863    /**
8864     * Set a given gengrid widget's scrolling page size, relative to
8865     * its viewport size.
8866     *
8867     * @param obj The gengrid object
8868     * @param h_pagerel The horizontal page (relative) size
8869     * @param v_pagerel The vertical page (relative) size
8870     *
8871     * The gengrid's scroller is capable of binding scrolling by the
8872     * user to "pages". It means that, while scrolling and, specially
8873     * after releasing the mouse button, the grid will @b snap to the
8874     * nearest displaying page's area. When page sizes are set, the
8875     * grid's continuous content area is split into (equal) page sized
8876     * pieces.
8877     *
8878     * This function sets the size of a page <b>relatively to the
8879     * viewport dimensions</b> of the gengrid, for each axis. A value
8880     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8881     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8882     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8883     * 1.0. Values beyond those will make it behave behave
8884     * inconsistently. If you only want one axis to snap to pages, use
8885     * the value @c 0.0 for the other one.
8886     *
8887     * There is a function setting page size values in @b absolute
8888     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8889     * is mutually exclusive to this one.
8890     *
8891     * @see elm_gengrid_page_relative_get()
8892     *
8893     * @ingroup Gengrid
8894     */
8895    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8896
8897    /**
8898     * Get a given gengrid widget's scrolling page size, relative to
8899     * its viewport size.
8900     *
8901     * @param obj The gengrid object
8902     * @param h_pagerel Pointer to a variable where to store the
8903     * horizontal page (relative) size
8904     * @param v_pagerel Pointer to a variable where to store the
8905     * vertical page (relative) size
8906     *
8907     * @see elm_gengrid_page_relative_set() for more details
8908     *
8909     * @ingroup Gengrid
8910     */
8911    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8912
8913    /**
8914     * Set a given gengrid widget's scrolling page size
8915     *
8916     * @param obj The gengrid object
8917     * @param h_pagerel The horizontal page size, in pixels
8918     * @param v_pagerel The vertical page size, in pixels
8919     *
8920     * The gengrid's scroller is capable of binding scrolling by the
8921     * user to "pages". It means that, while scrolling and, specially
8922     * after releasing the mouse button, the grid will @b snap to the
8923     * nearest displaying page's area. When page sizes are set, the
8924     * grid's continuous content area is split into (equal) page sized
8925     * pieces.
8926     *
8927     * This function sets the size of a page of the gengrid, in pixels,
8928     * for each axis. Sane usable values are, between @c 0 and the
8929     * dimensions of @p obj, for each axis. Values beyond those will
8930     * make it behave behave inconsistently. If you only want one axis
8931     * to snap to pages, use the value @c 0 for the other one.
8932     *
8933     * There is a function setting page size values in @b relative
8934     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8935     * use is mutually exclusive to this one.
8936     *
8937     * @ingroup Gengrid
8938     */
8939    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8940
8941    /**
8942     * @brief Get gengrid current page number.
8943     *
8944     * @param obj The gengrid object
8945     * @param h_pagenumber The horizontal page number
8946     * @param v_pagenumber The vertical page number
8947     *
8948     * The page number starts from 0. 0 is the first page.
8949     * Current page means the page which meet the top-left of the viewport.
8950     * If there are two or more pages in the viewport, it returns the number of page
8951     * which meet the top-left of the viewport.
8952     *
8953     * @see elm_gengrid_last_page_get()
8954     * @see elm_gengrid_page_show()
8955     * @see elm_gengrid_page_brint_in()
8956     */
8957    EAPI void         elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8958
8959    /**
8960     * @brief Get scroll last page number.
8961     *
8962     * @param obj The gengrid object
8963     * @param h_pagenumber The horizontal page number
8964     * @param v_pagenumber The vertical page number
8965     *
8966     * The page number starts from 0. 0 is the first page.
8967     * This returns the last page number among the pages.
8968     *
8969     * @see elm_gengrid_current_page_get()
8970     * @see elm_gengrid_page_show()
8971     * @see elm_gengrid_page_brint_in()
8972     */
8973    EAPI void         elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8974
8975    /**
8976     * Show a specific virtual region within the gengrid content object by page number.
8977     *
8978     * @param obj The gengrid object
8979     * @param h_pagenumber The horizontal page number
8980     * @param v_pagenumber The vertical page number
8981     *
8982     * 0, 0 of the indicated page is located at the top-left of the viewport.
8983     * This will jump to the page directly without animation.
8984     *
8985     * Example of usage:
8986     *
8987     * @code
8988     * sc = elm_gengrid_add(win);
8989     * elm_gengrid_content_set(sc, content);
8990     * elm_gengrid_page_relative_set(sc, 1, 0);
8991     * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8992     * elm_gengrid_page_show(sc, h_page + 1, v_page);
8993     * @endcode
8994     *
8995     * @see elm_gengrid_page_bring_in()
8996     */
8997    EAPI void         elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8998
8999    /**
9000     * Show a specific virtual region within the gengrid content object by page number.
9001     *
9002     * @param obj The gengrid object
9003     * @param h_pagenumber The horizontal page number
9004     * @param v_pagenumber The vertical page number
9005     *
9006     * 0, 0 of the indicated page is located at the top-left of the viewport.
9007     * This will slide to the page with animation.
9008     *
9009     * Example of usage:
9010     *
9011     * @code
9012     * sc = elm_gengrid_add(win);
9013     * elm_gengrid_content_set(sc, content);
9014     * elm_gengrid_page_relative_set(sc, 1, 0);
9015     * elm_gengrid_last_page_get(sc, &h_page, &v_page);
9016     * elm_gengrid_page_bring_in(sc, h_page, v_page);
9017     * @endcode
9018     *
9019     * @see elm_gengrid_page_show()
9020     */
9021     EAPI void         elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9022
9023    /**
9024     * Set the direction in which a given gengrid widget will expand while
9025     * placing its items.
9026     *
9027     * @param obj The gengrid object.
9028     * @param setting @c EINA_TRUE to make the gengrid expand
9029     * horizontally, @c EINA_FALSE to expand vertically.
9030     *
9031     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
9032     * in @b columns, from top to bottom and, when the space for a
9033     * column is filled, another one is started on the right, thus
9034     * expanding the grid horizontally. When in "vertical mode"
9035     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
9036     * to right and, when the space for a row is filled, another one is
9037     * started below, thus expanding the grid vertically.
9038     *
9039     * @see elm_gengrid_horizontal_get()
9040     *
9041     * @ingroup Gengrid
9042     */
9043    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
9044
9045    /**
9046     * Get for what direction a given gengrid widget will expand while
9047     * placing its items.
9048     *
9049     * @param obj The gengrid object.
9050     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
9051     * @c EINA_FALSE if it's set to expand vertically.
9052     *
9053     * @see elm_gengrid_horizontal_set() for more detais
9054     *
9055     * @ingroup Gengrid
9056     */
9057    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9058
9059    /**
9060     * Get the first item in a given gengrid widget
9061     *
9062     * @param obj The gengrid object
9063     * @return The first item's handle or @c NULL, if there are no
9064     * items in @p obj (and on errors)
9065     *
9066     * This returns the first item in the @p obj's internal list of
9067     * items.
9068     *
9069     * @see elm_gengrid_last_item_get()
9070     *
9071     * @ingroup Gengrid
9072     */
9073    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9074
9075    /**
9076     * Get the last item in a given gengrid widget
9077     *
9078     * @param obj The gengrid object
9079     * @return The last item's handle or @c NULL, if there are no
9080     * items in @p obj (and on errors)
9081     *
9082     * This returns the last item in the @p obj's internal list of
9083     * items.
9084     *
9085     * @see elm_gengrid_first_item_get()
9086     *
9087     * @ingroup Gengrid
9088     */
9089    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9090
9091    /**
9092     * Get the @b next item in a gengrid widget's internal list of items,
9093     * given a handle to one of those items.
9094     *
9095     * @param item The gengrid item to fetch next from
9096     * @return The item after @p item, or @c NULL if there's none (and
9097     * on errors)
9098     *
9099     * This returns the item placed after the @p item, on the container
9100     * gengrid.
9101     *
9102     * @see elm_gengrid_item_prev_get()
9103     *
9104     * @ingroup Gengrid
9105     */
9106    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9107
9108    /**
9109     * Get the @b previous item in a gengrid widget's internal list of items,
9110     * given a handle to one of those items.
9111     *
9112     * @param item The gengrid item to fetch previous from
9113     * @return The item before @p item, or @c NULL if there's none (and
9114     * on errors)
9115     *
9116     * This returns the item placed before the @p item, on the container
9117     * gengrid.
9118     *
9119     * @see elm_gengrid_item_next_get()
9120     *
9121     * @ingroup Gengrid
9122     */
9123    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9124
9125    /**
9126     * Get the gengrid object's handle which contains a given gengrid
9127     * item
9128     *
9129     * @param item The item to fetch the container from
9130     * @return The gengrid (parent) object
9131     *
9132     * This returns the gengrid object itself that an item belongs to.
9133     *
9134     * @ingroup Gengrid
9135     */
9136    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9137
9138    /**
9139     * Remove a gengrid item from its parent, deleting it.
9140     *
9141     * @param item The item to be removed.
9142     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
9143     *
9144     * @see elm_gengrid_clear(), to remove all items in a gengrid at
9145     * once.
9146     *
9147     * @ingroup Gengrid
9148     */
9149    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9150
9151    /**
9152     * Update the contents of a given gengrid item
9153     *
9154     * @param item The gengrid item
9155     *
9156     * This updates an item by calling all the item class functions
9157     * again to get the contents, texts and states. Use this when the
9158     * original item data has changed and you want the changes to be
9159     * reflected.
9160     *
9161     * @ingroup Gengrid
9162     */
9163    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9164
9165    /**
9166     * Get the Gengrid Item class for the given Gengrid Item.
9167     *
9168     * @param item The gengrid item
9169     *
9170     * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9171     * the function pointers and item_style.
9172     *
9173     * @ingroup Gengrid
9174     */
9175    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9176
9177    /**
9178     * Get the Gengrid Item class for the given Gengrid Item.
9179     *
9180     * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9181     * the function pointers and item_style.
9182     *
9183     * @param item The gengrid item
9184     * @param gic The gengrid item class describing the function pointers and the item style.
9185     *
9186     * @ingroup Gengrid
9187     */
9188    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9189
9190    /**
9191     * Return the data associated to a given gengrid item
9192     *
9193     * @param item The gengrid item.
9194     * @return the data associated with this item.
9195     *
9196     * This returns the @c data value passed on the
9197     * elm_gengrid_item_append() and related item addition calls.
9198     *
9199     * @see elm_gengrid_item_append()
9200     * @see elm_gengrid_item_data_set()
9201     *
9202     * @ingroup Gengrid
9203     */
9204    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9205
9206    /**
9207     * Set the data associated with a given gengrid item
9208     *
9209     * @param item The gengrid item
9210     * @param data The data pointer to set on it
9211     *
9212     * This @b overrides the @c data value passed on the
9213     * elm_gengrid_item_append() and related item addition calls. This
9214     * function @b won't call elm_gengrid_item_update() automatically,
9215     * so you'd issue it afterwards if you want to have the item
9216     * updated to reflect the new data.
9217     *
9218     * @see elm_gengrid_item_data_get()
9219     * @see elm_gengrid_item_update()
9220     *
9221     * @ingroup Gengrid
9222     */
9223    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9224
9225    /**
9226     * Get a given gengrid item's position, relative to the whole
9227     * gengrid's grid area.
9228     *
9229     * @param item The Gengrid item.
9230     * @param x Pointer to variable to store the item's <b>row number</b>.
9231     * @param y Pointer to variable to store the item's <b>column number</b>.
9232     *
9233     * This returns the "logical" position of the item within the
9234     * gengrid. For example, @c (0, 1) would stand for first row,
9235     * second column.
9236     *
9237     * @ingroup Gengrid
9238     */
9239    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9240
9241    /**
9242     * Set whether a given gengrid item is selected or not
9243     *
9244     * @param item The gengrid item
9245     * @param selected Use @c EINA_TRUE, to make it selected, @c
9246     * EINA_FALSE to make it unselected
9247     *
9248     * This sets the selected state of an item. If multi-selection is
9249     * not enabled on the containing gengrid and @p selected is @c
9250     * EINA_TRUE, any other previously selected items will get
9251     * unselected in favor of this new one.
9252     *
9253     * @see elm_gengrid_item_selected_get()
9254     *
9255     * @ingroup Gengrid
9256     */
9257    EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9258
9259    /**
9260     * Get whether a given gengrid item is selected or not
9261     *
9262     * @param item The gengrid item
9263     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9264     *
9265     * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9266     *
9267     * @see elm_gengrid_item_selected_set() for more details
9268     *
9269     * @ingroup Gengrid
9270     */
9271    EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9272
9273    /**
9274     * Get the real Evas object created to implement the view of a
9275     * given gengrid item
9276     *
9277     * @param item The gengrid item.
9278     * @return the Evas object implementing this item's view.
9279     *
9280     * This returns the actual Evas object used to implement the
9281     * specified gengrid item's view. This may be @c NULL, as it may
9282     * not have been created or may have been deleted, at any time, by
9283     * the gengrid. <b>Do not modify this object</b> (move, resize,
9284     * show, hide, etc.), as the gengrid is controlling it. This
9285     * function is for querying, emitting custom signals or hooking
9286     * lower level callbacks for events on that object. Do not delete
9287     * this object under any circumstances.
9288     *
9289     * @see elm_gengrid_item_data_get()
9290     *
9291     * @ingroup Gengrid
9292     */
9293    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9294
9295    /**
9296     * Show the portion of a gengrid's internal grid containing a given
9297     * item, @b immediately.
9298     *
9299     * @param item The item to display
9300     *
9301     * This causes gengrid to @b redraw its viewport's contents to the
9302     * region contining the given @p item item, if it is not fully
9303     * visible.
9304     *
9305     * @see elm_gengrid_item_bring_in()
9306     *
9307     * @ingroup Gengrid
9308     */
9309    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9310
9311    /**
9312     * Animatedly bring in, to the visible area of a gengrid, a given
9313     * item on it.
9314     *
9315     * @param item The gengrid item to display
9316     *
9317     * This causes gengrid to jump to the given @p item and show
9318     * it (by scrolling), if it is not fully visible. This will use
9319     * animation to do so and take a period of time to complete.
9320     *
9321     * @see elm_gengrid_item_show()
9322     *
9323     * @ingroup Gengrid
9324     */
9325    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9326
9327    /**
9328     * Set whether a given gengrid item is disabled or not.
9329     *
9330     * @param item The gengrid item
9331     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9332     * to enable it back.
9333     *
9334     * A disabled item cannot be selected or unselected. It will also
9335     * change its appearance, to signal the user it's disabled.
9336     *
9337     * @see elm_gengrid_item_disabled_get()
9338     *
9339     * @ingroup Gengrid
9340     */
9341    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9342
9343    /**
9344     * Get whether a given gengrid item is disabled or not.
9345     *
9346     * @param item The gengrid item
9347     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9348     * (and on errors).
9349     *
9350     * @see elm_gengrid_item_disabled_set() for more details
9351     *
9352     * @ingroup Gengrid
9353     */
9354    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9355
9356    /**
9357     * Set the text to be shown in a given gengrid item's tooltips.
9358     *
9359     * @param item The gengrid item
9360     * @param text The text to set in the content
9361     *
9362     * This call will setup the text to be used as tooltip to that item
9363     * (analogous to elm_object_tooltip_text_set(), but being item
9364     * tooltips with higher precedence than object tooltips). It can
9365     * have only one tooltip at a time, so any previous tooltip data
9366     * will get removed.
9367     *
9368     * @ingroup Gengrid
9369     */
9370    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9371
9372    /**
9373     * Set the content to be shown in a given gengrid item's tooltip
9374     *
9375     * @param item The gengrid item.
9376     * @param func The function returning the tooltip contents.
9377     * @param data What to provide to @a func as callback data/context.
9378     * @param del_cb Called when data is not needed anymore, either when
9379     *        another callback replaces @p func, the tooltip is unset with
9380     *        elm_gengrid_item_tooltip_unset() or the owner @p item
9381     *        dies. This callback receives as its first parameter the
9382     *        given @p data, being @c event_info the item handle.
9383     *
9384     * This call will setup the tooltip's contents to @p item
9385     * (analogous to elm_object_tooltip_content_cb_set(), but being
9386     * item tooltips with higher precedence than object tooltips). It
9387     * can have only one tooltip at a time, so any previous tooltip
9388     * content will get removed. @p func (with @p data) will be called
9389     * every time Elementary needs to show the tooltip and it should
9390     * return a valid Evas object, which will be fully managed by the
9391     * tooltip system, getting deleted when the tooltip is gone.
9392     *
9393     * @ingroup Gengrid
9394     */
9395    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);
9396
9397    /**
9398     * Unset a tooltip from a given gengrid item
9399     *
9400     * @param item gengrid item to remove a previously set tooltip from.
9401     *
9402     * This call removes any tooltip set on @p item. The callback
9403     * provided as @c del_cb to
9404     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9405     * notify it is not used anymore (and have resources cleaned, if
9406     * need be).
9407     *
9408     * @see elm_gengrid_item_tooltip_content_cb_set()
9409     *
9410     * @ingroup Gengrid
9411     */
9412    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9413
9414    /**
9415     * Set a different @b style for a given gengrid item's tooltip.
9416     *
9417     * @param item gengrid item with tooltip set
9418     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9419     * "default", @c "transparent", etc)
9420     *
9421     * Tooltips can have <b>alternate styles</b> to be displayed on,
9422     * which are defined by the theme set on Elementary. This function
9423     * works analogously as elm_object_tooltip_style_set(), but here
9424     * applied only to gengrid item objects. The default style for
9425     * tooltips is @c "default".
9426     *
9427     * @note before you set a style you should define a tooltip with
9428     *       elm_gengrid_item_tooltip_content_cb_set() or
9429     *       elm_gengrid_item_tooltip_text_set()
9430     *
9431     * @see elm_gengrid_item_tooltip_style_get()
9432     *
9433     * @ingroup Gengrid
9434     */
9435    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9436
9437    /**
9438     * Get the style set a given gengrid item's tooltip.
9439     *
9440     * @param item gengrid item with tooltip already set on.
9441     * @return style the theme style in use, which defaults to
9442     *         "default". If the object does not have a tooltip set,
9443     *         then @c NULL is returned.
9444     *
9445     * @see elm_gengrid_item_tooltip_style_set() for more details
9446     *
9447     * @ingroup Gengrid
9448     */
9449    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9450    /**
9451     * @brief Disable size restrictions on an object's tooltip
9452     * @param item The tooltip's anchor object
9453     * @param disable If EINA_TRUE, size restrictions are disabled
9454     * @return EINA_FALSE on failure, EINA_TRUE on success
9455     *
9456     * This function allows a tooltip to expand beyond its parant window's canvas.
9457     * It will instead be limited only by the size of the display.
9458     */
9459    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9460    /**
9461     * @brief Retrieve size restriction state of an object's tooltip
9462     * @param item The tooltip's anchor object
9463     * @return If EINA_TRUE, size restrictions are disabled
9464     *
9465     * This function returns whether a tooltip is allowed to expand beyond
9466     * its parant window's canvas.
9467     * It will instead be limited only by the size of the display.
9468     */
9469    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9470    /**
9471     * Set the type of mouse pointer/cursor decoration to be shown,
9472     * when the mouse pointer is over the given gengrid widget item
9473     *
9474     * @param item gengrid item to customize cursor on
9475     * @param cursor the cursor type's name
9476     *
9477     * This function works analogously as elm_object_cursor_set(), but
9478     * here the cursor's changing area is restricted to the item's
9479     * area, and not the whole widget's. Note that that item cursors
9480     * have precedence over widget cursors, so that a mouse over @p
9481     * item will always show cursor @p type.
9482     *
9483     * If this function is called twice for an object, a previously set
9484     * cursor will be unset on the second call.
9485     *
9486     * @see elm_object_cursor_set()
9487     * @see elm_gengrid_item_cursor_get()
9488     * @see elm_gengrid_item_cursor_unset()
9489     *
9490     * @ingroup Gengrid
9491     */
9492    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9493
9494    /**
9495     * Get the type of mouse pointer/cursor decoration set to be shown,
9496     * when the mouse pointer is over the given gengrid widget item
9497     *
9498     * @param item gengrid item with custom cursor set
9499     * @return the cursor type's name or @c NULL, if no custom cursors
9500     * were set to @p item (and on errors)
9501     *
9502     * @see elm_object_cursor_get()
9503     * @see elm_gengrid_item_cursor_set() for more details
9504     * @see elm_gengrid_item_cursor_unset()
9505     *
9506     * @ingroup Gengrid
9507     */
9508    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9509
9510    /**
9511     * Unset any custom mouse pointer/cursor decoration set to be
9512     * shown, when the mouse pointer is over the given gengrid widget
9513     * item, thus making it show the @b default cursor again.
9514     *
9515     * @param item a gengrid item
9516     *
9517     * Use this call to undo any custom settings on this item's cursor
9518     * decoration, bringing it back to defaults (no custom style set).
9519     *
9520     * @see elm_object_cursor_unset()
9521     * @see elm_gengrid_item_cursor_set() for more details
9522     *
9523     * @ingroup Gengrid
9524     */
9525    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9526
9527    /**
9528     * Set a different @b style for a given custom cursor set for a
9529     * gengrid item.
9530     *
9531     * @param item gengrid item with custom cursor set
9532     * @param style the <b>theme style</b> to use (e.g. @c "default",
9533     * @c "transparent", etc)
9534     *
9535     * This function only makes sense when one is using custom mouse
9536     * cursor decorations <b>defined in a theme file</b> , which can
9537     * have, given a cursor name/type, <b>alternate styles</b> on
9538     * it. It works analogously as elm_object_cursor_style_set(), but
9539     * here applied only to gengrid item objects.
9540     *
9541     * @warning Before you set a cursor style you should have defined a
9542     *       custom cursor previously on the item, with
9543     *       elm_gengrid_item_cursor_set()
9544     *
9545     * @see elm_gengrid_item_cursor_engine_only_set()
9546     * @see elm_gengrid_item_cursor_style_get()
9547     *
9548     * @ingroup Gengrid
9549     */
9550    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9551
9552    /**
9553     * Get the current @b style set for a given gengrid item's custom
9554     * cursor
9555     *
9556     * @param item gengrid item with custom cursor set.
9557     * @return style the cursor style in use. If the object does not
9558     *         have a cursor set, then @c NULL is returned.
9559     *
9560     * @see elm_gengrid_item_cursor_style_set() for more details
9561     *
9562     * @ingroup Gengrid
9563     */
9564    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9565
9566    /**
9567     * Set if the (custom) cursor for a given gengrid item should be
9568     * searched in its theme, also, or should only rely on the
9569     * rendering engine.
9570     *
9571     * @param item item with custom (custom) cursor already set on
9572     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9573     * only on those provided by the rendering engine, @c EINA_FALSE to
9574     * have them searched on the widget's theme, as well.
9575     *
9576     * @note This call is of use only if you've set a custom cursor
9577     * for gengrid items, with elm_gengrid_item_cursor_set().
9578     *
9579     * @note By default, cursors will only be looked for between those
9580     * provided by the rendering engine.
9581     *
9582     * @ingroup Gengrid
9583     */
9584    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9585
9586    /**
9587     * Get if the (custom) cursor for a given gengrid item is being
9588     * searched in its theme, also, or is only relying on the rendering
9589     * engine.
9590     *
9591     * @param item a gengrid item
9592     * @return @c EINA_TRUE, if cursors are being looked for only on
9593     * those provided by the rendering engine, @c EINA_FALSE if they
9594     * are being searched on the widget's theme, as well.
9595     *
9596     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9597     *
9598     * @ingroup Gengrid
9599     */
9600    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9601
9602    /**
9603     * Remove all items from a given gengrid widget
9604     *
9605     * @param obj The gengrid object.
9606     *
9607     * This removes (and deletes) all items in @p obj, leaving it
9608     * empty.
9609     *
9610     * @see elm_gengrid_item_del(), to remove just one item.
9611     *
9612     * @ingroup Gengrid
9613     */
9614    EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9615
9616    /**
9617     * Get the selected item in a given gengrid widget
9618     *
9619     * @param obj The gengrid object.
9620     * @return The selected item's handleor @c NULL, if none is
9621     * selected at the moment (and on errors)
9622     *
9623     * This returns the selected item in @p obj. If multi selection is
9624     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9625     * the first item in the list is selected, which might not be very
9626     * useful. For that case, see elm_gengrid_selected_items_get().
9627     *
9628     * @ingroup Gengrid
9629     */
9630    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9631
9632    /**
9633     * Get <b>a list</b> of selected items in a given gengrid
9634     *
9635     * @param obj The gengrid object.
9636     * @return The list of selected items or @c NULL, if none is
9637     * selected at the moment (and on errors)
9638     *
9639     * This returns a list of the selected items, in the order that
9640     * they appear in the grid. This list is only valid as long as no
9641     * more items are selected or unselected (or unselected implictly
9642     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9643     * data, naturally.
9644     *
9645     * @see elm_gengrid_selected_item_get()
9646     *
9647     * @ingroup Gengrid
9648     */
9649    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9650
9651    /**
9652     * @}
9653     */
9654
9655    /**
9656     * @defgroup Clock Clock
9657     *
9658     * @image html img/widget/clock/preview-00.png
9659     * @image latex img/widget/clock/preview-00.eps
9660     *
9661     * This is a @b digital clock widget. In its default theme, it has a
9662     * vintage "flipping numbers clock" appearance, which will animate
9663     * sheets of individual algarisms individually as time goes by.
9664     *
9665     * A newly created clock will fetch system's time (already
9666     * considering local time adjustments) to start with, and will tick
9667     * accondingly. It may or may not show seconds.
9668     *
9669     * Clocks have an @b edition mode. When in it, the sheets will
9670     * display extra arrow indications on the top and bottom and the
9671     * user may click on them to raise or lower the time values. After
9672     * it's told to exit edition mode, it will keep ticking with that
9673     * new time set (it keeps the difference from local time).
9674     *
9675     * Also, when under edition mode, user clicks on the cited arrows
9676     * which are @b held for some time will make the clock to flip the
9677     * sheet, thus editing the time, continuosly and automatically for
9678     * the user. The interval between sheet flips will keep growing in
9679     * time, so that it helps the user to reach a time which is distant
9680     * from the one set.
9681     *
9682     * The time display is, by default, in military mode (24h), but an
9683     * am/pm indicator may be optionally shown, too, when it will
9684     * switch to 12h.
9685     *
9686     * Smart callbacks one can register to:
9687     * - "changed" - the clock's user changed the time
9688     *
9689     * Here is an example on its usage:
9690     * @li @ref clock_example
9691     */
9692
9693    /**
9694     * @addtogroup Clock
9695     * @{
9696     */
9697
9698    /**
9699     * Identifiers for which clock digits should be editable, when a
9700     * clock widget is in edition mode. Values may be ORed together to
9701     * make a mask, naturally.
9702     *
9703     * @see elm_clock_edit_set()
9704     * @see elm_clock_digit_edit_set()
9705     */
9706    typedef enum _Elm_Clock_Digedit
9707      {
9708         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9709         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9710         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9711         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9712         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9713         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9714         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9715         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9716      } Elm_Clock_Digedit;
9717
9718    /**
9719     * Add a new clock widget to the given parent Elementary
9720     * (container) object
9721     *
9722     * @param parent The parent object
9723     * @return a new clock widget handle or @c NULL, on errors
9724     *
9725     * This function inserts a new clock widget on the canvas.
9726     *
9727     * @ingroup Clock
9728     */
9729    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9730
9731    /**
9732     * Set a clock widget's time, programmatically
9733     *
9734     * @param obj The clock widget object
9735     * @param hrs The hours to set
9736     * @param min The minutes to set
9737     * @param sec The secondes to set
9738     *
9739     * This function updates the time that is showed by the clock
9740     * widget.
9741     *
9742     *  Values @b must be set within the following ranges:
9743     * - 0 - 23, for hours
9744     * - 0 - 59, for minutes
9745     * - 0 - 59, for seconds,
9746     *
9747     * even if the clock is not in "military" mode.
9748     *
9749     * @warning The behavior for values set out of those ranges is @b
9750     * undefined.
9751     *
9752     * @ingroup Clock
9753     */
9754    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9755
9756    /**
9757     * Get a clock widget's time values
9758     *
9759     * @param obj The clock object
9760     * @param[out] hrs Pointer to the variable to get the hours value
9761     * @param[out] min Pointer to the variable to get the minutes value
9762     * @param[out] sec Pointer to the variable to get the seconds value
9763     *
9764     * This function gets the time set for @p obj, returning
9765     * it on the variables passed as the arguments to function
9766     *
9767     * @note Use @c NULL pointers on the time values you're not
9768     * interested in: they'll be ignored by the function.
9769     *
9770     * @ingroup Clock
9771     */
9772    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9773
9774    /**
9775     * Set whether a given clock widget is under <b>edition mode</b> or
9776     * under (default) displaying-only mode.
9777     *
9778     * @param obj The clock object
9779     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9780     * put it back to "displaying only" mode
9781     *
9782     * This function makes a clock's time to be editable or not <b>by
9783     * user interaction</b>. When in edition mode, clocks @b stop
9784     * ticking, until one brings them back to canonical mode. The
9785     * elm_clock_digit_edit_set() function will influence which digits
9786     * of the clock will be editable. By default, all of them will be
9787     * (#ELM_CLOCK_NONE).
9788     *
9789     * @note am/pm sheets, if being shown, will @b always be editable
9790     * under edition mode.
9791     *
9792     * @see elm_clock_edit_get()
9793     *
9794     * @ingroup Clock
9795     */
9796    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9797
9798    /**
9799     * Retrieve whether a given clock widget is under <b>edition
9800     * mode</b> or under (default) displaying-only mode.
9801     *
9802     * @param obj The clock object
9803     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9804     * otherwise
9805     *
9806     * This function retrieves whether the clock's time can be edited
9807     * or not by user interaction.
9808     *
9809     * @see elm_clock_edit_set() for more details
9810     *
9811     * @ingroup Clock
9812     */
9813    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9814
9815    /**
9816     * Set what digits of the given clock widget should be editable
9817     * when in edition mode.
9818     *
9819     * @param obj The clock object
9820     * @param digedit Bit mask indicating the digits to be editable
9821     * (values in #Elm_Clock_Digedit).
9822     *
9823     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9824     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9825     * EINA_FALSE).
9826     *
9827     * @see elm_clock_digit_edit_get()
9828     *
9829     * @ingroup Clock
9830     */
9831    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9832
9833    /**
9834     * Retrieve what digits of the given clock widget should be
9835     * editable when in edition mode.
9836     *
9837     * @param obj The clock object
9838     * @return Bit mask indicating the digits to be editable
9839     * (values in #Elm_Clock_Digedit).
9840     *
9841     * @see elm_clock_digit_edit_set() for more details
9842     *
9843     * @ingroup Clock
9844     */
9845    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9846
9847    /**
9848     * Set if the given clock widget must show hours in military or
9849     * am/pm mode
9850     *
9851     * @param obj The clock object
9852     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9853     * to military mode
9854     *
9855     * This function sets if the clock must show hours in military or
9856     * am/pm mode. In some countries like Brazil the military mode
9857     * (00-24h-format) is used, in opposition to the USA, where the
9858     * am/pm mode is more commonly used.
9859     *
9860     * @see elm_clock_show_am_pm_get()
9861     *
9862     * @ingroup Clock
9863     */
9864    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9865
9866    /**
9867     * Get if the given clock widget shows hours in military or am/pm
9868     * mode
9869     *
9870     * @param obj The clock object
9871     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9872     * military
9873     *
9874     * This function gets if the clock shows hours in military or am/pm
9875     * mode.
9876     *
9877     * @see elm_clock_show_am_pm_set() for more details
9878     *
9879     * @ingroup Clock
9880     */
9881    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9882
9883    /**
9884     * Set if the given clock widget must show time with seconds or not
9885     *
9886     * @param obj The clock object
9887     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9888     *
9889     * This function sets if the given clock must show or not elapsed
9890     * seconds. By default, they are @b not shown.
9891     *
9892     * @see elm_clock_show_seconds_get()
9893     *
9894     * @ingroup Clock
9895     */
9896    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9897
9898    /**
9899     * Get whether the given clock widget is showing time with seconds
9900     * or not
9901     *
9902     * @param obj The clock object
9903     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9904     *
9905     * This function gets whether @p obj is showing or not the elapsed
9906     * seconds.
9907     *
9908     * @see elm_clock_show_seconds_set()
9909     *
9910     * @ingroup Clock
9911     */
9912    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9913
9914    /**
9915     * Set the interval on time updates for an user mouse button hold
9916     * on clock widgets' time edition.
9917     *
9918     * @param obj The clock object
9919     * @param interval The (first) interval value in seconds
9920     *
9921     * This interval value is @b decreased while the user holds the
9922     * mouse pointer either incrementing or decrementing a given the
9923     * clock digit's value.
9924     *
9925     * This helps the user to get to a given time distant from the
9926     * current one easier/faster, as it will start to flip quicker and
9927     * quicker on mouse button holds.
9928     *
9929     * The calculation for the next flip interval value, starting from
9930     * the one set with this call, is the previous interval divided by
9931     * 1.05, so it decreases a little bit.
9932     *
9933     * The default starting interval value for automatic flips is
9934     * @b 0.85 seconds.
9935     *
9936     * @see elm_clock_interval_get()
9937     *
9938     * @ingroup Clock
9939     */
9940    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9941
9942    /**
9943     * Get the interval on time updates for an user mouse button hold
9944     * on clock widgets' time edition.
9945     *
9946     * @param obj The clock object
9947     * @return The (first) interval value, in seconds, set on it
9948     *
9949     * @see elm_clock_interval_set() for more details
9950     *
9951     * @ingroup Clock
9952     */
9953    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9954
9955    /**
9956     * @}
9957     */
9958
9959    /**
9960     * @defgroup Layout Layout
9961     *
9962     * @image html img/widget/layout/preview-00.png
9963     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9964     *
9965     * @image html img/layout-predefined.png
9966     * @image latex img/layout-predefined.eps width=\textwidth
9967     *
9968     * This is a container widget that takes a standard Edje design file and
9969     * wraps it very thinly in a widget.
9970     *
9971     * An Edje design (theme) file has a very wide range of possibilities to
9972     * describe the behavior of elements added to the Layout. Check out the Edje
9973     * documentation and the EDC reference to get more information about what can
9974     * be done with Edje.
9975     *
9976     * Just like @ref List, @ref Box, and other container widgets, any
9977     * object added to the Layout will become its child, meaning that it will be
9978     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9979     *
9980     * The Layout widget can contain as many Contents, Boxes or Tables as
9981     * described in its theme file. For instance, objects can be added to
9982     * different Tables by specifying the respective Table part names. The same
9983     * is valid for Content and Box.
9984     *
9985     * The objects added as child of the Layout will behave as described in the
9986     * part description where they were added. There are 3 possible types of
9987     * parts where a child can be added:
9988     *
9989     * @section secContent Content (SWALLOW part)
9990     *
9991     * Only one object can be added to the @c SWALLOW part (but you still can
9992     * have many @c SWALLOW parts and one object on each of them). Use the @c
9993     * elm_object_content_set/get/unset functions to set, retrieve and unset
9994     * objects as content of the @c SWALLOW. After being set to this part, the
9995     * object size, position, visibility, clipping and other description
9996     * properties will be totally controlled by the description of the given part
9997     * (inside the Edje theme file).
9998     *
9999     * One can use @c evas_object_size_hint_* functions on the child to have some
10000     * kind of control over its behavior, but the resulting behavior will still
10001     * depend heavily on the @c SWALLOW part description.
10002     *
10003     * The Edje theme also can change the part description, based on signals or
10004     * scripts running inside the theme. This change can also be animated. All of
10005     * this will affect the child object set as content accordingly. The object
10006     * size will be changed if the part size is changed, it will animate move if
10007     * the part is moving, and so on.
10008     *
10009     * The following picture demonstrates a Layout widget with a child object
10010     * added to its @c SWALLOW:
10011     *
10012     * @image html layout_swallow.png
10013     * @image latex layout_swallow.eps width=\textwidth
10014     *
10015     * @section secBox Box (BOX part)
10016     *
10017     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
10018     * allows one to add objects to the box and have them distributed along its
10019     * area, accordingly to the specified @a layout property (now by @a layout we
10020     * mean the chosen layouting design of the Box, not the Layout widget
10021     * itself).
10022     *
10023     * A similar effect for having a box with its position, size and other things
10024     * controlled by the Layout theme would be to create an Elementary @ref Box
10025     * widget and add it as a Content in the @c SWALLOW part.
10026     *
10027     * The main difference of using the Layout Box is that its behavior, the box
10028     * properties like layouting format, padding, align, etc. will be all
10029     * controlled by the theme. This means, for example, that a signal could be
10030     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
10031     * handled the signal by changing the box padding, or align, or both. Using
10032     * the Elementary @ref Box widget is not necessarily harder or easier, it
10033     * just depends on the circunstances and requirements.
10034     *
10035     * The Layout Box can be used through the @c elm_layout_box_* set of
10036     * functions.
10037     *
10038     * The following picture demonstrates a Layout widget with many child objects
10039     * added to its @c BOX part:
10040     *
10041     * @image html layout_box.png
10042     * @image latex layout_box.eps width=\textwidth
10043     *
10044     * @section secTable Table (TABLE part)
10045     *
10046     * Just like the @ref secBox, the Layout Table is very similar to the
10047     * Elementary @ref Table widget. It allows one to add objects to the Table
10048     * specifying the row and column where the object should be added, and any
10049     * column or row span if necessary.
10050     *
10051     * Again, we could have this design by adding a @ref Table widget to the @c
10052     * SWALLOW part using elm_object_part_content_set(). The same difference happens
10053     * here when choosing to use the Layout Table (a @c TABLE part) instead of
10054     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
10055     *
10056     * The Layout Table can be used through the @c elm_layout_table_* set of
10057     * functions.
10058     *
10059     * The following picture demonstrates a Layout widget with many child objects
10060     * added to its @c TABLE part:
10061     *
10062     * @image html layout_table.png
10063     * @image latex layout_table.eps width=\textwidth
10064     *
10065     * @section secPredef Predefined Layouts
10066     *
10067     * Another interesting thing about the Layout widget is that it offers some
10068     * predefined themes that come with the default Elementary theme. These
10069     * themes can be set by the call elm_layout_theme_set(), and provide some
10070     * basic functionality depending on the theme used.
10071     *
10072     * Most of them already send some signals, some already provide a toolbar or
10073     * back and next buttons.
10074     *
10075     * These are available predefined theme layouts. All of them have class = @c
10076     * layout, group = @c application, and style = one of the following options:
10077     *
10078     * @li @c toolbar-content - application with toolbar and main content area
10079     * @li @c toolbar-content-back - application with toolbar and main content
10080     * area with a back button and title area
10081     * @li @c toolbar-content-back-next - application with toolbar and main
10082     * content area with a back and next buttons and title area
10083     * @li @c content-back - application with a main content area with a back
10084     * button and title area
10085     * @li @c content-back-next - application with a main content area with a
10086     * back and next buttons and title area
10087     * @li @c toolbar-vbox - application with toolbar and main content area as a
10088     * vertical box
10089     * @li @c toolbar-table - application with toolbar and main content area as a
10090     * table
10091     *
10092     * @section secExamples Examples
10093     *
10094     * Some examples of the Layout widget can be found here:
10095     * @li @ref layout_example_01
10096     * @li @ref layout_example_02
10097     * @li @ref layout_example_03
10098     * @li @ref layout_example_edc
10099     *
10100     */
10101
10102    /**
10103     * Add a new layout to the parent
10104     *
10105     * @param parent The parent object
10106     * @return The new object or NULL if it cannot be created
10107     *
10108     * @see elm_layout_file_set()
10109     * @see elm_layout_theme_set()
10110     *
10111     * @ingroup Layout
10112     */
10113    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10114    /**
10115     * Set the file that will be used as layout
10116     *
10117     * @param obj The layout object
10118     * @param file The path to file (edj) that will be used as layout
10119     * @param group The group that the layout belongs in edje file
10120     *
10121     * @return (1 = success, 0 = error)
10122     *
10123     * @ingroup Layout
10124     */
10125    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
10126    /**
10127     * Set the edje group from the elementary theme that will be used as layout
10128     *
10129     * @param obj The layout object
10130     * @param clas the clas of the group
10131     * @param group the group
10132     * @param style the style to used
10133     *
10134     * @return (1 = success, 0 = error)
10135     *
10136     * @ingroup Layout
10137     */
10138    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
10139    /**
10140     * Set the layout content.
10141     *
10142     * @param obj The layout object
10143     * @param swallow The swallow part name in the edje file
10144     * @param content The child that will be added in this layout object
10145     *
10146     * Once the content object is set, a previously set one will be deleted.
10147     * If you want to keep that old content object, use the
10148     * elm_object_part_content_unset() function.
10149     *
10150     * @note In an Edje theme, the part used as a content container is called @c
10151     * SWALLOW. This is why the parameter name is called @p swallow, but it is
10152     * expected to be a part name just like the second parameter of
10153     * elm_layout_box_append().
10154     *
10155     * @see elm_layout_box_append()
10156     * @see elm_object_part_content_get()
10157     * @see elm_object_part_content_unset()
10158     * @see @ref secBox
10159     * @deprecated use elm_object_part_content_set() instead
10160     *
10161     * @ingroup Layout
10162     */
10163    EINA_DEPRECATED EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10164    /**
10165     * Get the child object in the given content part.
10166     *
10167     * @param obj The layout object
10168     * @param swallow The SWALLOW part to get its content
10169     *
10170     * @return The swallowed object or NULL if none or an error occurred
10171     *
10172     * @deprecated use elm_object_part_content_get() instead
10173     *
10174     * @ingroup Layout
10175     */
10176    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10177    /**
10178     * Unset the layout content.
10179     *
10180     * @param obj The layout object
10181     * @param swallow The swallow part name in the edje file
10182     * @return The content that was being used
10183     *
10184     * Unparent and return the content object which was set for this part.
10185     *
10186     * @deprecated use elm_object_part_content_unset() instead
10187     *
10188     * @ingroup Layout
10189     */
10190    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10191    /**
10192     * Set the text of the given part
10193     *
10194     * @param obj The layout object
10195     * @param part The TEXT part where to set the text
10196     * @param text The text to set
10197     *
10198     * @ingroup Layout
10199     * @deprecated use elm_object_part_text_set() instead.
10200     */
10201    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10202    /**
10203     * Get the text set in the given part
10204     *
10205     * @param obj The layout object
10206     * @param part The TEXT part to retrieve the text off
10207     *
10208     * @return The text set in @p part
10209     *
10210     * @ingroup Layout
10211     * @deprecated use elm_object_part_text_get() instead.
10212     */
10213    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10214    /**
10215     * Append child to layout box part.
10216     *
10217     * @param obj the layout object
10218     * @param part the box part to which the object will be appended.
10219     * @param child the child object to append to box.
10220     *
10221     * Once the object is appended, it will become child of the layout. Its
10222     * lifetime will be bound to the layout, whenever the layout dies the child
10223     * will be deleted automatically. One should use elm_layout_box_remove() to
10224     * make this layout forget about the object.
10225     *
10226     * @see elm_layout_box_prepend()
10227     * @see elm_layout_box_insert_before()
10228     * @see elm_layout_box_insert_at()
10229     * @see elm_layout_box_remove()
10230     *
10231     * @ingroup Layout
10232     */
10233    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10234    /**
10235     * Prepend child to layout box part.
10236     *
10237     * @param obj the layout object
10238     * @param part the box part to prepend.
10239     * @param child the child object to prepend to box.
10240     *
10241     * Once the object is prepended, it will become child of the layout. Its
10242     * lifetime will be bound to the layout, whenever the layout dies the child
10243     * will be deleted automatically. One should use elm_layout_box_remove() to
10244     * make this layout forget about the object.
10245     *
10246     * @see elm_layout_box_append()
10247     * @see elm_layout_box_insert_before()
10248     * @see elm_layout_box_insert_at()
10249     * @see elm_layout_box_remove()
10250     *
10251     * @ingroup Layout
10252     */
10253    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10254    /**
10255     * Insert child to layout box part before a reference object.
10256     *
10257     * @param obj the layout object
10258     * @param part the box part to insert.
10259     * @param child the child object to insert into box.
10260     * @param reference another reference object to insert before in box.
10261     *
10262     * Once the object is inserted, it will become child of the layout. Its
10263     * lifetime will be bound to the layout, whenever the layout dies the child
10264     * will be deleted automatically. One should use elm_layout_box_remove() to
10265     * make this layout forget about the object.
10266     *
10267     * @see elm_layout_box_append()
10268     * @see elm_layout_box_prepend()
10269     * @see elm_layout_box_insert_before()
10270     * @see elm_layout_box_remove()
10271     *
10272     * @ingroup Layout
10273     */
10274    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10275    /**
10276     * Insert child to layout box part at a given position.
10277     *
10278     * @param obj the layout object
10279     * @param part the box part to insert.
10280     * @param child the child object to insert into box.
10281     * @param pos the numeric position >=0 to insert the child.
10282     *
10283     * Once the object is inserted, it will become child of the layout. Its
10284     * lifetime will be bound to the layout, whenever the layout dies the child
10285     * will be deleted automatically. One should use elm_layout_box_remove() to
10286     * make this layout forget about the object.
10287     *
10288     * @see elm_layout_box_append()
10289     * @see elm_layout_box_prepend()
10290     * @see elm_layout_box_insert_before()
10291     * @see elm_layout_box_remove()
10292     *
10293     * @ingroup Layout
10294     */
10295    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10296    /**
10297     * Remove a child of the given part box.
10298     *
10299     * @param obj The layout object
10300     * @param part The box part name to remove child.
10301     * @param child The object to remove from box.
10302     * @return The object that was being used, or NULL if not found.
10303     *
10304     * The object will be removed from the box part and its lifetime will
10305     * not be handled by the layout anymore. This is equivalent to
10306     * elm_object_part_content_unset() for box.
10307     *
10308     * @see elm_layout_box_append()
10309     * @see elm_layout_box_remove_all()
10310     *
10311     * @ingroup Layout
10312     */
10313    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10314    /**
10315     * Remove all children of the given part box.
10316     *
10317     * @param obj The layout object
10318     * @param part The box part name to remove child.
10319     * @param clear If EINA_TRUE, then all objects will be deleted as
10320     *        well, otherwise they will just be removed and will be
10321     *        dangling on the canvas.
10322     *
10323     * The objects will be removed from the box part and their lifetime will
10324     * not be handled by the layout anymore. This is equivalent to
10325     * elm_layout_box_remove() for all box children.
10326     *
10327     * @see elm_layout_box_append()
10328     * @see elm_layout_box_remove()
10329     *
10330     * @ingroup Layout
10331     */
10332    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10333    /**
10334     * Insert child to layout table part.
10335     *
10336     * @param obj the layout object
10337     * @param part the box part to pack child.
10338     * @param child_obj the child object to pack into table.
10339     * @param col the column to which the child should be added. (>= 0)
10340     * @param row the row to which the child should be added. (>= 0)
10341     * @param colspan how many columns should be used to store this object. (>=
10342     *        1)
10343     * @param rowspan how many rows should be used to store this object. (>= 1)
10344     *
10345     * Once the object is inserted, it will become child of the table. Its
10346     * lifetime will be bound to the layout, and whenever the layout dies the
10347     * child will be deleted automatically. One should use
10348     * elm_layout_table_remove() to make this layout forget about the object.
10349     *
10350     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10351     * more space than a single cell. For instance, the following code:
10352     * @code
10353     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10354     * @endcode
10355     *
10356     * Would result in an object being added like the following picture:
10357     *
10358     * @image html layout_colspan.png
10359     * @image latex layout_colspan.eps width=\textwidth
10360     *
10361     * @see elm_layout_table_unpack()
10362     * @see elm_layout_table_clear()
10363     *
10364     * @ingroup Layout
10365     */
10366    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);
10367    /**
10368     * Unpack (remove) a child of the given part table.
10369     *
10370     * @param obj The layout object
10371     * @param part The table part name to remove child.
10372     * @param child_obj The object to remove from table.
10373     * @return The object that was being used, or NULL if not found.
10374     *
10375     * The object will be unpacked from the table part and its lifetime
10376     * will not be handled by the layout anymore. This is equivalent to
10377     * elm_object_part_content_unset() for table.
10378     *
10379     * @see elm_layout_table_pack()
10380     * @see elm_layout_table_clear()
10381     *
10382     * @ingroup Layout
10383     */
10384    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10385    /**
10386     * Remove all the child objects of the given part table.
10387     *
10388     * @param obj The layout object
10389     * @param part The table part name to remove child.
10390     * @param clear If EINA_TRUE, then all objects will be deleted as
10391     *        well, otherwise they will just be removed and will be
10392     *        dangling on the canvas.
10393     *
10394     * The objects will be removed from the table part and their lifetime will
10395     * not be handled by the layout anymore. This is equivalent to
10396     * elm_layout_table_unpack() for all table children.
10397     *
10398     * @see elm_layout_table_pack()
10399     * @see elm_layout_table_unpack()
10400     *
10401     * @ingroup Layout
10402     */
10403    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10404    /**
10405     * Get the edje layout
10406     *
10407     * @param obj The layout object
10408     *
10409     * @return A Evas_Object with the edje layout settings loaded
10410     * with function elm_layout_file_set
10411     *
10412     * This returns the edje object. It is not expected to be used to then
10413     * swallow objects via edje_object_part_swallow() for example. Use
10414     * elm_object_part_content_set() instead so child object handling and sizing is
10415     * done properly.
10416     *
10417     * @note This function should only be used if you really need to call some
10418     * low level Edje function on this edje object. All the common stuff (setting
10419     * text, emitting signals, hooking callbacks to signals, etc.) can be done
10420     * with proper elementary functions.
10421     *
10422     * @see elm_object_signal_callback_add()
10423     * @see elm_object_signal_emit()
10424     * @see elm_object_part_text_set()
10425     * @see elm_object_part_content_set()
10426     * @see elm_layout_box_append()
10427     * @see elm_layout_table_pack()
10428     * @see elm_layout_data_get()
10429     *
10430     * @ingroup Layout
10431     */
10432    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10433    /**
10434     * Get the edje data from the given layout
10435     *
10436     * @param obj The layout object
10437     * @param key The data key
10438     *
10439     * @return The edje data string
10440     *
10441     * This function fetches data specified inside the edje theme of this layout.
10442     * This function return NULL if data is not found.
10443     *
10444     * In EDC this comes from a data block within the group block that @p
10445     * obj was loaded from. E.g.
10446     *
10447     * @code
10448     * collections {
10449     *   group {
10450     *     name: "a_group";
10451     *     data {
10452     *       item: "key1" "value1";
10453     *       item: "key2" "value2";
10454     *     }
10455     *   }
10456     * }
10457     * @endcode
10458     *
10459     * @ingroup Layout
10460     */
10461    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10462    /**
10463     * Eval sizing
10464     *
10465     * @param obj The layout object
10466     *
10467     * Manually forces a sizing re-evaluation. This is useful when the minimum
10468     * size required by the edje theme of this layout has changed. The change on
10469     * the minimum size required by the edje theme is not immediately reported to
10470     * the elementary layout, so one needs to call this function in order to tell
10471     * the widget (layout) that it needs to reevaluate its own size.
10472     *
10473     * The minimum size of the theme is calculated based on minimum size of
10474     * parts, the size of elements inside containers like box and table, etc. All
10475     * of this can change due to state changes, and that's when this function
10476     * should be called.
10477     *
10478     * Also note that a standard signal of "size,eval" "elm" emitted from the
10479     * edje object will cause this to happen too.
10480     *
10481     * @ingroup Layout
10482     */
10483    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10484
10485    /**
10486     * Sets a specific cursor for an edje part.
10487     *
10488     * @param obj The layout object.
10489     * @param part_name a part from loaded edje group.
10490     * @param cursor cursor name to use, see Elementary_Cursor.h
10491     *
10492     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10493     *         part not exists or it has "mouse_events: 0".
10494     *
10495     * @ingroup Layout
10496     */
10497    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10498
10499    /**
10500     * Get the cursor to be shown when mouse is over an edje part
10501     *
10502     * @param obj The layout object.
10503     * @param part_name a part from loaded edje group.
10504     * @return the cursor name.
10505     *
10506     * @ingroup Layout
10507     */
10508    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10509
10510    /**
10511     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10512     *
10513     * @param obj The layout object.
10514     * @param part_name a part from loaded edje group, that had a cursor set
10515     *        with elm_layout_part_cursor_set().
10516     *
10517     * @ingroup Layout
10518     */
10519    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10520
10521    /**
10522     * Sets a specific cursor style for an edje part.
10523     *
10524     * @param obj The layout object.
10525     * @param part_name a part from loaded edje group.
10526     * @param style the theme style to use (default, transparent, ...)
10527     *
10528     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10529     *         part not exists or it did not had a cursor set.
10530     *
10531     * @ingroup Layout
10532     */
10533    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10534
10535    /**
10536     * Gets a specific cursor style for an edje part.
10537     *
10538     * @param obj The layout object.
10539     * @param part_name a part from loaded edje group.
10540     *
10541     * @return the theme style in use, defaults to "default". If the
10542     *         object does not have a cursor set, then NULL is returned.
10543     *
10544     * @ingroup Layout
10545     */
10546    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10547
10548    /**
10549     * Sets if the cursor set should be searched on the theme or should use
10550     * the provided by the engine, only.
10551     *
10552     * @note before you set if should look on theme you should define a
10553     * cursor with elm_layout_part_cursor_set(). By default it will only
10554     * look for cursors provided by the engine.
10555     *
10556     * @param obj The layout object.
10557     * @param part_name a part from loaded edje group.
10558     * @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
10559     *        or should also search on widget's theme as well (EINA_FALSE)
10560     *
10561     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10562     *         part not exists or it did not had a cursor set.
10563     *
10564     * @ingroup Layout
10565     */
10566    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);
10567
10568    /**
10569     * Gets a specific cursor engine_only for an edje part.
10570     *
10571     * @param obj The layout object.
10572     * @param part_name a part from loaded edje group.
10573     *
10574     * @return whenever the cursor is just provided by engine or also from theme.
10575     *
10576     * @ingroup Layout
10577     */
10578    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10579
10580 /**
10581  * @def elm_layout_icon_set
10582  * Convenience macro to set the icon object in a layout that follows the
10583  * Elementary naming convention for its parts.
10584  *
10585  * @ingroup Layout
10586  */
10587 #define elm_layout_icon_set(_ly, _obj) \
10588   do { \
10589     const char *sig; \
10590     elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10591     if ((_obj)) sig = "elm,state,icon,visible"; \
10592     else sig = "elm,state,icon,hidden"; \
10593     elm_object_signal_emit((_ly), sig, "elm"); \
10594   } while (0)
10595
10596 /**
10597  * @def elm_layout_icon_get
10598  * Convienience macro to get the icon object from a layout that follows the
10599  * Elementary naming convention for its parts.
10600  *
10601  * @ingroup Layout
10602  */
10603 #define elm_layout_icon_get(_ly) \
10604   elm_object_part_content_get((_ly), "elm.swallow.icon")
10605
10606 /**
10607  * @def elm_layout_end_set
10608  * Convienience macro to set the end object in a layout that follows the
10609  * Elementary naming convention for its parts.
10610  *
10611  * @ingroup Layout
10612  */
10613 #define elm_layout_end_set(_ly, _obj) \
10614   do { \
10615     const char *sig; \
10616     elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10617     if ((_obj)) sig = "elm,state,end,visible"; \
10618     else sig = "elm,state,end,hidden"; \
10619     elm_object_signal_emit((_ly), sig, "elm"); \
10620   } while (0)
10621
10622 /**
10623  * @def elm_layout_end_get
10624  * Convienience macro to get the end object in a layout that follows the
10625  * Elementary naming convention for its parts.
10626  *
10627  * @ingroup Layout
10628  */
10629 #define elm_layout_end_get(_ly) \
10630   elm_object_part_content_get((_ly), "elm.swallow.end")
10631
10632 /**
10633  * @def elm_layout_label_set
10634  * Convienience macro to set the label in a layout that follows the
10635  * Elementary naming convention for its parts.
10636  *
10637  * @ingroup Layout
10638  * @deprecated use elm_object_text_set() instead.
10639  */
10640 #define elm_layout_label_set(_ly, _txt) \
10641   elm_layout_text_set((_ly), "elm.text", (_txt))
10642
10643 /**
10644  * @def elm_layout_label_get
10645  * Convenience macro to get the label in a layout that follows the
10646  * Elementary naming convention for its parts.
10647  *
10648  * @ingroup Layout
10649  * @deprecated use elm_object_text_set() instead.
10650  */
10651 #define elm_layout_label_get(_ly) \
10652   elm_layout_text_get((_ly), "elm.text")
10653
10654    /* smart callbacks called:
10655     * "theme,changed" - when elm theme is changed.
10656     */
10657
10658    /**
10659     * @defgroup Notify Notify
10660     *
10661     * @image html img/widget/notify/preview-00.png
10662     * @image latex img/widget/notify/preview-00.eps
10663     *
10664     * Display a container in a particular region of the parent(top, bottom,
10665     * etc).  A timeout can be set to automatically hide the notify. This is so
10666     * that, after an evas_object_show() on a notify object, if a timeout was set
10667     * on it, it will @b automatically get hidden after that time.
10668     *
10669     * Signals that you can add callbacks for are:
10670     * @li "timeout" - when timeout happens on notify and it's hidden
10671     * @li "block,clicked" - when a click outside of the notify happens
10672     *
10673     * Default contents parts of the notify widget that you can use for are:
10674     * @li "default" - A content of the notify
10675     *
10676     * @ref tutorial_notify show usage of the API.
10677     *
10678     * @{
10679     */
10680    /**
10681     * @brief Possible orient values for notify.
10682     *
10683     * This values should be used in conjunction to elm_notify_orient_set() to
10684     * set the position in which the notify should appear(relative to its parent)
10685     * and in conjunction with elm_notify_orient_get() to know where the notify
10686     * is appearing.
10687     */
10688    typedef enum _Elm_Notify_Orient
10689      {
10690         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10691         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10692         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10693         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10694         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10695         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10696         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10697         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10698         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10699         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10700      } Elm_Notify_Orient;
10701    /**
10702     * @brief Add a new notify to the parent
10703     *
10704     * @param parent The parent object
10705     * @return The new object or NULL if it cannot be created
10706     */
10707    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10708    /**
10709     * @brief Set the content of the notify widget
10710     *
10711     * @param obj The notify object
10712     * @param content The content will be filled in this notify object
10713     *
10714     * Once the content object is set, a previously set one will be deleted. If
10715     * you want to keep that old content object, use the
10716     * elm_notify_content_unset() function.
10717     *
10718     * @deprecated use elm_object_content_set() instead
10719     *
10720     */
10721    EINA_DEPRECATED EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10722    /**
10723     * @brief Unset the content of the notify widget
10724     *
10725     * @param obj The notify object
10726     * @return The content that was being used
10727     *
10728     * Unparent and return the content object which was set for this widget
10729     *
10730     * @see elm_notify_content_set()
10731     * @deprecated use elm_object_content_unset() instead
10732     *
10733     */
10734    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10735    /**
10736     * @brief Return the content of the notify widget
10737     *
10738     * @param obj The notify object
10739     * @return The content that is being used
10740     *
10741     * @see elm_notify_content_set()
10742     * @deprecated use elm_object_content_get() instead
10743     *
10744     */
10745    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10746    /**
10747     * @brief Set the notify parent
10748     *
10749     * @param obj The notify object
10750     * @param content The new parent
10751     *
10752     * Once the parent object is set, a previously set one will be disconnected
10753     * and replaced.
10754     */
10755    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10756    /**
10757     * @brief Get the notify parent
10758     *
10759     * @param obj The notify object
10760     * @return The parent
10761     *
10762     * @see elm_notify_parent_set()
10763     */
10764    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10765    /**
10766     * @brief Set the orientation
10767     *
10768     * @param obj The notify object
10769     * @param orient The new orientation
10770     *
10771     * Sets the position in which the notify will appear in its parent.
10772     *
10773     * @see @ref Elm_Notify_Orient for possible values.
10774     */
10775    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10776    /**
10777     * @brief Return the orientation
10778     * @param obj The notify object
10779     * @return The orientation of the notification
10780     *
10781     * @see elm_notify_orient_set()
10782     * @see Elm_Notify_Orient
10783     */
10784    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10785    /**
10786     * @brief Set the time interval after which the notify window is going to be
10787     * hidden.
10788     *
10789     * @param obj The notify object
10790     * @param time The timeout in seconds
10791     *
10792     * This function sets a timeout and starts the timer controlling when the
10793     * notify is hidden. Since calling evas_object_show() on a notify restarts
10794     * the timer controlling when the notify is hidden, setting this before the
10795     * notify is shown will in effect mean starting the timer when the notify is
10796     * shown.
10797     *
10798     * @note Set a value <= 0.0 to disable a running timer.
10799     *
10800     * @note If the value > 0.0 and the notify is previously visible, the
10801     * timer will be started with this value, canceling any running timer.
10802     */
10803    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10804    /**
10805     * @brief Return the timeout value (in seconds)
10806     * @param obj the notify object
10807     *
10808     * @see elm_notify_timeout_set()
10809     */
10810    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10811    /**
10812     * @brief Sets whether events should be passed to by a click outside
10813     * its area.
10814     *
10815     * @param obj The notify object
10816     * @param repeats EINA_TRUE Events are repeats, else no
10817     *
10818     * When true if the user clicks outside the window the events will be caught
10819     * by the others widgets, else the events are blocked.
10820     *
10821     * @note The default value is EINA_TRUE.
10822     */
10823    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10824    /**
10825     * @brief Return true if events are repeat below the notify object
10826     * @param obj the notify object
10827     *
10828     * @see elm_notify_repeat_events_set()
10829     */
10830    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10831    /**
10832     * @}
10833     */
10834
10835    /**
10836     * @defgroup Hover Hover
10837     *
10838     * @image html img/widget/hover/preview-00.png
10839     * @image latex img/widget/hover/preview-00.eps
10840     *
10841     * A Hover object will hover over its @p parent object at the @p target
10842     * location. Anything in the background will be given a darker coloring to
10843     * indicate that the hover object is on top (at the default theme). When the
10844     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10845     * clicked that @b doesn't cause the hover to be dismissed.
10846     *
10847     * A Hover object has two parents. One parent that owns it during creation
10848     * and the other parent being the one over which the hover object spans.
10849     *
10850     *
10851     * @note The hover object will take up the entire space of @p target
10852     * object.
10853     *
10854     * Elementary has the following styles for the hover widget:
10855     * @li default
10856     * @li popout
10857     * @li menu
10858     * @li hoversel_vertical
10859     *
10860     * The following are the available position for content:
10861     * @li left
10862     * @li top-left
10863     * @li top
10864     * @li top-right
10865     * @li right
10866     * @li bottom-right
10867     * @li bottom
10868     * @li bottom-left
10869     * @li middle
10870     * @li smart
10871     *
10872     * Signals that you can add callbacks for are:
10873     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10874     * @li "smart,changed" - a content object placed under the "smart"
10875     *                   policy was replaced to a new slot direction.
10876     *
10877     * See @ref tutorial_hover for more information.
10878     *
10879     * @{
10880     */
10881    typedef enum _Elm_Hover_Axis
10882      {
10883         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10884         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10885         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10886         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10887      } Elm_Hover_Axis;
10888    /**
10889     * @brief Adds a hover object to @p parent
10890     *
10891     * @param parent The parent object
10892     * @return The hover object or NULL if one could not be created
10893     */
10894    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10895    /**
10896     * @brief Sets the target object for the hover.
10897     *
10898     * @param obj The hover object
10899     * @param target The object to center the hover onto.
10900     *
10901     * This function will cause the hover to be centered on the target object.
10902     */
10903    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10904    /**
10905     * @brief Gets the target object for the hover.
10906     *
10907     * @param obj The hover object
10908     * @return The target object for the hover.
10909     *
10910     * @see elm_hover_target_set()
10911     */
10912    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10913    /**
10914     * @brief Sets the parent object for the hover.
10915     *
10916     * @param obj The hover object
10917     * @param parent The object to locate the hover over.
10918     *
10919     * This function will cause the hover to take up the entire space that the
10920     * parent object fills.
10921     */
10922    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10923    /**
10924     * @brief Gets the parent object for the hover.
10925     *
10926     * @param obj The hover object
10927     * @return The parent object to locate the hover over.
10928     *
10929     * @see elm_hover_parent_set()
10930     */
10931    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10932    /**
10933     * @brief Sets the content of the hover object and the direction in which it
10934     * will pop out.
10935     *
10936     * @param obj The hover object
10937     * @param swallow The direction that the object will be displayed
10938     * at. Accepted values are "left", "top-left", "top", "top-right",
10939     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10940     * "smart".
10941     * @param content The content to place at @p swallow
10942     *
10943     * Once the content object is set for a given direction, a previously
10944     * set one (on the same direction) will be deleted. If you want to
10945     * keep that old content object, use the elm_hover_content_unset()
10946     * function.
10947     *
10948     * All directions may have contents at the same time, except for
10949     * "smart". This is a special placement hint and its use case
10950     * independs of the calculations coming from
10951     * elm_hover_best_content_location_get(). Its use is for cases when
10952     * one desires only one hover content, but with a dynamic special
10953     * placement within the hover area. The content's geometry, whenever
10954     * it changes, will be used to decide on a best location, not
10955     * extrapolating the hover's parent object view to show it in (still
10956     * being the hover's target determinant of its medium part -- move and
10957     * resize it to simulate finger sizes, for example). If one of the
10958     * directions other than "smart" are used, a previously content set
10959     * using it will be deleted, and vice-versa.
10960     */
10961    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10962    /**
10963     * @brief Get the content of the hover object, in a given direction.
10964     *
10965     * Return the content object which was set for this widget in the
10966     * @p swallow direction.
10967     *
10968     * @param obj The hover object
10969     * @param swallow The direction that the object was display at.
10970     * @return The content that was being used
10971     *
10972     * @see elm_hover_content_set()
10973     */
10974    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10975    /**
10976     * @brief Unset the content of the hover object, in a given direction.
10977     *
10978     * Unparent and return the content object set at @p swallow direction.
10979     *
10980     * @param obj The hover object
10981     * @param swallow The direction that the object was display at.
10982     * @return The content that was being used.
10983     *
10984     * @see elm_hover_content_set()
10985     */
10986    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10987    /**
10988     * @brief Returns the best swallow location for content in the hover.
10989     *
10990     * @param obj The hover object
10991     * @param pref_axis The preferred orientation axis for the hover object to use
10992     * @return The edje location to place content into the hover or @c
10993     *         NULL, on errors.
10994     *
10995     * Best is defined here as the location at which there is the most available
10996     * space.
10997     *
10998     * @p pref_axis may be one of
10999     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
11000     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
11001     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
11002     * - @c ELM_HOVER_AXIS_BOTH -- both
11003     *
11004     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
11005     * nescessarily be along the horizontal axis("left" or "right"). If
11006     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
11007     * be along the vertical axis("top" or "bottom"). Chossing
11008     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
11009     * returned position may be in either axis.
11010     *
11011     * @see elm_hover_content_set()
11012     */
11013    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
11014    /**
11015     * @}
11016     */
11017
11018    /* entry */
11019    /**
11020     * @defgroup Entry Entry
11021     *
11022     * @image html img/widget/entry/preview-00.png
11023     * @image latex img/widget/entry/preview-00.eps width=\textwidth
11024     * @image html img/widget/entry/preview-01.png
11025     * @image latex img/widget/entry/preview-01.eps width=\textwidth
11026     * @image html img/widget/entry/preview-02.png
11027     * @image latex img/widget/entry/preview-02.eps width=\textwidth
11028     * @image html img/widget/entry/preview-03.png
11029     * @image latex img/widget/entry/preview-03.eps width=\textwidth
11030     *
11031     * An entry is a convenience widget which shows a box that the user can
11032     * enter text into. Entries by default don't scroll, so they grow to
11033     * accomodate the entire text, resizing the parent window as needed. This
11034     * can be changed with the elm_entry_scrollable_set() function.
11035     *
11036     * They can also be single line or multi line (the default) and when set
11037     * to multi line mode they support text wrapping in any of the modes
11038     * indicated by #Elm_Wrap_Type.
11039     *
11040     * Other features include password mode, filtering of inserted text with
11041     * elm_entry_text_filter_append() and related functions, inline "items" and
11042     * formatted markup text.
11043     *
11044     * @section entry-markup Formatted text
11045     *
11046     * The markup tags supported by the Entry are defined by the theme, but
11047     * even when writing new themes or extensions it's a good idea to stick to
11048     * a sane default, to maintain coherency and avoid application breakages.
11049     * Currently defined by the default theme are the following tags:
11050     * @li \<br\>: Inserts a line break.
11051     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
11052     * breaks.
11053     * @li \<tab\>: Inserts a tab.
11054     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
11055     * enclosed text.
11056     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
11057     * @li \<link\>...\</link\>: Underlines the enclosed text.
11058     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
11059     *
11060     * @section entry-special Special markups
11061     *
11062     * Besides those used to format text, entries support two special markup
11063     * tags used to insert clickable portions of text or items inlined within
11064     * the text.
11065     *
11066     * @subsection entry-anchors Anchors
11067     *
11068     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
11069     * \</a\> tags and an event will be generated when this text is clicked,
11070     * like this:
11071     *
11072     * @code
11073     * This text is outside <a href=anc-01>but this one is an anchor</a>
11074     * @endcode
11075     *
11076     * The @c href attribute in the opening tag gives the name that will be
11077     * used to identify the anchor and it can be any valid utf8 string.
11078     *
11079     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
11080     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
11081     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
11082     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
11083     * an anchor.
11084     *
11085     * @subsection entry-items Items
11086     *
11087     * Inlined in the text, any other @c Evas_Object can be inserted by using
11088     * \<item\> tags this way:
11089     *
11090     * @code
11091     * <item size=16x16 vsize=full href=emoticon/haha></item>
11092     * @endcode
11093     *
11094     * Just like with anchors, the @c href identifies each item, but these need,
11095     * in addition, to indicate their size, which is done using any one of
11096     * @c size, @c absize or @c relsize attributes. These attributes take their
11097     * value in the WxH format, where W is the width and H the height of the
11098     * item.
11099     *
11100     * @li absize: Absolute pixel size for the item. Whatever value is set will
11101     * be the item's size regardless of any scale value the object may have
11102     * been set to. The final line height will be adjusted to fit larger items.
11103     * @li size: Similar to @c absize, but it's adjusted to the scale value set
11104     * for the object.
11105     * @li relsize: Size is adjusted for the item to fit within the current
11106     * line height.
11107     *
11108     * Besides their size, items are specificed a @c vsize value that affects
11109     * how their final size and position are calculated. The possible values
11110     * are:
11111     * @li ascent: Item will be placed within the line's baseline and its
11112     * ascent. That is, the height between the line where all characters are
11113     * positioned and the highest point in the line. For @c size and @c absize
11114     * items, the descent value will be added to the total line height to make
11115     * them fit. @c relsize items will be adjusted to fit within this space.
11116     * @li full: Items will be placed between the descent and ascent, or the
11117     * lowest point in the line and its highest.
11118     *
11119     * The next image shows different configurations of items and how
11120     * the previously mentioned options affect their sizes. In all cases,
11121     * the green line indicates the ascent, blue for the baseline and red for
11122     * the descent.
11123     *
11124     * @image html entry_item.png
11125     * @image latex entry_item.eps width=\textwidth
11126     *
11127     * And another one to show how size differs from absize. In the first one,
11128     * the scale value is set to 1.0, while the second one is using one of 2.0.
11129     *
11130     * @image html entry_item_scale.png
11131     * @image latex entry_item_scale.eps width=\textwidth
11132     *
11133     * After the size for an item is calculated, the entry will request an
11134     * object to place in its space. For this, the functions set with
11135     * elm_entry_item_provider_append() and related functions will be called
11136     * in order until one of them returns a @c non-NULL value. If no providers
11137     * are available, or all of them return @c NULL, then the entry falls back
11138     * to one of the internal defaults, provided the name matches with one of
11139     * them.
11140     *
11141     * All of the following are currently supported:
11142     *
11143     * - emoticon/angry
11144     * - emoticon/angry-shout
11145     * - emoticon/crazy-laugh
11146     * - emoticon/evil-laugh
11147     * - emoticon/evil
11148     * - emoticon/goggle-smile
11149     * - emoticon/grumpy
11150     * - emoticon/grumpy-smile
11151     * - emoticon/guilty
11152     * - emoticon/guilty-smile
11153     * - emoticon/haha
11154     * - emoticon/half-smile
11155     * - emoticon/happy-panting
11156     * - emoticon/happy
11157     * - emoticon/indifferent
11158     * - emoticon/kiss
11159     * - emoticon/knowing-grin
11160     * - emoticon/laugh
11161     * - emoticon/little-bit-sorry
11162     * - emoticon/love-lots
11163     * - emoticon/love
11164     * - emoticon/minimal-smile
11165     * - emoticon/not-happy
11166     * - emoticon/not-impressed
11167     * - emoticon/omg
11168     * - emoticon/opensmile
11169     * - emoticon/smile
11170     * - emoticon/sorry
11171     * - emoticon/squint-laugh
11172     * - emoticon/surprised
11173     * - emoticon/suspicious
11174     * - emoticon/tongue-dangling
11175     * - emoticon/tongue-poke
11176     * - emoticon/uh
11177     * - emoticon/unhappy
11178     * - emoticon/very-sorry
11179     * - emoticon/what
11180     * - emoticon/wink
11181     * - emoticon/worried
11182     * - emoticon/wtf
11183     *
11184     * Alternatively, an item may reference an image by its path, using
11185     * the URI form @c file:///path/to/an/image.png and the entry will then
11186     * use that image for the item.
11187     *
11188     * @section entry-files Loading and saving files
11189     *
11190     * Entries have convinience functions to load text from a file and save
11191     * changes back to it after a short delay. The automatic saving is enabled
11192     * by default, but can be disabled with elm_entry_autosave_set() and files
11193     * can be loaded directly as plain text or have any markup in them
11194     * recognized. See elm_entry_file_set() for more details.
11195     *
11196     * @section entry-signals Emitted signals
11197     *
11198     * This widget emits the following signals:
11199     *
11200     * @li "changed": The text within the entry was changed.
11201     * @li "changed,user": The text within the entry was changed because of user interaction.
11202     * @li "activated": The enter key was pressed on a single line entry.
11203     * @li "press": A mouse button has been pressed on the entry.
11204     * @li "longpressed": A mouse button has been pressed and held for a couple
11205     * seconds.
11206     * @li "clicked": The entry has been clicked (mouse press and release).
11207     * @li "clicked,double": The entry has been double clicked.
11208     * @li "clicked,triple": The entry has been triple clicked.
11209     * @li "focused": The entry has received focus.
11210     * @li "unfocused": The entry has lost focus.
11211     * @li "selection,paste": A paste of the clipboard contents was requested.
11212     * @li "selection,copy": A copy of the selected text into the clipboard was
11213     * requested.
11214     * @li "selection,cut": A cut of the selected text into the clipboard was
11215     * requested.
11216     * @li "selection,start": A selection has begun and no previous selection
11217     * existed.
11218     * @li "selection,changed": The current selection has changed.
11219     * @li "selection,cleared": The current selection has been cleared.
11220     * @li "cursor,changed": The cursor has changed position.
11221     * @li "anchor,clicked": An anchor has been clicked. The event_info
11222     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11223     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11224     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11225     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11226     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11227     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11228     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11229     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11230     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11231     * @li "preedit,changed": The preedit string has changed.
11232     * @li "language,changed": Program language changed.
11233     *
11234     * @section entry-examples
11235     *
11236     * An overview of the Entry API can be seen in @ref entry_example_01
11237     *
11238     * @{
11239     */
11240    /**
11241     * @typedef Elm_Entry_Anchor_Info
11242     *
11243     * The info sent in the callback for the "anchor,clicked" signals emitted
11244     * by entries.
11245     */
11246    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11247    /**
11248     * @struct _Elm_Entry_Anchor_Info
11249     *
11250     * The info sent in the callback for the "anchor,clicked" signals emitted
11251     * by entries.
11252     */
11253    struct _Elm_Entry_Anchor_Info
11254      {
11255         const char *name; /**< The name of the anchor, as stated in its href */
11256         int         button; /**< The mouse button used to click on it */
11257         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
11258                     y, /**< Anchor geometry, relative to canvas */
11259                     w, /**< Anchor geometry, relative to canvas */
11260                     h; /**< Anchor geometry, relative to canvas */
11261      };
11262    /**
11263     * @typedef Elm_Entry_Filter_Cb
11264     * This callback type is used by entry filters to modify text.
11265     * @param data The data specified as the last param when adding the filter
11266     * @param entry The entry object
11267     * @param text A pointer to the location of the text being filtered. This data can be modified,
11268     * but any additional allocations must be managed by the user.
11269     * @see elm_entry_text_filter_append
11270     * @see elm_entry_text_filter_prepend
11271     */
11272    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11273
11274    /**
11275     * @typedef Elm_Entry_Change_Info
11276     * This corresponds to Edje_Entry_Change_Info. Includes information about
11277     * a change in the entry.
11278     */
11279    typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
11280
11281
11282    /**
11283     * This adds an entry to @p parent object.
11284     *
11285     * By default, entries are:
11286     * @li not scrolled
11287     * @li multi-line
11288     * @li word wrapped
11289     * @li autosave is enabled
11290     *
11291     * @param parent The parent object
11292     * @return The new object or NULL if it cannot be created
11293     */
11294    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11295    /**
11296     * Sets the entry to single line mode.
11297     *
11298     * In single line mode, entries don't ever wrap when the text reaches the
11299     * edge, and instead they keep growing horizontally. Pressing the @c Enter
11300     * key will generate an @c "activate" event instead of adding a new line.
11301     *
11302     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11303     * and pressing enter will break the text into a different line
11304     * without generating any events.
11305     *
11306     * @param obj The entry object
11307     * @param single_line If true, the text in the entry
11308     * will be on a single line.
11309     */
11310    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11311    /**
11312     * Gets whether the entry is set to be single line.
11313     *
11314     * @param obj The entry object
11315     * @return single_line If true, the text in the entry is set to display
11316     * on a single line.
11317     *
11318     * @see elm_entry_single_line_set()
11319     */
11320    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11321    /**
11322     * Sets the entry to password mode.
11323     *
11324     * In password mode, entries are implicitly single line and the display of
11325     * any text in them is replaced with asterisks (*).
11326     *
11327     * @param obj The entry object
11328     * @param password If true, password mode is enabled.
11329     */
11330    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11331    /**
11332     * Gets whether the entry is set to password mode.
11333     *
11334     * @param obj The entry object
11335     * @return If true, the entry is set to display all characters
11336     * as asterisks (*).
11337     *
11338     * @see elm_entry_password_set()
11339     */
11340    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11341    /**
11342     * This sets the text displayed within the entry to @p entry.
11343     *
11344     * @param obj The entry object
11345     * @param entry The text to be displayed
11346     *
11347     * @deprecated Use elm_object_text_set() instead.
11348     * @note Using this function bypasses text filters
11349     */
11350    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11351    /**
11352     * This returns the text currently shown in object @p entry.
11353     * See also elm_entry_entry_set().
11354     *
11355     * @param obj The entry object
11356     * @return The currently displayed text or NULL on failure
11357     *
11358     * @deprecated Use elm_object_text_get() instead.
11359     */
11360    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11361    /**
11362     * Appends @p entry to the text of the entry.
11363     *
11364     * Adds the text in @p entry to the end of any text already present in the
11365     * widget.
11366     *
11367     * The appended text is subject to any filters set for the widget.
11368     *
11369     * @param obj The entry object
11370     * @param entry The text to be displayed
11371     *
11372     * @see elm_entry_text_filter_append()
11373     */
11374    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11375    /**
11376     * Gets whether the entry is empty.
11377     *
11378     * Empty means no text at all. If there are any markup tags, like an item
11379     * tag for which no provider finds anything, and no text is displayed, this
11380     * function still returns EINA_FALSE.
11381     *
11382     * @param obj The entry object
11383     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11384     */
11385    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11386    /**
11387     * Gets any selected text within the entry.
11388     *
11389     * If there's any selected text in the entry, this function returns it as
11390     * a string in markup format. NULL is returned if no selection exists or
11391     * if an error occurred.
11392     *
11393     * The returned value points to an internal string and should not be freed
11394     * or modified in any way. If the @p entry object is deleted or its
11395     * contents are changed, the returned pointer should be considered invalid.
11396     *
11397     * @param obj The entry object
11398     * @return The selected text within the entry or NULL on failure
11399     */
11400    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11401    /**
11402     * Returns the actual textblock object of the entry.
11403     *
11404     * This function exposes the internal textblock object that actually
11405     * contains and draws the text. This should be used for low-level
11406     * manipulations that are otherwise not possible.
11407     *
11408     * Changing the textblock directly from here will not notify edje/elm to
11409     * recalculate the textblock size automatically, so any modifications
11410     * done to the textblock returned by this function should be followed by
11411     * a call to elm_entry_calc_force().
11412     *
11413     * The return value is marked as const as an additional warning.
11414     * One should not use the returned object with any of the generic evas
11415     * functions (geometry_get/resize/move and etc), but only with the textblock
11416     * functions; The former will either not work at all, or break the correct
11417     * functionality.
11418     *
11419     * IMPORTANT: Many functions may change (i.e delete and create a new one)
11420     * the internal textblock object. Do NOT cache the returned object, and try
11421     * not to mix calls on this object with regular elm_entry calls (which may
11422     * change the internal textblock object). This applies to all cursors
11423     * returned from textblock calls, and all the other derivative values.
11424     *
11425     * @param obj The entry object
11426     * @return The textblock object.
11427     */
11428    EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11429    /**
11430     * Forces calculation of the entry size and text layouting.
11431     *
11432     * This should be used after modifying the textblock object directly. See
11433     * elm_entry_textblock_get() for more information.
11434     *
11435     * @param obj The entry object
11436     *
11437     * @see elm_entry_textblock_get()
11438     */
11439    EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11440    /**
11441     * Inserts the given text into the entry at the current cursor position.
11442     *
11443     * This inserts text at the cursor position as if it was typed
11444     * by the user (note that this also allows markup which a user
11445     * can't just "type" as it would be converted to escaped text, so this
11446     * call can be used to insert things like emoticon items or bold push/pop
11447     * tags, other font and color change tags etc.)
11448     *
11449     * If any selection exists, it will be replaced by the inserted text.
11450     *
11451     * The inserted text is subject to any filters set for the widget.
11452     *
11453     * @param obj The entry object
11454     * @param entry The text to insert
11455     *
11456     * @see elm_entry_text_filter_append()
11457     */
11458    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11459    /**
11460     * Set the line wrap type to use on multi-line entries.
11461     *
11462     * Sets the wrap type used by the entry to any of the specified in
11463     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11464     * line (without inserting a line break or paragraph separator) when it
11465     * reaches the far edge of the widget.
11466     *
11467     * Note that this only makes sense for multi-line entries. A widget set
11468     * to be single line will never wrap.
11469     *
11470     * @param obj The entry object
11471     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11472     */
11473    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11474    /**
11475     * Gets the wrap mode the entry was set to use.
11476     *
11477     * @param obj The entry object
11478     * @return Wrap type
11479     *
11480     * @see also elm_entry_line_wrap_set()
11481     */
11482    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11483    /**
11484     * Sets if the entry is to be editable or not.
11485     *
11486     * By default, entries are editable and when focused, any text input by the
11487     * user will be inserted at the current cursor position. But calling this
11488     * function with @p editable as EINA_FALSE will prevent the user from
11489     * inputting text into the entry.
11490     *
11491     * The only way to change the text of a non-editable entry is to use
11492     * elm_object_text_set(), elm_entry_entry_insert() and other related
11493     * functions.
11494     *
11495     * @param obj The entry object
11496     * @param editable If EINA_TRUE, user input will be inserted in the entry,
11497     * if not, the entry is read-only and no user input is allowed.
11498     */
11499    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11500    /**
11501     * Gets whether the entry is editable or not.
11502     *
11503     * @param obj The entry object
11504     * @return If true, the entry is editable by the user.
11505     * If false, it is not editable by the user
11506     *
11507     * @see elm_entry_editable_set()
11508     */
11509    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11510    /**
11511     * This drops any existing text selection within the entry.
11512     *
11513     * @param obj The entry object
11514     */
11515    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11516    /**
11517     * This selects all text within the entry.
11518     *
11519     * @param obj The entry object
11520     */
11521    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11522    /**
11523     * This moves the cursor one place to the right within the entry.
11524     *
11525     * @param obj The entry object
11526     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11527     */
11528    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11529    /**
11530     * This moves the cursor one place to the left within the entry.
11531     *
11532     * @param obj The entry object
11533     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11534     */
11535    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11536    /**
11537     * This moves the cursor one line up within the entry.
11538     *
11539     * @param obj The entry object
11540     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11541     */
11542    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11543    /**
11544     * This moves the cursor one line down within the entry.
11545     *
11546     * @param obj The entry object
11547     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11548     */
11549    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11550    /**
11551     * This moves the cursor to the beginning of the entry.
11552     *
11553     * @param obj The entry object
11554     */
11555    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11556    /**
11557     * This moves the cursor to the end of the entry.
11558     *
11559     * @param obj The entry object
11560     */
11561    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11562    /**
11563     * This moves the cursor to the beginning of the current line.
11564     *
11565     * @param obj The entry object
11566     */
11567    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11568    /**
11569     * This moves the cursor to the end of the current line.
11570     *
11571     * @param obj The entry object
11572     */
11573    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11574    /**
11575     * This begins a selection within the entry as though
11576     * the user were holding down the mouse button to make a selection.
11577     *
11578     * @param obj The entry object
11579     */
11580    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11581    /**
11582     * This ends a selection within the entry as though
11583     * the user had just released the mouse button while making a selection.
11584     *
11585     * @param obj The entry object
11586     */
11587    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11588    /**
11589     * Gets whether a format node exists at the current cursor position.
11590     *
11591     * A format node is anything that defines how the text is rendered. It can
11592     * be a visible format node, such as a line break or a paragraph separator,
11593     * or an invisible one, such as bold begin or end tag.
11594     * This function returns whether any format node exists at the current
11595     * cursor position.
11596     *
11597     * @param obj The entry object
11598     * @return EINA_TRUE if the current cursor position contains a format node,
11599     * EINA_FALSE otherwise.
11600     *
11601     * @see elm_entry_cursor_is_visible_format_get()
11602     */
11603    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11604    /**
11605     * Gets if the current cursor position holds a visible format node.
11606     *
11607     * @param obj The entry object
11608     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11609     * if it's an invisible one or no format exists.
11610     *
11611     * @see elm_entry_cursor_is_format_get()
11612     */
11613    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11614    /**
11615     * Gets the character pointed by the cursor at its current position.
11616     *
11617     * This function returns a string with the utf8 character stored at the
11618     * current cursor position.
11619     * Only the text is returned, any format that may exist will not be part
11620     * of the return value.
11621     *
11622     * @param obj The entry object
11623     * @return The text pointed by the cursors.
11624     */
11625    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11626    /**
11627     * This function returns the geometry of the cursor.
11628     *
11629     * It's useful if you want to draw something on the cursor (or where it is),
11630     * or for example in the case of scrolled entry where you want to show the
11631     * cursor.
11632     *
11633     * @param obj The entry object
11634     * @param x returned geometry
11635     * @param y returned geometry
11636     * @param w returned geometry
11637     * @param h returned geometry
11638     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11639     */
11640    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);
11641    /**
11642     * Sets the cursor position in the entry to the given value
11643     *
11644     * The value in @p pos is the index of the character position within the
11645     * contents of the string as returned by elm_entry_cursor_pos_get().
11646     *
11647     * @param obj The entry object
11648     * @param pos The position of the cursor
11649     */
11650    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11651    /**
11652     * Retrieves the current position of the cursor in the entry
11653     *
11654     * @param obj The entry object
11655     * @return The cursor position
11656     */
11657    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11658    /**
11659     * This executes a "cut" action on the selected text in the entry.
11660     *
11661     * @param obj The entry object
11662     */
11663    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11664    /**
11665     * This executes a "copy" action on the selected text in the entry.
11666     *
11667     * @param obj The entry object
11668     */
11669    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11670    /**
11671     * This executes a "paste" action in the entry.
11672     *
11673     * @param obj The entry object
11674     */
11675    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11676    /**
11677     * This clears and frees the items in a entry's contextual (longpress)
11678     * menu.
11679     *
11680     * @param obj The entry object
11681     *
11682     * @see elm_entry_context_menu_item_add()
11683     */
11684    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11685    /**
11686     * This adds an item to the entry's contextual menu.
11687     *
11688     * A longpress on an entry will make the contextual menu show up, if this
11689     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11690     * By default, this menu provides a few options like enabling selection mode,
11691     * which is useful on embedded devices that need to be explicit about it,
11692     * and when a selection exists it also shows the copy and cut actions.
11693     *
11694     * With this function, developers can add other options to this menu to
11695     * perform any action they deem necessary.
11696     *
11697     * @param obj The entry object
11698     * @param label The item's text label
11699     * @param icon_file The item's icon file
11700     * @param icon_type The item's icon type
11701     * @param func The callback to execute when the item is clicked
11702     * @param data The data to associate with the item for related functions
11703     */
11704    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);
11705    /**
11706     * This disables the entry's contextual (longpress) menu.
11707     *
11708     * @param obj The entry object
11709     * @param disabled If true, the menu is disabled
11710     */
11711    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11712    /**
11713     * This returns whether the entry's contextual (longpress) menu is
11714     * disabled.
11715     *
11716     * @param obj The entry object
11717     * @return If true, the menu is disabled
11718     */
11719    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11720    /**
11721     * This appends a custom item provider to the list for that entry
11722     *
11723     * This appends the given callback. The list is walked from beginning to end
11724     * with each function called given the item href string in the text. If the
11725     * function returns an object handle other than NULL (it should create an
11726     * object to do this), then this object is used to replace that item. If
11727     * not the next provider is called until one provides an item object, or the
11728     * default provider in entry does.
11729     *
11730     * @param obj The entry object
11731     * @param func The function called to provide the item object
11732     * @param data The data passed to @p func
11733     *
11734     * @see @ref entry-items
11735     */
11736    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);
11737    /**
11738     * This prepends a custom item provider to the list for that entry
11739     *
11740     * This prepends the given callback. See elm_entry_item_provider_append() for
11741     * more information
11742     *
11743     * @param obj The entry object
11744     * @param func The function called to provide the item object
11745     * @param data The data passed to @p func
11746     */
11747    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);
11748    /**
11749     * This removes a custom item provider to the list for that entry
11750     *
11751     * This removes the given callback. See elm_entry_item_provider_append() for
11752     * more information
11753     *
11754     * @param obj The entry object
11755     * @param func The function called to provide the item object
11756     * @param data The data passed to @p func
11757     */
11758    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);
11759    /**
11760     * Append a filter function for text inserted in the entry
11761     *
11762     * Append the given callback to the list. This functions will be called
11763     * whenever any text is inserted into the entry, with the text to be inserted
11764     * as a parameter. The callback function is free to alter the text in any way
11765     * it wants, but it must remember to free the given pointer and update it.
11766     * If the new text is to be discarded, the function can free it and set its
11767     * text parameter to NULL. This will also prevent any following filters from
11768     * being called.
11769     *
11770     * @param obj The entry object
11771     * @param func The function to use as text filter
11772     * @param data User data to pass to @p func
11773     */
11774    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11775    /**
11776     * Prepend a filter function for text insdrted in the entry
11777     *
11778     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11779     * for more information
11780     *
11781     * @param obj The entry object
11782     * @param func The function to use as text filter
11783     * @param data User data to pass to @p func
11784     */
11785    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11786    /**
11787     * Remove a filter from the list
11788     *
11789     * Removes the given callback from the filter list. See
11790     * elm_entry_text_filter_append() for more information.
11791     *
11792     * @param obj The entry object
11793     * @param func The filter function to remove
11794     * @param data The user data passed when adding the function
11795     */
11796    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11797    /**
11798     * This converts a markup (HTML-like) string into UTF-8.
11799     *
11800     * The returned string is a malloc'ed buffer and it should be freed when
11801     * not needed anymore.
11802     *
11803     * @param s The string (in markup) to be converted
11804     * @return The converted string (in UTF-8). It should be freed.
11805     */
11806    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11807    /**
11808     * This converts a UTF-8 string into markup (HTML-like).
11809     *
11810     * The returned string is a malloc'ed buffer and it should be freed when
11811     * not needed anymore.
11812     *
11813     * @param s The string (in UTF-8) to be converted
11814     * @return The converted string (in markup). It should be freed.
11815     */
11816    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11817    /**
11818     * This sets the file (and implicitly loads it) for the text to display and
11819     * then edit. All changes are written back to the file after a short delay if
11820     * the entry object is set to autosave (which is the default).
11821     *
11822     * If the entry had any other file set previously, any changes made to it
11823     * will be saved if the autosave feature is enabled, otherwise, the file
11824     * will be silently discarded and any non-saved changes will be lost.
11825     *
11826     * @param obj The entry object
11827     * @param file The path to the file to load and save
11828     * @param format The file format
11829     */
11830    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11831    /**
11832     * Gets the file being edited by the entry.
11833     *
11834     * This function can be used to retrieve any file set on the entry for
11835     * edition, along with the format used to load and save it.
11836     *
11837     * @param obj The entry object
11838     * @param file The path to the file to load and save
11839     * @param format The file format
11840     */
11841    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11842    /**
11843     * This function writes any changes made to the file set with
11844     * elm_entry_file_set()
11845     *
11846     * @param obj The entry object
11847     */
11848    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11849    /**
11850     * This sets the entry object to 'autosave' the loaded text file or not.
11851     *
11852     * @param obj The entry object
11853     * @param autosave Autosave the loaded file or not
11854     *
11855     * @see elm_entry_file_set()
11856     */
11857    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11858    /**
11859     * This gets the entry object's 'autosave' status.
11860     *
11861     * @param obj The entry object
11862     * @return Autosave the loaded file or not
11863     *
11864     * @see elm_entry_file_set()
11865     */
11866    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11867    /**
11868     * Control pasting of text and images for the widget.
11869     *
11870     * Normally the entry allows both text and images to be pasted.  By setting
11871     * textonly to be true, this prevents images from being pasted.
11872     *
11873     * Note this only changes the behaviour of text.
11874     *
11875     * @param obj The entry object
11876     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11877     * text+image+other.
11878     */
11879    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11880    /**
11881     * Getting elm_entry text paste/drop mode.
11882     *
11883     * In textonly mode, only text may be pasted or dropped into the widget.
11884     *
11885     * @param obj The entry object
11886     * @return If the widget only accepts text from pastes.
11887     */
11888    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11889    /**
11890     * Enable or disable scrolling in entry
11891     *
11892     * Normally the entry is not scrollable unless you enable it with this call.
11893     *
11894     * @param obj The entry object
11895     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11896     */
11897    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11898    /**
11899     * Get the scrollable state of the entry
11900     *
11901     * Normally the entry is not scrollable. This gets the scrollable state
11902     * of the entry. See elm_entry_scrollable_set() for more information.
11903     *
11904     * @param obj The entry object
11905     * @return The scrollable state
11906     */
11907    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11908    /**
11909     * This sets a widget to be displayed to the left of a scrolled entry.
11910     *
11911     * @param obj The scrolled entry object
11912     * @param icon The widget to display on the left side of the scrolled
11913     * entry.
11914     *
11915     * @note A previously set widget will be destroyed.
11916     * @note If the object being set does not have minimum size hints set,
11917     * it won't get properly displayed.
11918     *
11919     * @see elm_entry_end_set()
11920     */
11921    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11922    /**
11923     * Gets the leftmost widget of the scrolled entry. This object is
11924     * owned by the scrolled entry and should not be modified.
11925     *
11926     * @param obj The scrolled entry object
11927     * @return the left widget inside the scroller
11928     */
11929    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11930    /**
11931     * Unset the leftmost widget of the scrolled entry, unparenting and
11932     * returning it.
11933     *
11934     * @param obj The scrolled entry object
11935     * @return the previously set icon sub-object of this entry, on
11936     * success.
11937     *
11938     * @see elm_entry_icon_set()
11939     */
11940    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11941    /**
11942     * Sets the visibility of the left-side widget of the scrolled entry,
11943     * set by elm_entry_icon_set().
11944     *
11945     * @param obj The scrolled entry object
11946     * @param setting EINA_TRUE if the object should be displayed,
11947     * EINA_FALSE if not.
11948     */
11949    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11950    /**
11951     * This sets a widget to be displayed to the end of a scrolled entry.
11952     *
11953     * @param obj The scrolled entry object
11954     * @param end The widget to display on the right side of the scrolled
11955     * entry.
11956     *
11957     * @note A previously set widget will be destroyed.
11958     * @note If the object being set does not have minimum size hints set,
11959     * it won't get properly displayed.
11960     *
11961     * @see elm_entry_icon_set
11962     */
11963    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11964    /**
11965     * Gets the endmost widget of the scrolled entry. This object is owned
11966     * by the scrolled entry and should not be modified.
11967     *
11968     * @param obj The scrolled entry object
11969     * @return the right widget inside the scroller
11970     */
11971    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11972    /**
11973     * Unset the endmost widget of the scrolled entry, unparenting and
11974     * returning it.
11975     *
11976     * @param obj The scrolled entry object
11977     * @return the previously set icon sub-object of this entry, on
11978     * success.
11979     *
11980     * @see elm_entry_icon_set()
11981     */
11982    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11983    /**
11984     * Sets the visibility of the end widget of the scrolled entry, set by
11985     * elm_entry_end_set().
11986     *
11987     * @param obj The scrolled entry object
11988     * @param setting EINA_TRUE if the object should be displayed,
11989     * EINA_FALSE if not.
11990     */
11991    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11992    /**
11993     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11994     * them).
11995     *
11996     * Setting an entry to single-line mode with elm_entry_single_line_set()
11997     * will automatically disable the display of scrollbars when the entry
11998     * moves inside its scroller.
11999     *
12000     * @param obj The scrolled entry object
12001     * @param h The horizontal scrollbar policy to apply
12002     * @param v The vertical scrollbar policy to apply
12003     */
12004    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
12005    /**
12006     * This enables/disables bouncing within the entry.
12007     *
12008     * This function sets whether the entry will bounce when scrolling reaches
12009     * the end of the contained entry.
12010     *
12011     * @param obj The scrolled entry object
12012     * @param h The horizontal bounce state
12013     * @param v The vertical bounce state
12014     */
12015    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
12016    /**
12017     * Get the bounce mode
12018     *
12019     * @param obj The Entry object
12020     * @param h_bounce Allow bounce horizontally
12021     * @param v_bounce Allow bounce vertically
12022     */
12023    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
12024
12025    /* pre-made filters for entries */
12026    /**
12027     * @typedef Elm_Entry_Filter_Limit_Size
12028     *
12029     * Data for the elm_entry_filter_limit_size() entry filter.
12030     */
12031    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
12032    /**
12033     * @struct _Elm_Entry_Filter_Limit_Size
12034     *
12035     * Data for the elm_entry_filter_limit_size() entry filter.
12036     */
12037    struct _Elm_Entry_Filter_Limit_Size
12038      {
12039         int max_char_count; /**< The maximum number of characters allowed. */
12040         int max_byte_count; /**< The maximum number of bytes allowed*/
12041      };
12042    /**
12043     * Filter inserted text based on user defined character and byte limits
12044     *
12045     * Add this filter to an entry to limit the characters that it will accept
12046     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
12047     * The funtion works on the UTF-8 representation of the string, converting
12048     * it from the set markup, thus not accounting for any format in it.
12049     *
12050     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
12051     * it as data when setting the filter. In it, it's possible to set limits
12052     * by character count or bytes (any of them is disabled if 0), and both can
12053     * be set at the same time. In that case, it first checks for characters,
12054     * then bytes.
12055     *
12056     * The function will cut the inserted text in order to allow only the first
12057     * number of characters that are still allowed. The cut is made in
12058     * characters, even when limiting by bytes, in order to always contain
12059     * valid ones and avoid half unicode characters making it in.
12060     *
12061     * This filter, like any others, does not apply when setting the entry text
12062     * directly with elm_object_text_set() (or the deprecated
12063     * elm_entry_entry_set()).
12064     */
12065    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
12066    /**
12067     * @typedef Elm_Entry_Filter_Accept_Set
12068     *
12069     * Data for the elm_entry_filter_accept_set() entry filter.
12070     */
12071    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
12072    /**
12073     * @struct _Elm_Entry_Filter_Accept_Set
12074     *
12075     * Data for the elm_entry_filter_accept_set() entry filter.
12076     */
12077    struct _Elm_Entry_Filter_Accept_Set
12078      {
12079         const char *accepted; /**< Set of characters accepted in the entry. */
12080         const char *rejected; /**< Set of characters rejected from the entry. */
12081      };
12082    /**
12083     * Filter inserted text based on accepted or rejected sets of characters
12084     *
12085     * Add this filter to an entry to restrict the set of accepted characters
12086     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
12087     * This structure contains both accepted and rejected sets, but they are
12088     * mutually exclusive.
12089     *
12090     * The @c accepted set takes preference, so if it is set, the filter will
12091     * only work based on the accepted characters, ignoring anything in the
12092     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
12093     *
12094     * In both cases, the function filters by matching utf8 characters to the
12095     * raw markup text, so it can be used to remove formatting tags.
12096     *
12097     * This filter, like any others, does not apply when setting the entry text
12098     * directly with elm_object_text_set() (or the deprecated
12099     * elm_entry_entry_set()).
12100     */
12101    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
12102    /**
12103     * Set the input panel layout of the entry
12104     *
12105     * @param obj The entry object
12106     * @param layout layout type
12107     */
12108    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
12109    /**
12110     * Get the input panel layout of the entry
12111     *
12112     * @param obj The entry object
12113     * @return layout type
12114     *
12115     * @see elm_entry_input_panel_layout_set
12116     */
12117    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12118    /**
12119     * Set the autocapitalization type on the immodule.
12120     *
12121     * @param obj The entry object
12122     * @param autocapital_type The type of autocapitalization
12123     */
12124    EAPI void         elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
12125    /**
12126     * Retrieve the autocapitalization type on the immodule.
12127     *
12128     * @param obj The entry object
12129     * @return autocapitalization type
12130     */
12131    EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12132    /**
12133     * Sets the attribute to show the input panel automatically.
12134     *
12135     * @param obj The entry object
12136     * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12137     */
12138    EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12139    /**
12140     * Retrieve the attribute to show the input panel automatically.
12141     *
12142     * @param obj The entry object
12143     * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12144     */
12145    EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12146
12147    /**
12148     * @}
12149     */
12150
12151    /* composite widgets - these basically put together basic widgets above
12152     * in convenient packages that do more than basic stuff */
12153
12154    /* anchorview */
12155    /**
12156     * @defgroup Anchorview Anchorview
12157     *
12158     * @image html img/widget/anchorview/preview-00.png
12159     * @image latex img/widget/anchorview/preview-00.eps
12160     *
12161     * Anchorview is for displaying text that contains markup with anchors
12162     * like <c>\<a href=1234\>something\</\></c> in it.
12163     *
12164     * Besides being styled differently, the anchorview widget provides the
12165     * necessary functionality so that clicking on these anchors brings up a
12166     * popup with user defined content such as "call", "add to contacts" or
12167     * "open web page". This popup is provided using the @ref Hover widget.
12168     *
12169     * This widget is very similar to @ref Anchorblock, so refer to that
12170     * widget for an example. The only difference Anchorview has is that the
12171     * widget is already provided with scrolling functionality, so if the
12172     * text set to it is too large to fit in the given space, it will scroll,
12173     * whereas the @ref Anchorblock widget will keep growing to ensure all the
12174     * text can be displayed.
12175     *
12176     * This widget emits the following signals:
12177     * @li "anchor,clicked": will be called when an anchor is clicked. The
12178     * @p event_info parameter on the callback will be a pointer of type
12179     * ::Elm_Entry_Anchorview_Info.
12180     *
12181     * See @ref Anchorblock for an example on how to use both of them.
12182     *
12183     * @see Anchorblock
12184     * @see Entry
12185     * @see Hover
12186     *
12187     * @{
12188     */
12189    /**
12190     * @typedef Elm_Entry_Anchorview_Info
12191     *
12192     * The info sent in the callback for "anchor,clicked" signals emitted by
12193     * the Anchorview widget.
12194     */
12195    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12196    /**
12197     * @struct _Elm_Entry_Anchorview_Info
12198     *
12199     * The info sent in the callback for "anchor,clicked" signals emitted by
12200     * the Anchorview widget.
12201     */
12202    struct _Elm_Entry_Anchorview_Info
12203      {
12204         const char     *name; /**< Name of the anchor, as indicated in its href
12205                                    attribute */
12206         int             button; /**< The mouse button used to click on it */
12207         Evas_Object    *hover; /**< The hover object to use for the popup */
12208         struct {
12209              Evas_Coord    x, y, w, h;
12210         } anchor, /**< Geometry selection of text used as anchor */
12211           hover_parent; /**< Geometry of the object used as parent by the
12212                              hover */
12213         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12214                                              for content on the left side of
12215                                              the hover. Before calling the
12216                                              callback, the widget will make the
12217                                              necessary calculations to check
12218                                              which sides are fit to be set with
12219                                              content, based on the position the
12220                                              hover is activated and its distance
12221                                              to the edges of its parent object
12222                                              */
12223         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12224                                               the right side of the hover.
12225                                               See @ref hover_left */
12226         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12227                                             of the hover. See @ref hover_left */
12228         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12229                                                below the hover. See @ref
12230                                                hover_left */
12231      };
12232    /**
12233     * Add a new Anchorview object
12234     *
12235     * @param parent The parent object
12236     * @return The new object or NULL if it cannot be created
12237     */
12238    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12239    /**
12240     * Set the text to show in the anchorview
12241     *
12242     * Sets the text of the anchorview to @p text. This text can include markup
12243     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12244     * text that will be specially styled and react to click events, ended with
12245     * either of \</a\> or \</\>. When clicked, the anchor will emit an
12246     * "anchor,clicked" signal that you can attach a callback to with
12247     * evas_object_smart_callback_add(). The name of the anchor given in the
12248     * event info struct will be the one set in the href attribute, in this
12249     * case, anchorname.
12250     *
12251     * Other markup can be used to style the text in different ways, but it's
12252     * up to the style defined in the theme which tags do what.
12253     * @deprecated use elm_object_text_set() instead.
12254     */
12255    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12256    /**
12257     * Get the markup text set for the anchorview
12258     *
12259     * Retrieves the text set on the anchorview, with markup tags included.
12260     *
12261     * @param obj The anchorview object
12262     * @return The markup text set or @c NULL if nothing was set or an error
12263     * occurred
12264     * @deprecated use elm_object_text_set() instead.
12265     */
12266    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12267    /**
12268     * Set the parent of the hover popup
12269     *
12270     * Sets the parent object to use by the hover created by the anchorview
12271     * when an anchor is clicked. See @ref Hover for more details on this.
12272     * If no parent is set, the same anchorview object will be used.
12273     *
12274     * @param obj The anchorview object
12275     * @param parent The object to use as parent for the hover
12276     */
12277    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12278    /**
12279     * Get the parent of the hover popup
12280     *
12281     * Get the object used as parent for the hover created by the anchorview
12282     * widget. See @ref Hover for more details on this.
12283     *
12284     * @param obj The anchorview object
12285     * @return The object used as parent for the hover, NULL if none is set.
12286     */
12287    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12288    /**
12289     * Set the style that the hover should use
12290     *
12291     * When creating the popup hover, anchorview will request that it's
12292     * themed according to @p style.
12293     *
12294     * @param obj The anchorview object
12295     * @param style The style to use for the underlying hover
12296     *
12297     * @see elm_object_style_set()
12298     */
12299    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12300    /**
12301     * Get the style that the hover should use
12302     *
12303     * Get the style the hover created by anchorview will use.
12304     *
12305     * @param obj The anchorview object
12306     * @return The style to use by the hover. NULL means the default is used.
12307     *
12308     * @see elm_object_style_set()
12309     */
12310    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12311    /**
12312     * Ends the hover popup in the anchorview
12313     *
12314     * When an anchor is clicked, the anchorview widget will create a hover
12315     * object to use as a popup with user provided content. This function
12316     * terminates this popup, returning the anchorview to its normal state.
12317     *
12318     * @param obj The anchorview object
12319     */
12320    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12321    /**
12322     * Set bouncing behaviour when the scrolled content reaches an edge
12323     *
12324     * Tell the internal scroller object whether it should bounce or not
12325     * when it reaches the respective edges for each axis.
12326     *
12327     * @param obj The anchorview object
12328     * @param h_bounce Whether to bounce or not in the horizontal axis
12329     * @param v_bounce Whether to bounce or not in the vertical axis
12330     *
12331     * @see elm_scroller_bounce_set()
12332     */
12333    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12334    /**
12335     * Get the set bouncing behaviour of the internal scroller
12336     *
12337     * Get whether the internal scroller should bounce when the edge of each
12338     * axis is reached scrolling.
12339     *
12340     * @param obj The anchorview object
12341     * @param h_bounce Pointer where to store the bounce state of the horizontal
12342     *                 axis
12343     * @param v_bounce Pointer where to store the bounce state of the vertical
12344     *                 axis
12345     *
12346     * @see elm_scroller_bounce_get()
12347     */
12348    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12349    /**
12350     * Appends a custom item provider to the given anchorview
12351     *
12352     * Appends the given function to the list of items providers. This list is
12353     * called, one function at a time, with the given @p data pointer, the
12354     * anchorview object and, in the @p item parameter, the item name as
12355     * referenced in its href string. Following functions in the list will be
12356     * called in order until one of them returns something different to NULL,
12357     * which should be an Evas_Object which will be used in place of the item
12358     * element.
12359     *
12360     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12361     * href=item/name\>\</item\>
12362     *
12363     * @param obj The anchorview object
12364     * @param func The function to add to the list of providers
12365     * @param data User data that will be passed to the callback function
12366     *
12367     * @see elm_entry_item_provider_append()
12368     */
12369    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);
12370    /**
12371     * Prepend a custom item provider to the given anchorview
12372     *
12373     * Like elm_anchorview_item_provider_append(), but it adds the function
12374     * @p func to the beginning of the list, instead of the end.
12375     *
12376     * @param obj The anchorview object
12377     * @param func The function to add to the list of providers
12378     * @param data User data that will be passed to the callback function
12379     */
12380    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);
12381    /**
12382     * Remove a custom item provider from the list of the given anchorview
12383     *
12384     * Removes the function and data pairing that matches @p func and @p data.
12385     * That is, unless the same function and same user data are given, the
12386     * function will not be removed from the list. This allows us to add the
12387     * same callback several times, with different @p data pointers and be
12388     * able to remove them later without conflicts.
12389     *
12390     * @param obj The anchorview object
12391     * @param func The function to remove from the list
12392     * @param data The data matching the function to remove from the list
12393     */
12394    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);
12395    /**
12396     * @}
12397     */
12398
12399    /* anchorblock */
12400    /**
12401     * @defgroup Anchorblock Anchorblock
12402     *
12403     * @image html img/widget/anchorblock/preview-00.png
12404     * @image latex img/widget/anchorblock/preview-00.eps
12405     *
12406     * Anchorblock is for displaying text that contains markup with anchors
12407     * like <c>\<a href=1234\>something\</\></c> in it.
12408     *
12409     * Besides being styled differently, the anchorblock widget provides the
12410     * necessary functionality so that clicking on these anchors brings up a
12411     * popup with user defined content such as "call", "add to contacts" or
12412     * "open web page". This popup is provided using the @ref Hover widget.
12413     *
12414     * This widget emits the following signals:
12415     * @li "anchor,clicked": will be called when an anchor is clicked. The
12416     * @p event_info parameter on the callback will be a pointer of type
12417     * ::Elm_Entry_Anchorblock_Info.
12418     *
12419     * @see Anchorview
12420     * @see Entry
12421     * @see Hover
12422     *
12423     * Since examples are usually better than plain words, we might as well
12424     * try @ref tutorial_anchorblock_example "one".
12425     */
12426    /**
12427     * @addtogroup Anchorblock
12428     * @{
12429     */
12430    /**
12431     * @typedef Elm_Entry_Anchorblock_Info
12432     *
12433     * The info sent in the callback for "anchor,clicked" signals emitted by
12434     * the Anchorblock widget.
12435     */
12436    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12437    /**
12438     * @struct _Elm_Entry_Anchorblock_Info
12439     *
12440     * The info sent in the callback for "anchor,clicked" signals emitted by
12441     * the Anchorblock widget.
12442     */
12443    struct _Elm_Entry_Anchorblock_Info
12444      {
12445         const char     *name; /**< Name of the anchor, as indicated in its href
12446                                    attribute */
12447         int             button; /**< The mouse button used to click on it */
12448         Evas_Object    *hover; /**< The hover object to use for the popup */
12449         struct {
12450              Evas_Coord    x, y, w, h;
12451         } anchor, /**< Geometry selection of text used as anchor */
12452           hover_parent; /**< Geometry of the object used as parent by the
12453                              hover */
12454         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12455                                              for content on the left side of
12456                                              the hover. Before calling the
12457                                              callback, the widget will make the
12458                                              necessary calculations to check
12459                                              which sides are fit to be set with
12460                                              content, based on the position the
12461                                              hover is activated and its distance
12462                                              to the edges of its parent object
12463                                              */
12464         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12465                                               the right side of the hover.
12466                                               See @ref hover_left */
12467         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12468                                             of the hover. See @ref hover_left */
12469         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12470                                                below the hover. See @ref
12471                                                hover_left */
12472      };
12473    /**
12474     * Add a new Anchorblock object
12475     *
12476     * @param parent The parent object
12477     * @return The new object or NULL if it cannot be created
12478     */
12479    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12480    /**
12481     * Set the text to show in the anchorblock
12482     *
12483     * Sets the text of the anchorblock to @p text. This text can include markup
12484     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12485     * of text that will be specially styled and react to click events, ended
12486     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12487     * "anchor,clicked" signal that you can attach a callback to with
12488     * evas_object_smart_callback_add(). The name of the anchor given in the
12489     * event info struct will be the one set in the href attribute, in this
12490     * case, anchorname.
12491     *
12492     * Other markup can be used to style the text in different ways, but it's
12493     * up to the style defined in the theme which tags do what.
12494     * @deprecated use elm_object_text_set() instead.
12495     */
12496    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12497    /**
12498     * Get the markup text set for the anchorblock
12499     *
12500     * Retrieves the text set on the anchorblock, with markup tags included.
12501     *
12502     * @param obj The anchorblock object
12503     * @return The markup text set or @c NULL if nothing was set or an error
12504     * occurred
12505     * @deprecated use elm_object_text_set() instead.
12506     */
12507    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12508    /**
12509     * Set the parent of the hover popup
12510     *
12511     * Sets the parent object to use by the hover created by the anchorblock
12512     * when an anchor is clicked. See @ref Hover for more details on this.
12513     *
12514     * @param obj The anchorblock object
12515     * @param parent The object to use as parent for the hover
12516     */
12517    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12518    /**
12519     * Get the parent of the hover popup
12520     *
12521     * Get the object used as parent for the hover created by the anchorblock
12522     * widget. See @ref Hover for more details on this.
12523     * If no parent is set, the same anchorblock object will be used.
12524     *
12525     * @param obj The anchorblock object
12526     * @return The object used as parent for the hover, NULL if none is set.
12527     */
12528    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12529    /**
12530     * Set the style that the hover should use
12531     *
12532     * When creating the popup hover, anchorblock will request that it's
12533     * themed according to @p style.
12534     *
12535     * @param obj The anchorblock object
12536     * @param style The style to use for the underlying hover
12537     *
12538     * @see elm_object_style_set()
12539     */
12540    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12541    /**
12542     * Get the style that the hover should use
12543     *
12544     * Get the style, the hover created by anchorblock will use.
12545     *
12546     * @param obj The anchorblock object
12547     * @return The style to use by the hover. NULL means the default is used.
12548     *
12549     * @see elm_object_style_set()
12550     */
12551    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12552    /**
12553     * Ends the hover popup in the anchorblock
12554     *
12555     * When an anchor is clicked, the anchorblock widget will create a hover
12556     * object to use as a popup with user provided content. This function
12557     * terminates this popup, returning the anchorblock to its normal state.
12558     *
12559     * @param obj The anchorblock object
12560     */
12561    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12562    /**
12563     * Appends a custom item provider to the given anchorblock
12564     *
12565     * Appends the given function to the list of items providers. This list is
12566     * called, one function at a time, with the given @p data pointer, the
12567     * anchorblock object and, in the @p item parameter, the item name as
12568     * referenced in its href string. Following functions in the list will be
12569     * called in order until one of them returns something different to NULL,
12570     * which should be an Evas_Object which will be used in place of the item
12571     * element.
12572     *
12573     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12574     * href=item/name\>\</item\>
12575     *
12576     * @param obj The anchorblock object
12577     * @param func The function to add to the list of providers
12578     * @param data User data that will be passed to the callback function
12579     *
12580     * @see elm_entry_item_provider_append()
12581     */
12582    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);
12583    /**
12584     * Prepend a custom item provider to the given anchorblock
12585     *
12586     * Like elm_anchorblock_item_provider_append(), but it adds the function
12587     * @p func to the beginning of the list, instead of the end.
12588     *
12589     * @param obj The anchorblock object
12590     * @param func The function to add to the list of providers
12591     * @param data User data that will be passed to the callback function
12592     */
12593    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);
12594    /**
12595     * Remove a custom item provider from the list of the given anchorblock
12596     *
12597     * Removes the function and data pairing that matches @p func and @p data.
12598     * That is, unless the same function and same user data are given, the
12599     * function will not be removed from the list. This allows us to add the
12600     * same callback several times, with different @p data pointers and be
12601     * able to remove them later without conflicts.
12602     *
12603     * @param obj The anchorblock object
12604     * @param func The function to remove from the list
12605     * @param data The data matching the function to remove from the list
12606     */
12607    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);
12608    /**
12609     * @}
12610     */
12611
12612    /**
12613     * @defgroup Bubble Bubble
12614     *
12615     * @image html img/widget/bubble/preview-00.png
12616     * @image latex img/widget/bubble/preview-00.eps
12617     * @image html img/widget/bubble/preview-01.png
12618     * @image latex img/widget/bubble/preview-01.eps
12619     * @image html img/widget/bubble/preview-02.png
12620     * @image latex img/widget/bubble/preview-02.eps
12621     *
12622     * @brief The Bubble is a widget to show text similar to how speech is
12623     * represented in comics.
12624     *
12625     * The bubble widget contains 5 important visual elements:
12626     * @li The frame is a rectangle with rounded edjes and an "arrow".
12627     * @li The @p icon is an image to which the frame's arrow points to.
12628     * @li The @p label is a text which appears to the right of the icon if the
12629     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12630     * otherwise.
12631     * @li The @p info is a text which appears to the right of the label. Info's
12632     * font is of a ligther color than label.
12633     * @li The @p content is an evas object that is shown inside the frame.
12634     *
12635     * The position of the arrow, icon, label and info depends on which corner is
12636     * selected. The four available corners are:
12637     * @li "top_left" - Default
12638     * @li "top_right"
12639     * @li "bottom_left"
12640     * @li "bottom_right"
12641     *
12642     * Signals that you can add callbacks for are:
12643     * @li "clicked" - This is called when a user has clicked the bubble.
12644     *
12645     * Default contents parts of the bubble that you can use for are:
12646     * @li "default" - A content of the bubble
12647     * @li "icon" - An icon of the bubble
12648     *
12649     * Default text parts of the button widget that you can use for are:
12650     * @li NULL - Label of the bubble
12651     *
12652          * For an example of using a buble see @ref bubble_01_example_page "this".
12653     *
12654     * @{
12655     */
12656
12657    /**
12658     * Add a new bubble to the parent
12659     *
12660     * @param parent The parent object
12661     * @return The new object or NULL if it cannot be created
12662     *
12663     * This function adds a text bubble to the given parent evas object.
12664     */
12665    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12666    /**
12667     * Set the label of the bubble
12668     *
12669     * @param obj The bubble object
12670     * @param label The string to set in the label
12671     *
12672     * This function sets the title of the bubble. Where this appears depends on
12673     * the selected corner.
12674     * @deprecated use elm_object_text_set() instead.
12675     */
12676    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12677    /**
12678     * Get the label of the bubble
12679     *
12680     * @param obj The bubble object
12681     * @return The string of set in the label
12682     *
12683     * This function gets the title of the bubble.
12684     * @deprecated use elm_object_text_get() instead.
12685     */
12686    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12687    /**
12688     * Set the info of the bubble
12689     *
12690     * @param obj The bubble object
12691     * @param info The given info about the bubble
12692     *
12693     * This function sets the info of the bubble. Where this appears depends on
12694     * the selected corner.
12695     * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12696     */
12697    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12698    /**
12699     * Get the info of the bubble
12700     *
12701     * @param obj The bubble object
12702     *
12703     * @return The "info" string of the bubble
12704     *
12705     * This function gets the info text.
12706     * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12707     */
12708    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12709    /**
12710     * Set the content to be shown in the bubble
12711     *
12712     * Once the content object is set, a previously set one will be deleted.
12713     * If you want to keep the old content object, use the
12714     * elm_bubble_content_unset() function.
12715     *
12716     * @param obj The bubble object
12717     * @param content The given content of the bubble
12718     *
12719     * This function sets the content shown on the middle of the bubble.
12720     *
12721     * @deprecated use elm_object_content_set() instead
12722     *
12723     */
12724    EINA_DEPRECATED EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12725    /**
12726     * Get the content shown in the bubble
12727     *
12728     * Return the content object which is set for this widget.
12729     *
12730     * @param obj The bubble object
12731     * @return The content that is being used
12732     *
12733     * @deprecated use elm_object_content_get() instead
12734     *
12735     */
12736    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12737    /**
12738     * Unset the content shown in the bubble
12739     *
12740     * Unparent and return the content object which was set for this widget.
12741     *
12742     * @param obj The bubble object
12743     * @return The content that was being used
12744     *
12745     * @deprecated use elm_object_content_unset() instead
12746     *
12747     */
12748    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12749    /**
12750     * Set the icon of the bubble
12751     *
12752     * Once the icon object is set, a previously set one will be deleted.
12753     * If you want to keep the old content object, use the
12754     * elm_icon_content_unset() function.
12755     *
12756     * @param obj The bubble object
12757     * @param icon The given icon for the bubble
12758     *
12759     * @deprecated use elm_object_part_content_set() instead
12760     *
12761     */
12762    EINA_DEPRECATED EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12763    /**
12764     * Get the icon of the bubble
12765     *
12766     * @param obj The bubble object
12767     * @return The icon for the bubble
12768     *
12769     * This function gets the icon shown on the top left of bubble.
12770     *
12771     * @deprecated use elm_object_part_content_get() instead
12772     *
12773     */
12774    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12775    /**
12776     * Unset the icon of the bubble
12777     *
12778     * Unparent and return the icon object which was set for this widget.
12779     *
12780     * @param obj The bubble object
12781     * @return The icon that was being used
12782     *
12783     * @deprecated use elm_object_part_content_unset() instead
12784     *
12785     */
12786    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12787    /**
12788     * Set the corner of the bubble
12789     *
12790     * @param obj The bubble object.
12791     * @param corner The given corner for the bubble.
12792     *
12793     * This function sets the corner of the bubble. The corner will be used to
12794     * determine where the arrow in the frame points to and where label, icon and
12795     * info are shown.
12796     *
12797     * Possible values for corner are:
12798     * @li "top_left" - Default
12799     * @li "top_right"
12800     * @li "bottom_left"
12801     * @li "bottom_right"
12802     */
12803    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12804    /**
12805     * Get the corner of the bubble
12806     *
12807     * @param obj The bubble object.
12808     * @return The given corner for the bubble.
12809     *
12810     * This function gets the selected corner of the bubble.
12811     */
12812    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12813    /**
12814     * @}
12815     */
12816
12817    /**
12818     * @defgroup Photo Photo
12819     *
12820     * For displaying the photo of a person (contact). Simple, yet
12821     * with a very specific purpose.
12822     *
12823     * Signals that you can add callbacks for are:
12824     *
12825     * "clicked" - This is called when a user has clicked the photo
12826     * "drag,start" - Someone started dragging the image out of the object
12827     * "drag,end" - Dragged item was dropped (somewhere)
12828     *
12829     * @{
12830     */
12831
12832    /**
12833     * Add a new photo to the parent
12834     *
12835     * @param parent The parent object
12836     * @return The new object or NULL if it cannot be created
12837     *
12838     * @ingroup Photo
12839     */
12840    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12841
12842    /**
12843     * Set the file that will be used as photo
12844     *
12845     * @param obj The photo object
12846     * @param file The path to file that will be used as photo
12847     *
12848     * @return (1 = success, 0 = error)
12849     *
12850     * @ingroup Photo
12851     */
12852    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12853
12854     /**
12855     * Set the file that will be used as thumbnail in the photo.
12856     *
12857     * @param obj The photo object.
12858     * @param file The path to file that will be used as thumb.
12859     * @param group The key used in case of an EET file.
12860     *
12861     * @ingroup Photo
12862     */
12863    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12864
12865    /**
12866     * Set the size that will be used on the photo
12867     *
12868     * @param obj The photo object
12869     * @param size The size that the photo will be
12870     *
12871     * @ingroup Photo
12872     */
12873    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12874
12875    /**
12876     * Set if the photo should be completely visible or not.
12877     *
12878     * @param obj The photo object
12879     * @param fill if true the photo will be completely visible
12880     *
12881     * @ingroup Photo
12882     */
12883    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12884
12885    /**
12886     * Set editability of the photo.
12887     *
12888     * An editable photo can be dragged to or from, and can be cut or
12889     * pasted too.  Note that pasting an image or dropping an item on
12890     * the image will delete the existing content.
12891     *
12892     * @param obj The photo object.
12893     * @param set To set of clear editablity.
12894     */
12895    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12896
12897    /**
12898     * @}
12899     */
12900
12901    /* gesture layer */
12902    /**
12903     * @defgroup Elm_Gesture_Layer Gesture Layer
12904     * Gesture Layer Usage:
12905     *
12906     * Use Gesture Layer to detect gestures.
12907     * The advantage is that you don't have to implement
12908     * gesture detection, just set callbacks of gesture state.
12909     * By using gesture layer we make standard interface.
12910     *
12911     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12912     * with a parent object parameter.
12913     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12914     * call. Usually with same object as target (2nd parameter).
12915     *
12916     * Now you need to tell gesture layer what gestures you follow.
12917     * This is done with @ref elm_gesture_layer_cb_set call.
12918     * By setting the callback you actually saying to gesture layer:
12919     * I would like to know when the gesture @ref Elm_Gesture_Types
12920     * switches to state @ref Elm_Gesture_State.
12921     *
12922     * Next, you need to implement the actual action that follows the input
12923     * in your callback.
12924     *
12925     * Note that if you like to stop being reported about a gesture, just set
12926     * all callbacks referring this gesture to NULL.
12927     * (again with @ref elm_gesture_layer_cb_set)
12928     *
12929     * The information reported by gesture layer to your callback is depending
12930     * on @ref Elm_Gesture_Types:
12931     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12932     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12933     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12934     *
12935     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12936     * @ref ELM_GESTURE_MOMENTUM.
12937     *
12938     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12939     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12940     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12941     * Note that we consider a flick as a line-gesture that should be completed
12942     * in flick-time-limit as defined in @ref Config.
12943     *
12944     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12945     *
12946     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12947     *
12948     *
12949     * Gesture Layer Tweaks:
12950     *
12951     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12952     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12953     *
12954     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12955     * so gesture starts when user touches (a *DOWN event) touch-surface
12956     * and ends when no fingers touches surface (a *UP event).
12957     */
12958
12959    /**
12960     * @enum _Elm_Gesture_Types
12961     * Enum of supported gesture types.
12962     * @ingroup Elm_Gesture_Layer
12963     */
12964    enum _Elm_Gesture_Types
12965      {
12966         ELM_GESTURE_FIRST = 0,
12967
12968         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12969         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12970         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12971         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12972
12973         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12974
12975         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12976         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12977
12978         ELM_GESTURE_ZOOM, /**< Zoom */
12979         ELM_GESTURE_ROTATE, /**< Rotate */
12980
12981         ELM_GESTURE_LAST
12982      };
12983
12984    /**
12985     * @typedef Elm_Gesture_Types
12986     * gesture types enum
12987     * @ingroup Elm_Gesture_Layer
12988     */
12989    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12990
12991    /**
12992     * @enum _Elm_Gesture_State
12993     * Enum of gesture states.
12994     * @ingroup Elm_Gesture_Layer
12995     */
12996    enum _Elm_Gesture_State
12997      {
12998         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12999         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
13000         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
13001         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
13002         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
13003      };
13004
13005    /**
13006     * @typedef Elm_Gesture_State
13007     * gesture states enum
13008     * @ingroup Elm_Gesture_Layer
13009     */
13010    typedef enum _Elm_Gesture_State Elm_Gesture_State;
13011
13012    /**
13013     * @struct _Elm_Gesture_Taps_Info
13014     * Struct holds taps info for user
13015     * @ingroup Elm_Gesture_Layer
13016     */
13017    struct _Elm_Gesture_Taps_Info
13018      {
13019         Evas_Coord x, y;         /**< Holds center point between fingers */
13020         unsigned int n;          /**< Number of fingers tapped           */
13021         unsigned int timestamp;  /**< event timestamp       */
13022      };
13023
13024    /**
13025     * @typedef Elm_Gesture_Taps_Info
13026     * holds taps info for user
13027     * @ingroup Elm_Gesture_Layer
13028     */
13029    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
13030
13031    /**
13032     * @struct _Elm_Gesture_Momentum_Info
13033     * Struct holds momentum info for user
13034     * x1 and y1 are not necessarily in sync
13035     * x1 holds x value of x direction starting point
13036     * and same holds for y1.
13037     * This is noticeable when doing V-shape movement
13038     * @ingroup Elm_Gesture_Layer
13039     */
13040    struct _Elm_Gesture_Momentum_Info
13041      {  /* Report line ends, timestamps, and momentum computed        */
13042         Evas_Coord x1; /**< Final-swipe direction starting point on X */
13043         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
13044         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
13045         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
13046
13047         unsigned int tx; /**< Timestamp of start of final x-swipe */
13048         unsigned int ty; /**< Timestamp of start of final y-swipe */
13049
13050         Evas_Coord mx; /**< Momentum on X */
13051         Evas_Coord my; /**< Momentum on Y */
13052
13053         unsigned int n;  /**< Number of fingers */
13054      };
13055
13056    /**
13057     * @typedef Elm_Gesture_Momentum_Info
13058     * holds momentum info for user
13059     * @ingroup Elm_Gesture_Layer
13060     */
13061     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
13062
13063    /**
13064     * @struct _Elm_Gesture_Line_Info
13065     * Struct holds line info for user
13066     * @ingroup Elm_Gesture_Layer
13067     */
13068    struct _Elm_Gesture_Line_Info
13069      {  /* Report line ends, timestamps, and momentum computed      */
13070         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
13071         double angle;              /**< Angle (direction) of lines  */
13072      };
13073
13074    /**
13075     * @typedef Elm_Gesture_Line_Info
13076     * Holds line info for user
13077     * @ingroup Elm_Gesture_Layer
13078     */
13079     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
13080
13081    /**
13082     * @struct _Elm_Gesture_Zoom_Info
13083     * Struct holds zoom info for user
13084     * @ingroup Elm_Gesture_Layer
13085     */
13086    struct _Elm_Gesture_Zoom_Info
13087      {
13088         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
13089         Evas_Coord radius; /**< Holds radius between fingers reported to user */
13090         double zoom;            /**< Zoom value: 1.0 means no zoom             */
13091         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
13092      };
13093
13094    /**
13095     * @typedef Elm_Gesture_Zoom_Info
13096     * Holds zoom info for user
13097     * @ingroup Elm_Gesture_Layer
13098     */
13099    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
13100
13101    /**
13102     * @struct _Elm_Gesture_Rotate_Info
13103     * Struct holds rotation info for user
13104     * @ingroup Elm_Gesture_Layer
13105     */
13106    struct _Elm_Gesture_Rotate_Info
13107      {
13108         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
13109         Evas_Coord radius; /**< Holds radius between fingers reported to user */
13110         double base_angle; /**< Holds start-angle */
13111         double angle;      /**< Rotation value: 0.0 means no rotation         */
13112         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
13113      };
13114
13115    /**
13116     * @typedef Elm_Gesture_Rotate_Info
13117     * Holds rotation info for user
13118     * @ingroup Elm_Gesture_Layer
13119     */
13120    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
13121
13122    /**
13123     * @typedef Elm_Gesture_Event_Cb
13124     * User callback used to stream gesture info from gesture layer
13125     * @param data user data
13126     * @param event_info gesture report info
13127     * Returns a flag field to be applied on the causing event.
13128     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13129     * upon the event, in an irreversible way.
13130     *
13131     * @ingroup Elm_Gesture_Layer
13132     */
13133    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13134
13135    /**
13136     * Use function to set callbacks to be notified about
13137     * change of state of gesture.
13138     * When a user registers a callback with this function
13139     * this means this gesture has to be tested.
13140     *
13141     * When ALL callbacks for a gesture are set to NULL
13142     * it means user isn't interested in gesture-state
13143     * and it will not be tested.
13144     *
13145     * @param obj Pointer to gesture-layer.
13146     * @param idx The gesture you would like to track its state.
13147     * @param cb callback function pointer.
13148     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13149     * @param data user info to be sent to callback (usually, Smart Data)
13150     *
13151     * @ingroup Elm_Gesture_Layer
13152     */
13153    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);
13154
13155    /**
13156     * Call this function to get repeat-events settings.
13157     *
13158     * @param obj Pointer to gesture-layer.
13159     *
13160     * @return repeat events settings.
13161     * @see elm_gesture_layer_hold_events_set()
13162     * @ingroup Elm_Gesture_Layer
13163     */
13164    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13165
13166    /**
13167     * This function called in order to make gesture-layer repeat events.
13168     * Set this of you like to get the raw events only if gestures were not detected.
13169     * Clear this if you like gesture layer to fwd events as testing gestures.
13170     *
13171     * @param obj Pointer to gesture-layer.
13172     * @param r Repeat: TRUE/FALSE
13173     *
13174     * @ingroup Elm_Gesture_Layer
13175     */
13176    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13177
13178    /**
13179     * This function sets step-value for zoom action.
13180     * Set step to any positive value.
13181     * Cancel step setting by setting to 0.0
13182     *
13183     * @param obj Pointer to gesture-layer.
13184     * @param s new zoom step value.
13185     *
13186     * @ingroup Elm_Gesture_Layer
13187     */
13188    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13189
13190    /**
13191     * This function sets step-value for rotate action.
13192     * Set step to any positive value.
13193     * Cancel step setting by setting to 0.0
13194     *
13195     * @param obj Pointer to gesture-layer.
13196     * @param s new roatate step value.
13197     *
13198     * @ingroup Elm_Gesture_Layer
13199     */
13200    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13201
13202    /**
13203     * This function called to attach gesture-layer to an Evas_Object.
13204     * @param obj Pointer to gesture-layer.
13205     * @param t Pointer to underlying object (AKA Target)
13206     *
13207     * @return TRUE, FALSE on success, failure.
13208     *
13209     * @ingroup Elm_Gesture_Layer
13210     */
13211    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13212
13213    /**
13214     * Call this function to construct a new gesture-layer object.
13215     * This does not activate the gesture layer. You have to
13216     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13217     *
13218     * @param parent the parent object.
13219     *
13220     * @return Pointer to new gesture-layer object.
13221     *
13222     * @ingroup Elm_Gesture_Layer
13223     */
13224    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13225
13226    /**
13227     * @defgroup Thumb Thumb
13228     *
13229     * @image html img/widget/thumb/preview-00.png
13230     * @image latex img/widget/thumb/preview-00.eps
13231     *
13232     * A thumb object is used for displaying the thumbnail of an image or video.
13233     * You must have compiled Elementary with Ethumb_Client support and the DBus
13234     * service must be present and auto-activated in order to have thumbnails to
13235     * be generated.
13236     *
13237     * Once the thumbnail object becomes visible, it will check if there is a
13238     * previously generated thumbnail image for the file set on it. If not, it
13239     * will start generating this thumbnail.
13240     *
13241     * Different config settings will cause different thumbnails to be generated
13242     * even on the same file.
13243     *
13244     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13245     * Ethumb documentation to change this path, and to see other configuration
13246     * options.
13247     *
13248     * Signals that you can add callbacks for are:
13249     *
13250     * - "clicked" - This is called when a user has clicked the thumb without dragging
13251     *             around.
13252     * - "clicked,double" - This is called when a user has double-clicked the thumb.
13253     * - "press" - This is called when a user has pressed down the thumb.
13254     * - "generate,start" - The thumbnail generation started.
13255     * - "generate,stop" - The generation process stopped.
13256     * - "generate,error" - The generation failed.
13257     * - "load,error" - The thumbnail image loading failed.
13258     *
13259     * available styles:
13260     * - default
13261     * - noframe
13262     *
13263     * An example of use of thumbnail:
13264     *
13265     * - @ref thumb_example_01
13266     */
13267
13268    /**
13269     * @addtogroup Thumb
13270     * @{
13271     */
13272
13273    /**
13274     * @enum _Elm_Thumb_Animation_Setting
13275     * @typedef Elm_Thumb_Animation_Setting
13276     *
13277     * Used to set if a video thumbnail is animating or not.
13278     *
13279     * @ingroup Thumb
13280     */
13281    typedef enum _Elm_Thumb_Animation_Setting
13282      {
13283         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13284         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
13285         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
13286         ELM_THUMB_ANIMATION_LAST
13287      } Elm_Thumb_Animation_Setting;
13288
13289    /**
13290     * Add a new thumb object to the parent.
13291     *
13292     * @param parent The parent object.
13293     * @return The new object or NULL if it cannot be created.
13294     *
13295     * @see elm_thumb_file_set()
13296     * @see elm_thumb_ethumb_client_get()
13297     *
13298     * @ingroup Thumb
13299     */
13300    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13301    /**
13302     * Reload thumbnail if it was generated before.
13303     *
13304     * @param obj The thumb object to reload
13305     *
13306     * This is useful if the ethumb client configuration changed, like its
13307     * size, aspect or any other property one set in the handle returned
13308     * by elm_thumb_ethumb_client_get().
13309     *
13310     * If the options didn't change, the thumbnail won't be generated again, but
13311     * the old one will still be used.
13312     *
13313     * @see elm_thumb_file_set()
13314     *
13315     * @ingroup Thumb
13316     */
13317    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13318    /**
13319     * Set the file that will be used as thumbnail.
13320     *
13321     * @param obj The thumb object.
13322     * @param file The path to file that will be used as thumb.
13323     * @param key The key used in case of an EET file.
13324     *
13325     * The file can be an image or a video (in that case, acceptable extensions are:
13326     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13327     * function elm_thumb_animate().
13328     *
13329     * @see elm_thumb_file_get()
13330     * @see elm_thumb_reload()
13331     * @see elm_thumb_animate()
13332     *
13333     * @ingroup Thumb
13334     */
13335    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13336    /**
13337     * Get the image or video path and key used to generate the thumbnail.
13338     *
13339     * @param obj The thumb object.
13340     * @param file Pointer to filename.
13341     * @param key Pointer to key.
13342     *
13343     * @see elm_thumb_file_set()
13344     * @see elm_thumb_path_get()
13345     *
13346     * @ingroup Thumb
13347     */
13348    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13349    /**
13350     * Get the path and key to the image or video generated by ethumb.
13351     *
13352     * One just need to make sure that the thumbnail was generated before getting
13353     * its path; otherwise, the path will be NULL. One way to do that is by asking
13354     * for the path when/after the "generate,stop" smart callback is called.
13355     *
13356     * @param obj The thumb object.
13357     * @param file Pointer to thumb path.
13358     * @param key Pointer to thumb key.
13359     *
13360     * @see elm_thumb_file_get()
13361     *
13362     * @ingroup Thumb
13363     */
13364    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13365    /**
13366     * Set the animation state for the thumb object. If its content is an animated
13367     * video, you may start/stop the animation or tell it to play continuously and
13368     * looping.
13369     *
13370     * @param obj The thumb object.
13371     * @param setting The animation setting.
13372     *
13373     * @see elm_thumb_file_set()
13374     *
13375     * @ingroup Thumb
13376     */
13377    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13378    /**
13379     * Get the animation state for the thumb object.
13380     *
13381     * @param obj The thumb object.
13382     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13383     * on errors.
13384     *
13385     * @see elm_thumb_animate_set()
13386     *
13387     * @ingroup Thumb
13388     */
13389    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13390    /**
13391     * Get the ethumb_client handle so custom configuration can be made.
13392     *
13393     * @return Ethumb_Client instance or NULL.
13394     *
13395     * This must be called before the objects are created to be sure no object is
13396     * visible and no generation started.
13397     *
13398     * Example of usage:
13399     *
13400     * @code
13401     * #include <Elementary.h>
13402     * #ifndef ELM_LIB_QUICKLAUNCH
13403     * EAPI_MAIN int
13404     * elm_main(int argc, char **argv)
13405     * {
13406     *    Ethumb_Client *client;
13407     *
13408     *    elm_need_ethumb();
13409     *
13410     *    // ... your code
13411     *
13412     *    client = elm_thumb_ethumb_client_get();
13413     *    if (!client)
13414     *      {
13415     *         ERR("could not get ethumb_client");
13416     *         return 1;
13417     *      }
13418     *    ethumb_client_size_set(client, 100, 100);
13419     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
13420     *    // ... your code
13421     *
13422     *    // Create elm_thumb objects here
13423     *
13424     *    elm_run();
13425     *    elm_shutdown();
13426     *    return 0;
13427     * }
13428     * #endif
13429     * ELM_MAIN()
13430     * @endcode
13431     *
13432     * @note There's only one client handle for Ethumb, so once a configuration
13433     * change is done to it, any other request for thumbnails (for any thumbnail
13434     * object) will use that configuration. Thus, this configuration is global.
13435     *
13436     * @ingroup Thumb
13437     */
13438    EAPI void                        *elm_thumb_ethumb_client_get(void);
13439    /**
13440     * Get the ethumb_client connection state.
13441     *
13442     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13443     * otherwise.
13444     */
13445    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
13446    /**
13447     * Make the thumbnail 'editable'.
13448     *
13449     * @param obj Thumb object.
13450     * @param set Turn on or off editability. Default is @c EINA_FALSE.
13451     *
13452     * This means the thumbnail is a valid drag target for drag and drop, and can be
13453     * cut or pasted too.
13454     *
13455     * @see elm_thumb_editable_get()
13456     *
13457     * @ingroup Thumb
13458     */
13459    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13460    /**
13461     * Make the thumbnail 'editable'.
13462     *
13463     * @param obj Thumb object.
13464     * @return Editability.
13465     *
13466     * This means the thumbnail is a valid drag target for drag and drop, and can be
13467     * cut or pasted too.
13468     *
13469     * @see elm_thumb_editable_set()
13470     *
13471     * @ingroup Thumb
13472     */
13473    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13474
13475    /**
13476     * @}
13477     */
13478
13479    /**
13480     * @defgroup Web Web
13481     *
13482     * @image html img/widget/web/preview-00.png
13483     * @image latex img/widget/web/preview-00.eps
13484     *
13485     * A web object is used for displaying web pages (HTML/CSS/JS)
13486     * using WebKit-EFL. You must have compiled Elementary with
13487     * ewebkit support.
13488     *
13489     * Signals that you can add callbacks for are:
13490     * @li "download,request": A file download has been requested. Event info is
13491     * a pointer to a Elm_Web_Download
13492     * @li "editorclient,contents,changed": Editor client's contents changed
13493     * @li "editorclient,selection,changed": Editor client's selection changed
13494     * @li "frame,created": A new frame was created. Event info is an
13495     * Evas_Object which can be handled with WebKit's ewk_frame API
13496     * @li "icon,received": An icon was received by the main frame
13497     * @li "inputmethod,changed": Input method changed. Event info is an
13498     * Eina_Bool indicating whether it's enabled or not
13499     * @li "js,windowobject,clear": JS window object has been cleared
13500     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13501     * is a char *link[2], where the first string contains the URL the link
13502     * points to, and the second one the title of the link
13503     * @li "link,hover,out": Mouse cursor left the link
13504     * @li "load,document,finished": Loading of a document finished. Event info
13505     * is the frame that finished loading
13506     * @li "load,error": Load failed. Event info is a pointer to
13507     * Elm_Web_Frame_Load_Error
13508     * @li "load,finished": Load finished. Event info is NULL on success, on
13509     * error it's a pointer to Elm_Web_Frame_Load_Error
13510     * @li "load,newwindow,show": A new window was created and is ready to be
13511     * shown
13512     * @li "load,progress": Overall load progress. Event info is a pointer to
13513     * a double containing a value between 0.0 and 1.0
13514     * @li "load,provisional": Started provisional load
13515     * @li "load,started": Loading of a document started
13516     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13517     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13518     * the menubar is visible, or EINA_FALSE in case it's not
13519     * @li "menubar,visible,set": Informs menubar visibility. Event info is
13520     * an Eina_Bool indicating the visibility
13521     * @li "popup,created": A dropdown widget was activated, requesting its
13522     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13523     * @li "popup,willdelete": The web object is ready to destroy the popup
13524     * object created. Event info is a pointer to Elm_Web_Menu
13525     * @li "ready": Page is fully loaded
13526     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13527     * info is a pointer to Eina_Bool where the visibility state should be set
13528     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13529     * is an Eina_Bool with the visibility state set
13530     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13531     * a string with the new text
13532     * @li "statusbar,visible,get": Queries visibility of the status bar.
13533     * Event info is a pointer to Eina_Bool where the visibility state should be
13534     * set.
13535     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13536     * an Eina_Bool with the visibility value
13537     * @li "title,changed": Title of the main frame changed. Event info is a
13538     * string with the new title
13539     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13540     * is a pointer to Eina_Bool where the visibility state should be set
13541     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13542     * info is an Eina_Bool with the visibility state
13543     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13544     * a string with the text to show
13545     * @li "uri,changed": URI of the main frame changed. Event info is a string
13546     * with the new URI
13547     * @li "view,resized": The web object internal's view changed sized
13548     * @li "windows,close,request": A JavaScript request to close the current
13549     * window was requested
13550     * @li "zoom,animated,end": Animated zoom finished
13551     *
13552     * available styles:
13553     * - default
13554     *
13555     * An example of use of web:
13556     *
13557     * - @ref web_example_01 TBD
13558     */
13559
13560    /**
13561     * @addtogroup Web
13562     * @{
13563     */
13564
13565    /**
13566     * Structure used to report load errors.
13567     *
13568     * Load errors are reported as signal by elm_web. All the strings are
13569     * temporary references and should @b not be used after the signal
13570     * callback returns. If it's required, make copies with strdup() or
13571     * eina_stringshare_add() (they are not even guaranteed to be
13572     * stringshared, so must use eina_stringshare_add() and not
13573     * eina_stringshare_ref()).
13574     */
13575    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13576    /**
13577     * Structure used to report load errors.
13578     *
13579     * Load errors are reported as signal by elm_web. All the strings are
13580     * temporary references and should @b not be used after the signal
13581     * callback returns. If it's required, make copies with strdup() or
13582     * eina_stringshare_add() (they are not even guaranteed to be
13583     * stringshared, so must use eina_stringshare_add() and not
13584     * eina_stringshare_ref()).
13585     */
13586    struct _Elm_Web_Frame_Load_Error
13587      {
13588         int code; /**< Numeric error code */
13589         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13590         const char *domain; /**< Error domain name */
13591         const char *description; /**< Error description (already localized) */
13592         const char *failing_url; /**< The URL that failed to load */
13593         Evas_Object *frame; /**< Frame object that produced the error */
13594      };
13595
13596    /**
13597     * The possibles types that the items in a menu can be
13598     */
13599    typedef enum _Elm_Web_Menu_Item_Type
13600      {
13601         ELM_WEB_MENU_SEPARATOR,
13602         ELM_WEB_MENU_GROUP,
13603         ELM_WEB_MENU_OPTION
13604      } Elm_Web_Menu_Item_Type;
13605
13606    /**
13607     * Structure describing the items in a menu
13608     */
13609    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13610    /**
13611     * Structure describing the items in a menu
13612     */
13613    struct _Elm_Web_Menu_Item
13614      {
13615         const char *text; /**< The text for the item */
13616         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13617      };
13618
13619    /**
13620     * Structure describing the menu of a popup
13621     *
13622     * This structure will be passed as the @c event_info for the "popup,create"
13623     * signal, which is emitted when a dropdown menu is opened. Users wanting
13624     * to handle these popups by themselves should listen to this signal and
13625     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13626     * property as @c EINA_FALSE means that the user will not handle the popup
13627     * and the default implementation will be used.
13628     *
13629     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13630     * will be emitted to notify the user that it can destroy any objects and
13631     * free all data related to it.
13632     *
13633     * @see elm_web_popup_selected_set()
13634     * @see elm_web_popup_destroy()
13635     */
13636    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13637    /**
13638     * Structure describing the menu of a popup
13639     *
13640     * This structure will be passed as the @c event_info for the "popup,create"
13641     * signal, which is emitted when a dropdown menu is opened. Users wanting
13642     * to handle these popups by themselves should listen to this signal and
13643     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13644     * property as @c EINA_FALSE means that the user will not handle the popup
13645     * and the default implementation will be used.
13646     *
13647     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13648     * will be emitted to notify the user that it can destroy any objects and
13649     * free all data related to it.
13650     *
13651     * @see elm_web_popup_selected_set()
13652     * @see elm_web_popup_destroy()
13653     */
13654    struct _Elm_Web_Menu
13655      {
13656         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13657         int x; /**< The X position of the popup, relative to the elm_web object */
13658         int y; /**< The Y position of the popup, relative to the elm_web object */
13659         int width; /**< Width of the popup menu */
13660         int height; /**< Height of the popup menu */
13661
13662         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. */
13663      };
13664
13665    typedef struct _Elm_Web_Download Elm_Web_Download;
13666    struct _Elm_Web_Download
13667      {
13668         const char *url;
13669      };
13670
13671    /**
13672     * Types of zoom available.
13673     */
13674    typedef enum _Elm_Web_Zoom_Mode
13675      {
13676         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_web_zoom_set */
13677         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13678         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13679         ELM_WEB_ZOOM_MODE_LAST
13680      } Elm_Web_Zoom_Mode;
13681    /**
13682     * Opaque handler containing the features (such as statusbar, menubar, etc)
13683     * that are to be set on a newly requested window.
13684     */
13685    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13686    /**
13687     * Callback type for the create_window hook.
13688     *
13689     * The function parameters are:
13690     * @li @p data User data pointer set when setting the hook function
13691     * @li @p obj The elm_web object requesting the new window
13692     * @li @p js Set to @c EINA_TRUE if the request was originated from
13693     * JavaScript. @c EINA_FALSE otherwise.
13694     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13695     * the features requested for the new window.
13696     *
13697     * The returned value of the function should be the @c elm_web widget where
13698     * the request will be loaded. That is, if a new window or tab is created,
13699     * the elm_web widget in it should be returned, and @b NOT the window
13700     * object.
13701     * Returning @c NULL should cancel the request.
13702     *
13703     * @see elm_web_window_create_hook_set()
13704     */
13705    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13706    /**
13707     * Callback type for the JS alert hook.
13708     *
13709     * The function parameters are:
13710     * @li @p data User data pointer set when setting the hook function
13711     * @li @p obj The elm_web object requesting the new window
13712     * @li @p message The message to show in the alert dialog
13713     *
13714     * The function should return the object representing the alert dialog.
13715     * Elm_Web will run a second main loop to handle the dialog and normal
13716     * flow of the application will be restored when the object is deleted, so
13717     * the user should handle the popup properly in order to delete the object
13718     * when the action is finished.
13719     * If the function returns @c NULL the popup will be ignored.
13720     *
13721     * @see elm_web_dialog_alert_hook_set()
13722     */
13723    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13724    /**
13725     * Callback type for the JS confirm hook.
13726     *
13727     * The function parameters are:
13728     * @li @p data User data pointer set when setting the hook function
13729     * @li @p obj The elm_web object requesting the new window
13730     * @li @p message The message to show in the confirm dialog
13731     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13732     * the user selected @c Ok, @c EINA_FALSE otherwise.
13733     *
13734     * The function should return the object representing the confirm dialog.
13735     * Elm_Web will run a second main loop to handle the dialog and normal
13736     * flow of the application will be restored when the object is deleted, so
13737     * the user should handle the popup properly in order to delete the object
13738     * when the action is finished.
13739     * If the function returns @c NULL the popup will be ignored.
13740     *
13741     * @see elm_web_dialog_confirm_hook_set()
13742     */
13743    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13744    /**
13745     * Callback type for the JS prompt hook.
13746     *
13747     * The function parameters are:
13748     * @li @p data User data pointer set when setting the hook function
13749     * @li @p obj The elm_web object requesting the new window
13750     * @li @p message The message to show in the prompt dialog
13751     * @li @p def_value The default value to present the user in the entry
13752     * @li @p value Pointer where to store the value given by the user. Must
13753     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13754     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13755     * the user selected @c Ok, @c EINA_FALSE otherwise.
13756     *
13757     * The function should return the object representing the prompt dialog.
13758     * Elm_Web will run a second main loop to handle the dialog and normal
13759     * flow of the application will be restored when the object is deleted, so
13760     * the user should handle the popup properly in order to delete the object
13761     * when the action is finished.
13762     * If the function returns @c NULL the popup will be ignored.
13763     *
13764     * @see elm_web_dialog_prompt_hook_set()
13765     */
13766    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13767    /**
13768     * Callback type for the JS file selector hook.
13769     *
13770     * The function parameters are:
13771     * @li @p data User data pointer set when setting the hook function
13772     * @li @p obj The elm_web object requesting the new window
13773     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13774     * @li @p accept_types Mime types accepted
13775     * @li @p selected Pointer where to store the list of malloc'ed strings
13776     * containing the path to each file selected. Must be @c NULL if the file
13777     * dialog is cancelled
13778     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13779     * the user selected @c Ok, @c EINA_FALSE otherwise.
13780     *
13781     * The function should return the object representing the file selector
13782     * dialog.
13783     * Elm_Web will run a second main loop to handle the dialog and normal
13784     * flow of the application will be restored when the object is deleted, so
13785     * the user should handle the popup properly in order to delete the object
13786     * when the action is finished.
13787     * If the function returns @c NULL the popup will be ignored.
13788     *
13789     * @see elm_web_dialog_file selector_hook_set()
13790     */
13791    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);
13792    /**
13793     * Callback type for the JS console message hook.
13794     *
13795     * When a console message is added from JavaScript, any set function to the
13796     * console message hook will be called for the user to handle. There is no
13797     * default implementation of this hook.
13798     *
13799     * The function parameters are:
13800     * @li @p data User data pointer set when setting the hook function
13801     * @li @p obj The elm_web object that originated the message
13802     * @li @p message The message sent
13803     * @li @p line_number The line number
13804     * @li @p source_id Source id
13805     *
13806     * @see elm_web_console_message_hook_set()
13807     */
13808    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13809    /**
13810     * Add a new web object to the parent.
13811     *
13812     * @param parent The parent object.
13813     * @return The new object or NULL if it cannot be created.
13814     *
13815     * @see elm_web_uri_set()
13816     * @see elm_web_webkit_view_get()
13817     */
13818    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13819
13820    /**
13821     * Get internal ewk_view object from web object.
13822     *
13823     * Elementary may not provide some low level features of EWebKit,
13824     * instead of cluttering the API with proxy methods we opted to
13825     * return the internal reference. Be careful using it as it may
13826     * interfere with elm_web behavior.
13827     *
13828     * @param obj The web object.
13829     * @return The internal ewk_view object or NULL if it does not
13830     *         exist. (Failure to create or Elementary compiled without
13831     *         ewebkit)
13832     *
13833     * @see elm_web_add()
13834     */
13835    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13836
13837    /**
13838     * Sets the function to call when a new window is requested
13839     *
13840     * This hook will be called when a request to create a new window is
13841     * issued from the web page loaded.
13842     * There is no default implementation for this feature, so leaving this
13843     * unset or passing @c NULL in @p func will prevent new windows from
13844     * opening.
13845     *
13846     * @param obj The web object where to set the hook function
13847     * @param func The hook function to be called when a window is requested
13848     * @param data User data
13849     */
13850    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13851    /**
13852     * Sets the function to call when an alert dialog
13853     *
13854     * This hook will be called when a JavaScript alert dialog is requested.
13855     * If no function is set or @c NULL is passed in @p func, the default
13856     * implementation will take place.
13857     *
13858     * @param obj The web object where to set the hook function
13859     * @param func The callback function to be used
13860     * @param data User data
13861     *
13862     * @see elm_web_inwin_mode_set()
13863     */
13864    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13865    /**
13866     * Sets the function to call when an confirm dialog
13867     *
13868     * This hook will be called when a JavaScript confirm dialog is requested.
13869     * If no function is set or @c NULL is passed in @p func, the default
13870     * implementation will take place.
13871     *
13872     * @param obj The web object where to set the hook function
13873     * @param func The callback function to be used
13874     * @param data User data
13875     *
13876     * @see elm_web_inwin_mode_set()
13877     */
13878    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13879    /**
13880     * Sets the function to call when an prompt dialog
13881     *
13882     * This hook will be called when a JavaScript prompt dialog is requested.
13883     * If no function is set or @c NULL is passed in @p func, the default
13884     * implementation will take place.
13885     *
13886     * @param obj The web object where to set the hook function
13887     * @param func The callback function to be used
13888     * @param data User data
13889     *
13890     * @see elm_web_inwin_mode_set()
13891     */
13892    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13893    /**
13894     * Sets the function to call when an file selector dialog
13895     *
13896     * This hook will be called when a JavaScript file selector dialog is
13897     * requested.
13898     * If no function is set or @c NULL is passed in @p func, the default
13899     * implementation will take place.
13900     *
13901     * @param obj The web object where to set the hook function
13902     * @param func The callback function to be used
13903     * @param data User data
13904     *
13905     * @see elm_web_inwin_mode_set()
13906     */
13907    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13908    /**
13909     * Sets the function to call when a console message is emitted from JS
13910     *
13911     * This hook will be called when a console message is emitted from
13912     * JavaScript. There is no default implementation for this feature.
13913     *
13914     * @param obj The web object where to set the hook function
13915     * @param func The callback function to be used
13916     * @param data User data
13917     */
13918    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13919    /**
13920     * Gets the status of the tab propagation
13921     *
13922     * @param obj The web object to query
13923     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13924     *
13925     * @see elm_web_tab_propagate_set()
13926     */
13927    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
13928    /**
13929     * Sets whether to use tab propagation
13930     *
13931     * If tab propagation is enabled, whenever the user presses the Tab key,
13932     * Elementary will handle it and switch focus to the next widget.
13933     * The default value is disabled, where WebKit will handle the Tab key to
13934     * cycle focus though its internal objects, jumping to the next widget
13935     * only when that cycle ends.
13936     *
13937     * @param obj The web object
13938     * @param propagate Whether to propagate Tab keys to Elementary or not
13939     */
13940    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13941    /**
13942     * Sets the URI for the web object
13943     *
13944     * It must be a full URI, with resource included, in the form
13945     * http://www.enlightenment.org or file:///tmp/something.html
13946     *
13947     * @param obj The web object
13948     * @param uri The URI to set
13949     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13950     */
13951    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
13952    /**
13953     * Gets the current URI for the object
13954     *
13955     * The returned string must not be freed and is guaranteed to be
13956     * stringshared.
13957     *
13958     * @param obj The web object
13959     * @return A stringshared internal string with the current URI, or NULL on
13960     * failure
13961     */
13962    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
13963    /**
13964     * Gets the current title
13965     *
13966     * The returned string must not be freed and is guaranteed to be
13967     * stringshared.
13968     *
13969     * @param obj The web object
13970     * @return A stringshared internal string with the current title, or NULL on
13971     * failure
13972     */
13973    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
13974    /**
13975     * Sets the background color to be used by the web object
13976     *
13977     * This is the color that will be used by default when the loaded page
13978     * does not set it's own. Color values are pre-multiplied.
13979     *
13980     * @param obj The web object
13981     * @param r Red component
13982     * @param g Green component
13983     * @param b Blue component
13984     * @param a Alpha component
13985     */
13986    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13987    /**
13988     * Gets the background color to be used by the web object
13989     *
13990     * This is the color that will be used by default when the loaded page
13991     * does not set it's own. Color values are pre-multiplied.
13992     *
13993     * @param obj The web object
13994     * @param r Red component
13995     * @param g Green component
13996     * @param b Blue component
13997     * @param a Alpha component
13998     */
13999    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
14000    /**
14001     * Gets a copy of the currently selected text
14002     *
14003     * The string returned must be freed by the user when it's done with it.
14004     *
14005     * @param obj The web object
14006     * @return A newly allocated string, or NULL if nothing is selected or an
14007     * error occurred
14008     */
14009    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
14010    /**
14011     * Tells the web object which index in the currently open popup was selected
14012     *
14013     * When the user handles the popup creation from the "popup,created" signal,
14014     * it needs to tell the web object which item was selected by calling this
14015     * function with the index corresponding to the item.
14016     *
14017     * @param obj The web object
14018     * @param index The index selected
14019     *
14020     * @see elm_web_popup_destroy()
14021     */
14022    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
14023    /**
14024     * Dismisses an open dropdown popup
14025     *
14026     * When the popup from a dropdown widget is to be dismissed, either after
14027     * selecting an option or to cancel it, this function must be called, which
14028     * will later emit an "popup,willdelete" signal to notify the user that
14029     * any memory and objects related to this popup can be freed.
14030     *
14031     * @param obj The web object
14032     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
14033     * if there was no menu to destroy
14034     */
14035    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
14036    /**
14037     * Searches the given string in a document.
14038     *
14039     * @param obj The web object where to search the text
14040     * @param string String to search
14041     * @param case_sensitive If search should be case sensitive or not
14042     * @param forward If search is from cursor and on or backwards
14043     * @param wrap If search should wrap at the end
14044     *
14045     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
14046     * or failure
14047     */
14048    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
14049    /**
14050     * Marks matches of the given string in a document.
14051     *
14052     * @param obj The web object where to search text
14053     * @param string String to match
14054     * @param case_sensitive If match should be case sensitive or not
14055     * @param highlight If matches should be highlighted
14056     * @param limit Maximum amount of matches, or zero to unlimited
14057     *
14058     * @return number of matched @a string
14059     */
14060    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
14061    /**
14062     * Clears all marked matches in the document
14063     *
14064     * @param obj The web object
14065     *
14066     * @return EINA_TRUE on success, EINA_FALSE otherwise
14067     */
14068    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
14069    /**
14070     * Sets whether to highlight the matched marks
14071     *
14072     * If enabled, marks set with elm_web_text_matches_mark() will be
14073     * highlighted.
14074     *
14075     * @param obj The web object
14076     * @param highlight Whether to highlight the marks or not
14077     *
14078     * @return EINA_TRUE on success, EINA_FALSE otherwise
14079     */
14080    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
14081    /**
14082     * Gets whether highlighting marks is enabled
14083     *
14084     * @param The web object
14085     *
14086     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
14087     * otherwise
14088     */
14089    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
14090    /**
14091     * Gets the overall loading progress of the page
14092     *
14093     * Returns the estimated loading progress of the page, with a value between
14094     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
14095     * included in the page.
14096     *
14097     * @param The web object
14098     *
14099     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
14100     * failure
14101     */
14102    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
14103    /**
14104     * Stops loading the current page
14105     *
14106     * Cancels the loading of the current page in the web object. This will
14107     * cause a "load,error" signal to be emitted, with the is_cancellation
14108     * flag set to EINA_TRUE.
14109     *
14110     * @param obj The web object
14111     *
14112     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
14113     */
14114    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
14115    /**
14116     * Requests a reload of the current document in the object
14117     *
14118     * @param obj The web object
14119     *
14120     * @return EINA_TRUE on success, EINA_FALSE otherwise
14121     */
14122    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
14123    /**
14124     * Requests a reload of the current document, avoiding any existing caches
14125     *
14126     * @param obj The web object
14127     *
14128     * @return EINA_TRUE on success, EINA_FALSE otherwise
14129     */
14130    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
14131    /**
14132     * Goes back one step in the browsing history
14133     *
14134     * This is equivalent to calling elm_web_object_navigate(obj, -1);
14135     *
14136     * @param obj The web object
14137     *
14138     * @return EINA_TRUE on success, EINA_FALSE otherwise
14139     *
14140     * @see elm_web_history_enable_set()
14141     * @see elm_web_back_possible()
14142     * @see elm_web_forward()
14143     * @see elm_web_navigate()
14144     */
14145    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
14146    /**
14147     * Goes forward one step in the browsing history
14148     *
14149     * This is equivalent to calling elm_web_object_navigate(obj, 1);
14150     *
14151     * @param obj The web object
14152     *
14153     * @return EINA_TRUE on success, EINA_FALSE otherwise
14154     *
14155     * @see elm_web_history_enable_set()
14156     * @see elm_web_forward_possible()
14157     * @see elm_web_back()
14158     * @see elm_web_navigate()
14159     */
14160    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
14161    /**
14162     * Jumps the given number of steps in the browsing history
14163     *
14164     * The @p steps value can be a negative integer to back in history, or a
14165     * positive to move forward.
14166     *
14167     * @param obj The web object
14168     * @param steps The number of steps to jump
14169     *
14170     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14171     * history exists to jump the given number of steps
14172     *
14173     * @see elm_web_history_enable_set()
14174     * @see elm_web_navigate_possible()
14175     * @see elm_web_back()
14176     * @see elm_web_forward()
14177     */
14178    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
14179    /**
14180     * Queries whether it's possible to go back in history
14181     *
14182     * @param obj The web object
14183     *
14184     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14185     * otherwise
14186     */
14187    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
14188    /**
14189     * Queries whether it's possible to go forward in history
14190     *
14191     * @param obj The web object
14192     *
14193     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14194     * otherwise
14195     */
14196    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
14197    /**
14198     * Queries whether it's possible to jump the given number of steps
14199     *
14200     * The @p steps value can be a negative integer to back in history, or a
14201     * positive to move forward.
14202     *
14203     * @param obj The web object
14204     * @param steps The number of steps to check for
14205     *
14206     * @return EINA_TRUE if enough history exists to perform the given jump,
14207     * EINA_FALSE otherwise
14208     */
14209    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
14210    /**
14211     * Gets whether browsing history is enabled for the given object
14212     *
14213     * @param obj The web object
14214     *
14215     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14216     */
14217    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
14218    /**
14219     * Enables or disables the browsing history
14220     *
14221     * @param obj The web object
14222     * @param enable Whether to enable or disable the browsing history
14223     */
14224    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14225    /**
14226     * Sets the zoom level of the web object
14227     *
14228     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14229     * values meaning zoom in and lower meaning zoom out. This function will
14230     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14231     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14232     *
14233     * @param obj The web object
14234     * @param zoom The zoom level to set
14235     */
14236    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
14237    /**
14238     * Gets the current zoom level set on the web object
14239     *
14240     * Note that this is the zoom level set on the web object and not that
14241     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14242     * the two zoom levels should match, but for the other two modes the
14243     * Webkit zoom is calculated internally to match the chosen mode without
14244     * changing the zoom level set for the web object.
14245     *
14246     * @param obj The web object
14247     *
14248     * @return The zoom level set on the object
14249     */
14250    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
14251    /**
14252     * Sets the zoom mode to use
14253     *
14254     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14255     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14256     *
14257     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14258     * with the elm_web_zoom_set() function.
14259     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14260     * make sure the entirety of the web object's contents are shown.
14261     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14262     * fit the contents in the web object's size, without leaving any space
14263     * unused.
14264     *
14265     * @param obj The web object
14266     * @param mode The mode to set
14267     */
14268    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14269    /**
14270     * Gets the currently set zoom mode
14271     *
14272     * @param obj The web object
14273     *
14274     * @return The current zoom mode set for the object, or
14275     * ::ELM_WEB_ZOOM_MODE_LAST on error
14276     */
14277    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
14278    /**
14279     * Shows the given region in the web object
14280     *
14281     * @param obj The web object
14282     * @param x The x coordinate of the region to show
14283     * @param y The y coordinate of the region to show
14284     * @param w The width of the region to show
14285     * @param h The height of the region to show
14286     */
14287    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14288    /**
14289     * Brings in the region to the visible area
14290     *
14291     * Like elm_web_region_show(), but it animates the scrolling of the object
14292     * to show the area
14293     *
14294     * @param obj The web object
14295     * @param x The x coordinate of the region to show
14296     * @param y The y coordinate of the region to show
14297     * @param w The width of the region to show
14298     * @param h The height of the region to show
14299     */
14300    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14301    /**
14302     * Sets the default dialogs to use an Inwin instead of a normal window
14303     *
14304     * If set, then the default implementation for the JavaScript dialogs and
14305     * file selector will be opened in an Inwin. Otherwise they will use a
14306     * normal separated window.
14307     *
14308     * @param obj The web object
14309     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14310     */
14311    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14312    /**
14313     * Gets whether Inwin mode is set for the current object
14314     *
14315     * @param obj The web object
14316     *
14317     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14318     */
14319    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
14320
14321    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14322    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14323    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);
14324    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14325
14326    /**
14327     * @}
14328     */
14329
14330    /**
14331     * @defgroup Hoversel Hoversel
14332     *
14333     * @image html img/widget/hoversel/preview-00.png
14334     * @image latex img/widget/hoversel/preview-00.eps
14335     *
14336     * A hoversel is a button that pops up a list of items (automatically
14337     * choosing the direction to display) that have a label and, optionally, an
14338     * icon to select from. It is a convenience widget to avoid the need to do
14339     * all the piecing together yourself. It is intended for a small number of
14340     * items in the hoversel menu (no more than 8), though is capable of many
14341     * more.
14342     *
14343     * Signals that you can add callbacks for are:
14344     * "clicked" - the user clicked the hoversel button and popped up the sel
14345     * "selected" - an item in the hoversel list is selected. event_info is the item
14346     * "dismissed" - the hover is dismissed
14347     *
14348     * See @ref tutorial_hoversel for an example.
14349     * @{
14350     */
14351    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14352    /**
14353     * @brief Add a new Hoversel object
14354     *
14355     * @param parent The parent object
14356     * @return The new object or NULL if it cannot be created
14357     */
14358    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14359    /**
14360     * @brief This sets the hoversel to expand horizontally.
14361     *
14362     * @param obj The hoversel object
14363     * @param horizontal If true, the hover will expand horizontally to the
14364     * right.
14365     *
14366     * @note The initial button will display horizontally regardless of this
14367     * setting.
14368     */
14369    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14370    /**
14371     * @brief This returns whether the hoversel is set to expand horizontally.
14372     *
14373     * @param obj The hoversel object
14374     * @return If true, the hover will expand horizontally to the right.
14375     *
14376     * @see elm_hoversel_horizontal_set()
14377     */
14378    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14379    /**
14380     * @brief Set the Hover parent
14381     *
14382     * @param obj The hoversel object
14383     * @param parent The parent to use
14384     *
14385     * Sets the hover parent object, the area that will be darkened when the
14386     * hoversel is clicked. Should probably be the window that the hoversel is
14387     * in. See @ref Hover objects for more information.
14388     */
14389    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14390    /**
14391     * @brief Get the Hover parent
14392     *
14393     * @param obj The hoversel object
14394     * @return The used parent
14395     *
14396     * Gets the hover parent object.
14397     *
14398     * @see elm_hoversel_hover_parent_set()
14399     */
14400    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14401    /**
14402     * @brief Set the hoversel button label
14403     *
14404     * @param obj The hoversel object
14405     * @param label The label text.
14406     *
14407     * This sets the label of the button that is always visible (before it is
14408     * clicked and expanded).
14409     *
14410     * @deprecated elm_object_text_set()
14411     */
14412    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14413    /**
14414     * @brief Get the hoversel button label
14415     *
14416     * @param obj The hoversel object
14417     * @return The label text.
14418     *
14419     * @deprecated elm_object_text_get()
14420     */
14421    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14422    /**
14423     * @brief Set the icon of the hoversel button
14424     *
14425     * @param obj The hoversel object
14426     * @param icon The icon object
14427     *
14428     * Sets the icon of the button that is always visible (before it is clicked
14429     * and expanded).  Once the icon object is set, a previously set one will be
14430     * deleted, if you want to keep that old content object, use the
14431     * elm_hoversel_icon_unset() function.
14432     *
14433     * @see elm_object_content_set() for the button widget
14434     */
14435    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14436    /**
14437     * @brief Get the icon of the hoversel button
14438     *
14439     * @param obj The hoversel object
14440     * @return The icon object
14441     *
14442     * Get the icon of the button that is always visible (before it is clicked
14443     * and expanded). Also see elm_object_content_get() for the button widget.
14444     *
14445     * @see elm_hoversel_icon_set()
14446     */
14447    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14448    /**
14449     * @brief Get and unparent the icon of the hoversel button
14450     *
14451     * @param obj The hoversel object
14452     * @return The icon object that was being used
14453     *
14454     * Unparent and return the icon of the button that is always visible
14455     * (before it is clicked and expanded).
14456     *
14457     * @see elm_hoversel_icon_set()
14458     * @see elm_object_content_unset() for the button widget
14459     */
14460    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14461    /**
14462     * @brief This triggers the hoversel popup from code, the same as if the user
14463     * had clicked the button.
14464     *
14465     * @param obj The hoversel object
14466     */
14467    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14468    /**
14469     * @brief This dismisses the hoversel popup as if the user had clicked
14470     * outside the hover.
14471     *
14472     * @param obj The hoversel object
14473     */
14474    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14475    /**
14476     * @brief Returns whether the hoversel is expanded.
14477     *
14478     * @param obj The hoversel object
14479     * @return  This will return EINA_TRUE if the hoversel is expanded or
14480     * EINA_FALSE if it is not expanded.
14481     */
14482    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14483    /**
14484     * @brief This will remove all the children items from the hoversel.
14485     *
14486     * @param obj The hoversel object
14487     *
14488     * @warning Should @b not be called while the hoversel is active; use
14489     * elm_hoversel_expanded_get() to check first.
14490     *
14491     * @see elm_hoversel_item_del_cb_set()
14492     * @see elm_hoversel_item_del()
14493     */
14494    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14495    /**
14496     * @brief Get the list of items within the given hoversel.
14497     *
14498     * @param obj The hoversel object
14499     * @return Returns a list of Elm_Hoversel_Item*
14500     *
14501     * @see elm_hoversel_item_add()
14502     */
14503    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14504    /**
14505     * @brief Add an item to the hoversel button
14506     *
14507     * @param obj The hoversel object
14508     * @param label The text label to use for the item (NULL if not desired)
14509     * @param icon_file An image file path on disk to use for the icon or standard
14510     * icon name (NULL if not desired)
14511     * @param icon_type The icon type if relevant
14512     * @param func Convenience function to call when this item is selected
14513     * @param data Data to pass to item-related functions
14514     * @return A handle to the item added.
14515     *
14516     * This adds an item to the hoversel to show when it is clicked. Note: if you
14517     * need to use an icon from an edje file then use
14518     * elm_hoversel_item_icon_set() right after the this function, and set
14519     * icon_file to NULL here.
14520     *
14521     * For more information on what @p icon_file and @p icon_type are see the
14522     * @ref Icon "icon documentation".
14523     */
14524    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);
14525    /**
14526     * @brief Delete an item from the hoversel
14527     *
14528     * @param item The item to delete
14529     *
14530     * This deletes the item from the hoversel (should not be called while the
14531     * hoversel is active; use elm_hoversel_expanded_get() to check first).
14532     *
14533     * @see elm_hoversel_item_add()
14534     * @see elm_hoversel_item_del_cb_set()
14535     */
14536    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14537    /**
14538     * @brief Set the function to be called when an item from the hoversel is
14539     * freed.
14540     *
14541     * @param item The item to set the callback on
14542     * @param func The function called
14543     *
14544     * That function will receive these parameters:
14545     * @li void *item_data
14546     * @li Evas_Object *the_item_object
14547     * @li Elm_Hoversel_Item *the_object_struct
14548     *
14549     * @see elm_hoversel_item_add()
14550     */
14551    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14552    /**
14553     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14554     * that will be passed to associated function callbacks.
14555     *
14556     * @param item The item to get the data from
14557     * @return The data pointer set with elm_hoversel_item_add()
14558     *
14559     * @see elm_hoversel_item_add()
14560     */
14561    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14562    /**
14563     * @brief This returns the label text of the given hoversel item.
14564     *
14565     * @param item The item to get the label
14566     * @return The label text of the hoversel item
14567     *
14568     * @see elm_hoversel_item_add()
14569     */
14570    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14571    /**
14572     * @brief This sets the icon for the given hoversel item.
14573     *
14574     * @param item The item to set the icon
14575     * @param icon_file An image file path on disk to use for the icon or standard
14576     * icon name
14577     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14578     * to NULL if the icon is not an edje file
14579     * @param icon_type The icon type
14580     *
14581     * The icon can be loaded from the standard set, from an image file, or from
14582     * an edje file.
14583     *
14584     * @see elm_hoversel_item_add()
14585     */
14586    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);
14587    /**
14588     * @brief Get the icon object of the hoversel item
14589     *
14590     * @param item The item to get the icon from
14591     * @param icon_file The image file path on disk used for the icon or standard
14592     * icon name
14593     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14594     * if the icon is not an edje file
14595     * @param icon_type The icon type
14596     *
14597     * @see elm_hoversel_item_icon_set()
14598     * @see elm_hoversel_item_add()
14599     */
14600    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);
14601    /**
14602     * @}
14603     */
14604
14605    /**
14606     * @defgroup Toolbar Toolbar
14607     * @ingroup Elementary
14608     *
14609     * @image html img/widget/toolbar/preview-00.png
14610     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14611     *
14612     * @image html img/toolbar.png
14613     * @image latex img/toolbar.eps width=\textwidth
14614     *
14615     * A toolbar is a widget that displays a list of items inside
14616     * a box. It can be scrollable, show a menu with items that don't fit
14617     * to toolbar size or even crop them.
14618     *
14619     * Only one item can be selected at a time.
14620     *
14621     * Items can have multiple states, or show menus when selected by the user.
14622     *
14623     * Smart callbacks one can listen to:
14624     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14625     * - "language,changed" - when the program language changes
14626     *
14627     * Available styles for it:
14628     * - @c "default"
14629     * - @c "transparent" - no background or shadow, just show the content
14630     *
14631     * List of examples:
14632     * @li @ref toolbar_example_01
14633     * @li @ref toolbar_example_02
14634     * @li @ref toolbar_example_03
14635     */
14636
14637    /**
14638     * @addtogroup Toolbar
14639     * @{
14640     */
14641
14642    /**
14643     * @enum _Elm_Toolbar_Shrink_Mode
14644     * @typedef Elm_Toolbar_Shrink_Mode
14645     *
14646     * Set toolbar's items display behavior, it can be scrollabel,
14647     * show a menu with exceeding items, or simply hide them.
14648     *
14649     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14650     * from elm config.
14651     *
14652     * Values <b> don't </b> work as bitmask, only one can be choosen.
14653     *
14654     * @see elm_toolbar_mode_shrink_set()
14655     * @see elm_toolbar_mode_shrink_get()
14656     *
14657     * @ingroup Toolbar
14658     */
14659    typedef enum _Elm_Toolbar_Shrink_Mode
14660      {
14661         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
14662         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
14663         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14664         ELM_TOOLBAR_SHRINK_MENU,   /**< Inserts a button to pop up a menu with exceeding items. */
14665         ELM_TOOLBAR_SHRINK_LAST    /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14666      } Elm_Toolbar_Shrink_Mode;
14667
14668    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(). */
14669
14670    /**
14671     * Add a new toolbar widget to the given parent Elementary
14672     * (container) object.
14673     *
14674     * @param parent The parent object.
14675     * @return a new toolbar widget handle or @c NULL, on errors.
14676     *
14677     * This function inserts a new toolbar widget on the canvas.
14678     *
14679     * @ingroup Toolbar
14680     */
14681    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14682    /**
14683     * Set the icon size, in pixels, to be used by toolbar items.
14684     *
14685     * @param obj The toolbar object
14686     * @param icon_size The icon size in pixels
14687     *
14688     * @note Default value is @c 32. It reads value from elm config.
14689     *
14690     * @see elm_toolbar_icon_size_get()
14691     *
14692     * @ingroup Toolbar
14693     */
14694    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14695    /**
14696     * Get the icon size, in pixels, to be used by toolbar items.
14697     *
14698     * @param obj The toolbar object.
14699     * @return The icon size in pixels.
14700     *
14701     * @see elm_toolbar_icon_size_set() for details.
14702     *
14703     * @ingroup Toolbar
14704     */
14705    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14706    /**
14707     * Sets icon lookup order, for toolbar items' icons.
14708     *
14709     * @param obj The toolbar object.
14710     * @param order The icon lookup order.
14711     *
14712     * Icons added before calling this function will not be affected.
14713     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14714     *
14715     * @see elm_toolbar_icon_order_lookup_get()
14716     *
14717     * @ingroup Toolbar
14718     */
14719    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14720    /**
14721     * Gets the icon lookup order.
14722     *
14723     * @param obj The toolbar object.
14724     * @return The icon lookup order.
14725     *
14726     * @see elm_toolbar_icon_order_lookup_set() for details.
14727     *
14728     * @ingroup Toolbar
14729     */
14730    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14731    /**
14732     * Set whether the toolbar should always have an item selected.
14733     *
14734     * @param obj The toolbar object.
14735     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14736     * disable it.
14737     *
14738     * This will cause the toolbar to always have an item selected, and clicking
14739     * the selected item will not cause a selected event to be emitted. Enabling this mode
14740     * will immediately select the first toolbar item.
14741     *
14742     * Always-selected is disabled by default.
14743     *
14744     * @see elm_toolbar_always_select_mode_get().
14745     *
14746     * @ingroup Toolbar
14747     */
14748    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14749    /**
14750     * Get whether the toolbar should always have an item selected.
14751     *
14752     * @param obj The toolbar object.
14753     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14754     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14755     *
14756     * @see elm_toolbar_always_select_mode_set() for details.
14757     *
14758     * @ingroup Toolbar
14759     */
14760    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14761    /**
14762     * Set whether the toolbar items' should be selected by the user or not.
14763     *
14764     * @param obj The toolbar object.
14765     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14766     * enable it.
14767     *
14768     * This will turn off the ability to select items entirely and they will
14769     * neither appear selected nor emit selected signals. The clicked
14770     * callback function will still be called.
14771     *
14772     * Selection is enabled by default.
14773     *
14774     * @see elm_toolbar_no_select_mode_get().
14775     *
14776     * @ingroup Toolbar
14777     */
14778    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14779
14780    /**
14781     * Set whether the toolbar items' should be selected by the user or not.
14782     *
14783     * @param obj The toolbar object.
14784     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14785     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14786     *
14787     * @see elm_toolbar_no_select_mode_set() for details.
14788     *
14789     * @ingroup Toolbar
14790     */
14791    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14792    /**
14793     * Append item to the toolbar.
14794     *
14795     * @param obj The toolbar object.
14796     * @param icon A string with icon name or the absolute path of an image file.
14797     * @param label The label of the item.
14798     * @param func The function to call when the item is clicked.
14799     * @param data The data to associate with the item for related callbacks.
14800     * @return The created item or @c NULL upon failure.
14801     *
14802     * A new item will be created and appended to the toolbar, i.e., will
14803     * be set as @b last item.
14804     *
14805     * Items created with this method can be deleted with
14806     * elm_toolbar_item_del().
14807     *
14808     * Associated @p data can be properly freed when item is deleted if a
14809     * callback function is set with elm_toolbar_item_del_cb_set().
14810     *
14811     * If a function is passed as argument, it will be called everytime this item
14812     * is selected, i.e., the user clicks over an unselected item.
14813     * If such function isn't needed, just passing
14814     * @c NULL as @p func is enough. The same should be done for @p data.
14815     *
14816     * Toolbar will load icon image from fdo or current theme.
14817     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14818     * If an absolute path is provided it will load it direct from a file.
14819     *
14820     * @see elm_toolbar_item_icon_set()
14821     * @see elm_toolbar_item_del()
14822     * @see elm_toolbar_item_del_cb_set()
14823     *
14824     * @ingroup Toolbar
14825     */
14826    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);
14827    /**
14828     * Prepend item to the toolbar.
14829     *
14830     * @param obj The toolbar object.
14831     * @param icon A string with icon name or the absolute path of an image file.
14832     * @param label The label of the item.
14833     * @param func The function to call when the item is clicked.
14834     * @param data The data to associate with the item for related callbacks.
14835     * @return The created item or @c NULL upon failure.
14836     *
14837     * A new item will be created and prepended to the toolbar, i.e., will
14838     * be set as @b first item.
14839     *
14840     * Items created with this method can be deleted with
14841     * elm_toolbar_item_del().
14842     *
14843     * Associated @p data can be properly freed when item is deleted if a
14844     * callback function is set with elm_toolbar_item_del_cb_set().
14845     *
14846     * If a function is passed as argument, it will be called everytime this item
14847     * is selected, i.e., the user clicks over an unselected item.
14848     * If such function isn't needed, just passing
14849     * @c NULL as @p func is enough. The same should be done for @p data.
14850     *
14851     * Toolbar will load icon image from fdo or current theme.
14852     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14853     * If an absolute path is provided it will load it direct from a file.
14854     *
14855     * @see elm_toolbar_item_icon_set()
14856     * @see elm_toolbar_item_del()
14857     * @see elm_toolbar_item_del_cb_set()
14858     *
14859     * @ingroup Toolbar
14860     */
14861    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);
14862    /**
14863     * Insert a new item into the toolbar object before item @p before.
14864     *
14865     * @param obj The toolbar object.
14866     * @param before The toolbar item to insert before.
14867     * @param icon A string with icon name or the absolute path of an image file.
14868     * @param label The label of the item.
14869     * @param func The function to call when the item is clicked.
14870     * @param data The data to associate with the item for related callbacks.
14871     * @return The created item or @c NULL upon failure.
14872     *
14873     * A new item will be created and added to the toolbar. Its position in
14874     * this toolbar will be just before item @p before.
14875     *
14876     * Items created with this method can be deleted with
14877     * elm_toolbar_item_del().
14878     *
14879     * Associated @p data can be properly freed when item is deleted if a
14880     * callback function is set with elm_toolbar_item_del_cb_set().
14881     *
14882     * If a function is passed as argument, it will be called everytime this item
14883     * is selected, i.e., the user clicks over an unselected item.
14884     * If such function isn't needed, just passing
14885     * @c NULL as @p func is enough. The same should be done for @p data.
14886     *
14887     * Toolbar will load icon image from fdo or current theme.
14888     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14889     * If an absolute path is provided it will load it direct from a file.
14890     *
14891     * @see elm_toolbar_item_icon_set()
14892     * @see elm_toolbar_item_del()
14893     * @see elm_toolbar_item_del_cb_set()
14894     *
14895     * @ingroup Toolbar
14896     */
14897    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);
14898
14899    /**
14900     * Insert a new item into the toolbar object after item @p after.
14901     *
14902     * @param obj The toolbar object.
14903     * @param after The toolbar item to insert after.
14904     * @param icon A string with icon name or the absolute path of an image file.
14905     * @param label The label of the item.
14906     * @param func The function to call when the item is clicked.
14907     * @param data The data to associate with the item for related callbacks.
14908     * @return The created item or @c NULL upon failure.
14909     *
14910     * A new item will be created and added to the toolbar. Its position in
14911     * this toolbar will be just after item @p after.
14912     *
14913     * Items created with this method can be deleted with
14914     * elm_toolbar_item_del().
14915     *
14916     * Associated @p data can be properly freed when item is deleted if a
14917     * callback function is set with elm_toolbar_item_del_cb_set().
14918     *
14919     * If a function is passed as argument, it will be called everytime this item
14920     * is selected, i.e., the user clicks over an unselected item.
14921     * If such function isn't needed, just passing
14922     * @c NULL as @p func is enough. The same should be done for @p data.
14923     *
14924     * Toolbar will load icon image from fdo or current theme.
14925     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14926     * If an absolute path is provided it will load it direct from a file.
14927     *
14928     * @see elm_toolbar_item_icon_set()
14929     * @see elm_toolbar_item_del()
14930     * @see elm_toolbar_item_del_cb_set()
14931     *
14932     * @ingroup Toolbar
14933     */
14934    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);
14935    /**
14936     * Get the first item in the given toolbar widget's list of
14937     * items.
14938     *
14939     * @param obj The toolbar object
14940     * @return The first item or @c NULL, if it has no items (and on
14941     * errors)
14942     *
14943     * @see elm_toolbar_item_append()
14944     * @see elm_toolbar_last_item_get()
14945     *
14946     * @ingroup Toolbar
14947     */
14948    EAPI Elm_Object_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14949    /**
14950     * Get the last item in the given toolbar widget's list of
14951     * items.
14952     *
14953     * @param obj The toolbar object
14954     * @return The last item or @c NULL, if it has no items (and on
14955     * errors)
14956     *
14957     * @see elm_toolbar_item_prepend()
14958     * @see elm_toolbar_first_item_get()
14959     *
14960     * @ingroup Toolbar
14961     */
14962    EAPI Elm_Object_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14963    /**
14964     * Get the item after @p item in toolbar.
14965     *
14966     * @param it The toolbar item.
14967     * @return The item after @p item, or @c NULL if none or on failure.
14968     *
14969     * @note If it is the last item, @c NULL will be returned.
14970     *
14971     * @see elm_toolbar_item_append()
14972     *
14973     * @ingroup Toolbar
14974     */
14975    EAPI Elm_Object_Item       *elm_toolbar_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14976    /**
14977     * Get the item before @p item in toolbar.
14978     *
14979     * @param item The toolbar item.
14980     * @return The item before @p item, or @c NULL if none or on failure.
14981     *
14982     * @note If it is the first item, @c NULL will be returned.
14983     *
14984     * @see elm_toolbar_item_prepend()
14985     *
14986     * @ingroup Toolbar
14987     */
14988    EAPI Elm_Object_Item       *elm_toolbar_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
14989    /**
14990     * Get the toolbar object from an item.
14991     *
14992     * @param it The item.
14993     * @return The toolbar object.
14994     *
14995     * This returns the toolbar object itself that an item belongs to.
14996     *
14997     * @ingroup Toolbar
14998     */
14999    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15000    /**
15001     * Set the priority of a toolbar item.
15002     *
15003     * @param it The toolbar item.
15004     * @param priority The item priority. The default is zero.
15005     *
15006     * This is used only when the toolbar shrink mode is set to
15007     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
15008     * When space is less than required, items with low priority
15009     * will be removed from the toolbar and added to a dynamically-created menu,
15010     * while items with higher priority will remain on the toolbar,
15011     * with the same order they were added.
15012     *
15013     * @see elm_toolbar_item_priority_get()
15014     *
15015     * @ingroup Toolbar
15016     */
15017    EAPI void                    elm_toolbar_item_priority_set(Elm_Object_Item *it, int priority) EINA_ARG_NONNULL(1);
15018    /**
15019     * Get the priority of a toolbar item.
15020     *
15021     * @param it The toolbar item.
15022     * @return The @p item priority, or @c 0 on failure.
15023     *
15024     * @see elm_toolbar_item_priority_set() for details.
15025     *
15026     * @ingroup Toolbar
15027     */
15028    EAPI int                     elm_toolbar_item_priority_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15029    /**
15030     * Get the label of item.
15031     *
15032     * @param it The item of toolbar.
15033     * @return The label of item.
15034     *
15035     * The return value is a pointer to the label associated to @p item when
15036     * it was created, with function elm_toolbar_item_append() or similar,
15037     * or later,
15038     * with function elm_toolbar_item_label_set. If no label
15039     * was passed as argument, it will return @c NULL.
15040     *
15041     * @see elm_toolbar_item_label_set() for more details.
15042     * @see elm_toolbar_item_append()
15043     *
15044     * @ingroup Toolbar
15045     */
15046    EAPI const char             *elm_toolbar_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15047    /**
15048     * Set the label of item.
15049     *
15050     * @param it The item of toolbar.
15051     * @param text The label of item.
15052     *
15053     * The label to be displayed by the item.
15054     * Label will be placed at icons bottom (if set).
15055     *
15056     * If a label was passed as argument on item creation, with function
15057     * elm_toolbar_item_append() or similar, it will be already
15058     * displayed by the item.
15059     *
15060     * @see elm_toolbar_item_label_get()
15061     * @see elm_toolbar_item_append()
15062     *
15063     * @ingroup Toolbar
15064     */
15065    EAPI void                    elm_toolbar_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
15066    /**
15067     * Return the data associated with a given toolbar widget item.
15068     *
15069     * @param it The toolbar widget item handle.
15070     * @return The data associated with @p item.
15071     *
15072     * @see elm_toolbar_item_data_set()
15073     *
15074     * @ingroup Toolbar
15075     */
15076    EAPI void                   *elm_toolbar_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15077    /**
15078     * Set the data associated with a given toolbar widget item.
15079     *
15080     * @param it The toolbar widget item handle
15081     * @param data The new data pointer to set to @p item.
15082     *
15083     * This sets new item data on @p item.
15084     *
15085     * @warning The old data pointer won't be touched by this function, so
15086     * the user had better to free that old data himself/herself.
15087     *
15088     * @ingroup Toolbar
15089     */
15090    EAPI void                    elm_toolbar_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
15091    /**
15092     * Returns a pointer to a toolbar item by its label.
15093     *
15094     * @param obj The toolbar object.
15095     * @param label The label of the item to find.
15096     *
15097     * @return The pointer to the toolbar item matching @p label or @c NULL
15098     * on failure.
15099     *
15100     * @ingroup Toolbar
15101     */
15102    EAPI Elm_Object_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15103    /*
15104     * Get whether the @p item is selected or not.
15105     *
15106     * @param it The toolbar item.
15107     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15108     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15109     *
15110     * @see elm_toolbar_selected_item_set() for details.
15111     * @see elm_toolbar_item_selected_get()
15112     *
15113     * @ingroup Toolbar
15114     */
15115    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15116    /**
15117     * Set the selected state of an item.
15118     *
15119     * @param it The toolbar item
15120     * @param selected The selected state
15121     *
15122     * This sets the selected state of the given item @p it.
15123     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15124     *
15125     * If a new item is selected the previosly selected will be unselected.
15126     * Previoulsy selected item can be get with function
15127     * elm_toolbar_selected_item_get().
15128     *
15129     * Selected items will be highlighted.
15130     *
15131     * @see elm_toolbar_item_selected_get()
15132     * @see elm_toolbar_selected_item_get()
15133     *
15134     * @ingroup Toolbar
15135     */
15136    EAPI void                    elm_toolbar_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
15137    /**
15138     * Get the selected item.
15139     *
15140     * @param obj The toolbar object.
15141     * @return The selected toolbar item.
15142     *
15143     * The selected item can be unselected with function
15144     * elm_toolbar_item_selected_set().
15145     *
15146     * The selected item always will be highlighted on toolbar.
15147     *
15148     * @see elm_toolbar_selected_items_get()
15149     *
15150     * @ingroup Toolbar
15151     */
15152    EAPI Elm_Object_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15153    /**
15154     * Set the icon associated with @p item.
15155     *
15156     * @param obj The parent of this item.
15157     * @param it The toolbar item.
15158     * @param icon A string with icon name or the absolute path of an image file.
15159     *
15160     * Toolbar will load icon image from fdo or current theme.
15161     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15162     * If an absolute path is provided it will load it direct from a file.
15163     *
15164     * @see elm_toolbar_icon_order_lookup_set()
15165     * @see elm_toolbar_icon_order_lookup_get()
15166     *
15167     * @ingroup Toolbar
15168     */
15169    EAPI void                    elm_toolbar_item_icon_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1);
15170    /**
15171     * Get the string used to set the icon of @p item.
15172     *
15173     * @param it The toolbar item.
15174     * @return The string associated with the icon object.
15175     *
15176     * @see elm_toolbar_item_icon_set() for details.
15177     *
15178     * @ingroup Toolbar
15179     */
15180    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15181    /**
15182     * Get the object of @p item.
15183     *
15184     * @param it The toolbar item.
15185     * @return The object
15186     *
15187     * @ingroup Toolbar
15188     */
15189    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15190    /**
15191     * Get the icon object of @p item.
15192     *
15193     * @param it The toolbar item.
15194     * @return The icon object
15195     *
15196     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
15197     *
15198     * @ingroup Toolbar
15199     */
15200    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15201    /**
15202     * Set the icon associated with @p item to an image in a binary buffer.
15203     *
15204     * @param it The toolbar item.
15205     * @param img The binary data that will be used as an image
15206     * @param size The size of binary data @p img
15207     * @param format Optional format of @p img to pass to the image loader
15208     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15209     *
15210     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15211     *
15212     * @note The icon image set by this function can be changed by
15213     * elm_toolbar_item_icon_set().
15214     *
15215     * @ingroup Toolbar
15216     */
15217    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);
15218    /**
15219     * Delete them item from the toolbar.
15220     *
15221     * @param it The item of toolbar to be deleted.
15222     *
15223     * @see elm_toolbar_item_append()
15224     * @see elm_toolbar_item_del_cb_set()
15225     *
15226     * @ingroup Toolbar
15227     */
15228    EAPI void                    elm_toolbar_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15229
15230    /**
15231     * Set the function called when a toolbar item is freed.
15232     *
15233     * @param it The item to set the callback on.
15234     * @param func The function called.
15235     *
15236     * If there is a @p func, then it will be called prior item's memory release.
15237     * That will be called with the following arguments:
15238     * @li item's data;
15239     * @li item's Evas object;
15240     * @li item itself;
15241     *
15242     * This way, a data associated to a toolbar item could be properly freed.
15243     *
15244     * @ingroup Toolbar
15245     */
15246    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15247
15248    /**
15249     * Get a value whether toolbar item is disabled or not.
15250     *
15251     * @param it The item.
15252     * @return The disabled state.
15253     *
15254     * @see elm_toolbar_item_disabled_set() for more details.
15255     *
15256     * @ingroup Toolbar
15257     */
15258    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15259
15260    /**
15261     * Sets the disabled/enabled state of a toolbar item.
15262     *
15263     * @param it The item.
15264     * @param disabled The disabled state.
15265     *
15266     * A disabled item cannot be selected or unselected. It will also
15267     * change its appearance (generally greyed out). This sets the
15268     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15269     * enabled).
15270     *
15271     * @ingroup Toolbar
15272     */
15273    EAPI void                    elm_toolbar_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15274
15275    /**
15276     * Set or unset item as a separator.
15277     *
15278     * @param it The toolbar item.
15279     * @param setting @c EINA_TRUE to set item @p item as separator or
15280     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15281     *
15282     * Items aren't set as separator by default.
15283     *
15284     * If set as separator it will display separator theme, so won't display
15285     * icons or label.
15286     *
15287     * @see elm_toolbar_item_separator_get()
15288     *
15289     * @ingroup Toolbar
15290     */
15291    EAPI void                    elm_toolbar_item_separator_set(Elm_Object_Item *it, Eina_Bool separator) EINA_ARG_NONNULL(1);
15292
15293    /**
15294     * Get a value whether item is a separator or not.
15295     *
15296     * @param it The toolbar item.
15297     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15298     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15299     *
15300     * @see elm_toolbar_item_separator_set() for details.
15301     *
15302     * @ingroup Toolbar
15303     */
15304    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15305
15306    /**
15307     * Set the shrink state of toolbar @p obj.
15308     *
15309     * @param obj The toolbar object.
15310     * @param shrink_mode Toolbar's items display behavior.
15311     *
15312     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15313     * but will enforce a minimun size so all the items will fit, won't scroll
15314     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15315     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15316     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15317     *
15318     * @ingroup Toolbar
15319     */
15320    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15321
15322    /**
15323     * Get the shrink mode of toolbar @p obj.
15324     *
15325     * @param obj The toolbar object.
15326     * @return Toolbar's items display behavior.
15327     *
15328     * @see elm_toolbar_mode_shrink_set() for details.
15329     *
15330     * @ingroup Toolbar
15331     */
15332    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15333
15334    /**
15335     * Enable/disable homogeneous mode.
15336     *
15337     * @param obj The toolbar object
15338     * @param homogeneous Assume the items within the toolbar are of the
15339     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15340     *
15341     * This will enable the homogeneous mode where items are of the same size.
15342     * @see elm_toolbar_homogeneous_get()
15343     *
15344     * @ingroup Toolbar
15345     */
15346    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15347
15348    /**
15349     * Get whether the homogeneous mode is enabled.
15350     *
15351     * @param obj The toolbar object.
15352     * @return Assume the items within the toolbar are of the same height
15353     * and width (EINA_TRUE = on, EINA_FALSE = off).
15354     *
15355     * @see elm_toolbar_homogeneous_set()
15356     *
15357     * @ingroup Toolbar
15358     */
15359    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15360    /**
15361     * Set the parent object of the toolbar items' menus.
15362     *
15363     * @param obj The toolbar object.
15364     * @param parent The parent of the menu objects.
15365     *
15366     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15367     *
15368     * For more details about setting the parent for toolbar menus, see
15369     * elm_menu_parent_set().
15370     *
15371     * @see elm_menu_parent_set() for details.
15372     * @see elm_toolbar_item_menu_set() for details.
15373     *
15374     * @ingroup Toolbar
15375     */
15376    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15377    /**
15378     * Get the parent object of the toolbar items' menus.
15379     *
15380     * @param obj The toolbar object.
15381     * @return The parent of the menu objects.
15382     *
15383     * @see elm_toolbar_menu_parent_set() for details.
15384     *
15385     * @ingroup Toolbar
15386     */
15387    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15388    /**
15389     * Set the alignment of the items.
15390     *
15391     * @param obj The toolbar object.
15392     * @param align The new alignment, a float between <tt> 0.0 </tt>
15393     * and <tt> 1.0 </tt>.
15394     *
15395     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15396     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15397     * items.
15398     *
15399     * Centered items by default.
15400     *
15401     * @see elm_toolbar_align_get()
15402     *
15403     * @ingroup Toolbar
15404     */
15405    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15406    /**
15407     * Get the alignment of the items.
15408     *
15409     * @param obj The toolbar object.
15410     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15411     * <tt> 1.0 </tt>.
15412     *
15413     * @see elm_toolbar_align_set() for details.
15414     *
15415     * @ingroup Toolbar
15416     */
15417    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15418    /**
15419     * Set whether the toolbar item opens a menu.
15420     *
15421     * @param it The toolbar item.
15422     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15423     *
15424     * A toolbar item can be set to be a menu, using this function.
15425     *
15426     * Once it is set to be a menu, it can be manipulated through the
15427     * menu-like function elm_toolbar_menu_parent_set() and the other
15428     * elm_menu functions, using the Evas_Object @c menu returned by
15429     * elm_toolbar_item_menu_get().
15430     *
15431     * So, items to be displayed in this item's menu should be added with
15432     * elm_menu_item_add().
15433     *
15434     * The following code exemplifies the most basic usage:
15435     * @code
15436     * tb = elm_toolbar_add(win)
15437     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15438     * elm_toolbar_item_menu_set(item, EINA_TRUE);
15439     * elm_toolbar_menu_parent_set(tb, win);
15440     * menu = elm_toolbar_item_menu_get(item);
15441     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15442     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15443     * NULL);
15444     * @endcode
15445     *
15446     * @see elm_toolbar_item_menu_get()
15447     *
15448     * @ingroup Toolbar
15449     */
15450    EAPI void                    elm_toolbar_item_menu_set(Elm_Object_Item *it, Eina_Bool menu) EINA_ARG_NONNULL(1);
15451    /**
15452     * Get toolbar item's menu.
15453     *
15454     * @param it The toolbar item.
15455     * @return Item's menu object or @c NULL on failure.
15456     *
15457     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15458     * this function will set it.
15459     *
15460     * @see elm_toolbar_item_menu_set() for details.
15461     *
15462     * @ingroup Toolbar
15463     */
15464    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15465    /**
15466     * Add a new state to @p item.
15467     *
15468     * @param it The toolbar item.
15469     * @param icon A string with icon name or the absolute path of an image file.
15470     * @param label The label of the new state.
15471     * @param func The function to call when the item is clicked when this
15472     * state is selected.
15473     * @param data The data to associate with the state.
15474     * @return The toolbar item state, or @c NULL upon failure.
15475     *
15476     * Toolbar will load icon image from fdo or current theme.
15477     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15478     * If an absolute path is provided it will load it direct from a file.
15479     *
15480     * States created with this function can be removed with
15481     * elm_toolbar_item_state_del().
15482     *
15483     * @see elm_toolbar_item_state_del()
15484     * @see elm_toolbar_item_state_sel()
15485     * @see elm_toolbar_item_state_get()
15486     *
15487     * @ingroup Toolbar
15488     */
15489    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);
15490    /**
15491     * Delete a previoulsy added state to @p item.
15492     *
15493     * @param it The toolbar item.
15494     * @param state The state to be deleted.
15495     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15496     *
15497     * @see elm_toolbar_item_state_add()
15498     */
15499    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15500    /**
15501     * Set @p state as the current state of @p it.
15502     *
15503     * @param it The toolbar item.
15504     * @param state The state to use.
15505     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15506     *
15507     * If @p state is @c NULL, it won't select any state and the default item's
15508     * icon and label will be used. It's the same behaviour than
15509     * elm_toolbar_item_state_unser().
15510     *
15511     * @see elm_toolbar_item_state_unset()
15512     *
15513     * @ingroup Toolbar
15514     */
15515    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15516    /**
15517     * Unset the state of @p it.
15518     *
15519     * @param it The toolbar item.
15520     *
15521     * The default icon and label from this item will be displayed.
15522     *
15523     * @see elm_toolbar_item_state_set() for more details.
15524     *
15525     * @ingroup Toolbar
15526     */
15527    EAPI void                    elm_toolbar_item_state_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15528    /**
15529     * Get the current state of @p it.
15530     *
15531     * @param it The toolbar item.
15532     * @return The selected state or @c NULL if none is selected or on failure.
15533     *
15534     * @see elm_toolbar_item_state_set() for details.
15535     * @see elm_toolbar_item_state_unset()
15536     * @see elm_toolbar_item_state_add()
15537     *
15538     * @ingroup Toolbar
15539     */
15540    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15541    /**
15542     * Get the state after selected state in toolbar's @p item.
15543     *
15544     * @param it The toolbar item to change state.
15545     * @return The state after current state, or @c NULL on failure.
15546     *
15547     * If last state is selected, this function will return first state.
15548     *
15549     * @see elm_toolbar_item_state_set()
15550     * @see elm_toolbar_item_state_add()
15551     *
15552     * @ingroup Toolbar
15553     */
15554    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15555    /**
15556     * Get the state before selected state in toolbar's @p item.
15557     *
15558     * @param it The toolbar item to change state.
15559     * @return The state before current state, or @c NULL on failure.
15560     *
15561     * If first state is selected, this function will return last state.
15562     *
15563     * @see elm_toolbar_item_state_set()
15564     * @see elm_toolbar_item_state_add()
15565     *
15566     * @ingroup Toolbar
15567     */
15568    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15569    /**
15570     * Set the text to be shown in a given toolbar item's tooltips.
15571     *
15572     * @param it toolbar item.
15573     * @param text The text to set in the content.
15574     *
15575     * Setup the text as tooltip to object. The item can have only one tooltip,
15576     * so any previous tooltip data - set with this function or
15577     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15578     *
15579     * @see elm_object_tooltip_text_set() for more details.
15580     *
15581     * @ingroup Toolbar
15582     */
15583    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Object_Item *it, const char *text) EINA_ARG_NONNULL(1);
15584    /**
15585     * Set the content to be shown in the tooltip item.
15586     *
15587     * Setup the tooltip to item. The item can have only one tooltip,
15588     * so any previous tooltip data is removed. @p func(with @p data) will
15589     * be called every time that need show the tooltip and it should
15590     * return a valid Evas_Object. This object is then managed fully by
15591     * tooltip system and is deleted when the tooltip is gone.
15592     *
15593     * @param it the toolbar item being attached a tooltip.
15594     * @param func the function used to create the tooltip contents.
15595     * @param data what to provide to @a func as callback data/context.
15596     * @param del_cb called when data is not needed anymore, either when
15597     *        another callback replaces @a func, the tooltip is unset with
15598     *        elm_toolbar_item_tooltip_unset() or the owner @a item
15599     *        dies. This callback receives as the first parameter the
15600     *        given @a data, and @c event_info is the item.
15601     *
15602     * @see elm_object_tooltip_content_cb_set() for more details.
15603     *
15604     * @ingroup Toolbar
15605     */
15606    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);
15607    /**
15608     * Unset tooltip from item.
15609     *
15610     * @param it toolbar item to remove previously set tooltip.
15611     *
15612     * Remove tooltip from item. The callback provided as del_cb to
15613     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15614     * it is not used anymore.
15615     *
15616     * @see elm_object_tooltip_unset() for more details.
15617     * @see elm_toolbar_item_tooltip_content_cb_set()
15618     *
15619     * @ingroup Toolbar
15620     */
15621    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15622    /**
15623     * Sets a different style for this item tooltip.
15624     *
15625     * @note before you set a style you should define a tooltip with
15626     *       elm_toolbar_item_tooltip_content_cb_set() or
15627     *       elm_toolbar_item_tooltip_text_set()
15628     *
15629     * @param it toolbar item with tooltip already set.
15630     * @param style the theme style to use (default, transparent, ...)
15631     *
15632     * @see elm_object_tooltip_style_set() for more details.
15633     *
15634     * @ingroup Toolbar
15635     */
15636    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
15637    /**
15638     * Get the style for this item tooltip.
15639     *
15640     * @param it toolbar item with tooltip already set.
15641     * @return style the theme style in use, defaults to "default". If the
15642     *         object does not have a tooltip set, then NULL is returned.
15643     *
15644     * @see elm_object_tooltip_style_get() for more details.
15645     * @see elm_toolbar_item_tooltip_style_set()
15646     *
15647     * @ingroup Toolbar
15648     */
15649    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15650    /**
15651     * Set the type of mouse pointer/cursor decoration to be shown,
15652     * when the mouse pointer is over the given toolbar widget item
15653     *
15654     * @param it toolbar item to customize cursor on
15655     * @param cursor the cursor type's name
15656     *
15657     * This function works analogously as elm_object_cursor_set(), but
15658     * here the cursor's changing area is restricted to the item's
15659     * area, and not the whole widget's. Note that that item cursors
15660     * have precedence over widget cursors, so that a mouse over an
15661     * item with custom cursor set will always show @b that cursor.
15662     *
15663     * If this function is called twice for an object, a previously set
15664     * cursor will be unset on the second call.
15665     *
15666     * @see elm_object_cursor_set()
15667     * @see elm_toolbar_item_cursor_get()
15668     * @see elm_toolbar_item_cursor_unset()
15669     *
15670     * @ingroup Toolbar
15671     */
15672    EAPI void             elm_toolbar_item_cursor_set(Elm_Object_Item *it, const char *cursor) EINA_ARG_NONNULL(1);
15673
15674    /*
15675     * Get the type of mouse pointer/cursor decoration set to be shown,
15676     * when the mouse pointer is over the given toolbar widget item
15677     *
15678     * @param it toolbar item with custom cursor set
15679     * @return the cursor type's name or @c NULL, if no custom cursors
15680     * were set to @p item (and on errors)
15681     *
15682     * @see elm_object_cursor_get()
15683     * @see elm_toolbar_item_cursor_set()
15684     * @see elm_toolbar_item_cursor_unset()
15685     *
15686     * @ingroup Toolbar
15687     */
15688    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15689
15690    /**
15691     * Unset any custom mouse pointer/cursor decoration set to be
15692     * shown, when the mouse pointer is over the given toolbar widget
15693     * item, thus making it show the @b default cursor again.
15694     *
15695     * @param it a toolbar item
15696     *
15697     * Use this call to undo any custom settings on this item's cursor
15698     * decoration, bringing it back to defaults (no custom style set).
15699     *
15700     * @see elm_object_cursor_unset()
15701     * @see elm_toolbar_item_cursor_set()
15702     *
15703     * @ingroup Toolbar
15704     */
15705    EAPI void             elm_toolbar_item_cursor_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15706
15707    /**
15708     * Set a different @b style for a given custom cursor set for a
15709     * toolbar item.
15710     *
15711     * @param it toolbar item with custom cursor set
15712     * @param style the <b>theme style</b> to use (e.g. @c "default",
15713     * @c "transparent", etc)
15714     *
15715     * This function only makes sense when one is using custom mouse
15716     * cursor decorations <b>defined in a theme file</b>, which can have,
15717     * given a cursor name/type, <b>alternate styles</b> on it. It
15718     * works analogously as elm_object_cursor_style_set(), but here
15719     * applyed only to toolbar item objects.
15720     *
15721     * @warning Before you set a cursor style you should have definen a
15722     *       custom cursor previously on the item, with
15723     *       elm_toolbar_item_cursor_set()
15724     *
15725     * @see elm_toolbar_item_cursor_engine_only_set()
15726     * @see elm_toolbar_item_cursor_style_get()
15727     *
15728     * @ingroup Toolbar
15729     */
15730    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
15731
15732    /**
15733     * Get the current @b style set for a given toolbar item's custom
15734     * cursor
15735     *
15736     * @param it toolbar item with custom cursor set.
15737     * @return style the cursor style in use. If the object does not
15738     *         have a cursor set, then @c NULL is returned.
15739     *
15740     * @see elm_toolbar_item_cursor_style_set() for more details
15741     *
15742     * @ingroup Toolbar
15743     */
15744    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15745
15746    /**
15747     * Set if the (custom)cursor for a given toolbar item should be
15748     * searched in its theme, also, or should only rely on the
15749     * rendering engine.
15750     *
15751     * @param it item with custom (custom) cursor already set on
15752     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15753     * only on those provided by the rendering engine, @c EINA_FALSE to
15754     * have them searched on the widget's theme, as well.
15755     *
15756     * @note This call is of use only if you've set a custom cursor
15757     * for toolbar items, with elm_toolbar_item_cursor_set().
15758     *
15759     * @note By default, cursors will only be looked for between those
15760     * provided by the rendering engine.
15761     *
15762     * @ingroup Toolbar
15763     */
15764    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15765
15766    /**
15767     * Get if the (custom) cursor for a given toolbar item is being
15768     * searched in its theme, also, or is only relying on the rendering
15769     * engine.
15770     *
15771     * @param it a toolbar item
15772     * @return @c EINA_TRUE, if cursors are being looked for only on
15773     * those provided by the rendering engine, @c EINA_FALSE if they
15774     * are being searched on the widget's theme, as well.
15775     *
15776     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15777     *
15778     * @ingroup Toolbar
15779     */
15780    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15781
15782    /**
15783     * Change a toolbar's orientation
15784     * @param obj The toolbar object
15785     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15786     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15787     * @ingroup Toolbar
15788     * @deprecated use elm_toolbar_horizontal_set() instead.
15789     */
15790    EINA_DEPRECATED EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15791
15792    /**
15793     * Change a toolbar's orientation
15794     * @param obj The toolbar object
15795     * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15796     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15797     * @ingroup Toolbar
15798     */
15799    EAPI void             elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15800
15801    /**
15802     * Get a toolbar's orientation
15803     * @param obj The toolbar object
15804     * @return If @c EINA_TRUE, the toolbar is vertical
15805     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15806     * @ingroup Toolbar
15807     * @deprecated use elm_toolbar_horizontal_get() instead.
15808     */
15809    EINA_DEPRECATED EAPI Eina_Bool        elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15810
15811    /**
15812     * Get a toolbar's orientation
15813     * @param obj The toolbar object
15814     * @return If @c EINA_TRUE, the toolbar is horizontal
15815     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15816     * @ingroup Toolbar
15817     */
15818    EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15819    /**
15820     * @}
15821     */
15822
15823    /**
15824     * @defgroup Tooltips Tooltips
15825     *
15826     * The Tooltip is an (internal, for now) smart object used to show a
15827     * content in a frame on mouse hover of objects(or widgets), with
15828     * tips/information about them.
15829     *
15830     * @{
15831     */
15832
15833    EAPI double       elm_tooltip_delay_get(void);
15834    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
15835    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15836    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15837    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15838    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15839 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15840    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);
15841    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15842    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15843    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15844    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
15845    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15846
15847    /**
15848     * @}
15849     */
15850
15851    /**
15852     * @defgroup Cursors Cursors
15853     *
15854     * The Elementary cursor is an internal smart object used to
15855     * customize the mouse cursor displayed over objects (or
15856     * widgets). In the most common scenario, the cursor decoration
15857     * comes from the graphical @b engine Elementary is running
15858     * on. Those engines may provide different decorations for cursors,
15859     * and Elementary provides functions to choose them (think of X11
15860     * cursors, as an example).
15861     *
15862     * There's also the possibility of, besides using engine provided
15863     * cursors, also use ones coming from Edje theming files. Both
15864     * globally and per widget, Elementary makes it possible for one to
15865     * make the cursors lookup to be held on engines only or on
15866     * Elementary's theme file, too. To set cursor's hot spot,
15867     * two data items should be added to cursor's theme: "hot_x" and
15868     * "hot_y", that are the offset from upper-left corner of the cursor
15869     * (coordinates 0,0).
15870     *
15871     * @{
15872     */
15873
15874    /**
15875     * Set the cursor to be shown when mouse is over the object
15876     *
15877     * Set the cursor that will be displayed when mouse is over the
15878     * object. The object can have only one cursor set to it, so if
15879     * this function is called twice for an object, the previous set
15880     * will be unset.
15881     * If using X cursors, a definition of all the valid cursor names
15882     * is listed on Elementary_Cursors.h. If an invalid name is set
15883     * the default cursor will be used.
15884     *
15885     * @param obj the object being set a cursor.
15886     * @param cursor the cursor name to be used.
15887     *
15888     * @ingroup Cursors
15889     */
15890    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15891
15892    /**
15893     * Get the cursor to be shown when mouse is over the object
15894     *
15895     * @param obj an object with cursor already set.
15896     * @return the cursor name.
15897     *
15898     * @ingroup Cursors
15899     */
15900    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15901
15902    /**
15903     * Unset cursor for object
15904     *
15905     * Unset cursor for object, and set the cursor to default if the mouse
15906     * was over this object.
15907     *
15908     * @param obj Target object
15909     * @see elm_object_cursor_set()
15910     *
15911     * @ingroup Cursors
15912     */
15913    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15914
15915    /**
15916     * Sets a different style for this object cursor.
15917     *
15918     * @note before you set a style you should define a cursor with
15919     *       elm_object_cursor_set()
15920     *
15921     * @param obj an object with cursor already set.
15922     * @param style the theme style to use (default, transparent, ...)
15923     *
15924     * @ingroup Cursors
15925     */
15926    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15927
15928    /**
15929     * Get the style for this object cursor.
15930     *
15931     * @param obj an object with cursor already set.
15932     * @return style the theme style in use, defaults to "default". If the
15933     *         object does not have a cursor set, then NULL is returned.
15934     *
15935     * @ingroup Cursors
15936     */
15937    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15938
15939    /**
15940     * Set if the cursor set should be searched on the theme or should use
15941     * the provided by the engine, only.
15942     *
15943     * @note before you set if should look on theme you should define a cursor
15944     * with elm_object_cursor_set(). By default it will only look for cursors
15945     * provided by the engine.
15946     *
15947     * @param obj an object with cursor already set.
15948     * @param engine_only boolean to define it cursors should be looked only
15949     * between the provided by the engine or searched on widget's theme as well.
15950     *
15951     * @ingroup Cursors
15952     */
15953    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15954
15955    /**
15956     * Get the cursor engine only usage for this object cursor.
15957     *
15958     * @param obj an object with cursor already set.
15959     * @return engine_only boolean to define it cursors should be
15960     * looked only between the provided by the engine or searched on
15961     * widget's theme as well. If the object does not have a cursor
15962     * set, then EINA_FALSE is returned.
15963     *
15964     * @ingroup Cursors
15965     */
15966    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15967
15968    /**
15969     * Get the configured cursor engine only usage
15970     *
15971     * This gets the globally configured exclusive usage of engine cursors.
15972     *
15973     * @return 1 if only engine cursors should be used
15974     * @ingroup Cursors
15975     */
15976    EAPI int          elm_cursor_engine_only_get(void);
15977
15978    /**
15979     * Set the configured cursor engine only usage
15980     *
15981     * This sets the globally configured exclusive usage of engine cursors.
15982     * It won't affect cursors set before changing this value.
15983     *
15984     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15985     * look for them on theme before.
15986     * @return EINA_TRUE if value is valid and setted (0 or 1)
15987     * @ingroup Cursors
15988     */
15989    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
15990
15991    /**
15992     * @}
15993     */
15994
15995    /**
15996     * @defgroup Menu Menu
15997     *
15998     * @image html img/widget/menu/preview-00.png
15999     * @image latex img/widget/menu/preview-00.eps
16000     *
16001     * A menu is a list of items displayed above its parent. When the menu is
16002     * showing its parent is darkened. Each item can have a sub-menu. The menu
16003     * object can be used to display a menu on a right click event, in a toolbar,
16004     * anywhere.
16005     *
16006     * Signals that you can add callbacks for are:
16007     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
16008     *
16009     * Default contents parts of the menu items that you can use for are:
16010     * @li "default" - A main content of the menu item
16011     *
16012     * Default text parts of the menu items that you can use for are:
16013     * @li "default" - label in the menu item
16014     *
16015     * @see @ref tutorial_menu
16016     * @{
16017     */
16018
16019    /**
16020     * @brief Add a new menu to the parent
16021     *
16022     * @param parent The parent object.
16023     * @return The new object or NULL if it cannot be created.
16024     */
16025    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16026    /**
16027     * @brief Set the parent for the given menu widget
16028     *
16029     * @param obj The menu object.
16030     * @param parent The new parent.
16031     */
16032    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16033    /**
16034     * @brief Get the parent for the given menu widget
16035     *
16036     * @param obj The menu object.
16037     * @return The parent.
16038     *
16039     * @see elm_menu_parent_set()
16040     */
16041    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16042    /**
16043     * @brief Move the menu to a new position
16044     *
16045     * @param obj The menu object.
16046     * @param x The new position.
16047     * @param y The new position.
16048     *
16049     * Sets the top-left position of the menu to (@p x,@p y).
16050     *
16051     * @note @p x and @p y coordinates are relative to parent.
16052     */
16053    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
16054    /**
16055     * @brief Close a opened menu
16056     *
16057     * @param obj the menu object
16058     * @return void
16059     *
16060     * Hides the menu and all it's sub-menus.
16061     */
16062    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
16063    /**
16064     * @brief Returns a list of @p item's items.
16065     *
16066     * @param obj The menu object
16067     * @return An Eina_List* of @p item's items
16068     */
16069    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16070    /**
16071     * @brief Get the Evas_Object of an Elm_Object_Item
16072     *
16073     * @param it The menu item object.
16074     * @return The edje object containing the swallowed content
16075     *
16076     * @warning Don't manipulate this object!
16077     *
16078     */
16079    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16080    /**
16081     * @brief Add an item at the end of the given menu widget
16082     *
16083     * @param obj The menu object.
16084     * @param parent The parent menu item (optional)
16085     * @param icon An icon display on the item. The icon will be destryed by the menu.
16086     * @param label The label of the item.
16087     * @param func Function called when the user select the item.
16088     * @param data Data sent by the callback.
16089     * @return Returns the new item.
16090     */
16091    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);
16092    /**
16093     * @brief Add an object swallowed in an item at the end of the given menu
16094     * widget
16095     *
16096     * @param obj The menu object.
16097     * @param parent The parent menu item (optional)
16098     * @param subobj The object to swallow
16099     * @param func Function called when the user select the item.
16100     * @param data Data sent by the callback.
16101     * @return Returns the new item.
16102     *
16103     * Add an evas object as an item to the menu.
16104     */
16105    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);
16106    /**
16107     * @brief Set the label of a menu item
16108     *
16109     * @param it The menu item object.
16110     * @param label The label to set for @p item
16111     *
16112     * @warning Don't use this funcion on items created with
16113     * elm_menu_item_add_object() or elm_menu_item_separator_add().
16114     *
16115     * @deprecated Use elm_object_item_text_set() instead
16116     */
16117    EINA_DEPRECATED EAPI void               elm_menu_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
16118    /**
16119     * @brief Get the label of a menu item
16120     *
16121     * @param it The menu item object.
16122     * @return The label of @p item
16123          * @deprecated Use elm_object_item_text_get() instead
16124     */
16125    EINA_DEPRECATED EAPI const char        *elm_menu_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16126    /**
16127     * @brief Set the icon of a menu item to the standard icon with name @p icon
16128     *
16129     * @param it The menu item object.
16130     * @param icon The icon object to set for the content of @p item
16131     *
16132     * Once this icon is set, any previously set icon will be deleted.
16133     */
16134    EAPI void               elm_menu_item_object_icon_name_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1, 2);
16135    /**
16136     * @brief Get the string representation from the icon of a menu item
16137     *
16138     * @param it The menu item object.
16139     * @return The string representation of @p item's icon or NULL
16140     *
16141     * @see elm_menu_item_object_icon_name_set()
16142     */
16143    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16144    /**
16145     * @brief Set the content object of a menu item
16146     *
16147     * @param it The menu item object
16148     * @param The content object or NULL
16149     * @return EINA_TRUE on success, else EINA_FALSE
16150     *
16151     * Use this function to change the object swallowed by a menu item, deleting
16152     * any previously swallowed object.
16153     *
16154     * @deprecated Use elm_object_item_content_set() instead
16155     */
16156    EINA_DEPRECATED EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Object_Item *it, Evas_Object *obj) EINA_ARG_NONNULL(1);
16157    /**
16158     * @brief Get the content object of a menu item
16159     *
16160     * @param it The menu item object
16161     * @return The content object or NULL
16162     * @note If @p item was added with elm_menu_item_add_object, this
16163     * function will return the object passed, else it will return the
16164     * icon object.
16165     *
16166     * @see elm_menu_item_object_content_set()
16167     *
16168     * @deprecated Use elm_object_item_content_get() instead
16169     */
16170    EINA_DEPRECATED EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16171    /**
16172     * @brief Set the selected state of @p item.
16173     *
16174     * @param it The menu item object.
16175     * @param selected The selected/unselected state of the item
16176     */
16177    EAPI void               elm_menu_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
16178    /**
16179     * @brief Get the selected state of @p item.
16180     *
16181     * @param it The menu item object.
16182     * @return The selected/unselected state of the item
16183     *
16184     * @see elm_menu_item_selected_set()
16185     */
16186    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16187    /**
16188     * @brief Set the disabled state of @p item.
16189     *
16190     * @param it The menu item object.
16191     * @param disabled The enabled/disabled state of the item
16192     * @deprecated Use elm_object_item_disabled_set() instead
16193     */
16194    EINA_DEPRECATED EAPI void               elm_menu_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16195    /**
16196     * @brief Get the disabled state of @p item.
16197     *
16198     * @param it The menu item object.
16199     * @return The enabled/disabled state of the item
16200     *
16201     * @see elm_menu_item_disabled_set()
16202     * @deprecated Use elm_object_item_disabled_get() instead
16203     */
16204    EINA_DEPRECATED EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16205    /**
16206     * @brief Add a separator item to menu @p obj under @p parent.
16207     *
16208     * @param obj The menu object
16209     * @param parent The item to add the separator under
16210     * @return The created item or NULL on failure
16211     *
16212     * This is item is a @ref Separator.
16213     */
16214    EAPI Elm_Object_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Object_Item *parent) EINA_ARG_NONNULL(1);
16215    /**
16216     * @brief Returns whether @p item is a separator.
16217     *
16218     * @param it The item to check
16219     * @return If true, @p item is a separator
16220     *
16221     * @see elm_menu_item_separator_add()
16222     */
16223    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16224    /**
16225     * @brief Deletes an item from the menu.
16226     *
16227     * @param it The item to delete.
16228     *
16229     * @see elm_menu_item_add()
16230     */
16231    EAPI void               elm_menu_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16232    /**
16233     * @brief Set the function called when a menu item is deleted.
16234     *
16235     * @param it The item to set the callback on
16236     * @param func The function called
16237     *
16238     * @see elm_menu_item_add()
16239     * @see elm_menu_item_del()
16240     */
16241    EAPI void               elm_menu_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16242    /**
16243     * @brief Returns the data associated with menu item @p item.
16244     *
16245     * @param it The item
16246     * @return The data associated with @p item or NULL if none was set.
16247     *
16248     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16249          *
16250          * @deprecated Use elm_object_item_data_get() instead
16251     */
16252    EINA_DEPRECATED EAPI void              *elm_menu_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16253    /**
16254     * @brief Sets the data to be associated with menu item @p item.
16255     *
16256     * @param it The item
16257     * @param data The data to be associated with @p item
16258          *
16259          * @deprecated Use elm_object_item_data_set() instead
16260     */
16261    EINA_DEPRECATED EAPI void               elm_menu_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
16262
16263    /**
16264     * @brief Returns a list of @p item's subitems.
16265     *
16266     * @param it The item
16267     * @return An Eina_List* of @p item's subitems
16268     *
16269     * @see elm_menu_add()
16270     */
16271    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16272    /**
16273     * @brief Get the position of a menu item
16274     *
16275     * @param it The menu item
16276     * @return The item's index
16277     *
16278     * This function returns the index position of a menu item in a menu.
16279     * For a sub-menu, this number is relative to the first item in the sub-menu.
16280     *
16281     * @note Index values begin with 0
16282     */
16283    EAPI unsigned int       elm_menu_item_index_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
16284    /**
16285     * @brief @brief Return a menu item's owner menu
16286     *
16287     * @param it The menu item
16288     * @return The menu object owning @p item, or NULL on failure
16289     *
16290     * Use this function to get the menu object owning an item.
16291     */
16292    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
16293    /**
16294     * @brief Get the selected item in the menu
16295     *
16296     * @param obj The menu object
16297     * @return The selected item, or NULL if none
16298     *
16299     * @see elm_menu_item_selected_get()
16300     * @see elm_menu_item_selected_set()
16301     */
16302    EAPI Elm_Object_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16303    /**
16304     * @brief Get the last item in the menu
16305     *
16306     * @param obj The menu object
16307     * @return The last item, or NULL if none
16308     */
16309    EAPI Elm_Object_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16310    /**
16311     * @brief Get the first item in the menu
16312     *
16313     * @param obj The menu object
16314     * @return The first item, or NULL if none
16315     */
16316    EAPI Elm_Object_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16317    /**
16318     * @brief Get the next item in the menu.
16319     *
16320     * @param it The menu item object.
16321     * @return The item after it, or NULL if none
16322     */
16323    EAPI Elm_Object_Item *elm_menu_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16324    /**
16325     * @brief Get the previous item in the menu.
16326     *
16327     * @param it The menu item object.
16328     * @return The item before it, or NULL if none
16329     */
16330    EAPI Elm_Object_Item *elm_menu_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16331    /**
16332     * @}
16333     */
16334
16335    /**
16336     * @defgroup List List
16337     * @ingroup Elementary
16338     *
16339     * @image html img/widget/list/preview-00.png
16340     * @image latex img/widget/list/preview-00.eps width=\textwidth
16341     *
16342     * @image html img/list.png
16343     * @image latex img/list.eps width=\textwidth
16344     *
16345     * A list widget is a container whose children are displayed vertically or
16346     * horizontally, in order, and can be selected.
16347     * The list can accept only one or multiple items selection. Also has many
16348     * modes of items displaying.
16349     *
16350     * A list is a very simple type of list widget.  For more robust
16351     * lists, @ref Genlist should probably be used.
16352     *
16353     * Smart callbacks one can listen to:
16354     * - @c "activated" - The user has double-clicked or pressed
16355     *   (enter|return|spacebar) on an item. The @c event_info parameter
16356     *   is the item that was activated.
16357     * - @c "clicked,double" - The user has double-clicked an item.
16358     *   The @c event_info parameter is the item that was double-clicked.
16359     * - "selected" - when the user selected an item
16360     * - "unselected" - when the user unselected an item
16361     * - "longpressed" - an item in the list is long-pressed
16362     * - "edge,top" - the list is scrolled until the top edge
16363     * - "edge,bottom" - the list is scrolled until the bottom edge
16364     * - "edge,left" - the list is scrolled until the left edge
16365     * - "edge,right" - the list is scrolled until the right edge
16366     * - "language,changed" - the program's language changed
16367     *
16368     * Available styles for it:
16369     * - @c "default"
16370     *
16371     * List of examples:
16372     * @li @ref list_example_01
16373     * @li @ref list_example_02
16374     * @li @ref list_example_03
16375     */
16376
16377    /**
16378     * @addtogroup List
16379     * @{
16380     */
16381
16382    /**
16383     * @enum _Elm_List_Mode
16384     * @typedef Elm_List_Mode
16385     *
16386     * Set list's resize behavior, transverse axis scroll and
16387     * items cropping. See each mode's description for more details.
16388     *
16389     * @note Default value is #ELM_LIST_SCROLL.
16390     *
16391     * Values <b> don't </b> work as bitmask, only one can be choosen.
16392     *
16393     * @see elm_list_mode_set()
16394     * @see elm_list_mode_get()
16395     *
16396     * @ingroup List
16397     */
16398    typedef enum _Elm_List_Mode
16399      {
16400         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. */
16401         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). */
16402         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. */
16403         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. */
16404         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16405      } Elm_List_Mode;
16406
16407    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().  */
16408
16409    /**
16410     * Add a new list widget to the given parent Elementary
16411     * (container) object.
16412     *
16413     * @param parent The parent object.
16414     * @return a new list widget handle or @c NULL, on errors.
16415     *
16416     * This function inserts a new list widget on the canvas.
16417     *
16418     * @ingroup List
16419     */
16420    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16421
16422    /**
16423     * Starts the list.
16424     *
16425     * @param obj The list object
16426     *
16427     * @note Call before running show() on the list object.
16428     * @warning If not called, it won't display the list properly.
16429     *
16430     * @code
16431     * li = elm_list_add(win);
16432     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16433     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16434     * elm_list_go(li);
16435     * evas_object_show(li);
16436     * @endcode
16437     *
16438     * @ingroup List
16439     */
16440    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16441
16442    /**
16443     * Enable or disable multiple items selection on the list object.
16444     *
16445     * @param obj The list object
16446     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16447     * disable it.
16448     *
16449     * Disabled by default. If disabled, the user can select a single item of
16450     * the list each time. Selected items are highlighted on list.
16451     * If enabled, many items can be selected.
16452     *
16453     * If a selected item is selected again, it will be unselected.
16454     *
16455     * @see elm_list_multi_select_get()
16456     *
16457     * @ingroup List
16458     */
16459    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16460
16461    /**
16462     * Get a value whether multiple items selection is enabled or not.
16463     *
16464     * @see elm_list_multi_select_set() for details.
16465     *
16466     * @param obj The list object.
16467     * @return @c EINA_TRUE means multiple items selection is enabled.
16468     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16469     * @c EINA_FALSE is returned.
16470     *
16471     * @ingroup List
16472     */
16473    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16474
16475    /**
16476     * Set which mode to use for the list object.
16477     *
16478     * @param obj The list object
16479     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16480     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16481     *
16482     * Set list's resize behavior, transverse axis scroll and
16483     * items cropping. See each mode's description for more details.
16484     *
16485     * @note Default value is #ELM_LIST_SCROLL.
16486     *
16487     * Only one can be set, if a previous one was set, it will be changed
16488     * by the new mode set. Bitmask won't work as well.
16489     *
16490     * @see elm_list_mode_get()
16491     *
16492     * @ingroup List
16493     */
16494    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16495
16496    /**
16497     * Get the mode the list is at.
16498     *
16499     * @param obj The list object
16500     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16501     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16502     *
16503     * @note see elm_list_mode_set() for more information.
16504     *
16505     * @ingroup List
16506     */
16507    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16508
16509    /**
16510     * Enable or disable horizontal mode on the list object.
16511     *
16512     * @param obj The list object.
16513     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16514     * disable it, i.e., to enable vertical mode.
16515     *
16516     * @note Vertical mode is set by default.
16517     *
16518     * On horizontal mode items are displayed on list from left to right,
16519     * instead of from top to bottom. Also, the list will scroll horizontally.
16520     * Each item will presents left icon on top and right icon, or end, at
16521     * the bottom.
16522     *
16523     * @see elm_list_horizontal_get()
16524     *
16525     * @ingroup List
16526     */
16527    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16528
16529    /**
16530     * Get a value whether horizontal mode is enabled or not.
16531     *
16532     * @param obj The list object.
16533     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16534     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16535     * @c EINA_FALSE is returned.
16536     *
16537     * @see elm_list_horizontal_set() for details.
16538     *
16539     * @ingroup List
16540     */
16541    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16542
16543    /**
16544     * Enable or disable always select mode on the list object.
16545     *
16546     * @param obj The list object
16547     * @param always_select @c EINA_TRUE to enable always select mode or
16548     * @c EINA_FALSE to disable it.
16549     *
16550     * @note Always select mode is disabled by default.
16551     *
16552     * Default behavior of list items is to only call its callback function
16553     * the first time it's pressed, i.e., when it is selected. If a selected
16554     * item is pressed again, and multi-select is disabled, it won't call
16555     * this function (if multi-select is enabled it will unselect the item).
16556     *
16557     * If always select is enabled, it will call the callback function
16558     * everytime a item is pressed, so it will call when the item is selected,
16559     * and again when a selected item is pressed.
16560     *
16561     * @see elm_list_always_select_mode_get()
16562     * @see elm_list_multi_select_set()
16563     *
16564     * @ingroup List
16565     */
16566    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16567
16568    /**
16569     * Get a value whether always select mode is enabled or not, meaning that
16570     * an item will always call its callback function, even if already selected.
16571     *
16572     * @param obj The list object
16573     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16574     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16575     * @c EINA_FALSE is returned.
16576     *
16577     * @see elm_list_always_select_mode_set() for details.
16578     *
16579     * @ingroup List
16580     */
16581    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16582
16583    /**
16584     * Set bouncing behaviour when the scrolled content reaches an edge.
16585     *
16586     * Tell the internal scroller object whether it should bounce or not
16587     * when it reaches the respective edges for each axis.
16588     *
16589     * @param obj The list object
16590     * @param h_bounce Whether to bounce or not in the horizontal axis.
16591     * @param v_bounce Whether to bounce or not in the vertical axis.
16592     *
16593     * @see elm_scroller_bounce_set()
16594     *
16595     * @ingroup List
16596     */
16597    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16598
16599    /**
16600     * Get the bouncing behaviour of the internal scroller.
16601     *
16602     * Get whether the internal scroller should bounce when the edge of each
16603     * axis is reached scrolling.
16604     *
16605     * @param obj The list object.
16606     * @param h_bounce Pointer where to store the bounce state of the horizontal
16607     * axis.
16608     * @param v_bounce Pointer where to store the bounce state of the vertical
16609     * axis.
16610     *
16611     * @see elm_scroller_bounce_get()
16612     * @see elm_list_bounce_set()
16613     *
16614     * @ingroup List
16615     */
16616    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16617
16618    /**
16619     * Set the scrollbar policy.
16620     *
16621     * @param obj The list object
16622     * @param policy_h Horizontal scrollbar policy.
16623     * @param policy_v Vertical scrollbar policy.
16624     *
16625     * This sets the scrollbar visibility policy for the given scroller.
16626     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16627     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16628     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16629     * This applies respectively for the horizontal and vertical scrollbars.
16630     *
16631     * The both are disabled by default, i.e., are set to
16632     * #ELM_SCROLLER_POLICY_OFF.
16633     *
16634     * @ingroup List
16635     */
16636    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16637
16638    /**
16639     * Get the scrollbar policy.
16640     *
16641     * @see elm_list_scroller_policy_get() for details.
16642     *
16643     * @param obj The list object.
16644     * @param policy_h Pointer where to store horizontal scrollbar policy.
16645     * @param policy_v Pointer where to store vertical scrollbar policy.
16646     *
16647     * @ingroup List
16648     */
16649    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);
16650
16651    /**
16652     * Append a new item to the list object.
16653     *
16654     * @param obj The list object.
16655     * @param label The label of the list item.
16656     * @param icon The icon object to use for the left side of the item. An
16657     * icon can be any Evas object, but usually it is an icon created
16658     * with elm_icon_add().
16659     * @param end The icon object to use for the right side of the item. An
16660     * icon can be any Evas object.
16661     * @param func The function to call when the item is clicked.
16662     * @param data The data to associate with the item for related callbacks.
16663     *
16664     * @return The created item or @c NULL upon failure.
16665     *
16666     * A new item will be created and appended to the list, i.e., will
16667     * be set as @b last item.
16668     *
16669     * Items created with this method can be deleted with
16670     * elm_list_item_del().
16671     *
16672     * Associated @p data can be properly freed when item is deleted if a
16673     * callback function is set with elm_list_item_del_cb_set().
16674     *
16675     * If a function is passed as argument, it will be called everytime this item
16676     * is selected, i.e., the user clicks over an unselected item.
16677     * If always select is enabled it will call this function every time
16678     * user clicks over an item (already selected or not).
16679     * If such function isn't needed, just passing
16680     * @c NULL as @p func is enough. The same should be done for @p data.
16681     *
16682     * Simple example (with no function callback or data associated):
16683     * @code
16684     * li = elm_list_add(win);
16685     * ic = elm_icon_add(win);
16686     * elm_icon_file_set(ic, "path/to/image", NULL);
16687     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16688     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16689     * elm_list_go(li);
16690     * evas_object_show(li);
16691     * @endcode
16692     *
16693     * @see elm_list_always_select_mode_set()
16694     * @see elm_list_item_del()
16695     * @see elm_list_item_del_cb_set()
16696     * @see elm_list_clear()
16697     * @see elm_icon_add()
16698     *
16699     * @ingroup List
16700     */
16701    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);
16702
16703    /**
16704     * Prepend a new item to the list object.
16705     *
16706     * @param obj The list object.
16707     * @param label The label of the list item.
16708     * @param icon The icon object to use for the left side of the item. An
16709     * icon can be any Evas object, but usually it is an icon created
16710     * with elm_icon_add().
16711     * @param end The icon object to use for the right side of the item. An
16712     * icon can be any Evas object.
16713     * @param func The function to call when the item is clicked.
16714     * @param data The data to associate with the item for related callbacks.
16715     *
16716     * @return The created item or @c NULL upon failure.
16717     *
16718     * A new item will be created and prepended to the list, i.e., will
16719     * be set as @b first item.
16720     *
16721     * Items created with this method can be deleted with
16722     * elm_list_item_del().
16723     *
16724     * Associated @p data can be properly freed when item is deleted if a
16725     * callback function is set with elm_list_item_del_cb_set().
16726     *
16727     * If a function is passed as argument, it will be called everytime this item
16728     * is selected, i.e., the user clicks over an unselected item.
16729     * If always select is enabled it will call this function every time
16730     * user clicks over an item (already selected or not).
16731     * If such function isn't needed, just passing
16732     * @c NULL as @p func is enough. The same should be done for @p data.
16733     *
16734     * @see elm_list_item_append() for a simple code example.
16735     * @see elm_list_always_select_mode_set()
16736     * @see elm_list_item_del()
16737     * @see elm_list_item_del_cb_set()
16738     * @see elm_list_clear()
16739     * @see elm_icon_add()
16740     *
16741     * @ingroup List
16742     */
16743    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);
16744
16745    /**
16746     * Insert a new item into the list object before item @p before.
16747     *
16748     * @param obj The list object.
16749     * @param before The list item to insert before.
16750     * @param label The label of the list item.
16751     * @param icon The icon object to use for the left side of the item. An
16752     * icon can be any Evas object, but usually it is an icon created
16753     * with elm_icon_add().
16754     * @param end The icon object to use for the right side of the item. An
16755     * icon can be any Evas object.
16756     * @param func The function to call when the item is clicked.
16757     * @param data The data to associate with the item for related callbacks.
16758     *
16759     * @return The created item or @c NULL upon failure.
16760     *
16761     * A new item will be created and added to the list. Its position in
16762     * this list will be just before item @p before.
16763     *
16764     * Items created with this method can be deleted with
16765     * elm_list_item_del().
16766     *
16767     * Associated @p data can be properly freed when item is deleted if a
16768     * callback function is set with elm_list_item_del_cb_set().
16769     *
16770     * If a function is passed as argument, it will be called everytime this item
16771     * is selected, i.e., the user clicks over an unselected item.
16772     * If always select is enabled it will call this function every time
16773     * user clicks over an item (already selected or not).
16774     * If such function isn't needed, just passing
16775     * @c NULL as @p func is enough. The same should be done for @p data.
16776     *
16777     * @see elm_list_item_append() for a simple code example.
16778     * @see elm_list_always_select_mode_set()
16779     * @see elm_list_item_del()
16780     * @see elm_list_item_del_cb_set()
16781     * @see elm_list_clear()
16782     * @see elm_icon_add()
16783     *
16784     * @ingroup List
16785     */
16786    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);
16787
16788    /**
16789     * Insert a new item into the list object after item @p after.
16790     *
16791     * @param obj The list object.
16792     * @param after The list item to insert after.
16793     * @param label The label of the list item.
16794     * @param icon The icon object to use for the left side of the item. An
16795     * icon can be any Evas object, but usually it is an icon created
16796     * with elm_icon_add().
16797     * @param end The icon object to use for the right side of the item. An
16798     * icon can be any Evas object.
16799     * @param func The function to call when the item is clicked.
16800     * @param data The data to associate with the item for related callbacks.
16801     *
16802     * @return The created item or @c NULL upon failure.
16803     *
16804     * A new item will be created and added to the list. Its position in
16805     * this list will be just after item @p after.
16806     *
16807     * Items created with this method can be deleted with
16808     * elm_list_item_del().
16809     *
16810     * Associated @p data can be properly freed when item is deleted if a
16811     * callback function is set with elm_list_item_del_cb_set().
16812     *
16813     * If a function is passed as argument, it will be called everytime this item
16814     * is selected, i.e., the user clicks over an unselected item.
16815     * If always select is enabled it will call this function every time
16816     * user clicks over an item (already selected or not).
16817     * If such function isn't needed, just passing
16818     * @c NULL as @p func is enough. The same should be done for @p data.
16819     *
16820     * @see elm_list_item_append() for a simple code example.
16821     * @see elm_list_always_select_mode_set()
16822     * @see elm_list_item_del()
16823     * @see elm_list_item_del_cb_set()
16824     * @see elm_list_clear()
16825     * @see elm_icon_add()
16826     *
16827     * @ingroup List
16828     */
16829    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);
16830
16831    /**
16832     * Insert a new item into the sorted list object.
16833     *
16834     * @param obj The list object.
16835     * @param label The label of the list item.
16836     * @param icon The icon object to use for the left side of the item. An
16837     * icon can be any Evas object, but usually it is an icon created
16838     * with elm_icon_add().
16839     * @param end The icon object to use for the right side of the item. An
16840     * icon can be any Evas object.
16841     * @param func The function to call when the item is clicked.
16842     * @param data The data to associate with the item for related callbacks.
16843     * @param cmp_func The comparing function to be used to sort list
16844     * items <b>by #Elm_List_Item item handles</b>. This function will
16845     * receive two items and compare them, returning a non-negative integer
16846     * if the second item should be place after the first, or negative value
16847     * if should be placed before.
16848     *
16849     * @return The created item or @c NULL upon failure.
16850     *
16851     * @note This function inserts values into a list object assuming it was
16852     * sorted and the result will be sorted.
16853     *
16854     * A new item will be created and added to the list. Its position in
16855     * this list will be found comparing the new item with previously inserted
16856     * items using function @p cmp_func.
16857     *
16858     * Items created with this method can be deleted with
16859     * elm_list_item_del().
16860     *
16861     * Associated @p data can be properly freed when item is deleted if a
16862     * callback function is set with elm_list_item_del_cb_set().
16863     *
16864     * If a function is passed as argument, it will be called everytime this item
16865     * is selected, i.e., the user clicks over an unselected item.
16866     * If always select is enabled it will call this function every time
16867     * user clicks over an item (already selected or not).
16868     * If such function isn't needed, just passing
16869     * @c NULL as @p func is enough. The same should be done for @p data.
16870     *
16871     * @see elm_list_item_append() for a simple code example.
16872     * @see elm_list_always_select_mode_set()
16873     * @see elm_list_item_del()
16874     * @see elm_list_item_del_cb_set()
16875     * @see elm_list_clear()
16876     * @see elm_icon_add()
16877     *
16878     * @ingroup List
16879     */
16880    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);
16881
16882    /**
16883     * Remove all list's items.
16884     *
16885     * @param obj The list object
16886     *
16887     * @see elm_list_item_del()
16888     * @see elm_list_item_append()
16889     *
16890     * @ingroup List
16891     */
16892    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16893
16894    /**
16895     * Get a list of all the list items.
16896     *
16897     * @param obj The list object
16898     * @return An @c Eina_List of list items, #Elm_List_Item,
16899     * or @c NULL on failure.
16900     *
16901     * @see elm_list_item_append()
16902     * @see elm_list_item_del()
16903     * @see elm_list_clear()
16904     *
16905     * @ingroup List
16906     */
16907    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16908
16909    /**
16910     * Get the selected item.
16911     *
16912     * @param obj The list object.
16913     * @return The selected list item.
16914     *
16915     * The selected item can be unselected with function
16916     * elm_list_item_selected_set().
16917     *
16918     * The selected item always will be highlighted on list.
16919     *
16920     * @see elm_list_selected_items_get()
16921     *
16922     * @ingroup List
16923     */
16924    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16925
16926    /**
16927     * Return a list of the currently selected list items.
16928     *
16929     * @param obj The list object.
16930     * @return An @c Eina_List of list items, #Elm_List_Item,
16931     * or @c NULL on failure.
16932     *
16933     * Multiple items can be selected if multi select is enabled. It can be
16934     * done with elm_list_multi_select_set().
16935     *
16936     * @see elm_list_selected_item_get()
16937     * @see elm_list_multi_select_set()
16938     *
16939     * @ingroup List
16940     */
16941    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16942
16943    /**
16944     * Set the selected state of an item.
16945     *
16946     * @param item The list item
16947     * @param selected The selected state
16948     *
16949     * This sets the selected state of the given item @p it.
16950     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16951     *
16952     * If a new item is selected the previosly selected will be unselected,
16953     * unless multiple selection is enabled with elm_list_multi_select_set().
16954     * Previoulsy selected item can be get with function
16955     * elm_list_selected_item_get().
16956     *
16957     * Selected items will be highlighted.
16958     *
16959     * @see elm_list_item_selected_get()
16960     * @see elm_list_selected_item_get()
16961     * @see elm_list_multi_select_set()
16962     *
16963     * @ingroup List
16964     */
16965    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16966
16967    /*
16968     * Get whether the @p item is selected or not.
16969     *
16970     * @param item The list item.
16971     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16972     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16973     *
16974     * @see elm_list_selected_item_set() for details.
16975     * @see elm_list_item_selected_get()
16976     *
16977     * @ingroup List
16978     */
16979    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16980
16981    /**
16982     * Set or unset item as a separator.
16983     *
16984     * @param it The list item.
16985     * @param setting @c EINA_TRUE to set item @p it as separator or
16986     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16987     *
16988     * Items aren't set as separator by default.
16989     *
16990     * If set as separator it will display separator theme, so won't display
16991     * icons or label.
16992     *
16993     * @see elm_list_item_separator_get()
16994     *
16995     * @ingroup List
16996     */
16997    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16998
16999    /**
17000     * Get a value whether item is a separator or not.
17001     *
17002     * @see elm_list_item_separator_set() for details.
17003     *
17004     * @param it The list item.
17005     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
17006     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
17007     *
17008     * @ingroup List
17009     */
17010    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17011
17012    /**
17013     * Show @p item in the list view.
17014     *
17015     * @param item The list item to be shown.
17016     *
17017     * It won't animate list until item is visible. If such behavior is wanted,
17018     * use elm_list_bring_in() intead.
17019     *
17020     * @ingroup List
17021     */
17022    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17023
17024    /**
17025     * Bring in the given item to list view.
17026     *
17027     * @param item The item.
17028     *
17029     * This causes list to jump to the given item @p item and show it
17030     * (by scrolling), if it is not fully visible.
17031     *
17032     * This may use animation to do so and take a period of time.
17033     *
17034     * If animation isn't wanted, elm_list_item_show() can be used.
17035     *
17036     * @ingroup List
17037     */
17038    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17039
17040    /**
17041     * Delete them item from the list.
17042     *
17043     * @param item The item of list to be deleted.
17044     *
17045     * If deleting all list items is required, elm_list_clear()
17046     * should be used instead of getting items list and deleting each one.
17047     *
17048     * @see elm_list_clear()
17049     * @see elm_list_item_append()
17050     * @see elm_list_item_del_cb_set()
17051     *
17052     * @ingroup List
17053     */
17054    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17055
17056    /**
17057     * Set the function called when a list item is freed.
17058     *
17059     * @param item The item to set the callback on
17060     * @param func The function called
17061     *
17062     * If there is a @p func, then it will be called prior item's memory release.
17063     * That will be called with the following arguments:
17064     * @li item's data;
17065     * @li item's Evas object;
17066     * @li item itself;
17067     *
17068     * This way, a data associated to a list item could be properly freed.
17069     *
17070     * @ingroup List
17071     */
17072    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17073
17074    /**
17075     * Get the data associated to the item.
17076     *
17077     * @param item The list item
17078     * @return The data associated to @p item
17079     *
17080     * The return value is a pointer to data associated to @p item when it was
17081     * created, with function elm_list_item_append() or similar. If no data
17082     * was passed as argument, it will return @c NULL.
17083     *
17084     * @see elm_list_item_append()
17085     *
17086     * @ingroup List
17087     */
17088    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17089
17090    /**
17091     * Get the left side icon associated to the item.
17092     *
17093     * @param item The list item
17094     * @return The left side icon associated to @p item
17095     *
17096     * The return value is a pointer to the icon associated to @p item when
17097     * it was
17098     * created, with function elm_list_item_append() or similar, or later
17099     * with function elm_list_item_icon_set(). If no icon
17100     * was passed as argument, it will return @c NULL.
17101     *
17102     * @see elm_list_item_append()
17103     * @see elm_list_item_icon_set()
17104     *
17105     * @ingroup List
17106     */
17107    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17108
17109    /**
17110     * Set the left side icon associated to the item.
17111     *
17112     * @param item The list item
17113     * @param icon The left side icon object to associate with @p item
17114     *
17115     * The icon object to use at left side of the item. An
17116     * icon can be any Evas object, but usually it is an icon created
17117     * with elm_icon_add().
17118     *
17119     * Once the icon object is set, a previously set one will be deleted.
17120     * @warning Setting the same icon for two items will cause the icon to
17121     * dissapear from the first item.
17122     *
17123     * If an icon was passed as argument on item creation, with function
17124     * elm_list_item_append() or similar, it will be already
17125     * associated to the item.
17126     *
17127     * @see elm_list_item_append()
17128     * @see elm_list_item_icon_get()
17129     *
17130     * @ingroup List
17131     */
17132    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17133
17134    /**
17135     * Get the right side icon associated to the item.
17136     *
17137     * @param item The list item
17138     * @return The right side icon associated to @p item
17139     *
17140     * The return value is a pointer to the icon associated to @p item when
17141     * it was
17142     * created, with function elm_list_item_append() or similar, or later
17143     * with function elm_list_item_icon_set(). If no icon
17144     * was passed as argument, it will return @c NULL.
17145     *
17146     * @see elm_list_item_append()
17147     * @see elm_list_item_icon_set()
17148     *
17149     * @ingroup List
17150     */
17151    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17152
17153    /**
17154     * Set the right side icon associated to the item.
17155     *
17156     * @param item The list item
17157     * @param end The right side icon object to associate with @p item
17158     *
17159     * The icon object to use at right side of the item. An
17160     * icon can be any Evas object, but usually it is an icon created
17161     * with elm_icon_add().
17162     *
17163     * Once the icon object is set, a previously set one will be deleted.
17164     * @warning Setting the same icon for two items will cause the icon to
17165     * dissapear from the first item.
17166     *
17167     * If an icon was passed as argument on item creation, with function
17168     * elm_list_item_append() or similar, it will be already
17169     * associated to the item.
17170     *
17171     * @see elm_list_item_append()
17172     * @see elm_list_item_end_get()
17173     *
17174     * @ingroup List
17175     */
17176    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17177
17178    /**
17179     * Gets the base object of the item.
17180     *
17181     * @param item The list item
17182     * @return The base object associated with @p item
17183     *
17184     * Base object is the @c Evas_Object that represents that item.
17185     *
17186     * @ingroup List
17187     */
17188    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17189    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17190
17191    /**
17192     * Get the label of item.
17193     *
17194     * @param item The item of list.
17195     * @return The label of item.
17196     *
17197     * The return value is a pointer to the label associated to @p item when
17198     * it was created, with function elm_list_item_append(), or later
17199     * with function elm_list_item_label_set. If no label
17200     * was passed as argument, it will return @c NULL.
17201     *
17202     * @see elm_list_item_label_set() for more details.
17203     * @see elm_list_item_append()
17204     *
17205     * @ingroup List
17206     */
17207    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17208
17209    /**
17210     * Set the label of item.
17211     *
17212     * @param item The item of list.
17213     * @param text The label of item.
17214     *
17215     * The label to be displayed by the item.
17216     * Label will be placed between left and right side icons (if set).
17217     *
17218     * If a label was passed as argument on item creation, with function
17219     * elm_list_item_append() or similar, it will be already
17220     * displayed by the item.
17221     *
17222     * @see elm_list_item_label_get()
17223     * @see elm_list_item_append()
17224     *
17225     * @ingroup List
17226     */
17227    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17228
17229
17230    /**
17231     * Get the item before @p it in list.
17232     *
17233     * @param it The list item.
17234     * @return The item before @p it, or @c NULL if none or on failure.
17235     *
17236     * @note If it is the first item, @c NULL will be returned.
17237     *
17238     * @see elm_list_item_append()
17239     * @see elm_list_items_get()
17240     *
17241     * @ingroup List
17242     */
17243    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17244
17245    /**
17246     * Get the item after @p it in list.
17247     *
17248     * @param it The list item.
17249     * @return The item after @p it, or @c NULL if none or on failure.
17250     *
17251     * @note If it is the last item, @c NULL will be returned.
17252     *
17253     * @see elm_list_item_append()
17254     * @see elm_list_items_get()
17255     *
17256     * @ingroup List
17257     */
17258    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17259
17260    /**
17261     * Sets the disabled/enabled state of a list item.
17262     *
17263     * @param it The item.
17264     * @param disabled The disabled state.
17265     *
17266     * A disabled item cannot be selected or unselected. It will also
17267     * change its appearance (generally greyed out). This sets the
17268     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17269     * enabled).
17270     *
17271     * @ingroup List
17272     */
17273    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17274
17275    /**
17276     * Get a value whether list item is disabled or not.
17277     *
17278     * @param it The item.
17279     * @return The disabled state.
17280     *
17281     * @see elm_list_item_disabled_set() for more details.
17282     *
17283     * @ingroup List
17284     */
17285    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17286
17287    /**
17288     * Set the text to be shown in a given list item's tooltips.
17289     *
17290     * @param item Target item.
17291     * @param text The text to set in the content.
17292     *
17293     * Setup the text as tooltip to object. The item can have only one tooltip,
17294     * so any previous tooltip data - set with this function or
17295     * elm_list_item_tooltip_content_cb_set() - is removed.
17296     *
17297     * @see elm_object_tooltip_text_set() for more details.
17298     *
17299     * @ingroup List
17300     */
17301    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17302
17303
17304    /**
17305     * @brief Disable size restrictions on an object's tooltip
17306     * @param item The tooltip's anchor object
17307     * @param disable If EINA_TRUE, size restrictions are disabled
17308     * @return EINA_FALSE on failure, EINA_TRUE on success
17309     *
17310     * This function allows a tooltip to expand beyond its parant window's canvas.
17311     * It will instead be limited only by the size of the display.
17312     */
17313    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17314    /**
17315     * @brief Retrieve size restriction state of an object's tooltip
17316     * @param obj The tooltip's anchor object
17317     * @return If EINA_TRUE, size restrictions are disabled
17318     *
17319     * This function returns whether a tooltip is allowed to expand beyond
17320     * its parant window's canvas.
17321     * It will instead be limited only by the size of the display.
17322     */
17323    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17324
17325    /**
17326     * Set the content to be shown in the tooltip item.
17327     *
17328     * Setup the tooltip to item. The item can have only one tooltip,
17329     * so any previous tooltip data is removed. @p func(with @p data) will
17330     * be called every time that need show the tooltip and it should
17331     * return a valid Evas_Object. This object is then managed fully by
17332     * tooltip system and is deleted when the tooltip is gone.
17333     *
17334     * @param item the list item being attached a tooltip.
17335     * @param func the function used to create the tooltip contents.
17336     * @param data what to provide to @a func as callback data/context.
17337     * @param del_cb called when data is not needed anymore, either when
17338     *        another callback replaces @a func, the tooltip is unset with
17339     *        elm_list_item_tooltip_unset() or the owner @a item
17340     *        dies. This callback receives as the first parameter the
17341     *        given @a data, and @c event_info is the item.
17342     *
17343     * @see elm_object_tooltip_content_cb_set() for more details.
17344     *
17345     * @ingroup List
17346     */
17347    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);
17348
17349    /**
17350     * Unset tooltip from item.
17351     *
17352     * @param item list item to remove previously set tooltip.
17353     *
17354     * Remove tooltip from item. The callback provided as del_cb to
17355     * elm_list_item_tooltip_content_cb_set() will be called to notify
17356     * it is not used anymore.
17357     *
17358     * @see elm_object_tooltip_unset() for more details.
17359     * @see elm_list_item_tooltip_content_cb_set()
17360     *
17361     * @ingroup List
17362     */
17363    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17364
17365    /**
17366     * Sets a different style for this item tooltip.
17367     *
17368     * @note before you set a style you should define a tooltip with
17369     *       elm_list_item_tooltip_content_cb_set() or
17370     *       elm_list_item_tooltip_text_set()
17371     *
17372     * @param item list item with tooltip already set.
17373     * @param style the theme style to use (default, transparent, ...)
17374     *
17375     * @see elm_object_tooltip_style_set() for more details.
17376     *
17377     * @ingroup List
17378     */
17379    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17380
17381    /**
17382     * Get the style for this item tooltip.
17383     *
17384     * @param item list item with tooltip already set.
17385     * @return style the theme style in use, defaults to "default". If the
17386     *         object does not have a tooltip set, then NULL is returned.
17387     *
17388     * @see elm_object_tooltip_style_get() for more details.
17389     * @see elm_list_item_tooltip_style_set()
17390     *
17391     * @ingroup List
17392     */
17393    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17394
17395    /**
17396     * Set the type of mouse pointer/cursor decoration to be shown,
17397     * when the mouse pointer is over the given list widget item
17398     *
17399     * @param item list item to customize cursor on
17400     * @param cursor the cursor type's name
17401     *
17402     * This function works analogously as elm_object_cursor_set(), but
17403     * here the cursor's changing area is restricted to the item's
17404     * area, and not the whole widget's. Note that that item cursors
17405     * have precedence over widget cursors, so that a mouse over an
17406     * item with custom cursor set will always show @b that cursor.
17407     *
17408     * If this function is called twice for an object, a previously set
17409     * cursor will be unset on the second call.
17410     *
17411     * @see elm_object_cursor_set()
17412     * @see elm_list_item_cursor_get()
17413     * @see elm_list_item_cursor_unset()
17414     *
17415     * @ingroup List
17416     */
17417    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17418
17419    /*
17420     * Get the type of mouse pointer/cursor decoration set to be shown,
17421     * when the mouse pointer is over the given list widget item
17422     *
17423     * @param item list item with custom cursor set
17424     * @return the cursor type's name or @c NULL, if no custom cursors
17425     * were set to @p item (and on errors)
17426     *
17427     * @see elm_object_cursor_get()
17428     * @see elm_list_item_cursor_set()
17429     * @see elm_list_item_cursor_unset()
17430     *
17431     * @ingroup List
17432     */
17433    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17434
17435    /**
17436     * Unset any custom mouse pointer/cursor decoration set to be
17437     * shown, when the mouse pointer is over the given list widget
17438     * item, thus making it show the @b default cursor again.
17439     *
17440     * @param item a list item
17441     *
17442     * Use this call to undo any custom settings on this item's cursor
17443     * decoration, bringing it back to defaults (no custom style set).
17444     *
17445     * @see elm_object_cursor_unset()
17446     * @see elm_list_item_cursor_set()
17447     *
17448     * @ingroup List
17449     */
17450    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17451
17452    /**
17453     * Set a different @b style for a given custom cursor set for a
17454     * list item.
17455     *
17456     * @param item list item with custom cursor set
17457     * @param style the <b>theme style</b> to use (e.g. @c "default",
17458     * @c "transparent", etc)
17459     *
17460     * This function only makes sense when one is using custom mouse
17461     * cursor decorations <b>defined in a theme file</b>, which can have,
17462     * given a cursor name/type, <b>alternate styles</b> on it. It
17463     * works analogously as elm_object_cursor_style_set(), but here
17464     * applyed only to list item objects.
17465     *
17466     * @warning Before you set a cursor style you should have definen a
17467     *       custom cursor previously on the item, with
17468     *       elm_list_item_cursor_set()
17469     *
17470     * @see elm_list_item_cursor_engine_only_set()
17471     * @see elm_list_item_cursor_style_get()
17472     *
17473     * @ingroup List
17474     */
17475    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17476
17477    /**
17478     * Get the current @b style set for a given list item's custom
17479     * cursor
17480     *
17481     * @param item list item with custom cursor set.
17482     * @return style the cursor style in use. If the object does not
17483     *         have a cursor set, then @c NULL is returned.
17484     *
17485     * @see elm_list_item_cursor_style_set() for more details
17486     *
17487     * @ingroup List
17488     */
17489    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17490
17491    /**
17492     * Set if the (custom)cursor for a given list item should be
17493     * searched in its theme, also, or should only rely on the
17494     * rendering engine.
17495     *
17496     * @param item item with custom (custom) cursor already set on
17497     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17498     * only on those provided by the rendering engine, @c EINA_FALSE to
17499     * have them searched on the widget's theme, as well.
17500     *
17501     * @note This call is of use only if you've set a custom cursor
17502     * for list items, with elm_list_item_cursor_set().
17503     *
17504     * @note By default, cursors will only be looked for between those
17505     * provided by the rendering engine.
17506     *
17507     * @ingroup List
17508     */
17509    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17510
17511    /**
17512     * Get if the (custom) cursor for a given list item is being
17513     * searched in its theme, also, or is only relying on the rendering
17514     * engine.
17515     *
17516     * @param item a list item
17517     * @return @c EINA_TRUE, if cursors are being looked for only on
17518     * those provided by the rendering engine, @c EINA_FALSE if they
17519     * are being searched on the widget's theme, as well.
17520     *
17521     * @see elm_list_item_cursor_engine_only_set(), for more details
17522     *
17523     * @ingroup List
17524     */
17525    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17526
17527    /**
17528     * @}
17529     */
17530
17531    /**
17532     * @defgroup Slider Slider
17533     * @ingroup Elementary
17534     *
17535     * @image html img/widget/slider/preview-00.png
17536     * @image latex img/widget/slider/preview-00.eps width=\textwidth
17537     *
17538     * The slider adds a dragable ā€œsliderā€ widget for selecting the value of
17539     * something within a range.
17540     *
17541     * A slider can be horizontal or vertical. It can contain an Icon and has a
17542     * primary label as well as a units label (that is formatted with floating
17543     * point values and thus accepts a printf-style format string, like
17544     * ā€œ%1.2f unitsā€. There is also an indicator string that may be somewhere
17545     * else (like on the slider itself) that also accepts a format string like
17546     * units. Label, Icon Unit and Indicator strings/objects are optional.
17547     *
17548     * A slider may be inverted which means values invert, with high vales being
17549     * on the left or top and low values on the right or bottom (as opposed to
17550     * normally being low on the left or top and high on the bottom and right).
17551     *
17552     * The slider should have its minimum and maximum values set by the
17553     * application with  elm_slider_min_max_set() and value should also be set by
17554     * the application before use with  elm_slider_value_set(). The span of the
17555     * slider is its length (horizontally or vertically). This will be scaled by
17556     * the object or applications scaling factor. At any point code can query the
17557     * slider for its value with elm_slider_value_get().
17558     *
17559     * Smart callbacks one can listen to:
17560     * - "changed" - Whenever the slider value is changed by the user.
17561     * - "slider,drag,start" - dragging the slider indicator around has started.
17562     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17563     * - "delay,changed" - A short time after the value is changed by the user.
17564     * This will be called only when the user stops dragging for
17565     * a very short period or when they release their
17566     * finger/mouse, so it avoids possibly expensive reactions to
17567     * the value change.
17568     *
17569     * Available styles for it:
17570     * - @c "default"
17571     *
17572     * Default contents parts of the slider widget that you can use for are:
17573     * @li "icon" - An icon of the slider
17574     * @li "end" - A end part content of the slider
17575     *
17576     * Default text parts of the silder widget that you can use for are:
17577     * @li "default" - Label of the silder
17578     * Here is an example on its usage:
17579     * @li @ref slider_example
17580     */
17581
17582    /**
17583     * @addtogroup Slider
17584     * @{
17585     */
17586
17587    /**
17588     * Add a new slider widget to the given parent Elementary
17589     * (container) object.
17590     *
17591     * @param parent The parent object.
17592     * @return a new slider widget handle or @c NULL, on errors.
17593     *
17594     * This function inserts a new slider widget on the canvas.
17595     *
17596     * @ingroup Slider
17597     */
17598    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17599
17600    /**
17601     * Set the label of a given slider widget
17602     *
17603     * @param obj The progress bar object
17604     * @param label The text label string, in UTF-8
17605     *
17606     * @ingroup Slider
17607     * @deprecated use elm_object_text_set() instead.
17608     */
17609    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17610
17611    /**
17612     * Get the label of a given slider widget
17613     *
17614     * @param obj The progressbar object
17615     * @return The text label string, in UTF-8
17616     *
17617     * @ingroup Slider
17618     * @deprecated use elm_object_text_get() instead.
17619     */
17620    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17621
17622    /**
17623     * Set the icon object of the slider object.
17624     *
17625     * @param obj The slider object.
17626     * @param icon The icon object.
17627     *
17628     * On horizontal mode, icon is placed at left, and on vertical mode,
17629     * placed at top.
17630     *
17631     * @note Once the icon object is set, a previously set one will be deleted.
17632     * If you want to keep that old content object, use the
17633     * elm_slider_icon_unset() function.
17634     *
17635     * @warning If the object being set does not have minimum size hints set,
17636     * it won't get properly displayed.
17637     *
17638     * @ingroup Slider
17639     * @deprecated use elm_object_part_content_set() instead.
17640     */
17641    EINA_DEPRECATED EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17642
17643    /**
17644     * Unset an icon set on a given slider widget.
17645     *
17646     * @param obj The slider object.
17647     * @return The icon object that was being used, if any was set, or
17648     * @c NULL, otherwise (and on errors).
17649     *
17650     * On horizontal mode, icon is placed at left, and on vertical mode,
17651     * placed at top.
17652     *
17653     * This call will unparent and return the icon object which was set
17654     * for this widget, previously, on success.
17655     *
17656     * @see elm_slider_icon_set() for more details
17657     * @see elm_slider_icon_get()
17658     * @deprecated use elm_object_part_content_unset() instead.
17659     *
17660     * @ingroup Slider
17661     */
17662    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17663
17664    /**
17665     * Retrieve the icon object set for a given slider widget.
17666     *
17667     * @param obj The slider object.
17668     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17669     * otherwise (and on errors).
17670     *
17671     * On horizontal mode, icon is placed at left, and on vertical mode,
17672     * placed at top.
17673     *
17674     * @see elm_slider_icon_set() for more details
17675     * @see elm_slider_icon_unset()
17676     *
17677     * @deprecated use elm_object_part_content_get() instead.
17678     *
17679     * @ingroup Slider
17680     */
17681    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17682
17683    /**
17684     * Set the end object of the slider object.
17685     *
17686     * @param obj The slider object.
17687     * @param end The end object.
17688     *
17689     * On horizontal mode, end is placed at left, and on vertical mode,
17690     * placed at bottom.
17691     *
17692     * @note Once the icon object is set, a previously set one will be deleted.
17693     * If you want to keep that old content object, use the
17694     * elm_slider_end_unset() function.
17695     *
17696     * @warning If the object being set does not have minimum size hints set,
17697     * it won't get properly displayed.
17698     *
17699     * @deprecated use elm_object_part_content_set() instead.
17700     *
17701     * @ingroup Slider
17702     */
17703    EINA_DEPRECATED EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17704
17705    /**
17706     * Unset an end object set on a given slider widget.
17707     *
17708     * @param obj The slider object.
17709     * @return The end object that was being used, if any was set, or
17710     * @c NULL, otherwise (and on errors).
17711     *
17712     * On horizontal mode, end is placed at left, and on vertical mode,
17713     * placed at bottom.
17714     *
17715     * This call will unparent and return the icon object which was set
17716     * for this widget, previously, on success.
17717     *
17718     * @see elm_slider_end_set() for more details.
17719     * @see elm_slider_end_get()
17720     *
17721     * @deprecated use elm_object_part_content_unset() instead
17722     * instead.
17723     *
17724     * @ingroup Slider
17725     */
17726    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17727
17728    /**
17729     * Retrieve the end object set for a given slider widget.
17730     *
17731     * @param obj The slider object.
17732     * @return The end object's handle, if @p obj had one set, or @c NULL,
17733     * otherwise (and on errors).
17734     *
17735     * On horizontal mode, icon is placed at right, and on vertical mode,
17736     * placed at bottom.
17737     *
17738     * @see elm_slider_end_set() for more details.
17739     * @see elm_slider_end_unset()
17740     *
17741     *
17742     * @deprecated use elm_object_part_content_get() instead
17743     * instead.
17744     *
17745     * @ingroup Slider
17746     */
17747    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17748
17749    /**
17750     * Set the (exact) length of the bar region of a given slider widget.
17751     *
17752     * @param obj The slider object.
17753     * @param size The length of the slider's bar region.
17754     *
17755     * This sets the minimum width (when in horizontal mode) or height
17756     * (when in vertical mode) of the actual bar area of the slider
17757     * @p obj. This in turn affects the object's minimum size. Use
17758     * this when you're not setting other size hints expanding on the
17759     * given direction (like weight and alignment hints) and you would
17760     * like it to have a specific size.
17761     *
17762     * @note Icon, end, label, indicator and unit text around @p obj
17763     * will require their
17764     * own space, which will make @p obj to require more the @p size,
17765     * actually.
17766     *
17767     * @see elm_slider_span_size_get()
17768     *
17769     * @ingroup Slider
17770     */
17771    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17772
17773    /**
17774     * Get the length set for the bar region of a given slider widget
17775     *
17776     * @param obj The slider object.
17777     * @return The length of the slider's bar region.
17778     *
17779     * If that size was not set previously, with
17780     * elm_slider_span_size_set(), this call will return @c 0.
17781     *
17782     * @ingroup Slider
17783     */
17784    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17785
17786    /**
17787     * Set the format string for the unit label.
17788     *
17789     * @param obj The slider object.
17790     * @param format The format string for the unit display.
17791     *
17792     * Unit label is displayed all the time, if set, after slider's bar.
17793     * In horizontal mode, at right and in vertical mode, at bottom.
17794     *
17795     * If @c NULL, unit label won't be visible. If not it sets the format
17796     * string for the label text. To the label text is provided a floating point
17797     * value, so the label text can display up to 1 floating point value.
17798     * Note that this is optional.
17799     *
17800     * Use a format string such as "%1.2f meters" for example, and it will
17801     * display values like: "3.14 meters" for a value equal to 3.14159.
17802     *
17803     * Default is unit label disabled.
17804     *
17805     * @see elm_slider_indicator_format_get()
17806     *
17807     * @ingroup Slider
17808     */
17809    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17810
17811    /**
17812     * Get the unit label format of the slider.
17813     *
17814     * @param obj The slider object.
17815     * @return The unit label format string in UTF-8.
17816     *
17817     * Unit label is displayed all the time, if set, after slider's bar.
17818     * In horizontal mode, at right and in vertical mode, at bottom.
17819     *
17820     * @see elm_slider_unit_format_set() for more
17821     * information on how this works.
17822     *
17823     * @ingroup Slider
17824     */
17825    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17826
17827    /**
17828     * Set the format string for the indicator label.
17829     *
17830     * @param obj The slider object.
17831     * @param indicator The format string for the indicator display.
17832     *
17833     * The slider may display its value somewhere else then unit label,
17834     * for example, above the slider knob that is dragged around. This function
17835     * sets the format string used for this.
17836     *
17837     * If @c NULL, indicator label won't be visible. If not it sets the format
17838     * string for the label text. To the label text is provided a floating point
17839     * value, so the label text can display up to 1 floating point value.
17840     * Note that this is optional.
17841     *
17842     * Use a format string such as "%1.2f meters" for example, and it will
17843     * display values like: "3.14 meters" for a value equal to 3.14159.
17844     *
17845     * Default is indicator label disabled.
17846     *
17847     * @see elm_slider_indicator_format_get()
17848     *
17849     * @ingroup Slider
17850     */
17851    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17852
17853    /**
17854     * Get the indicator label format of the slider.
17855     *
17856     * @param obj The slider object.
17857     * @return The indicator label format string in UTF-8.
17858     *
17859     * The slider may display its value somewhere else then unit label,
17860     * for example, above the slider knob that is dragged around. This function
17861     * gets the format string used for this.
17862     *
17863     * @see elm_slider_indicator_format_set() for more
17864     * information on how this works.
17865     *
17866     * @ingroup Slider
17867     */
17868    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17869
17870    /**
17871     * Set the format function pointer for the indicator label
17872     *
17873     * @param obj The slider object.
17874     * @param func The indicator format function.
17875     * @param free_func The freeing function for the format string.
17876     *
17877     * Set the callback function to format the indicator string.
17878     *
17879     * @see elm_slider_indicator_format_set() for more info on how this works.
17880     *
17881     * @ingroup Slider
17882     */
17883   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);
17884
17885   /**
17886    * Set the format function pointer for the units label
17887    *
17888    * @param obj The slider object.
17889    * @param func The units format function.
17890    * @param free_func The freeing function for the format string.
17891    *
17892    * Set the callback function to format the indicator string.
17893    *
17894    * @see elm_slider_units_format_set() for more info on how this works.
17895    *
17896    * @ingroup Slider
17897    */
17898   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);
17899
17900   /**
17901    * Set the orientation of a given slider widget.
17902    *
17903    * @param obj The slider object.
17904    * @param horizontal Use @c EINA_TRUE to make @p obj to be
17905    * @b horizontal, @c EINA_FALSE to make it @b vertical.
17906    *
17907    * Use this function to change how your slider is to be
17908    * disposed: vertically or horizontally.
17909    *
17910    * By default it's displayed horizontally.
17911    *
17912    * @see elm_slider_horizontal_get()
17913    *
17914    * @ingroup Slider
17915    */
17916    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17917
17918    /**
17919     * Retrieve the orientation of a given slider widget
17920     *
17921     * @param obj The slider object.
17922     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17923     * @c EINA_FALSE if it's @b vertical (and on errors).
17924     *
17925     * @see elm_slider_horizontal_set() for more details.
17926     *
17927     * @ingroup Slider
17928     */
17929    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17930
17931    /**
17932     * Set the minimum and maximum values for the slider.
17933     *
17934     * @param obj The slider object.
17935     * @param min The minimum value.
17936     * @param max The maximum value.
17937     *
17938     * Define the allowed range of values to be selected by the user.
17939     *
17940     * If actual value is less than @p min, it will be updated to @p min. If it
17941     * is bigger then @p max, will be updated to @p max. Actual value can be
17942     * get with elm_slider_value_get().
17943     *
17944     * By default, min is equal to 0.0, and max is equal to 1.0.
17945     *
17946     * @warning Maximum must be greater than minimum, otherwise behavior
17947     * is undefined.
17948     *
17949     * @see elm_slider_min_max_get()
17950     *
17951     * @ingroup Slider
17952     */
17953    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17954
17955    /**
17956     * Get the minimum and maximum values of the slider.
17957     *
17958     * @param obj The slider object.
17959     * @param min Pointer where to store the minimum value.
17960     * @param max Pointer where to store the maximum value.
17961     *
17962     * @note If only one value is needed, the other pointer can be passed
17963     * as @c NULL.
17964     *
17965     * @see elm_slider_min_max_set() for details.
17966     *
17967     * @ingroup Slider
17968     */
17969    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17970
17971    /**
17972     * Set the value the slider displays.
17973     *
17974     * @param obj The slider object.
17975     * @param val The value to be displayed.
17976     *
17977     * Value will be presented on the unit label following format specified with
17978     * elm_slider_unit_format_set() and on indicator with
17979     * elm_slider_indicator_format_set().
17980     *
17981     * @warning The value must to be between min and max values. This values
17982     * are set by elm_slider_min_max_set().
17983     *
17984     * @see elm_slider_value_get()
17985     * @see elm_slider_unit_format_set()
17986     * @see elm_slider_indicator_format_set()
17987     * @see elm_slider_min_max_set()
17988     *
17989     * @ingroup Slider
17990     */
17991    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17992
17993    /**
17994     * Get the value displayed by the spinner.
17995     *
17996     * @param obj The spinner object.
17997     * @return The value displayed.
17998     *
17999     * @see elm_spinner_value_set() for details.
18000     *
18001     * @ingroup Slider
18002     */
18003    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18004
18005    /**
18006     * Invert a given slider widget's displaying values order
18007     *
18008     * @param obj The slider object.
18009     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
18010     * @c EINA_FALSE to bring it back to default, non-inverted values.
18011     *
18012     * A slider may be @b inverted, in which state it gets its
18013     * values inverted, with high vales being on the left or top and
18014     * low values on the right or bottom, as opposed to normally have
18015     * the low values on the former and high values on the latter,
18016     * respectively, for horizontal and vertical modes.
18017     *
18018     * @see elm_slider_inverted_get()
18019     *
18020     * @ingroup Slider
18021     */
18022    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
18023
18024    /**
18025     * Get whether a given slider widget's displaying values are
18026     * inverted or not.
18027     *
18028     * @param obj The slider object.
18029     * @return @c EINA_TRUE, if @p obj has inverted values,
18030     * @c EINA_FALSE otherwise (and on errors).
18031     *
18032     * @see elm_slider_inverted_set() for more details.
18033     *
18034     * @ingroup Slider
18035     */
18036    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18037
18038    /**
18039     * Set whether to enlarge slider indicator (augmented knob) or not.
18040     *
18041     * @param obj The slider object.
18042     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
18043     * let the knob always at default size.
18044     *
18045     * By default, indicator will be bigger while dragged by the user.
18046     *
18047     * @warning It won't display values set with
18048     * elm_slider_indicator_format_set() if you disable indicator.
18049     *
18050     * @ingroup Slider
18051     */
18052    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
18053
18054    /**
18055     * Get whether a given slider widget's enlarging indicator or not.
18056     *
18057     * @param obj The slider object.
18058     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
18059     * @c EINA_FALSE otherwise (and on errors).
18060     *
18061     * @see elm_slider_indicator_show_set() for details.
18062     *
18063     * @ingroup Slider
18064     */
18065    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18066
18067    /**
18068     * @}
18069     */
18070
18071    /**
18072     * @addtogroup Actionslider Actionslider
18073     *
18074     * @image html img/widget/actionslider/preview-00.png
18075     * @image latex img/widget/actionslider/preview-00.eps
18076     *
18077     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18078     * properties. The user drags and releases the indicator, to choose a label.
18079     *
18080     * Labels occupy the following positions.
18081     * a. Left
18082     * b. Right
18083     * c. Center
18084     *
18085     * Positions can be enabled or disabled.
18086     *
18087     * Magnets can be set on the above positions.
18088     *
18089     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18090     *
18091     * @note By default all positions are set as enabled.
18092     *
18093     * Signals that you can add callbacks for are:
18094     *
18095     * "selected" - when user selects an enabled position (the label is passed
18096     *              as event info)".
18097     * @n
18098     * "pos_changed" - when the indicator reaches any of the positions("left",
18099     *                 "right" or "center").
18100     *
18101     * See an example of actionslider usage @ref actionslider_example_page "here"
18102     * @{
18103     */
18104    typedef enum _Elm_Actionslider_Pos
18105      {
18106         ELM_ACTIONSLIDER_NONE = 0,
18107         ELM_ACTIONSLIDER_LEFT = 1 << 0,
18108         ELM_ACTIONSLIDER_CENTER = 1 << 1,
18109         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
18110         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
18111      } Elm_Actionslider_Pos;
18112
18113    /**
18114     * Add a new actionslider to the parent.
18115     *
18116     * @param parent The parent object
18117     * @return The new actionslider object or NULL if it cannot be created
18118     */
18119    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18120    /**
18121     * Set actionslider labels.
18122     *
18123     * @param obj The actionslider object
18124     * @param left_label The label to be set on the left.
18125     * @param center_label The label to be set on the center.
18126     * @param right_label The label to be set on the right.
18127     * @deprecated use elm_object_text_set() instead.
18128     */
18129    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);
18130    /**
18131     * Get actionslider labels.
18132     *
18133     * @param obj The actionslider object
18134     * @param left_label A char** to place the left_label of @p obj into.
18135     * @param center_label A char** to place the center_label of @p obj into.
18136     * @param right_label A char** to place the right_label of @p obj into.
18137     * @deprecated use elm_object_text_set() instead.
18138     */
18139    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);
18140    /**
18141     * Get actionslider selected label.
18142     *
18143     * @param obj The actionslider object
18144     * @return The selected label
18145     */
18146    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18147    /**
18148     * Set actionslider indicator position.
18149     *
18150     * @param obj The actionslider object.
18151     * @param pos The position of the indicator.
18152     */
18153    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18154    /**
18155     * Get actionslider indicator position.
18156     *
18157     * @param obj The actionslider object.
18158     * @return The position of the indicator.
18159     */
18160    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18161    /**
18162     * Set actionslider magnet position. To make multiple positions magnets @c or
18163     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
18164     *
18165     * @param obj The actionslider object.
18166     * @param pos Bit mask indicating the magnet positions.
18167     */
18168    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18169    /**
18170     * Get actionslider magnet position.
18171     *
18172     * @param obj The actionslider object.
18173     * @return The positions with magnet property.
18174     */
18175    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18176    /**
18177     * Set actionslider enabled position. To set multiple positions as enabled @c or
18178     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
18179     *
18180     * @note All the positions are enabled by default.
18181     *
18182     * @param obj The actionslider object.
18183     * @param pos Bit mask indicating the enabled positions.
18184     */
18185    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
18186    /**
18187     * Get actionslider enabled position.
18188     *
18189     * @param obj The actionslider object.
18190     * @return The enabled positions.
18191     */
18192    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18193    /**
18194     * Set the label used on the indicator.
18195     *
18196     * @param obj The actionslider object
18197     * @param label The label to be set on the indicator.
18198     * @deprecated use elm_object_text_set() instead.
18199     */
18200    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18201    /**
18202     * Get the label used on the indicator object.
18203     *
18204     * @param obj The actionslider object
18205     * @return The indicator label
18206     * @deprecated use elm_object_text_get() instead.
18207     */
18208    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18209    /**
18210     * @}
18211     */
18212
18213    /**
18214     * @defgroup Genlist Genlist
18215     *
18216     * @image html img/widget/genlist/preview-00.png
18217     * @image latex img/widget/genlist/preview-00.eps
18218     * @image html img/genlist.png
18219     * @image latex img/genlist.eps
18220     *
18221     * This widget aims to have more expansive list than the simple list in
18222     * Elementary that could have more flexible items and allow many more entries
18223     * while still being fast and low on memory usage. At the same time it was
18224     * also made to be able to do tree structures. But the price to pay is more
18225     * complexity when it comes to usage. If all you want is a simple list with
18226     * icons and a single text, use the normal @ref List object.
18227     *
18228     * Genlist has a fairly large API, mostly because it's relatively complex,
18229     * trying to be both expansive, powerful and efficient. First we will begin
18230     * an overview on the theory behind genlist.
18231     *
18232     * @section Genlist_Item_Class Genlist item classes - creating items
18233     *
18234     * In order to have the ability to add and delete items on the fly, genlist
18235     * implements a class (callback) system where the application provides a
18236     * structure with information about that type of item (genlist may contain
18237     * multiple different items with different classes, states and styles).
18238     * Genlist will call the functions in this struct (methods) when an item is
18239     * "realized" (i.e., created dynamically, while the user is scrolling the
18240     * grid). All objects will simply be deleted when no longer needed with
18241     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18242     * following members:
18243     * - @c item_style - This is a constant string and simply defines the name
18244     *   of the item style. It @b must be specified and the default should be @c
18245     *   "default".
18246     *
18247     * - @c func - A struct with pointers to functions that will be called when
18248     *   an item is going to be actually created. All of them receive a @c data
18249     *   parameter that will point to the same data passed to
18250     *   elm_genlist_item_append() and related item creation functions, and a @c
18251     *   obj parameter that points to the genlist object itself.
18252     *
18253     * The function pointers inside @c func are @c text_get, @c content_get, @c
18254     * state_get and @c del. The 3 first functions also receive a @c part
18255     * parameter described below. A brief description of these functions follows:
18256     *
18257     * - @c text_get - The @c part parameter is the name string of one of the
18258     *   existing text parts in the Edje group implementing the item's theme.
18259     *   This function @b must return a strdup'()ed string, as the caller will
18260     *   free() it when done. See #Elm_Genlist_Item_Text_Get_Cb.
18261     * - @c content_get - The @c part parameter is the name string of one of the
18262     *   existing (content) swallow parts in the Edje group implementing the item's
18263     *   theme. It must return @c NULL, when no content is desired, or a valid
18264     *   object handle, otherwise.  The object will be deleted by the genlist on
18265     *   its deletion or when the item is "unrealized".  See
18266     *   #Elm_Genlist_Item_Content_Get_Cb.
18267     * - @c func.state_get - The @c part parameter is the name string of one of
18268     *   the state parts in the Edje group implementing the item's theme. Return
18269     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18270     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18271     *   and @c "elm" as "emission" and "source" arguments, respectively, when
18272     *   the state is true (the default is false), where @c XXX is the name of
18273     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
18274     * - @c func.del - This is intended for use when genlist items are deleted,
18275     *   so any data attached to the item (e.g. its data parameter on creation)
18276     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
18277     *
18278     * available item styles:
18279     * - default
18280     * - default_style - The text part is a textblock
18281     *
18282     * @image html img/widget/genlist/preview-04.png
18283     * @image latex img/widget/genlist/preview-04.eps
18284     *
18285     * - double_label
18286     *
18287     * @image html img/widget/genlist/preview-01.png
18288     * @image latex img/widget/genlist/preview-01.eps
18289     *
18290     * - icon_top_text_bottom
18291     *
18292     * @image html img/widget/genlist/preview-02.png
18293     * @image latex img/widget/genlist/preview-02.eps
18294     *
18295     * - group_index
18296     *
18297     * @image html img/widget/genlist/preview-03.png
18298     * @image latex img/widget/genlist/preview-03.eps
18299     *
18300     * @section Genlist_Items Structure of items
18301     *
18302     * An item in a genlist can have 0 or more texts (they can be regular
18303     * text or textblock Evas objects - that's up to the style to determine), 0
18304     * or more contents (which are simply objects swallowed into the genlist item's
18305     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18306     * behavior left to the user to define. The Edje part names for each of
18307     * these properties will be looked up, in the theme file for the genlist,
18308     * under the Edje (string) data items named @c "labels", @c "contents" and @c
18309     * "states", respectively. For each of those properties, if more than one
18310     * part is provided, they must have names listed separated by spaces in the
18311     * data fields. For the default genlist item theme, we have @b one text 
18312     * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18313     * "elm.swallow.end") and @b no state parts.
18314     *
18315     * A genlist item may be at one of several styles. Elementary provides one
18316     * by default - "default", but this can be extended by system or application
18317     * custom themes/overlays/extensions (see @ref Theme "themes" for more
18318     * details).
18319     *
18320     * @section Genlist_Manipulation Editing and Navigating
18321     *
18322     * Items can be added by several calls. All of them return a @ref
18323     * Elm_Genlist_Item handle that is an internal member inside the genlist.
18324     * They all take a data parameter that is meant to be used for a handle to
18325     * the applications internal data (eg the struct with the original item
18326     * data). The parent parameter is the parent genlist item this belongs to if
18327     * it is a tree or an indexed group, and NULL if there is no parent. The
18328     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18329     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18330     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18331     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
18332     * is set then this item is group index item that is displayed at the top
18333     * until the next group comes. The func parameter is a convenience callback
18334     * that is called when the item is selected and the data parameter will be
18335     * the func_data parameter, obj be the genlist object and event_info will be
18336     * the genlist item.
18337     *
18338     * elm_genlist_item_append() adds an item to the end of the list, or if
18339     * there is a parent, to the end of all the child items of the parent.
18340     * elm_genlist_item_prepend() is the same but adds to the beginning of
18341     * the list or children list. elm_genlist_item_insert_before() inserts at
18342     * item before another item and elm_genlist_item_insert_after() inserts after
18343     * the indicated item.
18344     *
18345     * The application can clear the list with elm_genlist_clear() which deletes
18346     * all the items in the list and elm_genlist_item_del() will delete a specific
18347     * item. elm_genlist_item_subitems_clear() will clear all items that are
18348     * children of the indicated parent item.
18349     *
18350     * To help inspect list items you can jump to the item at the top of the list
18351     * with elm_genlist_first_item_get() which will return the item pointer, and
18352     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18353     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18354     * and previous items respectively relative to the indicated item. Using
18355     * these calls you can walk the entire item list/tree. Note that as a tree
18356     * the items are flattened in the list, so elm_genlist_item_parent_get() will
18357     * let you know which item is the parent (and thus know how to skip them if
18358     * wanted).
18359     *
18360     * @section Genlist_Muti_Selection Multi-selection
18361     *
18362     * If the application wants multiple items to be able to be selected,
18363     * elm_genlist_multi_select_set() can enable this. If the list is
18364     * single-selection only (the default), then elm_genlist_selected_item_get()
18365     * will return the selected item, if any, or NULL if none is selected. If the
18366     * list is multi-select then elm_genlist_selected_items_get() will return a
18367     * list (that is only valid as long as no items are modified (added, deleted,
18368     * selected or unselected)).
18369     *
18370     * @section Genlist_Usage_Hints Usage hints
18371     *
18372     * There are also convenience functions. elm_genlist_item_genlist_get() will
18373     * return the genlist object the item belongs to. elm_genlist_item_show()
18374     * will make the scroller scroll to show that specific item so its visible.
18375     * elm_genlist_item_data_get() returns the data pointer set by the item
18376     * creation functions.
18377     *
18378     * If an item changes (state of boolean changes, text or contents change),
18379     * then use elm_genlist_item_update() to have genlist update the item with
18380     * the new state. Genlist will re-realize the item thus call the functions
18381     * in the _Elm_Genlist_Item_Class for that item.
18382     *
18383     * To programmatically (un)select an item use elm_genlist_item_selected_set().
18384     * To get its selected state use elm_genlist_item_selected_get(). Similarly
18385     * to expand/contract an item and get its expanded state, use
18386     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18387     * again to make an item disabled (unable to be selected and appear
18388     * differently) use elm_genlist_item_disabled_set() to set this and
18389     * elm_genlist_item_disabled_get() to get the disabled state.
18390     *
18391     * In general to indicate how the genlist should expand items horizontally to
18392     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18393     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18394     * mode means that if items are too wide to fit, the scroller will scroll
18395     * horizontally. Otherwise items are expanded to fill the width of the
18396     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18397     * to the viewport width and limited to that size. This can be combined with
18398     * a different style that uses edjes' ellipsis feature (cutting text off like
18399     * this: "tex...").
18400     *
18401     * Items will only call their selection func and callback when first becoming
18402     * selected. Any further clicks will do nothing, unless you enable always
18403     * select with elm_genlist_always_select_mode_set(). This means even if
18404     * selected, every click will make the selected callbacks be called.
18405     * elm_genlist_no_select_mode_set() will turn off the ability to select
18406     * items entirely and they will neither appear selected nor call selected
18407     * callback functions.
18408     *
18409     * Remember that you can create new styles and add your own theme augmentation
18410     * per application with elm_theme_extension_add(). If you absolutely must
18411     * have a specific style that overrides any theme the user or system sets up
18412     * you can use elm_theme_overlay_add() to add such a file.
18413     *
18414     * @section Genlist_Implementation Implementation
18415     *
18416     * Evas tracks every object you create. Every time it processes an event
18417     * (mouse move, down, up etc.) it needs to walk through objects and find out
18418     * what event that affects. Even worse every time it renders display updates,
18419     * in order to just calculate what to re-draw, it needs to walk through many
18420     * many many objects. Thus, the more objects you keep active, the more
18421     * overhead Evas has in just doing its work. It is advisable to keep your
18422     * active objects to the minimum working set you need. Also remember that
18423     * object creation and deletion carries an overhead, so there is a
18424     * middle-ground, which is not easily determined. But don't keep massive lists
18425     * of objects you can't see or use. Genlist does this with list objects. It
18426     * creates and destroys them dynamically as you scroll around. It groups them
18427     * into blocks so it can determine the visibility etc. of a whole block at
18428     * once as opposed to having to walk the whole list. This 2-level list allows
18429     * for very large numbers of items to be in the list (tests have used up to
18430     * 2,000,000 items). Also genlist employs a queue for adding items. As items
18431     * may be different sizes, every item added needs to be calculated as to its
18432     * size and thus this presents a lot of overhead on populating the list, this
18433     * genlist employs a queue. Any item added is queued and spooled off over
18434     * time, actually appearing some time later, so if your list has many members
18435     * you may find it takes a while for them to all appear, with your process
18436     * consuming a lot of CPU while it is busy spooling.
18437     *
18438     * Genlist also implements a tree structure, but it does so with callbacks to
18439     * the application, with the application filling in tree structures when
18440     * requested (allowing for efficient building of a very deep tree that could
18441     * even be used for file-management). See the above smart signal callbacks for
18442     * details.
18443     *
18444     * @section Genlist_Smart_Events Genlist smart events
18445     *
18446     * Signals that you can add callbacks for are:
18447     * - @c "activated" - The user has double-clicked or pressed
18448     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
18449     *   item that was activated.
18450     * - @c "clicked,double" - The user has double-clicked an item.  The @c
18451     *   event_info parameter is the item that was double-clicked.
18452     * - @c "selected" - This is called when a user has made an item selected.
18453     *   The event_info parameter is the genlist item that was selected.
18454     * - @c "unselected" - This is called when a user has made an item
18455     *   unselected. The event_info parameter is the genlist item that was
18456     *   unselected.
18457     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18458     *   called and the item is now meant to be expanded. The event_info
18459     *   parameter is the genlist item that was indicated to expand.  It is the
18460     *   job of this callback to then fill in the child items.
18461     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18462     *   called and the item is now meant to be contracted. The event_info
18463     *   parameter is the genlist item that was indicated to contract. It is the
18464     *   job of this callback to then delete the child items.
18465     * - @c "expand,request" - This is called when a user has indicated they want
18466     *   to expand a tree branch item. The callback should decide if the item can
18467     *   expand (has any children) and then call elm_genlist_item_expanded_set()
18468     *   appropriately to set the state. The event_info parameter is the genlist
18469     *   item that was indicated to expand.
18470     * - @c "contract,request" - This is called when a user has indicated they
18471     *   want to contract a tree branch item. The callback should decide if the
18472     *   item can contract (has any children) and then call
18473     *   elm_genlist_item_expanded_set() appropriately to set the state. The
18474     *   event_info parameter is the genlist item that was indicated to contract.
18475     * - @c "realized" - This is called when the item in the list is created as a
18476     *   real evas object. event_info parameter is the genlist item that was
18477     *   created. The object may be deleted at any time, so it is up to the
18478     *   caller to not use the object pointer from elm_genlist_item_object_get()
18479     *   in a way where it may point to freed objects.
18480     * - @c "unrealized" - This is called just before an item is unrealized.
18481     *   After this call content objects provided will be deleted and the item
18482     *   object itself delete or be put into a floating cache.
18483     * - @c "drag,start,up" - This is called when the item in the list has been
18484     *   dragged (not scrolled) up.
18485     * - @c "drag,start,down" - This is called when the item in the list has been
18486     *   dragged (not scrolled) down.
18487     * - @c "drag,start,left" - This is called when the item in the list has been
18488     *   dragged (not scrolled) left.
18489     * - @c "drag,start,right" - This is called when the item in the list has
18490     *   been dragged (not scrolled) right.
18491     * - @c "drag,stop" - This is called when the item in the list has stopped
18492     *   being dragged.
18493     * - @c "drag" - This is called when the item in the list is being dragged.
18494     * - @c "longpressed" - This is called when the item is pressed for a certain
18495     *   amount of time. By default it's 1 second.
18496     * - @c "scroll,anim,start" - This is called when scrolling animation has
18497     *   started.
18498     * - @c "scroll,anim,stop" - This is called when scrolling animation has
18499     *   stopped.
18500     * - @c "scroll,drag,start" - This is called when dragging the content has
18501     *   started.
18502     * - @c "scroll,drag,stop" - This is called when dragging the content has
18503     *   stopped.
18504     * - @c "edge,top" - This is called when the genlist is scrolled until
18505     *   the top edge.
18506     * - @c "edge,bottom" - This is called when the genlist is scrolled
18507     *   until the bottom edge.
18508     * - @c "edge,left" - This is called when the genlist is scrolled
18509     *   until the left edge.
18510     * - @c "edge,right" - This is called when the genlist is scrolled
18511     *   until the right edge.
18512     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18513     *   swiped left.
18514     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18515     *   swiped right.
18516     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18517     *   swiped up.
18518     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18519     *   swiped down.
18520     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18521     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
18522     *   multi-touch pinched in.
18523     * - @c "swipe" - This is called when the genlist is swiped.
18524     * - @c "moved" - This is called when a genlist item is moved.
18525     * - @c "language,changed" - This is called when the program's language is
18526     *   changed.
18527     *
18528     * @section Genlist_Examples Examples
18529     *
18530     * Here is a list of examples that use the genlist, trying to show some of
18531     * its capabilities:
18532     * - @ref genlist_example_01
18533     * - @ref genlist_example_02
18534     * - @ref genlist_example_03
18535     * - @ref genlist_example_04
18536     * - @ref genlist_example_05
18537     */
18538
18539    /**
18540     * @addtogroup Genlist
18541     * @{
18542     */
18543
18544    /**
18545     * @enum _Elm_Genlist_Item_Flags
18546     * @typedef Elm_Genlist_Item_Flags
18547     *
18548     * Defines if the item is of any special type (has subitems or it's the
18549     * index of a group), or is just a simple item.
18550     *
18551     * @ingroup Genlist
18552     */
18553    typedef enum _Elm_Genlist_Item_Flags
18554      {
18555         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18556         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18557         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18558      } Elm_Genlist_Item_Flags;
18559    typedef enum _Elm_Genlist_Item_Field_Flags
18560      {
18561         ELM_GENLIST_ITEM_FIELD_ALL = 0,
18562         ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18563         ELM_GENLIST_ITEM_FIELD_CONTENT = (1 << 1),
18564         ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18565      } Elm_Genlist_Item_Field_Flags;
18566    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
18567    #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18568    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18569    #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18570    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18571    /**
18572     * Text fetching class function for Elm_Gen_Item_Class.
18573     * @param data The data passed in the item creation function
18574     * @param obj The base widget object
18575     * @param part The part name of the swallow
18576     * @return The allocated (NOT stringshared) string to set as the text
18577     */
18578    typedef char        *(*Elm_Genlist_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18579    /**
18580     * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
18581     * @param data The data passed in the item creation function
18582     * @param obj The base widget object
18583     * @param part The part name of the swallow
18584     * @return The content object to swallow
18585     */
18586    typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part);
18587    /**
18588     * State fetching class function for Elm_Gen_Item_Class.
18589     * @param data The data passed in the item creation function
18590     * @param obj The base widget object
18591     * @param part The part name of the swallow
18592     * @return The hell if I know
18593     */
18594    typedef Eina_Bool    (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
18595    /**
18596     * Deletion class function for Elm_Gen_Item_Class.
18597     * @param data The data passed in the item creation function
18598     * @param obj The base widget object
18599     */
18600    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj);
18601
18602    /**
18603     * @struct _Elm_Genlist_Item_Class
18604     *
18605     * Genlist item class definition structs.
18606     *
18607     * This struct contains the style and fetching functions that will define the
18608     * contents of each item.
18609     *
18610     * @see @ref Genlist_Item_Class
18611     */
18612    struct _Elm_Genlist_Item_Class
18613      {
18614         const char                *item_style; /**< style of this class. */
18615         struct Elm_Genlist_Item_Class_Func
18616           {
18617              union /* temporary compatibility code */
18618                {
18619                   Elm_Genlist_Item_Text_Get_Cb  label_get EINA_DEPRECATED;
18620                   Elm_Genlist_Item_Text_Get_Cb  text_get; /**< Text fetching class function for genlist item classes.*/
18621                };
18622              Elm_Genlist_Item_Content_Get_Cb   content_get; /**< Content fetching class function for genlist item classes. */
18623              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
18624              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
18625           } func;
18626      };
18627    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18628    /**
18629     * Add a new genlist widget to the given parent Elementary
18630     * (container) object
18631     *
18632     * @param parent The parent object
18633     * @return a new genlist widget handle or @c NULL, on errors
18634     *
18635     * This function inserts a new genlist widget on the canvas.
18636     *
18637     * @see elm_genlist_item_append()
18638     * @see elm_genlist_item_del()
18639     * @see elm_genlist_clear()
18640     *
18641     * @ingroup Genlist
18642     */
18643    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18644    /**
18645     * Remove all items from a given genlist widget.
18646     *
18647     * @param obj The genlist object
18648     *
18649     * This removes (and deletes) all items in @p obj, leaving it empty.
18650     *
18651     * @see elm_genlist_item_del(), to remove just one item.
18652     *
18653     * @ingroup Genlist
18654     */
18655    EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18656    /**
18657     * Enable or disable multi-selection in the genlist
18658     *
18659     * @param obj The genlist object
18660     * @param multi Multi-select enable/disable. Default is disabled.
18661     *
18662     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18663     * the list. This allows more than 1 item to be selected. To retrieve the list
18664     * of selected items, use elm_genlist_selected_items_get().
18665     *
18666     * @see elm_genlist_selected_items_get()
18667     * @see elm_genlist_multi_select_get()
18668     *
18669     * @ingroup Genlist
18670     */
18671    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18672    /**
18673     * Gets if multi-selection in genlist is enabled or disabled.
18674     *
18675     * @param obj The genlist object
18676     * @return Multi-select enabled/disabled
18677     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18678     *
18679     * @see elm_genlist_multi_select_set()
18680     *
18681     * @ingroup Genlist
18682     */
18683    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18684    /**
18685     * This sets the horizontal stretching mode.
18686     *
18687     * @param obj The genlist object
18688     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18689     *
18690     * This sets the mode used for sizing items horizontally. Valid modes
18691     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18692     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18693     * the scroller will scroll horizontally. Otherwise items are expanded
18694     * to fill the width of the viewport of the scroller. If it is
18695     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18696     * limited to that size.
18697     *
18698     * @see elm_genlist_horizontal_get()
18699     *
18700     * @ingroup Genlist
18701     */
18702    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18703    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18704    /**
18705     * Gets the horizontal stretching mode.
18706     *
18707     * @param obj The genlist object
18708     * @return The mode to use
18709     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18710     *
18711     * @see elm_genlist_horizontal_set()
18712     *
18713     * @ingroup Genlist
18714     */
18715    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18716    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18717    /**
18718     * Set the always select mode.
18719     *
18720     * @param obj The genlist object
18721     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18722     * EINA_FALSE = off). Default is @c EINA_FALSE.
18723     *
18724     * Items will only call their selection func and callback when first
18725     * becoming selected. Any further clicks will do nothing, unless you
18726     * enable always select with elm_genlist_always_select_mode_set().
18727     * This means that, even if selected, every click will make the selected
18728     * callbacks be called.
18729     *
18730     * @see elm_genlist_always_select_mode_get()
18731     *
18732     * @ingroup Genlist
18733     */
18734    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18735    /**
18736     * Get the always select mode.
18737     *
18738     * @param obj The genlist object
18739     * @return The always select mode
18740     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18741     *
18742     * @see elm_genlist_always_select_mode_set()
18743     *
18744     * @ingroup Genlist
18745     */
18746    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18747    /**
18748     * Enable/disable the no select mode.
18749     *
18750     * @param obj The genlist object
18751     * @param no_select The no select mode
18752     * (EINA_TRUE = on, EINA_FALSE = off)
18753     *
18754     * This will turn off the ability to select items entirely and they
18755     * will neither appear selected nor call selected callback functions.
18756     *
18757     * @see elm_genlist_no_select_mode_get()
18758     *
18759     * @ingroup Genlist
18760     */
18761    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18762    /**
18763     * Gets whether the no select mode is enabled.
18764     *
18765     * @param obj The genlist object
18766     * @return The no select mode
18767     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18768     *
18769     * @see elm_genlist_no_select_mode_set()
18770     *
18771     * @ingroup Genlist
18772     */
18773    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18774    /**
18775     * Enable/disable compress mode.
18776     *
18777     * @param obj The genlist object
18778     * @param compress The compress mode
18779     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18780     *
18781     * This will enable the compress mode where items are "compressed"
18782     * horizontally to fit the genlist scrollable viewport width. This is
18783     * special for genlist.  Do not rely on
18784     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18785     * work as genlist needs to handle it specially.
18786     *
18787     * @see elm_genlist_compress_mode_get()
18788     *
18789     * @ingroup Genlist
18790     */
18791    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18792    /**
18793     * Get whether the compress mode is enabled.
18794     *
18795     * @param obj The genlist object
18796     * @return The compress mode
18797     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18798     *
18799     * @see elm_genlist_compress_mode_set()
18800     *
18801     * @ingroup Genlist
18802     */
18803    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18804    /**
18805     * Enable/disable height-for-width mode.
18806     *
18807     * @param obj The genlist object
18808     * @param setting The height-for-width mode (@c EINA_TRUE = on,
18809     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18810     *
18811     * With height-for-width mode the item width will be fixed (restricted
18812     * to a minimum of) to the list width when calculating its size in
18813     * order to allow the height to be calculated based on it. This allows,
18814     * for instance, text block to wrap lines if the Edje part is
18815     * configured with "text.min: 0 1".
18816     *
18817     * @note This mode will make list resize slower as it will have to
18818     *       recalculate every item height again whenever the list width
18819     *       changes!
18820     *
18821     * @note When height-for-width mode is enabled, it also enables
18822     *       compress mode (see elm_genlist_compress_mode_set()) and
18823     *       disables homogeneous (see elm_genlist_homogeneous_set()).
18824     *
18825     * @ingroup Genlist
18826     */
18827    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18828    /**
18829     * Get whether the height-for-width mode is enabled.
18830     *
18831     * @param obj The genlist object
18832     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18833     * off)
18834     *
18835     * @ingroup Genlist
18836     */
18837    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18838    /**
18839     * Enable/disable horizontal and vertical bouncing effect.
18840     *
18841     * @param obj The genlist object
18842     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18843     * EINA_FALSE = off). Default is @c EINA_FALSE.
18844     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18845     * EINA_FALSE = off). Default is @c EINA_TRUE.
18846     *
18847     * This will enable or disable the scroller bouncing effect for the
18848     * genlist. See elm_scroller_bounce_set() for details.
18849     *
18850     * @see elm_scroller_bounce_set()
18851     * @see elm_genlist_bounce_get()
18852     *
18853     * @ingroup Genlist
18854     */
18855    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18856    /**
18857     * Get whether the horizontal and vertical bouncing effect is enabled.
18858     *
18859     * @param obj The genlist object
18860     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18861     * option is set.
18862     * @param v_bounce Pointer to a bool to receive if the bounce vertically
18863     * option is set.
18864     *
18865     * @see elm_genlist_bounce_set()
18866     *
18867     * @ingroup Genlist
18868     */
18869    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18870    /**
18871     * Enable/disable homogeneous mode.
18872     *
18873     * @param obj The genlist object
18874     * @param homogeneous Assume the items within the genlist are of the
18875     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18876     * EINA_FALSE.
18877     *
18878     * This will enable the homogeneous mode where items are of the same
18879     * height and width so that genlist may do the lazy-loading at its
18880     * maximum (which increases the performance for scrolling the list). This
18881     * implies 'compressed' mode.
18882     *
18883     * @see elm_genlist_compress_mode_set()
18884     * @see elm_genlist_homogeneous_get()
18885     *
18886     * @ingroup Genlist
18887     */
18888    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18889    /**
18890     * Get whether the homogeneous mode is enabled.
18891     *
18892     * @param obj The genlist object
18893     * @return Assume the items within the genlist are of the same height
18894     * and width (EINA_TRUE = on, EINA_FALSE = off)
18895     *
18896     * @see elm_genlist_homogeneous_set()
18897     *
18898     * @ingroup Genlist
18899     */
18900    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18901    /**
18902     * Set the maximum number of items within an item block
18903     *
18904     * @param obj The genlist object
18905     * @param n   Maximum number of items within an item block. Default is 32.
18906     *
18907     * This will configure the block count to tune to the target with
18908     * particular performance matrix.
18909     *
18910     * A block of objects will be used to reduce the number of operations due to
18911     * many objects in the screen. It can determine the visibility, or if the
18912     * object has changed, it theme needs to be updated, etc. doing this kind of
18913     * calculation to the entire block, instead of per object.
18914     *
18915     * The default value for the block count is enough for most lists, so unless
18916     * you know you will have a lot of objects visible in the screen at the same
18917     * time, don't try to change this.
18918     *
18919     * @see elm_genlist_block_count_get()
18920     * @see @ref Genlist_Implementation
18921     *
18922     * @ingroup Genlist
18923     */
18924    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18925    /**
18926     * Get the maximum number of items within an item block
18927     *
18928     * @param obj The genlist object
18929     * @return Maximum number of items within an item block
18930     *
18931     * @see elm_genlist_block_count_set()
18932     *
18933     * @ingroup Genlist
18934     */
18935    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18936    /**
18937     * Set the timeout in seconds for the longpress event.
18938     *
18939     * @param obj The genlist object
18940     * @param timeout timeout in seconds. Default is 1.
18941     *
18942     * This option will change how long it takes to send an event "longpressed"
18943     * after the mouse down signal is sent to the list. If this event occurs, no
18944     * "clicked" event will be sent.
18945     *
18946     * @see elm_genlist_longpress_timeout_set()
18947     *
18948     * @ingroup Genlist
18949     */
18950    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18951    /**
18952     * Get the timeout in seconds for the longpress event.
18953     *
18954     * @param obj The genlist object
18955     * @return timeout in seconds
18956     *
18957     * @see elm_genlist_longpress_timeout_get()
18958     *
18959     * @ingroup Genlist
18960     */
18961    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18962    /**
18963     * Append a new item in a given genlist widget.
18964     *
18965     * @param obj The genlist object
18966     * @param itc The item class for the item
18967     * @param data The item data
18968     * @param parent The parent item, or NULL if none
18969     * @param flags Item flags
18970     * @param func Convenience function called when the item is selected
18971     * @param func_data Data passed to @p func above.
18972     * @return A handle to the item added or @c NULL if not possible
18973     *
18974     * This adds the given item to the end of the list or the end of
18975     * the children list if the @p parent is given.
18976     *
18977     * @see elm_genlist_item_prepend()
18978     * @see elm_genlist_item_insert_before()
18979     * @see elm_genlist_item_insert_after()
18980     * @see elm_genlist_item_del()
18981     *
18982     * @ingroup Genlist
18983     */
18984    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);
18985    /**
18986     * Prepend a new item in a given genlist widget.
18987     *
18988     * @param obj The genlist object
18989     * @param itc The item class for the item
18990     * @param data The item data
18991     * @param parent The parent item, or NULL if none
18992     * @param flags Item flags
18993     * @param func Convenience function called when the item is selected
18994     * @param func_data Data passed to @p func above.
18995     * @return A handle to the item added or NULL if not possible
18996     *
18997     * This adds an item to the beginning of the list or beginning of the
18998     * children of the parent if given.
18999     *
19000     * @see elm_genlist_item_append()
19001     * @see elm_genlist_item_insert_before()
19002     * @see elm_genlist_item_insert_after()
19003     * @see elm_genlist_item_del()
19004     *
19005     * @ingroup Genlist
19006     */
19007    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);
19008    /**
19009     * Insert an item before another in a genlist widget
19010     *
19011     * @param obj The genlist object
19012     * @param itc The item class for the item
19013     * @param data The item data
19014     * @param before The item to place this new one before.
19015     * @param flags Item flags
19016     * @param func Convenience function called when the item is selected
19017     * @param func_data Data passed to @p func above.
19018     * @return A handle to the item added or @c NULL if not possible
19019     *
19020     * This inserts an item before another in the list. It will be in the
19021     * same tree level or group as the item it is inserted before.
19022     *
19023     * @see elm_genlist_item_append()
19024     * @see elm_genlist_item_prepend()
19025     * @see elm_genlist_item_insert_after()
19026     * @see elm_genlist_item_del()
19027     *
19028     * @ingroup Genlist
19029     */
19030    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);
19031    /**
19032     * Insert an item after another in a genlist widget
19033     *
19034     * @param obj The genlist object
19035     * @param itc The item class for the item
19036     * @param data The item data
19037     * @param after The item to place this new one after.
19038     * @param flags Item flags
19039     * @param func Convenience function called when the item is selected
19040     * @param func_data Data passed to @p func above.
19041     * @return A handle to the item added or @c NULL if not possible
19042     *
19043     * This inserts an item after another in the list. It will be in the
19044     * same tree level or group as the item it is inserted after.
19045     *
19046     * @see elm_genlist_item_append()
19047     * @see elm_genlist_item_prepend()
19048     * @see elm_genlist_item_insert_before()
19049     * @see elm_genlist_item_del()
19050     *
19051     * @ingroup Genlist
19052     */
19053    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);
19054    /**
19055     * Insert a new item into the sorted genlist object
19056     *
19057     * @param obj The genlist object
19058     * @param itc The item class for the item
19059     * @param data The item data
19060     * @param parent The parent item, or NULL if none
19061     * @param flags Item flags
19062     * @param comp The function called for the sort
19063     * @param func Convenience function called when item selected
19064     * @param func_data Data passed to @p func above.
19065     * @return A handle to the item added or NULL if not possible
19066     *
19067     * @ingroup Genlist
19068     */
19069    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);
19070    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);
19071    /* operations to retrieve existing items */
19072    /**
19073     * Get the selectd item in the genlist.
19074     *
19075     * @param obj The genlist object
19076     * @return The selected item, or NULL if none is selected.
19077     *
19078     * This gets the selected item in the list (if multi-selection is enabled, only
19079     * the item that was first selected in the list is returned - which is not very
19080     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19081     * used).
19082     *
19083     * If no item is selected, NULL is returned.
19084     *
19085     * @see elm_genlist_selected_items_get()
19086     *
19087     * @ingroup Genlist
19088     */
19089    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19090    /**
19091     * Get a list of selected items in the genlist.
19092     *
19093     * @param obj The genlist object
19094     * @return The list of selected items, or NULL if none are selected.
19095     *
19096     * It returns a list of the selected items. This list pointer is only valid so
19097     * long as the selection doesn't change (no items are selected or unselected, or
19098     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
19099     * pointers. The order of the items in this list is the order which they were
19100     * selected, i.e. the first item in this list is the first item that was
19101     * selected, and so on.
19102     *
19103     * @note If not in multi-select mode, consider using function
19104     * elm_genlist_selected_item_get() instead.
19105     *
19106     * @see elm_genlist_multi_select_set()
19107     * @see elm_genlist_selected_item_get()
19108     *
19109     * @ingroup Genlist
19110     */
19111    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19112    /**
19113     * Get the mode item style of items in the genlist
19114     * @param obj The genlist object
19115     * @return The mode item style string, or NULL if none is specified
19116     *
19117     * This is a constant string and simply defines the name of the
19118     * style that will be used for mode animations. It can be
19119     * @c NULL if you don't plan to use Genlist mode. See
19120     * elm_genlist_item_mode_set() for more info.
19121     *
19122     * @ingroup Genlist
19123     */
19124    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19125    /**
19126     * Set the mode item style of items in the genlist
19127     * @param obj The genlist object
19128     * @param style The mode item style string, or NULL if none is desired
19129     *
19130     * This is a constant string and simply defines the name of the
19131     * style that will be used for mode animations. It can be
19132     * @c NULL if you don't plan to use Genlist mode. See
19133     * elm_genlist_item_mode_set() for more info.
19134     *
19135     * @ingroup Genlist
19136     */
19137    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
19138    /**
19139     * Get a list of realized items in genlist
19140     *
19141     * @param obj The genlist object
19142     * @return The list of realized items, nor NULL if none are realized.
19143     *
19144     * This returns a list of the realized items in the genlist. The list
19145     * contains Elm_Genlist_Item pointers. The list must be freed by the
19146     * caller when done with eina_list_free(). The item pointers in the
19147     * list are only valid so long as those items are not deleted or the
19148     * genlist is not deleted.
19149     *
19150     * @see elm_genlist_realized_items_update()
19151     *
19152     * @ingroup Genlist
19153     */
19154    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19155    /**
19156     * Get the item that is at the x, y canvas coords.
19157     *
19158     * @param obj The gelinst object.
19159     * @param x The input x coordinate
19160     * @param y The input y coordinate
19161     * @param posret The position relative to the item returned here
19162     * @return The item at the coordinates or NULL if none
19163     *
19164     * This returns the item at the given coordinates (which are canvas
19165     * relative, not object-relative). If an item is at that coordinate,
19166     * that item handle is returned, and if @p posret is not NULL, the
19167     * integer pointed to is set to a value of -1, 0 or 1, depending if
19168     * the coordinate is on the upper portion of that item (-1), on the
19169     * middle section (0) or on the lower part (1). If NULL is returned as
19170     * an item (no item found there), then posret may indicate -1 or 1
19171     * based if the coordinate is above or below all items respectively in
19172     * the genlist.
19173     *
19174     * @ingroup Genlist
19175     */
19176    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);
19177    /**
19178     * Get the first item in the genlist
19179     *
19180     * This returns the first item in the list.
19181     *
19182     * @param obj The genlist object
19183     * @return The first item, or NULL if none
19184     *
19185     * @ingroup Genlist
19186     */
19187    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19188    /**
19189     * Get the last item in the genlist
19190     *
19191     * This returns the last item in the list.
19192     *
19193     * @return The last item, or NULL if none
19194     *
19195     * @ingroup Genlist
19196     */
19197    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19198    /**
19199     * Set the scrollbar policy
19200     *
19201     * @param obj The genlist object
19202     * @param policy_h Horizontal scrollbar policy.
19203     * @param policy_v Vertical scrollbar policy.
19204     *
19205     * This sets the scrollbar visibility policy for the given genlist
19206     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19207     * made visible if it is needed, and otherwise kept hidden.
19208     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19209     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19210     * respectively for the horizontal and vertical scrollbars. Default is
19211     * #ELM_SMART_SCROLLER_POLICY_AUTO
19212     *
19213     * @see elm_genlist_scroller_policy_get()
19214     *
19215     * @ingroup Genlist
19216     */
19217    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19218    /**
19219     * Get the scrollbar policy
19220     *
19221     * @param obj The genlist object
19222     * @param policy_h Pointer to store the horizontal scrollbar policy.
19223     * @param policy_v Pointer to store the vertical scrollbar policy.
19224     *
19225     * @see elm_genlist_scroller_policy_set()
19226     *
19227     * @ingroup Genlist
19228     */
19229    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);
19230    /**
19231     * Get the @b next item in a genlist widget's internal list of items,
19232     * given a handle to one of those items.
19233     *
19234     * @param item The genlist item to fetch next from
19235     * @return The item after @p item, or @c NULL if there's none (and
19236     * on errors)
19237     *
19238     * This returns the item placed after the @p item, on the container
19239     * genlist.
19240     *
19241     * @see elm_genlist_item_prev_get()
19242     *
19243     * @ingroup Genlist
19244     */
19245    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19246    /**
19247     * Get the @b previous item in a genlist widget's internal list of items,
19248     * given a handle to one of those items.
19249     *
19250     * @param item The genlist item to fetch previous from
19251     * @return The item before @p item, or @c NULL if there's none (and
19252     * on errors)
19253     *
19254     * This returns the item placed before the @p item, on the container
19255     * genlist.
19256     *
19257     * @see elm_genlist_item_next_get()
19258     *
19259     * @ingroup Genlist
19260     */
19261    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19262    /**
19263     * Get the genlist object's handle which contains a given genlist
19264     * item
19265     *
19266     * @param item The item to fetch the container from
19267     * @return The genlist (parent) object
19268     *
19269     * This returns the genlist object itself that an item belongs to.
19270     *
19271     * @ingroup Genlist
19272     */
19273    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19274    /**
19275     * Get the parent item of the given item
19276     *
19277     * @param it The item
19278     * @return The parent of the item or @c NULL if it has no parent.
19279     *
19280     * This returns the item that was specified as parent of the item @p it on
19281     * elm_genlist_item_append() and insertion related functions.
19282     *
19283     * @ingroup Genlist
19284     */
19285    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19286    /**
19287     * Remove all sub-items (children) of the given item
19288     *
19289     * @param it The item
19290     *
19291     * This removes all items that are children (and their descendants) of the
19292     * given item @p it.
19293     *
19294     * @see elm_genlist_clear()
19295     * @see elm_genlist_item_del()
19296     *
19297     * @ingroup Genlist
19298     */
19299    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19300    /**
19301     * Set whether a given genlist item is selected or not
19302     *
19303     * @param it The item
19304     * @param selected Use @c EINA_TRUE, to make it selected, @c
19305     * EINA_FALSE to make it unselected
19306     *
19307     * This sets the selected state of an item. If multi selection is
19308     * not enabled on the containing genlist and @p selected is @c
19309     * EINA_TRUE, any other previously selected items will get
19310     * unselected in favor of this new one.
19311     *
19312     * @see elm_genlist_item_selected_get()
19313     *
19314     * @ingroup Genlist
19315     */
19316    EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19317    /**
19318     * Get whether a given genlist item is selected or not
19319     *
19320     * @param it The item
19321     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19322     *
19323     * @see elm_genlist_item_selected_set() for more details
19324     *
19325     * @ingroup Genlist
19326     */
19327    EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19328    /**
19329     * Sets the expanded state of an item.
19330     *
19331     * @param it The item
19332     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19333     *
19334     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19335     * expanded or not.
19336     *
19337     * The theme will respond to this change visually, and a signal "expanded" or
19338     * "contracted" will be sent from the genlist with a pointer to the item that
19339     * has been expanded/contracted.
19340     *
19341     * Calling this function won't show or hide any child of this item (if it is
19342     * a parent). You must manually delete and create them on the callbacks fo
19343     * the "expanded" or "contracted" signals.
19344     *
19345     * @see elm_genlist_item_expanded_get()
19346     *
19347     * @ingroup Genlist
19348     */
19349    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19350    /**
19351     * Get the expanded state of an item
19352     *
19353     * @param it The item
19354     * @return The expanded state
19355     *
19356     * This gets the expanded state of an item.
19357     *
19358     * @see elm_genlist_item_expanded_set()
19359     *
19360     * @ingroup Genlist
19361     */
19362    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19363    /**
19364     * Get the depth of expanded item
19365     *
19366     * @param it The genlist item object
19367     * @return The depth of expanded item
19368     *
19369     * @ingroup Genlist
19370     */
19371    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19372    /**
19373     * Set whether a given genlist item is disabled or not.
19374     *
19375     * @param it The item
19376     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19377     * to enable it back.
19378     *
19379     * A disabled item cannot be selected or unselected. It will also
19380     * change its appearance, to signal the user it's disabled.
19381     *
19382     * @see elm_genlist_item_disabled_get()
19383     *
19384     * @ingroup Genlist
19385     */
19386    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19387    /**
19388     * Get whether a given genlist item is disabled or not.
19389     *
19390     * @param it The item
19391     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19392     * (and on errors).
19393     *
19394     * @see elm_genlist_item_disabled_set() for more details
19395     *
19396     * @ingroup Genlist
19397     */
19398    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19399    /**
19400     * Sets the display only state of an item.
19401     *
19402     * @param it The item
19403     * @param display_only @c EINA_TRUE if the item is display only, @c
19404     * EINA_FALSE otherwise.
19405     *
19406     * A display only item cannot be selected or unselected. It is for
19407     * display only and not selecting or otherwise clicking, dragging
19408     * etc. by the user, thus finger size rules will not be applied to
19409     * this item.
19410     *
19411     * It's good to set group index items to display only state.
19412     *
19413     * @see elm_genlist_item_display_only_get()
19414     *
19415     * @ingroup Genlist
19416     */
19417    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19418    /**
19419     * Get the display only state of an item
19420     *
19421     * @param it The item
19422     * @return @c EINA_TRUE if the item is display only, @c
19423     * EINA_FALSE otherwise.
19424     *
19425     * @see elm_genlist_item_display_only_set()
19426     *
19427     * @ingroup Genlist
19428     */
19429    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19430    /**
19431     * Show the portion of a genlist's internal list containing a given
19432     * item, immediately.
19433     *
19434     * @param it The item to display
19435     *
19436     * This causes genlist to jump to the given item @p it and show it (by
19437     * immediately scrolling to that position), if it is not fully visible.
19438     *
19439     * @see elm_genlist_item_bring_in()
19440     * @see elm_genlist_item_top_show()
19441     * @see elm_genlist_item_middle_show()
19442     *
19443     * @ingroup Genlist
19444     */
19445    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19446    /**
19447     * Animatedly bring in, to the visible are of a genlist, a given
19448     * item on it.
19449     *
19450     * @param it The item to display
19451     *
19452     * This causes genlist to jump to the given item @p it and show it (by
19453     * animatedly scrolling), if it is not fully visible. This may use animation
19454     * to do so and take a period of time
19455     *
19456     * @see elm_genlist_item_show()
19457     * @see elm_genlist_item_top_bring_in()
19458     * @see elm_genlist_item_middle_bring_in()
19459     *
19460     * @ingroup Genlist
19461     */
19462    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19463    /**
19464     * Show the portion of a genlist's internal list containing a given
19465     * item, immediately.
19466     *
19467     * @param it The item to display
19468     *
19469     * This causes genlist to jump to the given item @p it and show it (by
19470     * immediately scrolling to that position), if it is not fully visible.
19471     *
19472     * The item will be positioned at the top of the genlist viewport.
19473     *
19474     * @see elm_genlist_item_show()
19475     * @see elm_genlist_item_top_bring_in()
19476     *
19477     * @ingroup Genlist
19478     */
19479    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19480    /**
19481     * Animatedly bring in, to the visible are of a genlist, a given
19482     * item on it.
19483     *
19484     * @param it The item
19485     *
19486     * This causes genlist to jump to the given item @p it and show it (by
19487     * animatedly scrolling), if it is not fully visible. This may use animation
19488     * to do so and take a period of time
19489     *
19490     * The item will be positioned at the top of the genlist viewport.
19491     *
19492     * @see elm_genlist_item_bring_in()
19493     * @see elm_genlist_item_top_show()
19494     *
19495     * @ingroup Genlist
19496     */
19497    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19498    /**
19499     * Show the portion of a genlist's internal list containing a given
19500     * item, immediately.
19501     *
19502     * @param it The item to display
19503     *
19504     * This causes genlist to jump to the given item @p it and show it (by
19505     * immediately scrolling to that position), if it is not fully visible.
19506     *
19507     * The item will be positioned at the middle of the genlist viewport.
19508     *
19509     * @see elm_genlist_item_show()
19510     * @see elm_genlist_item_middle_bring_in()
19511     *
19512     * @ingroup Genlist
19513     */
19514    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19515    /**
19516     * Animatedly bring in, to the visible are of a genlist, a given
19517     * item on it.
19518     *
19519     * @param it The item
19520     *
19521     * This causes genlist to jump to the given item @p it and show it (by
19522     * animatedly scrolling), if it is not fully visible. This may use animation
19523     * to do so and take a period of time
19524     *
19525     * The item will be positioned at the middle of the genlist viewport.
19526     *
19527     * @see elm_genlist_item_bring_in()
19528     * @see elm_genlist_item_middle_show()
19529     *
19530     * @ingroup Genlist
19531     */
19532    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19533    /**
19534     * Remove a genlist item from the its parent, deleting it.
19535     *
19536     * @param item The item to be removed.
19537     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19538     *
19539     * @see elm_genlist_clear(), to remove all items in a genlist at
19540     * once.
19541     *
19542     * @ingroup Genlist
19543     */
19544    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19545    /**
19546     * Return the data associated to a given genlist item
19547     *
19548     * @param item The genlist item.
19549     * @return the data associated to this item.
19550     *
19551     * This returns the @c data value passed on the
19552     * elm_genlist_item_append() and related item addition calls.
19553     *
19554     * @see elm_genlist_item_append()
19555     * @see elm_genlist_item_data_set()
19556     *
19557     * @ingroup Genlist
19558     */
19559    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19560    /**
19561     * Set the data associated to a given genlist item
19562     *
19563     * @param item The genlist item
19564     * @param data The new data pointer to set on it
19565     *
19566     * This @b overrides the @c data value passed on the
19567     * elm_genlist_item_append() and related item addition calls. This
19568     * function @b won't call elm_genlist_item_update() automatically,
19569     * so you'd issue it afterwards if you want to hove the item
19570     * updated to reflect the that new data.
19571     *
19572     * @see elm_genlist_item_data_get()
19573     *
19574     * @ingroup Genlist
19575     */
19576    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19577    /**
19578     * Tells genlist to "orphan" contents fetchs by the item class
19579     *
19580     * @param it The item
19581     *
19582     * This instructs genlist to release references to contents in the item,
19583     * meaning that they will no longer be managed by genlist and are
19584     * floating "orphans" that can be re-used elsewhere if the user wants
19585     * to.
19586     *
19587     * @ingroup Genlist
19588     */
19589    EAPI void               elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19590    EINA_DEPRECATED EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19591    /**
19592     * Get the real Evas object created to implement the view of a
19593     * given genlist item
19594     *
19595     * @param item The genlist item.
19596     * @return the Evas object implementing this item's view.
19597     *
19598     * This returns the actual Evas object used to implement the
19599     * specified genlist item's view. This may be @c NULL, as it may
19600     * not have been created or may have been deleted, at any time, by
19601     * the genlist. <b>Do not modify this object</b> (move, resize,
19602     * show, hide, etc.), as the genlist is controlling it. This
19603     * function is for querying, emitting custom signals or hooking
19604     * lower level callbacks for events on that object. Do not delete
19605     * this object under any circumstances.
19606     *
19607     * @see elm_genlist_item_data_get()
19608     *
19609     * @ingroup Genlist
19610     */
19611    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19612    /**
19613     * Update the contents of an item
19614     *
19615     * @param it The item
19616     *
19617     * This updates an item by calling all the item class functions again
19618     * to get the contents, texts and states. Use this when the original
19619     * item data has changed and the changes are desired to be reflected.
19620     *
19621     * Use elm_genlist_realized_items_update() to update all already realized
19622     * items.
19623     *
19624     * @see elm_genlist_realized_items_update()
19625     *
19626     * @ingroup Genlist
19627     */
19628    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19629    /**
19630     * Promote an item to the top of the list
19631     *
19632     * @param it The item
19633     *
19634     * @ingroup Genlist
19635     */
19636    EAPI void               elm_genlist_item_promote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
19637    /**
19638     * Demote an item to the end of the list
19639     *
19640     * @param it The item
19641     *
19642     * @ingroup Genlist
19643     */
19644    EAPI void               elm_genlist_item_demote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
19645    /**
19646     * Update the part of an item
19647     *
19648     * @param it The item
19649     * @param parts The name of item's part
19650     * @param itf The flags of item's part type
19651     *
19652     * This updates an item's part by calling item's fetching functions again
19653     * to get the contents, texts and states. Use this when the original
19654     * item data has changed and the changes are desired to be reflected.
19655     * Second parts argument is used for globbing to match '*', '?', and '.'
19656     * It can be used at updating multi fields.
19657     *
19658     * Use elm_genlist_realized_items_update() to update an item's all
19659     * property.
19660     *
19661     * @see elm_genlist_item_update()
19662     *
19663     * @ingroup Genlist
19664     */
19665    EAPI void               elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19666    /**
19667     * Update the item class of an item
19668     *
19669     * @param it The item
19670     * @param itc The item class for the item
19671     *
19672     * This sets another class fo the item, changing the way that it is
19673     * displayed. After changing the item class, elm_genlist_item_update() is
19674     * called on the item @p it.
19675     *
19676     * @ingroup Genlist
19677     */
19678    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19679    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19680    /**
19681     * Set the text to be shown in a given genlist item's tooltips.
19682     *
19683     * @param item The genlist item
19684     * @param text The text to set in the content
19685     *
19686     * This call will setup the text to be used as tooltip to that item
19687     * (analogous to elm_object_tooltip_text_set(), but being item
19688     * tooltips with higher precedence than object tooltips). It can
19689     * have only one tooltip at a time, so any previous tooltip data
19690     * will get removed.
19691     *
19692     * In order to set a content or something else as a tooltip, look at
19693     * elm_genlist_item_tooltip_content_cb_set().
19694     *
19695     * @ingroup Genlist
19696     */
19697    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19698    /**
19699     * Set the content to be shown in a given genlist item's tooltips
19700     *
19701     * @param item The genlist item.
19702     * @param func The function returning the tooltip contents.
19703     * @param data What to provide to @a func as callback data/context.
19704     * @param del_cb Called when data is not needed anymore, either when
19705     *        another callback replaces @p func, the tooltip is unset with
19706     *        elm_genlist_item_tooltip_unset() or the owner @p item
19707     *        dies. This callback receives as its first parameter the
19708     *        given @p data, being @c event_info the item handle.
19709     *
19710     * This call will setup the tooltip's contents to @p item
19711     * (analogous to elm_object_tooltip_content_cb_set(), but being
19712     * item tooltips with higher precedence than object tooltips). It
19713     * can have only one tooltip at a time, so any previous tooltip
19714     * content will get removed. @p func (with @p data) will be called
19715     * every time Elementary needs to show the tooltip and it should
19716     * return a valid Evas object, which will be fully managed by the
19717     * tooltip system, getting deleted when the tooltip is gone.
19718     *
19719     * In order to set just a text as a tooltip, look at
19720     * elm_genlist_item_tooltip_text_set().
19721     *
19722     * @ingroup Genlist
19723     */
19724    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);
19725    /**
19726     * Unset a tooltip from a given genlist item
19727     *
19728     * @param item genlist item to remove a previously set tooltip from.
19729     *
19730     * This call removes any tooltip set on @p item. The callback
19731     * provided as @c del_cb to
19732     * elm_genlist_item_tooltip_content_cb_set() will be called to
19733     * notify it is not used anymore (and have resources cleaned, if
19734     * need be).
19735     *
19736     * @see elm_genlist_item_tooltip_content_cb_set()
19737     *
19738     * @ingroup Genlist
19739     */
19740    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19741    /**
19742     * Set a different @b style for a given genlist item's tooltip.
19743     *
19744     * @param item genlist item with tooltip set
19745     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19746     * "default", @c "transparent", etc)
19747     *
19748     * Tooltips can have <b>alternate styles</b> to be displayed on,
19749     * which are defined by the theme set on Elementary. This function
19750     * works analogously as elm_object_tooltip_style_set(), but here
19751     * applied only to genlist item objects. The default style for
19752     * tooltips is @c "default".
19753     *
19754     * @note before you set a style you should define a tooltip with
19755     *       elm_genlist_item_tooltip_content_cb_set() or
19756     *       elm_genlist_item_tooltip_text_set()
19757     *
19758     * @see elm_genlist_item_tooltip_style_get()
19759     *
19760     * @ingroup Genlist
19761     */
19762    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19763    /**
19764     * Get the style set a given genlist item's tooltip.
19765     *
19766     * @param item genlist item with tooltip already set on.
19767     * @return style the theme style in use, which defaults to
19768     *         "default". If the object does not have a tooltip set,
19769     *         then @c NULL is returned.
19770     *
19771     * @see elm_genlist_item_tooltip_style_set() for more details
19772     *
19773     * @ingroup Genlist
19774     */
19775    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19776    /**
19777     * @brief Disable size restrictions on an object's tooltip
19778     * @param item The tooltip's anchor object
19779     * @param disable If EINA_TRUE, size restrictions are disabled
19780     * @return EINA_FALSE on failure, EINA_TRUE on success
19781     *
19782     * This function allows a tooltip to expand beyond its parant window's canvas.
19783     * It will instead be limited only by the size of the display.
19784     */
19785    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19786    /**
19787     * @brief Retrieve size restriction state of an object's tooltip
19788     * @param item The tooltip's anchor object
19789     * @return If EINA_TRUE, size restrictions are disabled
19790     *
19791     * This function returns whether a tooltip is allowed to expand beyond
19792     * its parant window's canvas.
19793     * It will instead be limited only by the size of the display.
19794     */
19795    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19796    /**
19797     * Set the type of mouse pointer/cursor decoration to be shown,
19798     * when the mouse pointer is over the given genlist widget item
19799     *
19800     * @param item genlist item to customize cursor on
19801     * @param cursor the cursor type's name
19802     *
19803     * This function works analogously as elm_object_cursor_set(), but
19804     * here the cursor's changing area is restricted to the item's
19805     * area, and not the whole widget's. Note that that item cursors
19806     * have precedence over widget cursors, so that a mouse over @p
19807     * item will always show cursor @p type.
19808     *
19809     * If this function is called twice for an object, a previously set
19810     * cursor will be unset on the second call.
19811     *
19812     * @see elm_object_cursor_set()
19813     * @see elm_genlist_item_cursor_get()
19814     * @see elm_genlist_item_cursor_unset()
19815     *
19816     * @ingroup Genlist
19817     */
19818    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19819    /**
19820     * Get the type of mouse pointer/cursor decoration set to be shown,
19821     * when the mouse pointer is over the given genlist widget item
19822     *
19823     * @param item genlist item with custom cursor set
19824     * @return the cursor type's name or @c NULL, if no custom cursors
19825     * were set to @p item (and on errors)
19826     *
19827     * @see elm_object_cursor_get()
19828     * @see elm_genlist_item_cursor_set() for more details
19829     * @see elm_genlist_item_cursor_unset()
19830     *
19831     * @ingroup Genlist
19832     */
19833    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19834    /**
19835     * Unset any custom mouse pointer/cursor decoration set to be
19836     * shown, when the mouse pointer is over the given genlist widget
19837     * item, thus making it show the @b default cursor again.
19838     *
19839     * @param item a genlist item
19840     *
19841     * Use this call to undo any custom settings on this item's cursor
19842     * decoration, bringing it back to defaults (no custom style set).
19843     *
19844     * @see elm_object_cursor_unset()
19845     * @see elm_genlist_item_cursor_set() for more details
19846     *
19847     * @ingroup Genlist
19848     */
19849    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19850    /**
19851     * Set a different @b style for a given custom cursor set for a
19852     * genlist item.
19853     *
19854     * @param item genlist item with custom cursor set
19855     * @param style the <b>theme style</b> to use (e.g. @c "default",
19856     * @c "transparent", etc)
19857     *
19858     * This function only makes sense when one is using custom mouse
19859     * cursor decorations <b>defined in a theme file</b> , which can
19860     * have, given a cursor name/type, <b>alternate styles</b> on
19861     * it. It works analogously as elm_object_cursor_style_set(), but
19862     * here applied only to genlist item objects.
19863     *
19864     * @warning Before you set a cursor style you should have defined a
19865     *       custom cursor previously on the item, with
19866     *       elm_genlist_item_cursor_set()
19867     *
19868     * @see elm_genlist_item_cursor_engine_only_set()
19869     * @see elm_genlist_item_cursor_style_get()
19870     *
19871     * @ingroup Genlist
19872     */
19873    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19874    /**
19875     * Get the current @b style set for a given genlist item's custom
19876     * cursor
19877     *
19878     * @param item genlist item with custom cursor set.
19879     * @return style the cursor style in use. If the object does not
19880     *         have a cursor set, then @c NULL is returned.
19881     *
19882     * @see elm_genlist_item_cursor_style_set() for more details
19883     *
19884     * @ingroup Genlist
19885     */
19886    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19887    /**
19888     * Set if the (custom) cursor for a given genlist item should be
19889     * searched in its theme, also, or should only rely on the
19890     * rendering engine.
19891     *
19892     * @param item item with custom (custom) cursor already set on
19893     * @param engine_only Use @c EINA_TRUE to have cursors looked for
19894     * only on those provided by the rendering engine, @c EINA_FALSE to
19895     * have them searched on the widget's theme, as well.
19896     *
19897     * @note This call is of use only if you've set a custom cursor
19898     * for genlist items, with elm_genlist_item_cursor_set().
19899     *
19900     * @note By default, cursors will only be looked for between those
19901     * provided by the rendering engine.
19902     *
19903     * @ingroup Genlist
19904     */
19905    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19906    /**
19907     * Get if the (custom) cursor for a given genlist item is being
19908     * searched in its theme, also, or is only relying on the rendering
19909     * engine.
19910     *
19911     * @param item a genlist item
19912     * @return @c EINA_TRUE, if cursors are being looked for only on
19913     * those provided by the rendering engine, @c EINA_FALSE if they
19914     * are being searched on the widget's theme, as well.
19915     *
19916     * @see elm_genlist_item_cursor_engine_only_set(), for more details
19917     *
19918     * @ingroup Genlist
19919     */
19920    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19921    /**
19922     * Update the contents of all realized items.
19923     *
19924     * @param obj The genlist object.
19925     *
19926     * This updates all realized items by calling all the item class functions again
19927     * to get the contents, texts and states. Use this when the original
19928     * item data has changed and the changes are desired to be reflected.
19929     *
19930     * To update just one item, use elm_genlist_item_update().
19931     *
19932     * @see elm_genlist_realized_items_get()
19933     * @see elm_genlist_item_update()
19934     *
19935     * @ingroup Genlist
19936     */
19937    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19938    /**
19939     * Activate a genlist mode on an item
19940     *
19941     * @param item The genlist item
19942     * @param mode Mode name
19943     * @param mode_set Boolean to define set or unset mode.
19944     *
19945     * A genlist mode is a different way of selecting an item. Once a mode is
19946     * activated on an item, any other selected item is immediately unselected.
19947     * This feature provides an easy way of implementing a new kind of animation
19948     * for selecting an item, without having to entirely rewrite the item style
19949     * theme. However, the elm_genlist_selected_* API can't be used to get what
19950     * item is activate for a mode.
19951     *
19952     * The current item style will still be used, but applying a genlist mode to
19953     * an item will select it using a different kind of animation.
19954     *
19955     * The current active item for a mode can be found by
19956     * elm_genlist_mode_item_get().
19957     *
19958     * The characteristics of genlist mode are:
19959     * - Only one mode can be active at any time, and for only one item.
19960     * - Genlist handles deactivating other items when one item is activated.
19961     * - A mode is defined in the genlist theme (edc), and more modes can easily
19962     *   be added.
19963     * - A mode style and the genlist item style are different things. They
19964     *   can be combined to provide a default style to the item, with some kind
19965     *   of animation for that item when the mode is activated.
19966     *
19967     * When a mode is activated on an item, a new view for that item is created.
19968     * The theme of this mode defines the animation that will be used to transit
19969     * the item from the old view to the new view. This second (new) view will be
19970     * active for that item while the mode is active on the item, and will be
19971     * destroyed after the mode is totally deactivated from that item.
19972     *
19973     * @see elm_genlist_mode_get()
19974     * @see elm_genlist_mode_item_get()
19975     *
19976     * @ingroup Genlist
19977     */
19978    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19979    /**
19980     * Get the last (or current) genlist mode used.
19981     *
19982     * @param obj The genlist object
19983     *
19984     * This function just returns the name of the last used genlist mode. It will
19985     * be the current mode if it's still active.
19986     *
19987     * @see elm_genlist_item_mode_set()
19988     * @see elm_genlist_mode_item_get()
19989     *
19990     * @ingroup Genlist
19991     */
19992    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19993    /**
19994     * Get active genlist mode item
19995     *
19996     * @param obj The genlist object
19997     * @return The active item for that current mode. Or @c NULL if no item is
19998     * activated with any mode.
19999     *
20000     * This function returns the item that was activated with a mode, by the
20001     * function elm_genlist_item_mode_set().
20002     *
20003     * @see elm_genlist_item_mode_set()
20004     * @see elm_genlist_mode_get()
20005     *
20006     * @ingroup Genlist
20007     */
20008    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20009
20010    /**
20011     * Set reorder mode
20012     *
20013     * @param obj The genlist object
20014     * @param reorder_mode The reorder mode
20015     * (EINA_TRUE = on, EINA_FALSE = off)
20016     *
20017     * @ingroup Genlist
20018     */
20019    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
20020
20021    /**
20022     * Get the reorder mode
20023     *
20024     * @param obj The genlist object
20025     * @return The reorder mode
20026     * (EINA_TRUE = on, EINA_FALSE = off)
20027     *
20028     * @ingroup Genlist
20029     */
20030    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20031
20032    /**
20033     * @}
20034     */
20035
20036    /**
20037     * @defgroup Check Check
20038     *
20039     * @image html img/widget/check/preview-00.png
20040     * @image latex img/widget/check/preview-00.eps
20041     * @image html img/widget/check/preview-01.png
20042     * @image latex img/widget/check/preview-01.eps
20043     * @image html img/widget/check/preview-02.png
20044     * @image latex img/widget/check/preview-02.eps
20045     *
20046     * @brief The check widget allows for toggling a value between true and
20047     * false.
20048     *
20049     * Check objects are a lot like radio objects in layout and functionality
20050     * except they do not work as a group, but independently and only toggle the
20051     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
20052     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
20053     * returns the current state. For convenience, like the radio objects, you
20054     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
20055     * for it to modify.
20056     *
20057     * Signals that you can add callbacks for are:
20058     * "changed" - This is called whenever the user changes the state of one of
20059     *             the check object(event_info is NULL).
20060     *
20061     * Default contents parts of the check widget that you can use for are:
20062     * @li "icon" - An icon of the check
20063     *
20064     * Default text parts of the check widget that you can use for are:
20065     * @li "elm.text" - Label of the check
20066     *
20067     * @ref tutorial_check should give you a firm grasp of how to use this widget
20068     * .
20069     * @{
20070     */
20071    /**
20072     * @brief Add a new Check object
20073     *
20074     * @param parent The parent object
20075     * @return The new object or NULL if it cannot be created
20076     */
20077    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20078    /**
20079     * @brief Set the text label of the check object
20080     *
20081     * @param obj The check object
20082     * @param label The text label string in UTF-8
20083     *
20084     * @deprecated use elm_object_text_set() instead.
20085     */
20086    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20087    /**
20088     * @brief Get the text label of the check object
20089     *
20090     * @param obj The check object
20091     * @return The text label string in UTF-8
20092     *
20093     * @deprecated use elm_object_text_get() instead.
20094     */
20095    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20096    /**
20097     * @brief Set the icon object of the check object
20098     *
20099     * @param obj The check object
20100     * @param icon The icon object
20101     *
20102     * Once the icon object is set, a previously set one will be deleted.
20103     * If you want to keep that old content object, use the
20104     * elm_object_content_unset() function.
20105     *
20106     * @deprecated use elm_object_part_content_set() instead.
20107     *
20108     */
20109    EINA_DEPRECATED EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20110    /**
20111     * @brief Get the icon object of the check object
20112     *
20113     * @param obj The check object
20114     * @return The icon object
20115     *
20116     * @deprecated use elm_object_part_content_get() instead.
20117     *
20118     */
20119    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20120    /**
20121     * @brief Unset the icon used for the check object
20122     *
20123     * @param obj The check object
20124     * @return The icon object that was being used
20125     *
20126     * Unparent and return the icon object which was set for this widget.
20127     *
20128     * @deprecated use elm_object_part_content_unset() instead.
20129     *
20130     */
20131    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20132    /**
20133     * @brief Set the on/off state of the check object
20134     *
20135     * @param obj The check object
20136     * @param state The state to use (1 == on, 0 == off)
20137     *
20138     * This sets the state of the check. If set
20139     * with elm_check_state_pointer_set() the state of that variable is also
20140     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
20141     */
20142    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20143    /**
20144     * @brief Get the state of the check object
20145     *
20146     * @param obj The check object
20147     * @return The boolean state
20148     */
20149    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20150    /**
20151     * @brief Set a convenience pointer to a boolean to change
20152     *
20153     * @param obj The check object
20154     * @param statep Pointer to the boolean to modify
20155     *
20156     * This sets a pointer to a boolean, that, in addition to the check objects
20157     * state will also be modified directly. To stop setting the object pointed
20158     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
20159     * then when this is called, the check objects state will also be modified to
20160     * reflect the value of the boolean @p statep points to, just like calling
20161     * elm_check_state_set().
20162     */
20163    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
20164    EINA_DEPRECATED EAPI void         elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
20165    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);
20166
20167    /**
20168     * @}
20169     */
20170
20171    /**
20172     * @defgroup Radio Radio
20173     *
20174     * @image html img/widget/radio/preview-00.png
20175     * @image latex img/widget/radio/preview-00.eps
20176     *
20177     * @brief Radio is a widget that allows for 1 or more options to be displayed
20178     * and have the user choose only 1 of them.
20179     *
20180     * A radio object contains an indicator, an optional Label and an optional
20181     * icon object. While it's possible to have a group of only one radio they,
20182     * are normally used in groups of 2 or more. To add a radio to a group use
20183     * elm_radio_group_add(). The radio object(s) will select from one of a set
20184     * of integer values, so any value they are configuring needs to be mapped to
20185     * a set of integers. To configure what value that radio object represents,
20186     * use  elm_radio_state_value_set() to set the integer it represents. To set
20187     * the value the whole group(which one is currently selected) is to indicate
20188     * use elm_radio_value_set() on any group member, and to get the groups value
20189     * use elm_radio_value_get(). For convenience the radio objects are also able
20190     * to directly set an integer(int) to the value that is selected. To specify
20191     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20192     * The radio objects will modify this directly. That implies the pointer must
20193     * point to valid memory for as long as the radio objects exist.
20194     *
20195     * Signals that you can add callbacks for are:
20196     * @li changed - This is called whenever the user changes the state of one of
20197     * the radio objects within the group of radio objects that work together.
20198     *
20199     * Default contents parts of the radio widget that you can use for are:
20200     * @li "icon" - An icon of the radio
20201     *
20202     * @ref tutorial_radio show most of this API in action.
20203     * @{
20204     */
20205    /**
20206     * @brief Add a new radio to the parent
20207     *
20208     * @param parent The parent object
20209     * @return The new object or NULL if it cannot be created
20210     */
20211    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20212    /**
20213     * @brief Set the text label of the radio object
20214     *
20215     * @param obj The radio object
20216     * @param label The text label string in UTF-8
20217     *
20218     * @deprecated use elm_object_text_set() instead.
20219     */
20220    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20221    /**
20222     * @brief Get the text label of the radio object
20223     *
20224     * @param obj The radio object
20225     * @return The text label string in UTF-8
20226     *
20227     * @deprecated use elm_object_text_set() instead.
20228     */
20229    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20230    /**
20231     * @brief Set the icon object of the radio object
20232     *
20233     * @param obj The radio object
20234     * @param icon The icon object
20235     *
20236     * Once the icon object is set, a previously set one will be deleted. If you
20237     * want to keep that old content object, use the elm_radio_icon_unset()
20238     * function.
20239     *
20240     * @deprecated use elm_object_part_content_set() instead.
20241     *
20242     */
20243    EINA_DEPRECATED EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20244    /**
20245     * @brief Get the icon object of the radio object
20246     *
20247     * @param obj The radio object
20248     * @return The icon object
20249     *
20250     * @see elm_radio_icon_set()
20251     *
20252     * @deprecated use elm_object_part_content_get() instead.
20253     *
20254     */
20255    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20256    /**
20257     * @brief Unset the icon used for the radio object
20258     *
20259     * @param obj The radio object
20260     * @return The icon object that was being used
20261     *
20262     * Unparent and return the icon object which was set for this widget.
20263     *
20264     * @see elm_radio_icon_set()
20265     * @deprecated use elm_object_part_content_unset() instead.
20266     *
20267     */
20268    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20269    /**
20270     * @brief Add this radio to a group of other radio objects
20271     *
20272     * @param obj The radio object
20273     * @param group Any object whose group the @p obj is to join.
20274     *
20275     * Radio objects work in groups. Each member should have a different integer
20276     * value assigned. In order to have them work as a group, they need to know
20277     * about each other. This adds the given radio object to the group of which
20278     * the group object indicated is a member.
20279     */
20280    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20281    /**
20282     * @brief Set the integer value that this radio object represents
20283     *
20284     * @param obj The radio object
20285     * @param value The value to use if this radio object is selected
20286     *
20287     * This sets the value of the radio.
20288     */
20289    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20290    /**
20291     * @brief Get the integer value that this radio object represents
20292     *
20293     * @param obj The radio object
20294     * @return The value used if this radio object is selected
20295     *
20296     * This gets the value of the radio.
20297     *
20298     * @see elm_radio_value_set()
20299     */
20300    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20301    /**
20302     * @brief Set the value of the radio.
20303     *
20304     * @param obj The radio object
20305     * @param value The value to use for the group
20306     *
20307     * This sets the value of the radio group and will also set the value if
20308     * pointed to, to the value supplied, but will not call any callbacks.
20309     */
20310    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20311    /**
20312     * @brief Get the state of the radio object
20313     *
20314     * @param obj The radio object
20315     * @return The integer state
20316     */
20317    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20318    /**
20319     * @brief Set a convenience pointer to a integer to change
20320     *
20321     * @param obj The radio object
20322     * @param valuep Pointer to the integer to modify
20323     *
20324     * This sets a pointer to a integer, that, in addition to the radio objects
20325     * state will also be modified directly. To stop setting the object pointed
20326     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20327     * when this is called, the radio objects state will also be modified to
20328     * reflect the value of the integer valuep points to, just like calling
20329     * elm_radio_value_set().
20330     */
20331    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20332    /**
20333     * @}
20334     */
20335
20336    /**
20337     * @defgroup Pager Pager
20338     *
20339     * @image html img/widget/pager/preview-00.png
20340     * @image latex img/widget/pager/preview-00.eps
20341     *
20342     * @brief Widget that allows flipping between one or more ā€œpagesā€
20343     * of objects.
20344     *
20345     * The flipping between pages of objects is animated. All content
20346     * in the pager is kept in a stack, being the last content added
20347     * (visible one) on the top of that stack.
20348     *
20349     * Objects can be pushed or popped from the stack or deleted as
20350     * well. Pushes and pops will animate the widget accordingly to its
20351     * style (a pop will also delete the child object once the
20352     * animation is finished). Any object already in the pager can be
20353     * promoted to the top (from its current stacking position) through
20354     * the use of elm_pager_content_promote(). New objects are pushed
20355     * to the top with elm_pager_content_push(). When the top item is
20356     * no longer wanted, simply pop it with elm_pager_content_pop() and
20357     * it will also be deleted. If an object is no longer needed and is
20358     * not the top item, just delete it as normal. You can query which
20359     * objects are the top and bottom with
20360     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20361     *
20362     * Signals that you can add callbacks for are:
20363     * - @c "show,finished" - when a new page is actually shown on the top
20364     * - @c "hide,finished" - when a previous page is hidden
20365     *
20366     * Only after the first of that signals the child object is
20367     * guaranteed to be visible, as in @c evas_object_visible_get().
20368     *
20369     * This widget has the following styles available:
20370     * - @c "default"
20371     * - @c "fade"
20372     * - @c "fade_translucide"
20373     * - @c "fade_invisible"
20374     *
20375     * @note These styles affect only the flipping animations on the
20376     * default theme; the appearance when not animating is unaffected
20377     * by them.
20378     *
20379     * @ref tutorial_pager gives a good overview of the usage of the API.
20380     * @{
20381     */
20382
20383    /**
20384     * Add a new pager to the parent
20385     *
20386     * @param parent The parent object
20387     * @return The new object or NULL if it cannot be created
20388     *
20389     * @ingroup Pager
20390     */
20391    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20392
20393    /**
20394     * @brief Push an object to the top of the pager stack (and show it).
20395     *
20396     * @param obj The pager object
20397     * @param content The object to push
20398     *
20399     * The object pushed becomes a child of the pager, it will be controlled and
20400     * deleted when the pager is deleted.
20401     *
20402     * @note If the content is already in the stack use
20403     * elm_pager_content_promote().
20404     * @warning Using this function on @p content already in the stack results in
20405     * undefined behavior.
20406     */
20407    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20408
20409    /**
20410     * @brief Pop the object that is on top of the stack
20411     *
20412     * @param obj The pager object
20413     *
20414     * This pops the object that is on the top(visible) of the pager, makes it
20415     * disappear, then deletes the object. The object that was underneath it on
20416     * the stack will become visible.
20417     */
20418    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20419
20420    /**
20421     * @brief Moves an object already in the pager stack to the top of the stack.
20422     *
20423     * @param obj The pager object
20424     * @param content The object to promote
20425     *
20426     * This will take the @p content and move it to the top of the stack as
20427     * if it had been pushed there.
20428     *
20429     * @note If the content isn't already in the stack use
20430     * elm_pager_content_push().
20431     * @warning Using this function on @p content not already in the stack
20432     * results in undefined behavior.
20433     */
20434    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20435
20436    /**
20437     * @brief Return the object at the bottom of the pager stack
20438     *
20439     * @param obj The pager object
20440     * @return The bottom object or NULL if none
20441     */
20442    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20443
20444    /**
20445     * @brief  Return the object at the top of the pager stack
20446     *
20447     * @param obj The pager object
20448     * @return The top object or NULL if none
20449     */
20450    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20451
20452    /**
20453     * @}
20454     */
20455
20456    /**
20457     * @defgroup Slideshow Slideshow
20458     *
20459     * @image html img/widget/slideshow/preview-00.png
20460     * @image latex img/widget/slideshow/preview-00.eps
20461     *
20462     * This widget, as the name indicates, is a pre-made image
20463     * slideshow panel, with API functions acting on (child) image
20464     * items presentation. Between those actions, are:
20465     * - advance to next/previous image
20466     * - select the style of image transition animation
20467     * - set the exhibition time for each image
20468     * - start/stop the slideshow
20469     *
20470     * The transition animations are defined in the widget's theme,
20471     * consequently new animations can be added without having to
20472     * update the widget's code.
20473     *
20474     * @section Slideshow_Items Slideshow items
20475     *
20476     * For slideshow items, just like for @ref Genlist "genlist" ones,
20477     * the user defines a @b classes, specifying functions that will be
20478     * called on the item's creation and deletion times.
20479     *
20480     * The #Elm_Slideshow_Item_Class structure contains the following
20481     * members:
20482     *
20483     * - @c func.get - When an item is displayed, this function is
20484     *   called, and it's where one should create the item object, de
20485     *   facto. For example, the object can be a pure Evas image object
20486     *   or an Elementary @ref Photocam "photocam" widget. See
20487     *   #SlideshowItemGetFunc.
20488     * - @c func.del - When an item is no more displayed, this function
20489     *   is called, where the user must delete any data associated to
20490     *   the item. See #SlideshowItemDelFunc.
20491     *
20492     * @section Slideshow_Caching Slideshow caching
20493     *
20494     * The slideshow provides facilities to have items adjacent to the
20495     * one being displayed <b>already "realized"</b> (i.e. loaded) for
20496     * you, so that the system does not have to decode image data
20497     * anymore at the time it has to actually switch images on its
20498     * viewport. The user is able to set the numbers of items to be
20499     * cached @b before and @b after the current item, in the widget's
20500     * item list.
20501     *
20502     * Smart events one can add callbacks for are:
20503     *
20504     * - @c "changed" - when the slideshow switches its view to a new
20505     *   item
20506     *
20507     * List of examples for the slideshow widget:
20508     * @li @ref slideshow_example
20509     */
20510
20511    /**
20512     * @addtogroup Slideshow
20513     * @{
20514     */
20515
20516    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20517    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20518    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
20519    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20520    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20521
20522    /**
20523     * @struct _Elm_Slideshow_Item_Class
20524     *
20525     * Slideshow item class definition. See @ref Slideshow_Items for
20526     * field details.
20527     */
20528    struct _Elm_Slideshow_Item_Class
20529      {
20530         struct _Elm_Slideshow_Item_Class_Func
20531           {
20532              SlideshowItemGetFunc get;
20533              SlideshowItemDelFunc del;
20534           } func;
20535      }; /**< #Elm_Slideshow_Item_Class member definitions */
20536
20537    /**
20538     * Add a new slideshow widget to the given parent Elementary
20539     * (container) object
20540     *
20541     * @param parent The parent object
20542     * @return A new slideshow widget handle or @c NULL, on errors
20543     *
20544     * This function inserts a new slideshow widget on the canvas.
20545     *
20546     * @ingroup Slideshow
20547     */
20548    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20549
20550    /**
20551     * Add (append) a new item in a given slideshow widget.
20552     *
20553     * @param obj The slideshow object
20554     * @param itc The item class for the item
20555     * @param data The item's data
20556     * @return A handle to the item added or @c NULL, on errors
20557     *
20558     * Add a new item to @p obj's internal list of items, appending it.
20559     * The item's class must contain the function really fetching the
20560     * image object to show for this item, which could be an Evas image
20561     * object or an Elementary photo, for example. The @p data
20562     * parameter is going to be passed to both class functions of the
20563     * item.
20564     *
20565     * @see #Elm_Slideshow_Item_Class
20566     * @see elm_slideshow_item_sorted_insert()
20567     *
20568     * @ingroup Slideshow
20569     */
20570    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20571
20572    /**
20573     * Insert a new item into the given slideshow widget, using the @p func
20574     * function to sort items (by item handles).
20575     *
20576     * @param obj The slideshow object
20577     * @param itc The item class for the item
20578     * @param data The item's data
20579     * @param func The comparing function to be used to sort slideshow
20580     * items <b>by #Elm_Slideshow_Item item handles</b>
20581     * @return Returns The slideshow item handle, on success, or
20582     * @c NULL, on errors
20583     *
20584     * Add a new item to @p obj's internal list of items, in a position
20585     * determined by the @p func comparing function. The item's class
20586     * must contain the function really fetching the image object to
20587     * show for this item, which could be an Evas image object or an
20588     * Elementary photo, for example. The @p data parameter is going to
20589     * be passed to both class functions of the item.
20590     *
20591     * @see #Elm_Slideshow_Item_Class
20592     * @see elm_slideshow_item_add()
20593     *
20594     * @ingroup Slideshow
20595     */
20596    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);
20597
20598    /**
20599     * Display a given slideshow widget's item, programmatically.
20600     *
20601     * @param obj The slideshow object
20602     * @param item The item to display on @p obj's viewport
20603     *
20604     * The change between the current item and @p item will use the
20605     * transition @p obj is set to use (@see
20606     * elm_slideshow_transition_set()).
20607     *
20608     * @ingroup Slideshow
20609     */
20610    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20611
20612    /**
20613     * Slide to the @b next item, in a given slideshow widget
20614     *
20615     * @param obj The slideshow object
20616     *
20617     * The sliding animation @p obj is set to use will be the
20618     * transition effect used, after this call is issued.
20619     *
20620     * @note If the end of the slideshow's internal list of items is
20621     * reached, it'll wrap around to the list's beginning, again.
20622     *
20623     * @ingroup Slideshow
20624     */
20625    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20626
20627    /**
20628     * Slide to the @b previous item, in a given slideshow widget
20629     *
20630     * @param obj The slideshow object
20631     *
20632     * The sliding animation @p obj is set to use will be the
20633     * transition effect used, after this call is issued.
20634     *
20635     * @note If the beginning of the slideshow's internal list of items
20636     * is reached, it'll wrap around to the list's end, again.
20637     *
20638     * @ingroup Slideshow
20639     */
20640    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20641
20642    /**
20643     * Returns the list of sliding transition/effect names available, for a
20644     * given slideshow widget.
20645     *
20646     * @param obj The slideshow object
20647     * @return The list of transitions (list of @b stringshared strings
20648     * as data)
20649     *
20650     * The transitions, which come from @p obj's theme, must be an EDC
20651     * data item named @c "transitions" on the theme file, with (prefix)
20652     * names of EDC programs actually implementing them.
20653     *
20654     * The available transitions for slideshows on the default theme are:
20655     * - @c "fade" - the current item fades out, while the new one
20656     *   fades in to the slideshow's viewport.
20657     * - @c "black_fade" - the current item fades to black, and just
20658     *   then, the new item will fade in.
20659     * - @c "horizontal" - the current item slides horizontally, until
20660     *   it gets out of the slideshow's viewport, while the new item
20661     *   comes from the left to take its place.
20662     * - @c "vertical" - the current item slides vertically, until it
20663     *   gets out of the slideshow's viewport, while the new item comes
20664     *   from the bottom to take its place.
20665     * - @c "square" - the new item starts to appear from the middle of
20666     *   the current one, but with a tiny size, growing until its
20667     *   target (full) size and covering the old one.
20668     *
20669     * @warning The stringshared strings get no new references
20670     * exclusive to the user grabbing the list, here, so if you'd like
20671     * to use them out of this call's context, you'd better @c
20672     * eina_stringshare_ref() them.
20673     *
20674     * @see elm_slideshow_transition_set()
20675     *
20676     * @ingroup Slideshow
20677     */
20678    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20679
20680    /**
20681     * Set the current slide transition/effect in use for a given
20682     * slideshow widget
20683     *
20684     * @param obj The slideshow object
20685     * @param transition The new transition's name string
20686     *
20687     * If @p transition is implemented in @p obj's theme (i.e., is
20688     * contained in the list returned by
20689     * elm_slideshow_transitions_get()), this new sliding effect will
20690     * be used on the widget.
20691     *
20692     * @see elm_slideshow_transitions_get() for more details
20693     *
20694     * @ingroup Slideshow
20695     */
20696    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20697
20698    /**
20699     * Get the current slide transition/effect in use for a given
20700     * slideshow widget
20701     *
20702     * @param obj The slideshow object
20703     * @return The current transition's name
20704     *
20705     * @see elm_slideshow_transition_set() for more details
20706     *
20707     * @ingroup Slideshow
20708     */
20709    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20710
20711    /**
20712     * Set the interval between each image transition on a given
20713     * slideshow widget, <b>and start the slideshow, itself</b>
20714     *
20715     * @param obj The slideshow object
20716     * @param timeout The new displaying timeout for images
20717     *
20718     * After this call, the slideshow widget will start cycling its
20719     * view, sequentially and automatically, with the images of the
20720     * items it has. The time between each new image displayed is going
20721     * to be @p timeout, in @b seconds. If a different timeout was set
20722     * previously and an slideshow was in progress, it will continue
20723     * with the new time between transitions, after this call.
20724     *
20725     * @note A value less than or equal to 0 on @p timeout will disable
20726     * the widget's internal timer, thus halting any slideshow which
20727     * could be happening on @p obj.
20728     *
20729     * @see elm_slideshow_timeout_get()
20730     *
20731     * @ingroup Slideshow
20732     */
20733    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20734
20735    /**
20736     * Get the interval set for image transitions on a given slideshow
20737     * widget.
20738     *
20739     * @param obj The slideshow object
20740     * @return Returns the timeout set on it
20741     *
20742     * @see elm_slideshow_timeout_set() for more details
20743     *
20744     * @ingroup Slideshow
20745     */
20746    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20747
20748    /**
20749     * Set if, after a slideshow is started, for a given slideshow
20750     * widget, its items should be displayed cyclically or not.
20751     *
20752     * @param obj The slideshow object
20753     * @param loop Use @c EINA_TRUE to make it cycle through items or
20754     * @c EINA_FALSE for it to stop at the end of @p obj's internal
20755     * list of items
20756     *
20757     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20758     * ignore what is set by this functions, i.e., they'll @b always
20759     * cycle through items. This affects only the "automatic"
20760     * slideshow, as set by elm_slideshow_timeout_set().
20761     *
20762     * @see elm_slideshow_loop_get()
20763     *
20764     * @ingroup Slideshow
20765     */
20766    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20767
20768    /**
20769     * Get if, after a slideshow is started, for a given slideshow
20770     * widget, its items are to be displayed cyclically or not.
20771     *
20772     * @param obj The slideshow object
20773     * @return @c EINA_TRUE, if the items in @p obj will be cycled
20774     * through or @c EINA_FALSE, otherwise
20775     *
20776     * @see elm_slideshow_loop_set() for more details
20777     *
20778     * @ingroup Slideshow
20779     */
20780    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20781
20782    /**
20783     * Remove all items from a given slideshow widget
20784     *
20785     * @param obj The slideshow object
20786     *
20787     * This removes (and deletes) all items in @p obj, leaving it
20788     * empty.
20789     *
20790     * @see elm_slideshow_item_del(), to remove just one item.
20791     *
20792     * @ingroup Slideshow
20793     */
20794    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20795
20796    /**
20797     * Get the internal list of items in a given slideshow widget.
20798     *
20799     * @param obj The slideshow object
20800     * @return The list of items (#Elm_Slideshow_Item as data) or
20801     * @c NULL on errors.
20802     *
20803     * This list is @b not to be modified in any way and must not be
20804     * freed. Use the list members with functions like
20805     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20806     *
20807     * @warning This list is only valid until @p obj object's internal
20808     * items list is changed. It should be fetched again with another
20809     * call to this function when changes happen.
20810     *
20811     * @ingroup Slideshow
20812     */
20813    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20814
20815    /**
20816     * Delete a given item from a slideshow widget.
20817     *
20818     * @param item The slideshow item
20819     *
20820     * @ingroup Slideshow
20821     */
20822    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20823
20824    /**
20825     * Return the data associated with a given slideshow item
20826     *
20827     * @param item The slideshow item
20828     * @return Returns the data associated to this item
20829     *
20830     * @ingroup Slideshow
20831     */
20832    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20833
20834    /**
20835     * Returns the currently displayed item, in a given slideshow widget
20836     *
20837     * @param obj The slideshow object
20838     * @return A handle to the item being displayed in @p obj or
20839     * @c NULL, if none is (and on errors)
20840     *
20841     * @ingroup Slideshow
20842     */
20843    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20844
20845    /**
20846     * Get the real Evas object created to implement the view of a
20847     * given slideshow item
20848     *
20849     * @param item The slideshow item.
20850     * @return the Evas object implementing this item's view.
20851     *
20852     * This returns the actual Evas object used to implement the
20853     * specified slideshow item's view. This may be @c NULL, as it may
20854     * not have been created or may have been deleted, at any time, by
20855     * the slideshow. <b>Do not modify this object</b> (move, resize,
20856     * show, hide, etc.), as the slideshow is controlling it. This
20857     * function is for querying, emitting custom signals or hooking
20858     * lower level callbacks for events on that object. Do not delete
20859     * this object under any circumstances.
20860     *
20861     * @see elm_slideshow_item_data_get()
20862     *
20863     * @ingroup Slideshow
20864     */
20865    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20866
20867    /**
20868     * Get the the item, in a given slideshow widget, placed at
20869     * position @p nth, in its internal items list
20870     *
20871     * @param obj The slideshow object
20872     * @param nth The number of the item to grab a handle to (0 being
20873     * the first)
20874     * @return The item stored in @p obj at position @p nth or @c NULL,
20875     * if there's no item with that index (and on errors)
20876     *
20877     * @ingroup Slideshow
20878     */
20879    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20880
20881    /**
20882     * Set the current slide layout in use for a given slideshow widget
20883     *
20884     * @param obj The slideshow object
20885     * @param layout The new layout's name string
20886     *
20887     * If @p layout is implemented in @p obj's theme (i.e., is contained
20888     * in the list returned by elm_slideshow_layouts_get()), this new
20889     * images layout will be used on the widget.
20890     *
20891     * @see elm_slideshow_layouts_get() for more details
20892     *
20893     * @ingroup Slideshow
20894     */
20895    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20896
20897    /**
20898     * Get the current slide layout in use for a given slideshow widget
20899     *
20900     * @param obj The slideshow object
20901     * @return The current layout's name
20902     *
20903     * @see elm_slideshow_layout_set() for more details
20904     *
20905     * @ingroup Slideshow
20906     */
20907    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20908
20909    /**
20910     * Returns the list of @b layout names available, for a given
20911     * slideshow widget.
20912     *
20913     * @param obj The slideshow object
20914     * @return The list of layouts (list of @b stringshared strings
20915     * as data)
20916     *
20917     * Slideshow layouts will change how the widget is to dispose each
20918     * image item in its viewport, with regard to cropping, scaling,
20919     * etc.
20920     *
20921     * The layouts, which come from @p obj's theme, must be an EDC
20922     * data item name @c "layouts" on the theme file, with (prefix)
20923     * names of EDC programs actually implementing them.
20924     *
20925     * The available layouts for slideshows on the default theme are:
20926     * - @c "fullscreen" - item images with original aspect, scaled to
20927     *   touch top and down slideshow borders or, if the image's heigh
20928     *   is not enough, left and right slideshow borders.
20929     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20930     *   one, but always leaving 10% of the slideshow's dimensions of
20931     *   distance between the item image's borders and the slideshow
20932     *   borders, for each axis.
20933     *
20934     * @warning The stringshared strings get no new references
20935     * exclusive to the user grabbing the list, here, so if you'd like
20936     * to use them out of this call's context, you'd better @c
20937     * eina_stringshare_ref() them.
20938     *
20939     * @see elm_slideshow_layout_set()
20940     *
20941     * @ingroup Slideshow
20942     */
20943    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20944
20945    /**
20946     * Set the number of items to cache, on a given slideshow widget,
20947     * <b>before the current item</b>
20948     *
20949     * @param obj The slideshow object
20950     * @param count Number of items to cache before the current one
20951     *
20952     * The default value for this property is @c 2. See
20953     * @ref Slideshow_Caching "slideshow caching" for more details.
20954     *
20955     * @see elm_slideshow_cache_before_get()
20956     *
20957     * @ingroup Slideshow
20958     */
20959    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20960
20961    /**
20962     * Retrieve the number of items to cache, on a given slideshow widget,
20963     * <b>before the current item</b>
20964     *
20965     * @param obj The slideshow object
20966     * @return The number of items set to be cached before the current one
20967     *
20968     * @see elm_slideshow_cache_before_set() for more details
20969     *
20970     * @ingroup Slideshow
20971     */
20972    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20973
20974    /**
20975     * Set the number of items to cache, on a given slideshow widget,
20976     * <b>after the current item</b>
20977     *
20978     * @param obj The slideshow object
20979     * @param count Number of items to cache after the current one
20980     *
20981     * The default value for this property is @c 2. See
20982     * @ref Slideshow_Caching "slideshow caching" for more details.
20983     *
20984     * @see elm_slideshow_cache_after_get()
20985     *
20986     * @ingroup Slideshow
20987     */
20988    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20989
20990    /**
20991     * Retrieve the number of items to cache, on a given slideshow widget,
20992     * <b>after the current item</b>
20993     *
20994     * @param obj The slideshow object
20995     * @return The number of items set to be cached after the current one
20996     *
20997     * @see elm_slideshow_cache_after_set() for more details
20998     *
20999     * @ingroup Slideshow
21000     */
21001    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21002
21003    /**
21004     * Get the number of items stored in a given slideshow widget
21005     *
21006     * @param obj The slideshow object
21007     * @return The number of items on @p obj, at the moment of this call
21008     *
21009     * @ingroup Slideshow
21010     */
21011    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21012
21013    /**
21014     * @}
21015     */
21016
21017    /**
21018     * @defgroup Fileselector File Selector
21019     *
21020     * @image html img/widget/fileselector/preview-00.png
21021     * @image latex img/widget/fileselector/preview-00.eps
21022     *
21023     * A file selector is a widget that allows a user to navigate
21024     * through a file system, reporting file selections back via its
21025     * API.
21026     *
21027     * It contains shortcut buttons for home directory (@c ~) and to
21028     * jump one directory upwards (..), as well as cancel/ok buttons to
21029     * confirm/cancel a given selection. After either one of those two
21030     * former actions, the file selector will issue its @c "done" smart
21031     * callback.
21032     *
21033     * There's a text entry on it, too, showing the name of the current
21034     * selection. There's the possibility of making it editable, so it
21035     * is useful on file saving dialogs on applications, where one
21036     * gives a file name to save contents to, in a given directory in
21037     * the system. This custom file name will be reported on the @c
21038     * "done" smart callback (explained in sequence).
21039     *
21040     * Finally, it has a view to display file system items into in two
21041     * possible forms:
21042     * - list
21043     * - grid
21044     *
21045     * If Elementary is built with support of the Ethumb thumbnailing
21046     * library, the second form of view will display preview thumbnails
21047     * of files which it supports.
21048     *
21049     * Smart callbacks one can register to:
21050     *
21051     * - @c "selected" - the user has clicked on a file (when not in
21052     *      folders-only mode) or directory (when in folders-only mode)
21053     * - @c "directory,open" - the list has been populated with new
21054     *      content (@c event_info is a pointer to the directory's
21055     *      path, a @b stringshared string)
21056     * - @c "done" - the user has clicked on the "ok" or "cancel"
21057     *      buttons (@c event_info is a pointer to the selection's
21058     *      path, a @b stringshared string)
21059     *
21060     * Here is an example on its usage:
21061     * @li @ref fileselector_example
21062     */
21063
21064    /**
21065     * @addtogroup Fileselector
21066     * @{
21067     */
21068
21069    /**
21070     * Defines how a file selector widget is to layout its contents
21071     * (file system entries).
21072     */
21073    typedef enum _Elm_Fileselector_Mode
21074      {
21075         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
21076         ELM_FILESELECTOR_GRID, /**< layout as a grid */
21077         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
21078      } Elm_Fileselector_Mode;
21079
21080    /**
21081     * Add a new file selector widget to the given parent Elementary
21082     * (container) object
21083     *
21084     * @param parent The parent object
21085     * @return a new file selector widget handle or @c NULL, on errors
21086     *
21087     * This function inserts a new file selector widget on the canvas.
21088     *
21089     * @ingroup Fileselector
21090     */
21091    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21092
21093    /**
21094     * Enable/disable the file name entry box where the user can type
21095     * in a name for a file, in a given file selector widget
21096     *
21097     * @param obj The file selector object
21098     * @param is_save @c EINA_TRUE to make the file selector a "saving
21099     * dialog", @c EINA_FALSE otherwise
21100     *
21101     * Having the entry editable is useful on file saving dialogs on
21102     * applications, where one gives a file name to save contents to,
21103     * in a given directory in the system. This custom file name will
21104     * be reported on the @c "done" smart callback.
21105     *
21106     * @see elm_fileselector_is_save_get()
21107     *
21108     * @ingroup Fileselector
21109     */
21110    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
21111
21112    /**
21113     * Get whether the given file selector is in "saving dialog" mode
21114     *
21115     * @param obj The file selector object
21116     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
21117     * mode, @c EINA_FALSE otherwise (and on errors)
21118     *
21119     * @see elm_fileselector_is_save_set() for more details
21120     *
21121     * @ingroup Fileselector
21122     */
21123    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21124
21125    /**
21126     * Enable/disable folder-only view for a given file selector widget
21127     *
21128     * @param obj The file selector object
21129     * @param only @c EINA_TRUE to make @p obj only display
21130     * directories, @c EINA_FALSE to make files to be displayed in it
21131     * too
21132     *
21133     * If enabled, the widget's view will only display folder items,
21134     * naturally.
21135     *
21136     * @see elm_fileselector_folder_only_get()
21137     *
21138     * @ingroup Fileselector
21139     */
21140    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
21141
21142    /**
21143     * Get whether folder-only view is set for a given file selector
21144     * widget
21145     *
21146     * @param obj The file selector object
21147     * @return only @c EINA_TRUE if @p obj is only displaying
21148     * directories, @c EINA_FALSE if files are being displayed in it
21149     * too (and on errors)
21150     *
21151     * @see elm_fileselector_folder_only_get()
21152     *
21153     * @ingroup Fileselector
21154     */
21155    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21156
21157    /**
21158     * Enable/disable the "ok" and "cancel" buttons on a given file
21159     * selector widget
21160     *
21161     * @param obj The file selector object
21162     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21163     *
21164     * @note A file selector without those buttons will never emit the
21165     * @c "done" smart event, and is only usable if one is just hooking
21166     * to the other two events.
21167     *
21168     * @see elm_fileselector_buttons_ok_cancel_get()
21169     *
21170     * @ingroup Fileselector
21171     */
21172    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21173
21174    /**
21175     * Get whether the "ok" and "cancel" buttons on a given file
21176     * selector widget are being shown.
21177     *
21178     * @param obj The file selector object
21179     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21180     * otherwise (and on errors)
21181     *
21182     * @see elm_fileselector_buttons_ok_cancel_set() for more details
21183     *
21184     * @ingroup Fileselector
21185     */
21186    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21187
21188    /**
21189     * Enable/disable a tree view in the given file selector widget,
21190     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21191     *
21192     * @param obj The file selector object
21193     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21194     * disable
21195     *
21196     * In a tree view, arrows are created on the sides of directories,
21197     * allowing them to expand in place.
21198     *
21199     * @note If it's in other mode, the changes made by this function
21200     * will only be visible when one switches back to "list" mode.
21201     *
21202     * @see elm_fileselector_expandable_get()
21203     *
21204     * @ingroup Fileselector
21205     */
21206    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21207
21208    /**
21209     * Get whether tree view is enabled for the given file selector
21210     * widget
21211     *
21212     * @param obj The file selector object
21213     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21214     * otherwise (and or errors)
21215     *
21216     * @see elm_fileselector_expandable_set() for more details
21217     *
21218     * @ingroup Fileselector
21219     */
21220    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21221
21222    /**
21223     * Set, programmatically, the @b directory that a given file
21224     * selector widget will display contents from
21225     *
21226     * @param obj The file selector object
21227     * @param path The path to display in @p obj
21228     *
21229     * This will change the @b directory that @p obj is displaying. It
21230     * will also clear the text entry area on the @p obj object, which
21231     * displays select files' names.
21232     *
21233     * @see elm_fileselector_path_get()
21234     *
21235     * @ingroup Fileselector
21236     */
21237    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21238
21239    /**
21240     * Get the parent directory's path that a given file selector
21241     * widget is displaying
21242     *
21243     * @param obj The file selector object
21244     * @return The (full) path of the directory the file selector is
21245     * displaying, a @b stringshared string
21246     *
21247     * @see elm_fileselector_path_set()
21248     *
21249     * @ingroup Fileselector
21250     */
21251    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21252
21253    /**
21254     * Set, programmatically, the currently selected file/directory in
21255     * the given file selector widget
21256     *
21257     * @param obj The file selector object
21258     * @param path The (full) path to a file or directory
21259     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21260     * latter case occurs if the directory or file pointed to do not
21261     * exist.
21262     *
21263     * @see elm_fileselector_selected_get()
21264     *
21265     * @ingroup Fileselector
21266     */
21267    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21268
21269    /**
21270     * Get the currently selected item's (full) path, in the given file
21271     * selector widget
21272     *
21273     * @param obj The file selector object
21274     * @return The absolute path of the selected item, a @b
21275     * stringshared string
21276     *
21277     * @note Custom editions on @p obj object's text entry, if made,
21278     * will appear on the return string of this function, naturally.
21279     *
21280     * @see elm_fileselector_selected_set() for more details
21281     *
21282     * @ingroup Fileselector
21283     */
21284    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21285
21286    /**
21287     * Set the mode in which a given file selector widget will display
21288     * (layout) file system entries in its view
21289     *
21290     * @param obj The file selector object
21291     * @param mode The mode of the fileselector, being it one of
21292     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21293     * first one, naturally, will display the files in a list. The
21294     * latter will make the widget to display its entries in a grid
21295     * form.
21296     *
21297     * @note By using elm_fileselector_expandable_set(), the user may
21298     * trigger a tree view for that list.
21299     *
21300     * @note If Elementary is built with support of the Ethumb
21301     * thumbnailing library, the second form of view will display
21302     * preview thumbnails of files which it supports. You must have
21303     * elm_need_ethumb() called in your Elementary for thumbnailing to
21304     * work, though.
21305     *
21306     * @see elm_fileselector_expandable_set().
21307     * @see elm_fileselector_mode_get().
21308     *
21309     * @ingroup Fileselector
21310     */
21311    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21312
21313    /**
21314     * Get the mode in which a given file selector widget is displaying
21315     * (layouting) file system entries in its view
21316     *
21317     * @param obj The fileselector object
21318     * @return The mode in which the fileselector is at
21319     *
21320     * @see elm_fileselector_mode_set() for more details
21321     *
21322     * @ingroup Fileselector
21323     */
21324    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21325
21326    /**
21327     * @}
21328     */
21329
21330    /**
21331     * @defgroup Progressbar Progress bar
21332     *
21333     * The progress bar is a widget for visually representing the
21334     * progress status of a given job/task.
21335     *
21336     * A progress bar may be horizontal or vertical. It may display an
21337     * icon besides it, as well as primary and @b units labels. The
21338     * former is meant to label the widget as a whole, while the
21339     * latter, which is formatted with floating point values (and thus
21340     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21341     * units"</c>), is meant to label the widget's <b>progress
21342     * value</b>. Label, icon and unit strings/objects are @b optional
21343     * for progress bars.
21344     *
21345     * A progress bar may be @b inverted, in which state it gets its
21346     * values inverted, with high values being on the left or top and
21347     * low values on the right or bottom, as opposed to normally have
21348     * the low values on the former and high values on the latter,
21349     * respectively, for horizontal and vertical modes.
21350     *
21351     * The @b span of the progress, as set by
21352     * elm_progressbar_span_size_set(), is its length (horizontally or
21353     * vertically), unless one puts size hints on the widget to expand
21354     * on desired directions, by any container. That length will be
21355     * scaled by the object or applications scaling factor. At any
21356     * point code can query the progress bar for its value with
21357     * elm_progressbar_value_get().
21358     *
21359     * Available widget styles for progress bars:
21360     * - @c "default"
21361     * - @c "wheel" (simple style, no text, no progression, only
21362     *      "pulse" effect is available)
21363     *
21364     * Default contents parts of the progressbar widget that you can use for are:
21365     * @li "icon" - An icon of the progressbar
21366     *
21367     * Here is an example on its usage:
21368     * @li @ref progressbar_example
21369     */
21370
21371    /**
21372     * Add a new progress bar widget to the given parent Elementary
21373     * (container) object
21374     *
21375     * @param parent The parent object
21376     * @return a new progress bar widget handle or @c NULL, on errors
21377     *
21378     * This function inserts a new progress bar widget on the canvas.
21379     *
21380     * @ingroup Progressbar
21381     */
21382    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21383
21384    /**
21385     * Set whether a given progress bar widget is at "pulsing mode" or
21386     * not.
21387     *
21388     * @param obj The progress bar object
21389     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21390     * @c EINA_FALSE to put it back to its default one
21391     *
21392     * By default, progress bars will display values from the low to
21393     * high value boundaries. There are, though, contexts in which the
21394     * state of progression of a given task is @b unknown.  For those,
21395     * one can set a progress bar widget to a "pulsing state", to give
21396     * the user an idea that some computation is being held, but
21397     * without exact progress values. In the default theme it will
21398     * animate its bar with the contents filling in constantly and back
21399     * to non-filled, in a loop. To start and stop this pulsing
21400     * animation, one has to explicitly call elm_progressbar_pulse().
21401     *
21402     * @see elm_progressbar_pulse_get()
21403     * @see elm_progressbar_pulse()
21404     *
21405     * @ingroup Progressbar
21406     */
21407    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21408
21409    /**
21410     * Get whether a given progress bar widget is at "pulsing mode" or
21411     * not.
21412     *
21413     * @param obj The progress bar object
21414     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21415     * if it's in the default one (and on errors)
21416     *
21417     * @ingroup Progressbar
21418     */
21419    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21420
21421    /**
21422     * Start/stop a given progress bar "pulsing" animation, if its
21423     * under that mode
21424     *
21425     * @param obj The progress bar object
21426     * @param state @c EINA_TRUE, to @b start the pulsing animation,
21427     * @c EINA_FALSE to @b stop it
21428     *
21429     * @note This call won't do anything if @p obj is not under "pulsing mode".
21430     *
21431     * @see elm_progressbar_pulse_set() for more details.
21432     *
21433     * @ingroup Progressbar
21434     */
21435    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21436
21437    /**
21438     * Set the progress value (in percentage) on a given progress bar
21439     * widget
21440     *
21441     * @param obj The progress bar object
21442     * @param val The progress value (@b must be between @c 0.0 and @c
21443     * 1.0)
21444     *
21445     * Use this call to set progress bar levels.
21446     *
21447     * @note If you passes a value out of the specified range for @p
21448     * val, it will be interpreted as the @b closest of the @b boundary
21449     * values in the range.
21450     *
21451     * @ingroup Progressbar
21452     */
21453    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21454
21455    /**
21456     * Get the progress value (in percentage) on a given progress bar
21457     * widget
21458     *
21459     * @param obj The progress bar object
21460     * @return The value of the progressbar
21461     *
21462     * @see elm_progressbar_value_set() for more details
21463     *
21464     * @ingroup Progressbar
21465     */
21466    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21467
21468    /**
21469     * Set the label of a given progress bar widget
21470     *
21471     * @param obj The progress bar object
21472     * @param label The text label string, in UTF-8
21473     *
21474     * @ingroup Progressbar
21475     * @deprecated use elm_object_text_set() instead.
21476     */
21477    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21478
21479    /**
21480     * Get the label of a given progress bar widget
21481     *
21482     * @param obj The progressbar object
21483     * @return The text label string, in UTF-8
21484     *
21485     * @ingroup Progressbar
21486     * @deprecated use elm_object_text_set() instead.
21487     */
21488    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21489
21490    /**
21491     * Set the icon object of a given progress bar widget
21492     *
21493     * @param obj The progress bar object
21494     * @param icon The icon object
21495     *
21496     * Use this call to decorate @p obj with an icon next to it.
21497     *
21498     * @note Once the icon object is set, a previously set one will be
21499     * deleted. If you want to keep that old content object, use the
21500     * elm_progressbar_icon_unset() function.
21501     *
21502     * @see elm_progressbar_icon_get()
21503     * @deprecated use elm_object_part_content_set() instead.
21504     *
21505     * @ingroup Progressbar
21506     */
21507    EINA_DEPRECATED EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21508
21509    /**
21510     * Retrieve the icon object set for a given progress bar widget
21511     *
21512     * @param obj The progress bar object
21513     * @return The icon object's handle, if @p obj had one set, or @c NULL,
21514     * otherwise (and on errors)
21515     *
21516     * @see elm_progressbar_icon_set() for more details
21517     * @deprecated use elm_object_part_content_get() instead.
21518     *
21519     * @ingroup Progressbar
21520     */
21521    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21522
21523    /**
21524     * Unset an icon set on a given progress bar widget
21525     *
21526     * @param obj The progress bar object
21527     * @return The icon object that was being used, if any was set, or
21528     * @c NULL, otherwise (and on errors)
21529     *
21530     * This call will unparent and return the icon object which was set
21531     * for this widget, previously, on success.
21532     *
21533     * @see elm_progressbar_icon_set() for more details
21534     * @deprecated use elm_object_part_content_unset() instead.
21535     *
21536     * @ingroup Progressbar
21537     */
21538    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21539
21540    /**
21541     * Set the (exact) length of the bar region of a given progress bar
21542     * widget
21543     *
21544     * @param obj The progress bar object
21545     * @param size The length of the progress bar's bar region
21546     *
21547     * This sets the minimum width (when in horizontal mode) or height
21548     * (when in vertical mode) of the actual bar area of the progress
21549     * bar @p obj. This in turn affects the object's minimum size. Use
21550     * this when you're not setting other size hints expanding on the
21551     * given direction (like weight and alignment hints) and you would
21552     * like it to have a specific size.
21553     *
21554     * @note Icon, label and unit text around @p obj will require their
21555     * own space, which will make @p obj to require more the @p size,
21556     * actually.
21557     *
21558     * @see elm_progressbar_span_size_get()
21559     *
21560     * @ingroup Progressbar
21561     */
21562    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21563
21564    /**
21565     * Get the length set for the bar region of a given progress bar
21566     * widget
21567     *
21568     * @param obj The progress bar object
21569     * @return The length of the progress bar's bar region
21570     *
21571     * If that size was not set previously, with
21572     * elm_progressbar_span_size_set(), this call will return @c 0.
21573     *
21574     * @ingroup Progressbar
21575     */
21576    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21577
21578    /**
21579     * Set the format string for a given progress bar widget's units
21580     * label
21581     *
21582     * @param obj The progress bar object
21583     * @param format The format string for @p obj's units label
21584     *
21585     * If @c NULL is passed on @p format, it will make @p obj's units
21586     * area to be hidden completely. If not, it'll set the <b>format
21587     * string</b> for the units label's @b text. The units label is
21588     * provided a floating point value, so the units text is up display
21589     * at most one floating point falue. Note that the units label is
21590     * optional. Use a format string such as "%1.2f meters" for
21591     * example.
21592     *
21593     * @note The default format string for a progress bar is an integer
21594     * percentage, as in @c "%.0f %%".
21595     *
21596     * @see elm_progressbar_unit_format_get()
21597     *
21598     * @ingroup Progressbar
21599     */
21600    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21601
21602    /**
21603     * Retrieve the format string set for a given progress bar widget's
21604     * units label
21605     *
21606     * @param obj The progress bar object
21607     * @return The format set string for @p obj's units label or
21608     * @c NULL, if none was set (and on errors)
21609     *
21610     * @see elm_progressbar_unit_format_set() for more details
21611     *
21612     * @ingroup Progressbar
21613     */
21614    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21615
21616    /**
21617     * Set the orientation of a given progress bar widget
21618     *
21619     * @param obj The progress bar object
21620     * @param horizontal Use @c EINA_TRUE to make @p obj to be
21621     * @b horizontal, @c EINA_FALSE to make it @b vertical
21622     *
21623     * Use this function to change how your progress bar is to be
21624     * disposed: vertically or horizontally.
21625     *
21626     * @see elm_progressbar_horizontal_get()
21627     *
21628     * @ingroup Progressbar
21629     */
21630    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21631
21632    /**
21633     * Retrieve the orientation of a given progress bar widget
21634     *
21635     * @param obj The progress bar object
21636     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21637     * @c EINA_FALSE if it's @b vertical (and on errors)
21638     *
21639     * @see elm_progressbar_horizontal_set() for more details
21640     *
21641     * @ingroup Progressbar
21642     */
21643    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21644
21645    /**
21646     * Invert a given progress bar widget's displaying values order
21647     *
21648     * @param obj The progress bar object
21649     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21650     * @c EINA_FALSE to bring it back to default, non-inverted values.
21651     *
21652     * A progress bar may be @b inverted, in which state it gets its
21653     * values inverted, with high values being on the left or top and
21654     * low values on the right or bottom, as opposed to normally have
21655     * the low values on the former and high values on the latter,
21656     * respectively, for horizontal and vertical modes.
21657     *
21658     * @see elm_progressbar_inverted_get()
21659     *
21660     * @ingroup Progressbar
21661     */
21662    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21663
21664    /**
21665     * Get whether a given progress bar widget's displaying values are
21666     * inverted or not
21667     *
21668     * @param obj The progress bar object
21669     * @return @c EINA_TRUE, if @p obj has inverted values,
21670     * @c EINA_FALSE otherwise (and on errors)
21671     *
21672     * @see elm_progressbar_inverted_set() for more details
21673     *
21674     * @ingroup Progressbar
21675     */
21676    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21677
21678    /**
21679     * @defgroup Separator Separator
21680     *
21681     * @brief Separator is a very thin object used to separate other objects.
21682     *
21683     * A separator can be vertical or horizontal.
21684     *
21685     * @ref tutorial_separator is a good example of how to use a separator.
21686     * @{
21687     */
21688    /**
21689     * @brief Add a separator object to @p parent
21690     *
21691     * @param parent The parent object
21692     *
21693     * @return The separator object, or NULL upon failure
21694     */
21695    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21696    /**
21697     * @brief Set the horizontal mode of a separator object
21698     *
21699     * @param obj The separator object
21700     * @param horizontal If true, the separator is horizontal
21701     */
21702    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21703    /**
21704     * @brief Get the horizontal mode of a separator object
21705     *
21706     * @param obj The separator object
21707     * @return If true, the separator is horizontal
21708     *
21709     * @see elm_separator_horizontal_set()
21710     */
21711    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21712    /**
21713     * @}
21714     */
21715
21716    /**
21717     * @defgroup Spinner Spinner
21718     * @ingroup Elementary
21719     *
21720     * @image html img/widget/spinner/preview-00.png
21721     * @image latex img/widget/spinner/preview-00.eps
21722     *
21723     * A spinner is a widget which allows the user to increase or decrease
21724     * numeric values using arrow buttons, or edit values directly, clicking
21725     * over it and typing the new value.
21726     *
21727     * By default the spinner will not wrap and has a label
21728     * of "%.0f" (just showing the integer value of the double).
21729     *
21730     * A spinner has a label that is formatted with floating
21731     * point values and thus accepts a printf-style format string, like
21732     * ā€œ%1.2f unitsā€.
21733     *
21734     * It also allows specific values to be replaced by pre-defined labels.
21735     *
21736     * Smart callbacks one can register to:
21737     *
21738     * - "changed" - Whenever the spinner value is changed.
21739     * - "delay,changed" - A short time after the value is changed by the user.
21740     *    This will be called only when the user stops dragging for a very short
21741     *    period or when they release their finger/mouse, so it avoids possibly
21742     *    expensive reactions to the value change.
21743     *
21744     * Available styles for it:
21745     * - @c "default";
21746     * - @c "vertical": up/down buttons at the right side and text left aligned.
21747     *
21748     * Here is an example on its usage:
21749     * @ref spinner_example
21750     */
21751
21752    /**
21753     * @addtogroup Spinner
21754     * @{
21755     */
21756
21757    /**
21758     * Add a new spinner widget to the given parent Elementary
21759     * (container) object.
21760     *
21761     * @param parent The parent object.
21762     * @return a new spinner widget handle or @c NULL, on errors.
21763     *
21764     * This function inserts a new spinner widget on the canvas.
21765     *
21766     * @ingroup Spinner
21767     *
21768     */
21769    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21770
21771    /**
21772     * Set the format string of the displayed label.
21773     *
21774     * @param obj The spinner object.
21775     * @param fmt The format string for the label display.
21776     *
21777     * If @c NULL, this sets the format to "%.0f". If not it sets the format
21778     * string for the label text. The label text is provided a floating point
21779     * value, so the label text can display up to 1 floating point value.
21780     * Note that this is optional.
21781     *
21782     * Use a format string such as "%1.2f meters" for example, and it will
21783     * display values like: "3.14 meters" for a value equal to 3.14159.
21784     *
21785     * Default is "%0.f".
21786     *
21787     * @see elm_spinner_label_format_get()
21788     *
21789     * @ingroup Spinner
21790     */
21791    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21792
21793    /**
21794     * Get the label format of the spinner.
21795     *
21796     * @param obj The spinner object.
21797     * @return The text label format string in UTF-8.
21798     *
21799     * @see elm_spinner_label_format_set() for details.
21800     *
21801     * @ingroup Spinner
21802     */
21803    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21804
21805    /**
21806     * Set the minimum and maximum values for the spinner.
21807     *
21808     * @param obj The spinner object.
21809     * @param min The minimum value.
21810     * @param max The maximum value.
21811     *
21812     * Define the allowed range of values to be selected by the user.
21813     *
21814     * If actual value is less than @p min, it will be updated to @p min. If it
21815     * is bigger then @p max, will be updated to @p max. Actual value can be
21816     * get with elm_spinner_value_get().
21817     *
21818     * By default, min is equal to 0, and max is equal to 100.
21819     *
21820     * @warning Maximum must be greater than minimum.
21821     *
21822     * @see elm_spinner_min_max_get()
21823     *
21824     * @ingroup Spinner
21825     */
21826    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21827
21828    /**
21829     * Get the minimum and maximum values of the spinner.
21830     *
21831     * @param obj The spinner object.
21832     * @param min Pointer where to store the minimum value.
21833     * @param max Pointer where to store the maximum value.
21834     *
21835     * @note If only one value is needed, the other pointer can be passed
21836     * as @c NULL.
21837     *
21838     * @see elm_spinner_min_max_set() for details.
21839     *
21840     * @ingroup Spinner
21841     */
21842    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21843
21844    /**
21845     * Set the step used to increment or decrement the spinner value.
21846     *
21847     * @param obj The spinner object.
21848     * @param step The step value.
21849     *
21850     * This value will be incremented or decremented to the displayed value.
21851     * It will be incremented while the user keep right or top arrow pressed,
21852     * and will be decremented while the user keep left or bottom arrow pressed.
21853     *
21854     * The interval to increment / decrement can be set with
21855     * elm_spinner_interval_set().
21856     *
21857     * By default step value is equal to 1.
21858     *
21859     * @see elm_spinner_step_get()
21860     *
21861     * @ingroup Spinner
21862     */
21863    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21864
21865    /**
21866     * Get the step used to increment or decrement the spinner value.
21867     *
21868     * @param obj The spinner object.
21869     * @return The step value.
21870     *
21871     * @see elm_spinner_step_get() for more details.
21872     *
21873     * @ingroup Spinner
21874     */
21875    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21876
21877    /**
21878     * Set the value the spinner displays.
21879     *
21880     * @param obj The spinner object.
21881     * @param val The value to be displayed.
21882     *
21883     * Value will be presented on the label following format specified with
21884     * elm_spinner_format_set().
21885     *
21886     * @warning The value must to be between min and max values. This values
21887     * are set by elm_spinner_min_max_set().
21888     *
21889     * @see elm_spinner_value_get().
21890     * @see elm_spinner_format_set().
21891     * @see elm_spinner_min_max_set().
21892     *
21893     * @ingroup Spinner
21894     */
21895    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21896
21897    /**
21898     * Get the value displayed by the spinner.
21899     *
21900     * @param obj The spinner object.
21901     * @return The value displayed.
21902     *
21903     * @see elm_spinner_value_set() for details.
21904     *
21905     * @ingroup Spinner
21906     */
21907    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21908
21909    /**
21910     * Set whether the spinner should wrap when it reaches its
21911     * minimum or maximum value.
21912     *
21913     * @param obj The spinner object.
21914     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21915     * disable it.
21916     *
21917     * Disabled by default. If disabled, when the user tries to increment the
21918     * value,
21919     * but displayed value plus step value is bigger than maximum value,
21920     * the spinner
21921     * won't allow it. The same happens when the user tries to decrement it,
21922     * but the value less step is less than minimum value.
21923     *
21924     * When wrap is enabled, in such situations it will allow these changes,
21925     * but will get the value that would be less than minimum and subtracts
21926     * from maximum. Or add the value that would be more than maximum to
21927     * the minimum.
21928     *
21929     * E.g.:
21930     * @li min value = 10
21931     * @li max value = 50
21932     * @li step value = 20
21933     * @li displayed value = 20
21934     *
21935     * When the user decrement value (using left or bottom arrow), it will
21936     * displays @c 40, because max - (min - (displayed - step)) is
21937     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21938     *
21939     * @see elm_spinner_wrap_get().
21940     *
21941     * @ingroup Spinner
21942     */
21943    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21944
21945    /**
21946     * Get whether the spinner should wrap when it reaches its
21947     * minimum or maximum value.
21948     *
21949     * @param obj The spinner object
21950     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21951     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21952     *
21953     * @see elm_spinner_wrap_set() for details.
21954     *
21955     * @ingroup Spinner
21956     */
21957    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21958
21959    /**
21960     * Set whether the spinner can be directly edited by the user or not.
21961     *
21962     * @param obj The spinner object.
21963     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21964     * don't allow users to edit it directly.
21965     *
21966     * Spinner objects can have edition @b disabled, in which state they will
21967     * be changed only by arrows.
21968     * Useful for contexts
21969     * where you don't want your users to interact with it writting the value.
21970     * Specially
21971     * when using special values, the user can see real value instead
21972     * of special label on edition.
21973     *
21974     * It's enabled by default.
21975     *
21976     * @see elm_spinner_editable_get()
21977     *
21978     * @ingroup Spinner
21979     */
21980    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21981
21982    /**
21983     * Get whether the spinner can be directly edited by the user or not.
21984     *
21985     * @param obj The spinner object.
21986     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21987     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21988     *
21989     * @see elm_spinner_editable_set() for details.
21990     *
21991     * @ingroup Spinner
21992     */
21993    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21994
21995    /**
21996     * Set a special string to display in the place of the numerical value.
21997     *
21998     * @param obj The spinner object.
21999     * @param value The value to be replaced.
22000     * @param label The label to be used.
22001     *
22002     * It's useful for cases when a user should select an item that is
22003     * better indicated by a label than a value. For example, weekdays or months.
22004     *
22005     * E.g.:
22006     * @code
22007     * sp = elm_spinner_add(win);
22008     * elm_spinner_min_max_set(sp, 1, 3);
22009     * elm_spinner_special_value_add(sp, 1, "January");
22010     * elm_spinner_special_value_add(sp, 2, "February");
22011     * elm_spinner_special_value_add(sp, 3, "March");
22012     * evas_object_show(sp);
22013     * @endcode
22014     *
22015     * @ingroup Spinner
22016     */
22017    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
22018
22019    /**
22020     * Set the interval on time updates for an user mouse button hold
22021     * on spinner widgets' arrows.
22022     *
22023     * @param obj The spinner object.
22024     * @param interval The (first) interval value in seconds.
22025     *
22026     * This interval value is @b decreased while the user holds the
22027     * mouse pointer either incrementing or decrementing spinner's value.
22028     *
22029     * This helps the user to get to a given value distant from the
22030     * current one easier/faster, as it will start to change quicker and
22031     * quicker on mouse button holds.
22032     *
22033     * The calculation for the next change interval value, starting from
22034     * the one set with this call, is the previous interval divided by
22035     * @c 1.05, so it decreases a little bit.
22036     *
22037     * The default starting interval value for automatic changes is
22038     * @c 0.85 seconds.
22039     *
22040     * @see elm_spinner_interval_get()
22041     *
22042     * @ingroup Spinner
22043     */
22044    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
22045
22046    /**
22047     * Get the interval on time updates for an user mouse button hold
22048     * on spinner widgets' arrows.
22049     *
22050     * @param obj The spinner object.
22051     * @return The (first) interval value, in seconds, set on it.
22052     *
22053     * @see elm_spinner_interval_set() for more details.
22054     *
22055     * @ingroup Spinner
22056     */
22057    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22058
22059    /**
22060     * @}
22061     */
22062
22063    /**
22064     * @defgroup Index Index
22065     *
22066     * @image html img/widget/index/preview-00.png
22067     * @image latex img/widget/index/preview-00.eps
22068     *
22069     * An index widget gives you an index for fast access to whichever
22070     * group of other UI items one might have. It's a list of text
22071     * items (usually letters, for alphabetically ordered access).
22072     *
22073     * Index widgets are by default hidden and just appear when the
22074     * user clicks over it's reserved area in the canvas. In its
22075     * default theme, it's an area one @ref Fingers "finger" wide on
22076     * the right side of the index widget's container.
22077     *
22078     * When items on the index are selected, smart callbacks get
22079     * called, so that its user can make other container objects to
22080     * show a given area or child object depending on the index item
22081     * selected. You'd probably be using an index together with @ref
22082     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
22083     * "general grids".
22084     *
22085     * Smart events one  can add callbacks for are:
22086     * - @c "changed" - When the selected index item changes. @c
22087     *      event_info is the selected item's data pointer.
22088     * - @c "delay,changed" - When the selected index item changes, but
22089     *      after a small idling period. @c event_info is the selected
22090     *      item's data pointer.
22091     * - @c "selected" - When the user releases a mouse button and
22092     *      selects an item. @c event_info is the selected item's data
22093     *      pointer.
22094     * - @c "level,up" - when the user moves a finger from the first
22095     *      level to the second level
22096     * - @c "level,down" - when the user moves a finger from the second
22097     *      level to the first level
22098     *
22099     * The @c "delay,changed" event is so that it'll wait a small time
22100     * before actually reporting those events and, moreover, just the
22101     * last event happening on those time frames will actually be
22102     * reported.
22103     *
22104     * Here are some examples on its usage:
22105     * @li @ref index_example_01
22106     * @li @ref index_example_02
22107     */
22108
22109    /**
22110     * @addtogroup Index
22111     * @{
22112     */
22113
22114    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
22115
22116    /**
22117     * Add a new index widget to the given parent Elementary
22118     * (container) object
22119     *
22120     * @param parent The parent object
22121     * @return a new index widget handle or @c NULL, on errors
22122     *
22123     * This function inserts a new index widget on the canvas.
22124     *
22125     * @ingroup Index
22126     */
22127    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22128
22129    /**
22130     * Set whether a given index widget is or not visible,
22131     * programatically.
22132     *
22133     * @param obj The index object
22134     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
22135     *
22136     * Not to be confused with visible as in @c evas_object_show() --
22137     * visible with regard to the widget's auto hiding feature.
22138     *
22139     * @see elm_index_active_get()
22140     *
22141     * @ingroup Index
22142     */
22143    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
22144
22145    /**
22146     * Get whether a given index widget is currently visible or not.
22147     *
22148     * @param obj The index object
22149     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
22150     *
22151     * @see elm_index_active_set() for more details
22152     *
22153     * @ingroup Index
22154     */
22155    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22156
22157    /**
22158     * Set the items level for a given index widget.
22159     *
22160     * @param obj The index object.
22161     * @param level @c 0 or @c 1, the currently implemented levels.
22162     *
22163     * @see elm_index_item_level_get()
22164     *
22165     * @ingroup Index
22166     */
22167    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22168
22169    /**
22170     * Get the items level set for a given index widget.
22171     *
22172     * @param obj The index object.
22173     * @return @c 0 or @c 1, which are the levels @p obj might be at.
22174     *
22175     * @see elm_index_item_level_set() for more information
22176     *
22177     * @ingroup Index
22178     */
22179    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22180
22181    /**
22182     * Returns the last selected item's data, for a given index widget.
22183     *
22184     * @param obj The index object.
22185     * @return The item @b data associated to the last selected item on
22186     * @p obj (or @c NULL, on errors).
22187     *
22188     * @warning The returned value is @b not an #Elm_Index_Item item
22189     * handle, but the data associated to it (see the @c item parameter
22190     * in elm_index_item_append(), as an example).
22191     *
22192     * @ingroup Index
22193     */
22194    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22195
22196    /**
22197     * Append a new item on a given index widget.
22198     *
22199     * @param obj The index object.
22200     * @param letter Letter under which the item should be indexed
22201     * @param item The item data to set for the index's item
22202     *
22203     * Despite the most common usage of the @p letter argument is for
22204     * single char strings, one could use arbitrary strings as index
22205     * entries.
22206     *
22207     * @c item will be the pointer returned back on @c "changed", @c
22208     * "delay,changed" and @c "selected" smart events.
22209     *
22210     * @ingroup Index
22211     */
22212    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22213
22214    /**
22215     * Prepend a new item on a given index widget.
22216     *
22217     * @param obj The index object.
22218     * @param letter Letter under which the item should be indexed
22219     * @param item The item data to set for the index's item
22220     *
22221     * Despite the most common usage of the @p letter argument is for
22222     * single char strings, one could use arbitrary strings as index
22223     * entries.
22224     *
22225     * @c item will be the pointer returned back on @c "changed", @c
22226     * "delay,changed" and @c "selected" smart events.
22227     *
22228     * @ingroup Index
22229     */
22230    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22231
22232    /**
22233     * Append a new item, on a given index widget, <b>after the item
22234     * having @p relative as data</b>.
22235     *
22236     * @param obj The index object.
22237     * @param letter Letter under which the item should be indexed
22238     * @param item The item data to set for the index's item
22239     * @param relative The item data of the index item to be the
22240     * predecessor of this new one
22241     *
22242     * Despite the most common usage of the @p letter argument is for
22243     * single char strings, one could use arbitrary strings as index
22244     * entries.
22245     *
22246     * @c item will be the pointer returned back on @c "changed", @c
22247     * "delay,changed" and @c "selected" smart events.
22248     *
22249     * @note If @p relative is @c NULL or if it's not found to be data
22250     * set on any previous item on @p obj, this function will behave as
22251     * elm_index_item_append().
22252     *
22253     * @ingroup Index
22254     */
22255    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22256
22257    /**
22258     * Prepend a new item, on a given index widget, <b>after the item
22259     * having @p relative as data</b>.
22260     *
22261     * @param obj The index object.
22262     * @param letter Letter under which the item should be indexed
22263     * @param item The item data to set for the index's item
22264     * @param relative The item data of the index item to be the
22265     * successor of this new one
22266     *
22267     * Despite the most common usage of the @p letter argument is for
22268     * single char strings, one could use arbitrary strings as index
22269     * entries.
22270     *
22271     * @c item will be the pointer returned back on @c "changed", @c
22272     * "delay,changed" and @c "selected" smart events.
22273     *
22274     * @note If @p relative is @c NULL or if it's not found to be data
22275     * set on any previous item on @p obj, this function will behave as
22276     * elm_index_item_prepend().
22277     *
22278     * @ingroup Index
22279     */
22280    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22281
22282    /**
22283     * Insert a new item into the given index widget, using @p cmp_func
22284     * function to sort items (by item handles).
22285     *
22286     * @param obj The index object.
22287     * @param letter Letter under which the item should be indexed
22288     * @param item The item data to set for the index's item
22289     * @param cmp_func The comparing function to be used to sort index
22290     * items <b>by #Elm_Index_Item item handles</b>
22291     * @param cmp_data_func A @b fallback function to be called for the
22292     * sorting of index items <b>by item data</b>). It will be used
22293     * when @p cmp_func returns @c 0 (equality), which means an index
22294     * item with provided item data already exists. To decide which
22295     * data item should be pointed to by the index item in question, @p
22296     * cmp_data_func will be used. If @p cmp_data_func returns a
22297     * non-negative value, the previous index item data will be
22298     * replaced by the given @p item pointer. If the previous data need
22299     * to be freed, it should be done by the @p cmp_data_func function,
22300     * because all references to it will be lost. If this function is
22301     * not provided (@c NULL is given), index items will be @b
22302     * duplicated, if @p cmp_func returns @c 0.
22303     *
22304     * Despite the most common usage of the @p letter argument is for
22305     * single char strings, one could use arbitrary strings as index
22306     * entries.
22307     *
22308     * @c item will be the pointer returned back on @c "changed", @c
22309     * "delay,changed" and @c "selected" smart events.
22310     *
22311     * @ingroup Index
22312     */
22313    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);
22314
22315    /**
22316     * Remove an item from a given index widget, <b>to be referenced by
22317     * it's data value</b>.
22318     *
22319     * @param obj The index object
22320     * @param item The item's data pointer for the item to be removed
22321     * from @p obj
22322     *
22323     * If a deletion callback is set, via elm_index_item_del_cb_set(),
22324     * that callback function will be called by this one.
22325     *
22326     * @warning The item to be removed from @p obj will be found via
22327     * its item data pointer, and not by an #Elm_Index_Item handle.
22328     *
22329     * @ingroup Index
22330     */
22331    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22332
22333    /**
22334     * Find a given index widget's item, <b>using item data</b>.
22335     *
22336     * @param obj The index object
22337     * @param item The item data pointed to by the desired index item
22338     * @return The index item handle, if found, or @c NULL otherwise
22339     *
22340     * @ingroup Index
22341     */
22342    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22343
22344    /**
22345     * Removes @b all items from a given index widget.
22346     *
22347     * @param obj The index object.
22348     *
22349     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22350     * that callback function will be called for each item in @p obj.
22351     *
22352     * @ingroup Index
22353     */
22354    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22355
22356    /**
22357     * Go to a given items level on a index widget
22358     *
22359     * @param obj The index object
22360     * @param level The index level (one of @c 0 or @c 1)
22361     *
22362     * @ingroup Index
22363     */
22364    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22365
22366    /**
22367     * Return the data associated with a given index widget item
22368     *
22369     * @param it The index widget item handle
22370     * @return The data associated with @p it
22371     *
22372     * @see elm_index_item_data_set()
22373     *
22374     * @ingroup Index
22375     */
22376    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22377
22378    /**
22379     * Set the data associated with a given index widget item
22380     *
22381     * @param it The index widget item handle
22382     * @param data The new data pointer to set to @p it
22383     *
22384     * This sets new item data on @p it.
22385     *
22386     * @warning The old data pointer won't be touched by this function, so
22387     * the user had better to free that old data himself/herself.
22388     *
22389     * @ingroup Index
22390     */
22391    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22392
22393    /**
22394     * Set the function to be called when a given index widget item is freed.
22395     *
22396     * @param it The item to set the callback on
22397     * @param func The function to call on the item's deletion
22398     *
22399     * When called, @p func will have both @c data and @c event_info
22400     * arguments with the @p it item's data value and, naturally, the
22401     * @c obj argument with a handle to the parent index widget.
22402     *
22403     * @ingroup Index
22404     */
22405    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22406
22407    /**
22408     * Get the letter (string) set on a given index widget item.
22409     *
22410     * @param it The index item handle
22411     * @return The letter string set on @p it
22412     *
22413     * @ingroup Index
22414     */
22415    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22416
22417    /**
22418     * @}
22419     */
22420
22421    /**
22422     * @defgroup Photocam Photocam
22423     *
22424     * @image html img/widget/photocam/preview-00.png
22425     * @image latex img/widget/photocam/preview-00.eps
22426     *
22427     * This is a widget specifically for displaying high-resolution digital
22428     * camera photos giving speedy feedback (fast load), low memory footprint
22429     * and zooming and panning as well as fitting logic. It is entirely focused
22430     * on jpeg images, and takes advantage of properties of the jpeg format (via
22431     * evas loader features in the jpeg loader).
22432     *
22433     * Signals that you can add callbacks for are:
22434     * @li "clicked" - This is called when a user has clicked the photo without
22435     *                 dragging around.
22436     * @li "press" - This is called when a user has pressed down on the photo.
22437     * @li "longpressed" - This is called when a user has pressed down on the
22438     *                     photo for a long time without dragging around.
22439     * @li "clicked,double" - This is called when a user has double-clicked the
22440     *                        photo.
22441     * @li "load" - Photo load begins.
22442     * @li "loaded" - This is called when the image file load is complete for the
22443     *                first view (low resolution blurry version).
22444     * @li "load,detail" - Photo detailed data load begins.
22445     * @li "loaded,detail" - This is called when the image file load is complete
22446     *                      for the detailed image data (full resolution needed).
22447     * @li "zoom,start" - Zoom animation started.
22448     * @li "zoom,stop" - Zoom animation stopped.
22449     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22450     * @li "scroll" - the content has been scrolled (moved)
22451     * @li "scroll,anim,start" - scrolling animation has started
22452     * @li "scroll,anim,stop" - scrolling animation has stopped
22453     * @li "scroll,drag,start" - dragging the contents around has started
22454     * @li "scroll,drag,stop" - dragging the contents around has stopped
22455     *
22456     * @ref tutorial_photocam shows the API in action.
22457     * @{
22458     */
22459    /**
22460     * @brief Types of zoom available.
22461     */
22462    typedef enum _Elm_Photocam_Zoom_Mode
22463      {
22464         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_photocam_zoom_set */
22465         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22466         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22467         ELM_PHOTOCAM_ZOOM_MODE_LAST
22468      } Elm_Photocam_Zoom_Mode;
22469    /**
22470     * @brief Add a new Photocam object
22471     *
22472     * @param parent The parent object
22473     * @return The new object or NULL if it cannot be created
22474     */
22475    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22476    /**
22477     * @brief Set the photo file to be shown
22478     *
22479     * @param obj The photocam object
22480     * @param file The photo file
22481     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22482     *
22483     * This sets (and shows) the specified file (with a relative or absolute
22484     * path) and will return a load error (same error that
22485     * evas_object_image_load_error_get() will return). The image will change and
22486     * adjust its size at this point and begin a background load process for this
22487     * photo that at some time in the future will be displayed at the full
22488     * quality needed.
22489     */
22490    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22491    /**
22492     * @brief Returns the path of the current image file
22493     *
22494     * @param obj The photocam object
22495     * @return Returns the path
22496     *
22497     * @see elm_photocam_file_set()
22498     */
22499    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22500    /**
22501     * @brief Set the zoom level of the photo
22502     *
22503     * @param obj The photocam object
22504     * @param zoom The zoom level to set
22505     *
22506     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22507     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22508     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22509     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22510     * 16, 32, etc.).
22511     */
22512    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22513    /**
22514     * @brief Get the zoom level of the photo
22515     *
22516     * @param obj The photocam object
22517     * @return The current zoom level
22518     *
22519     * This returns the current zoom level of the photocam object. Note that if
22520     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22521     * (which is the default), the zoom level may be changed at any time by the
22522     * photocam object itself to account for photo size and photocam viewpoer
22523     * size.
22524     *
22525     * @see elm_photocam_zoom_set()
22526     * @see elm_photocam_zoom_mode_set()
22527     */
22528    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22529    /**
22530     * @brief Set the zoom mode
22531     *
22532     * @param obj The photocam object
22533     * @param mode The desired mode
22534     *
22535     * This sets the zoom mode to manual or one of several automatic levels.
22536     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22537     * elm_photocam_zoom_set() and will stay at that level until changed by code
22538     * or until zoom mode is changed. This is the default mode. The Automatic
22539     * modes will allow the photocam object to automatically adjust zoom mode
22540     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22541     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22542     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22543     * pixels within the frame are left unfilled.
22544     */
22545    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22546    /**
22547     * @brief Get the zoom mode
22548     *
22549     * @param obj The photocam object
22550     * @return The current zoom mode
22551     *
22552     * This gets the current zoom mode of the photocam object.
22553     *
22554     * @see elm_photocam_zoom_mode_set()
22555     */
22556    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22557    /**
22558     * @brief Get the current image pixel width and height
22559     *
22560     * @param obj The photocam object
22561     * @param w A pointer to the width return
22562     * @param h A pointer to the height return
22563     *
22564     * This gets the current photo pixel width and height (for the original).
22565     * The size will be returned in the integers @p w and @p h that are pointed
22566     * to.
22567     */
22568    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22569    /**
22570     * @brief Get the area of the image that is currently shown
22571     *
22572     * @param obj
22573     * @param x A pointer to the X-coordinate of region
22574     * @param y A pointer to the Y-coordinate of region
22575     * @param w A pointer to the width
22576     * @param h A pointer to the height
22577     *
22578     * @see elm_photocam_image_region_show()
22579     * @see elm_photocam_image_region_bring_in()
22580     */
22581    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22582    /**
22583     * @brief Set the viewed portion of the image
22584     *
22585     * @param obj The photocam object
22586     * @param x X-coordinate of region in image original pixels
22587     * @param y Y-coordinate of region in image original pixels
22588     * @param w Width of region in image original pixels
22589     * @param h Height of region in image original pixels
22590     *
22591     * This shows the region of the image without using animation.
22592     */
22593    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22594    /**
22595     * @brief Bring in the viewed portion of the image
22596     *
22597     * @param obj The photocam object
22598     * @param x X-coordinate of region in image original pixels
22599     * @param y Y-coordinate of region in image original pixels
22600     * @param w Width of region in image original pixels
22601     * @param h Height of region in image original pixels
22602     *
22603     * This shows the region of the image using animation.
22604     */
22605    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22606    /**
22607     * @brief Set the paused state for photocam
22608     *
22609     * @param obj The photocam object
22610     * @param paused The pause state to set
22611     *
22612     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22613     * photocam. The default is off. This will stop zooming using animation on
22614     * zoom levels changes and change instantly. This will stop any existing
22615     * animations that are running.
22616     */
22617    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22618    /**
22619     * @brief Get the paused state for photocam
22620     *
22621     * @param obj The photocam object
22622     * @return The current paused state
22623     *
22624     * This gets the current paused state for the photocam object.
22625     *
22626     * @see elm_photocam_paused_set()
22627     */
22628    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22629    /**
22630     * @brief Get the internal low-res image used for photocam
22631     *
22632     * @param obj The photocam object
22633     * @return The internal image object handle, or NULL if none exists
22634     *
22635     * This gets the internal image object inside photocam. Do not modify it. It
22636     * is for inspection only, and hooking callbacks to. Nothing else. It may be
22637     * deleted at any time as well.
22638     */
22639    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22640    /**
22641     * @brief Set the photocam scrolling bouncing.
22642     *
22643     * @param obj The photocam object
22644     * @param h_bounce bouncing for horizontal
22645     * @param v_bounce bouncing for vertical
22646     */
22647    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22648    /**
22649     * @brief Get the photocam scrolling bouncing.
22650     *
22651     * @param obj The photocam object
22652     * @param h_bounce bouncing for horizontal
22653     * @param v_bounce bouncing for vertical
22654     *
22655     * @see elm_photocam_bounce_set()
22656     */
22657    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22658    /**
22659     * @}
22660     */
22661
22662    /**
22663     * @defgroup Map Map
22664     * @ingroup Elementary
22665     *
22666     * @image html img/widget/map/preview-00.png
22667     * @image latex img/widget/map/preview-00.eps
22668     *
22669     * This is a widget specifically for displaying a map. It uses basically
22670     * OpenStreetMap provider http://www.openstreetmap.org/,
22671     * but custom providers can be added.
22672     *
22673     * It supports some basic but yet nice features:
22674     * @li zoom and scroll
22675     * @li markers with content to be displayed when user clicks over it
22676     * @li group of markers
22677     * @li routes
22678     *
22679     * Smart callbacks one can listen to:
22680     *
22681     * - "clicked" - This is called when a user has clicked the map without
22682     *   dragging around.
22683     * - "press" - This is called when a user has pressed down on the map.
22684     * - "longpressed" - This is called when a user has pressed down on the map
22685     *   for a long time without dragging around.
22686     * - "clicked,double" - This is called when a user has double-clicked
22687     *   the map.
22688     * - "load,detail" - Map detailed data load begins.
22689     * - "loaded,detail" - This is called when all currently visible parts of
22690     *   the map are loaded.
22691     * - "zoom,start" - Zoom animation started.
22692     * - "zoom,stop" - Zoom animation stopped.
22693     * - "zoom,change" - Zoom changed when using an auto zoom mode.
22694     * - "scroll" - the content has been scrolled (moved).
22695     * - "scroll,anim,start" - scrolling animation has started.
22696     * - "scroll,anim,stop" - scrolling animation has stopped.
22697     * - "scroll,drag,start" - dragging the contents around has started.
22698     * - "scroll,drag,stop" - dragging the contents around has stopped.
22699     * - "downloaded" - This is called when all currently required map images
22700     *   are downloaded.
22701     * - "route,load" - This is called when route request begins.
22702     * - "route,loaded" - This is called when route request ends.
22703     * - "name,load" - This is called when name request begins.
22704     * - "name,loaded- This is called when name request ends.
22705     *
22706     * Available style for map widget:
22707     * - @c "default"
22708     *
22709     * Available style for markers:
22710     * - @c "radio"
22711     * - @c "radio2"
22712     * - @c "empty"
22713     *
22714     * Available style for marker bubble:
22715     * - @c "default"
22716     *
22717     * List of examples:
22718     * @li @ref map_example_01
22719     * @li @ref map_example_02
22720     * @li @ref map_example_03
22721     */
22722
22723    /**
22724     * @addtogroup Map
22725     * @{
22726     */
22727
22728    /**
22729     * @enum _Elm_Map_Zoom_Mode
22730     * @typedef Elm_Map_Zoom_Mode
22731     *
22732     * Set map's zoom behavior. It can be set to manual or automatic.
22733     *
22734     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22735     *
22736     * Values <b> don't </b> work as bitmask, only one can be choosen.
22737     *
22738     * @note Valid sizes are 2^zoom, consequently the map may be smaller
22739     * than the scroller view.
22740     *
22741     * @see elm_map_zoom_mode_set()
22742     * @see elm_map_zoom_mode_get()
22743     *
22744     * @ingroup Map
22745     */
22746    typedef enum _Elm_Map_Zoom_Mode
22747      {
22748         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controlled manually by elm_map_zoom_set(). It's set by default. */
22749         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22750         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22751         ELM_MAP_ZOOM_MODE_LAST
22752      } Elm_Map_Zoom_Mode;
22753
22754    /**
22755     * @enum _Elm_Map_Route_Sources
22756     * @typedef Elm_Map_Route_Sources
22757     *
22758     * Set route service to be used. By default used source is
22759     * #ELM_MAP_ROUTE_SOURCE_YOURS.
22760     *
22761     * @see elm_map_route_source_set()
22762     * @see elm_map_route_source_get()
22763     *
22764     * @ingroup Map
22765     */
22766    typedef enum _Elm_Map_Route_Sources
22767      {
22768         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22769         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. */
22770         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22771         ELM_MAP_ROUTE_SOURCE_LAST
22772      } Elm_Map_Route_Sources;
22773
22774    typedef enum _Elm_Map_Name_Sources
22775      {
22776         ELM_MAP_NAME_SOURCE_NOMINATIM,
22777         ELM_MAP_NAME_SOURCE_LAST
22778      } Elm_Map_Name_Sources;
22779
22780    /**
22781     * @enum _Elm_Map_Route_Type
22782     * @typedef Elm_Map_Route_Type
22783     *
22784     * Set type of transport used on route.
22785     *
22786     * @see elm_map_route_add()
22787     *
22788     * @ingroup Map
22789     */
22790    typedef enum _Elm_Map_Route_Type
22791      {
22792         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22793         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22794         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22795         ELM_MAP_ROUTE_TYPE_LAST
22796      } Elm_Map_Route_Type;
22797
22798    /**
22799     * @enum _Elm_Map_Route_Method
22800     * @typedef Elm_Map_Route_Method
22801     *
22802     * Set the routing method, what should be priorized, time or distance.
22803     *
22804     * @see elm_map_route_add()
22805     *
22806     * @ingroup Map
22807     */
22808    typedef enum _Elm_Map_Route_Method
22809      {
22810         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22811         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22812         ELM_MAP_ROUTE_METHOD_LAST
22813      } Elm_Map_Route_Method;
22814
22815    typedef enum _Elm_Map_Name_Method
22816      {
22817         ELM_MAP_NAME_METHOD_SEARCH,
22818         ELM_MAP_NAME_METHOD_REVERSE,
22819         ELM_MAP_NAME_METHOD_LAST
22820      } Elm_Map_Name_Method;
22821
22822    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(). */
22823    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(). */
22824    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(). */
22825    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(). */
22826    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
22827    typedef struct _Elm_Map_Track           Elm_Map_Track;
22828
22829    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. */
22830    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22831    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22832    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22833
22834    typedef char        *(*ElmMapModuleSourceFunc) (void);
22835    typedef int          (*ElmMapModuleZoomMinFunc) (void);
22836    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
22837    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22838    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
22839    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22840    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22841    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22842    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22843
22844    /**
22845     * Add a new map widget to the given parent Elementary (container) object.
22846     *
22847     * @param parent The parent object.
22848     * @return a new map widget handle or @c NULL, on errors.
22849     *
22850     * This function inserts a new map widget on the canvas.
22851     *
22852     * @ingroup Map
22853     */
22854    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22855
22856    /**
22857     * Set the zoom level of the map.
22858     *
22859     * @param obj The map object.
22860     * @param zoom The zoom level to set.
22861     *
22862     * This sets the zoom level.
22863     *
22864     * It will respect limits defined by elm_map_source_zoom_min_set() and
22865     * elm_map_source_zoom_max_set().
22866     *
22867     * By default these values are 0 (world map) and 18 (maximum zoom).
22868     *
22869     * This function should be used when zoom mode is set to
22870     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22871     * with elm_map_zoom_mode_set().
22872     *
22873     * @see elm_map_zoom_mode_set().
22874     * @see elm_map_zoom_get().
22875     *
22876     * @ingroup Map
22877     */
22878    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22879
22880    /**
22881     * Get the zoom level of the map.
22882     *
22883     * @param obj The map object.
22884     * @return The current zoom level.
22885     *
22886     * This returns the current zoom level of the map object.
22887     *
22888     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22889     * (which is the default), the zoom level may be changed at any time by the
22890     * map object itself to account for map size and map viewport size.
22891     *
22892     * @see elm_map_zoom_set() for details.
22893     *
22894     * @ingroup Map
22895     */
22896    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22897
22898    /**
22899     * Set the zoom mode used by the map object.
22900     *
22901     * @param obj The map object.
22902     * @param mode The zoom mode of the map, being it one of
22903     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22904     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22905     *
22906     * This sets the zoom mode to manual or one of the automatic levels.
22907     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22908     * elm_map_zoom_set() and will stay at that level until changed by code
22909     * or until zoom mode is changed. This is the default mode.
22910     *
22911     * The Automatic modes will allow the map object to automatically
22912     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22913     * adjust zoom so the map fits inside the scroll frame with no pixels
22914     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22915     * ensure no pixels within the frame are left unfilled. Do not forget that
22916     * the valid sizes are 2^zoom, consequently the map may be smaller than
22917     * the scroller view.
22918     *
22919     * @see elm_map_zoom_set()
22920     *
22921     * @ingroup Map
22922     */
22923    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22924
22925    /**
22926     * Get the zoom mode used by the map object.
22927     *
22928     * @param obj The map object.
22929     * @return The zoom mode of the map, being it one of
22930     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22931     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22932     *
22933     * This function returns the current zoom mode used by the map object.
22934     *
22935     * @see elm_map_zoom_mode_set() for more details.
22936     *
22937     * @ingroup Map
22938     */
22939    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22940
22941    /**
22942     * Get the current coordinates of the map.
22943     *
22944     * @param obj The map object.
22945     * @param lon Pointer where to store longitude.
22946     * @param lat Pointer where to store latitude.
22947     *
22948     * This gets the current center coordinates of the map object. It can be
22949     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22950     *
22951     * @see elm_map_geo_region_bring_in()
22952     * @see elm_map_geo_region_show()
22953     *
22954     * @ingroup Map
22955     */
22956    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22957
22958    /**
22959     * Animatedly bring in given coordinates to the center of the map.
22960     *
22961     * @param obj The map object.
22962     * @param lon Longitude to center at.
22963     * @param lat Latitude to center at.
22964     *
22965     * This causes map to jump to the given @p lat and @p lon coordinates
22966     * and show it (by scrolling) in the center of the viewport, if it is not
22967     * already centered. This will use animation to do so and take a period
22968     * of time to complete.
22969     *
22970     * @see elm_map_geo_region_show() for a function to avoid animation.
22971     * @see elm_map_geo_region_get()
22972     *
22973     * @ingroup Map
22974     */
22975    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22976
22977    /**
22978     * Show the given coordinates at the center of the map, @b immediately.
22979     *
22980     * @param obj The map object.
22981     * @param lon Longitude to center at.
22982     * @param lat Latitude to center at.
22983     *
22984     * This causes map to @b redraw its viewport's contents to the
22985     * region contining the given @p lat and @p lon, that will be moved to the
22986     * center of the map.
22987     *
22988     * @see elm_map_geo_region_bring_in() for a function to move with animation.
22989     * @see elm_map_geo_region_get()
22990     *
22991     * @ingroup Map
22992     */
22993    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22994
22995    /**
22996     * Pause or unpause the map.
22997     *
22998     * @param obj The map object.
22999     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
23000     * to unpause it.
23001     *
23002     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23003     * for map.
23004     *
23005     * The default is off.
23006     *
23007     * This will stop zooming using animation, changing zoom levels will
23008     * change instantly. This will stop any existing animations that are running.
23009     *
23010     * @see elm_map_paused_get()
23011     *
23012     * @ingroup Map
23013     */
23014    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23015
23016    /**
23017     * Get a value whether map is paused or not.
23018     *
23019     * @param obj The map object.
23020     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
23021     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
23022     *
23023     * This gets the current paused state for the map object.
23024     *
23025     * @see elm_map_paused_set() for details.
23026     *
23027     * @ingroup Map
23028     */
23029    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23030
23031    /**
23032     * Set to show markers during zoom level changes or not.
23033     *
23034     * @param obj The map object.
23035     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
23036     * to show them.
23037     *
23038     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23039     * for map.
23040     *
23041     * The default is off.
23042     *
23043     * This will stop zooming using animation, changing zoom levels will
23044     * change instantly. This will stop any existing animations that are running.
23045     *
23046     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23047     * for the markers.
23048     *
23049     * The default  is off.
23050     *
23051     * Enabling it will force the map to stop displaying the markers during
23052     * zoom level changes. Set to on if you have a large number of markers.
23053     *
23054     * @see elm_map_paused_markers_get()
23055     *
23056     * @ingroup Map
23057     */
23058    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23059
23060    /**
23061     * Get a value whether markers will be displayed on zoom level changes or not
23062     *
23063     * @param obj The map object.
23064     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
23065     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
23066     *
23067     * This gets the current markers paused state for the map object.
23068     *
23069     * @see elm_map_paused_markers_set() for details.
23070     *
23071     * @ingroup Map
23072     */
23073    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23074
23075    /**
23076     * Get the information of downloading status.
23077     *
23078     * @param obj The map object.
23079     * @param try_num Pointer where to store number of tiles being downloaded.
23080     * @param finish_num Pointer where to store number of tiles successfully
23081     * downloaded.
23082     *
23083     * This gets the current downloading status for the map object, the number
23084     * of tiles being downloaded and the number of tiles already downloaded.
23085     *
23086     * @ingroup Map
23087     */
23088    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
23089
23090    /**
23091     * Convert a pixel coordinate (x,y) into a geographic coordinate
23092     * (longitude, latitude).
23093     *
23094     * @param obj The map object.
23095     * @param x the coordinate.
23096     * @param y the coordinate.
23097     * @param size the size in pixels of the map.
23098     * The map is a square and generally his size is : pow(2.0, zoom)*256.
23099     * @param lon Pointer where to store the longitude that correspond to x.
23100     * @param lat Pointer where to store the latitude that correspond to y.
23101     *
23102     * @note Origin pixel point is the top left corner of the viewport.
23103     * Map zoom and size are taken on account.
23104     *
23105     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
23106     *
23107     * @ingroup Map
23108     */
23109    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);
23110
23111    /**
23112     * Convert a geographic coordinate (longitude, latitude) into a pixel
23113     * coordinate (x, y).
23114     *
23115     * @param obj The map object.
23116     * @param lon the longitude.
23117     * @param lat the latitude.
23118     * @param size the size in pixels of the map. The map is a square
23119     * and generally his size is : pow(2.0, zoom)*256.
23120     * @param x Pointer where to store the horizontal pixel coordinate that
23121     * correspond to the longitude.
23122     * @param y Pointer where to store the vertical pixel coordinate that
23123     * correspond to the latitude.
23124     *
23125     * @note Origin pixel point is the top left corner of the viewport.
23126     * Map zoom and size are taken on account.
23127     *
23128     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
23129     *
23130     * @ingroup Map
23131     */
23132    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);
23133
23134    /**
23135     * Convert a geographic coordinate (longitude, latitude) into a name
23136     * (address).
23137     *
23138     * @param obj The map object.
23139     * @param lon the longitude.
23140     * @param lat the latitude.
23141     * @return name A #Elm_Map_Name handle for this coordinate.
23142     *
23143     * To get the string for this address, elm_map_name_address_get()
23144     * should be used.
23145     *
23146     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23147     *
23148     * @ingroup Map
23149     */
23150    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23151
23152    /**
23153     * Convert a name (address) into a geographic coordinate
23154     * (longitude, latitude).
23155     *
23156     * @param obj The map object.
23157     * @param name The address.
23158     * @return name A #Elm_Map_Name handle for this address.
23159     *
23160     * To get the longitude and latitude, elm_map_name_region_get()
23161     * should be used.
23162     *
23163     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23164     *
23165     * @ingroup Map
23166     */
23167    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23168
23169    /**
23170     * Convert a pixel coordinate into a rotated pixel coordinate.
23171     *
23172     * @param obj The map object.
23173     * @param x horizontal coordinate of the point to rotate.
23174     * @param y vertical coordinate of the point to rotate.
23175     * @param cx rotation's center horizontal position.
23176     * @param cy rotation's center vertical position.
23177     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23178     * @param xx Pointer where to store rotated x.
23179     * @param yy Pointer where to store rotated y.
23180     *
23181     * @ingroup Map
23182     */
23183    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);
23184
23185    /**
23186     * Add a new marker to the map object.
23187     *
23188     * @param obj The map object.
23189     * @param lon The longitude of the marker.
23190     * @param lat The latitude of the marker.
23191     * @param clas The class, to use when marker @b isn't grouped to others.
23192     * @param clas_group The class group, to use when marker is grouped to others
23193     * @param data The data passed to the callbacks.
23194     *
23195     * @return The created marker or @c NULL upon failure.
23196     *
23197     * A marker will be created and shown in a specific point of the map, defined
23198     * by @p lon and @p lat.
23199     *
23200     * It will be displayed using style defined by @p class when this marker
23201     * is displayed alone (not grouped). A new class can be created with
23202     * elm_map_marker_class_new().
23203     *
23204     * If the marker is grouped to other markers, it will be displayed with
23205     * style defined by @p class_group. Markers with the same group are grouped
23206     * if they are close. A new group class can be created with
23207     * elm_map_marker_group_class_new().
23208     *
23209     * Markers created with this method can be deleted with
23210     * elm_map_marker_remove().
23211     *
23212     * A marker can have associated content to be displayed by a bubble,
23213     * when a user click over it, as well as an icon. These objects will
23214     * be fetch using class' callback functions.
23215     *
23216     * @see elm_map_marker_class_new()
23217     * @see elm_map_marker_group_class_new()
23218     * @see elm_map_marker_remove()
23219     *
23220     * @ingroup Map
23221     */
23222    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);
23223
23224    /**
23225     * Set the maximum numbers of markers' content to be displayed in a group.
23226     *
23227     * @param obj The map object.
23228     * @param max The maximum numbers of items displayed in a bubble.
23229     *
23230     * A bubble will be displayed when the user clicks over the group,
23231     * and will place the content of markers that belong to this group
23232     * inside it.
23233     *
23234     * A group can have a long list of markers, consequently the creation
23235     * of the content of the bubble can be very slow.
23236     *
23237     * In order to avoid this, a maximum number of items is displayed
23238     * in a bubble.
23239     *
23240     * By default this number is 30.
23241     *
23242     * Marker with the same group class are grouped if they are close.
23243     *
23244     * @see elm_map_marker_add()
23245     *
23246     * @ingroup Map
23247     */
23248    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23249
23250    /**
23251     * Remove a marker from the map.
23252     *
23253     * @param marker The marker to remove.
23254     *
23255     * @see elm_map_marker_add()
23256     *
23257     * @ingroup Map
23258     */
23259    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23260
23261    /**
23262     * Get the current coordinates of the marker.
23263     *
23264     * @param marker marker.
23265     * @param lat Pointer where to store the marker's latitude.
23266     * @param lon Pointer where to store the marker's longitude.
23267     *
23268     * These values are set when adding markers, with function
23269     * elm_map_marker_add().
23270     *
23271     * @see elm_map_marker_add()
23272     *
23273     * @ingroup Map
23274     */
23275    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23276
23277    /**
23278     * Animatedly bring in given marker to the center of the map.
23279     *
23280     * @param marker The marker to center at.
23281     *
23282     * This causes map to jump to the given @p marker's coordinates
23283     * and show it (by scrolling) in the center of the viewport, if it is not
23284     * already centered. This will use animation to do so and take a period
23285     * of time to complete.
23286     *
23287     * @see elm_map_marker_show() for a function to avoid animation.
23288     * @see elm_map_marker_region_get()
23289     *
23290     * @ingroup Map
23291     */
23292    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23293
23294    /**
23295     * Show the given marker at the center of the map, @b immediately.
23296     *
23297     * @param marker The marker to center at.
23298     *
23299     * This causes map to @b redraw its viewport's contents to the
23300     * region contining the given @p marker's coordinates, that will be
23301     * moved to the center of the map.
23302     *
23303     * @see elm_map_marker_bring_in() for a function to move with animation.
23304     * @see elm_map_markers_list_show() if more than one marker need to be
23305     * displayed.
23306     * @see elm_map_marker_region_get()
23307     *
23308     * @ingroup Map
23309     */
23310    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23311
23312    /**
23313     * Move and zoom the map to display a list of markers.
23314     *
23315     * @param markers A list of #Elm_Map_Marker handles.
23316     *
23317     * The map will be centered on the center point of the markers in the list.
23318     * Then the map will be zoomed in order to fit the markers using the maximum
23319     * zoom which allows display of all the markers.
23320     *
23321     * @warning All the markers should belong to the same map object.
23322     *
23323     * @see elm_map_marker_show() to show a single marker.
23324     * @see elm_map_marker_bring_in()
23325     *
23326     * @ingroup Map
23327     */
23328    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23329
23330    /**
23331     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23332     *
23333     * @param marker The marker wich content should be returned.
23334     * @return Return the evas object if it exists, else @c NULL.
23335     *
23336     * To set callback function #ElmMapMarkerGetFunc for the marker class,
23337     * elm_map_marker_class_get_cb_set() should be used.
23338     *
23339     * This content is what will be inside the bubble that will be displayed
23340     * when an user clicks over the marker.
23341     *
23342     * This returns the actual Evas object used to be placed inside
23343     * the bubble. This may be @c NULL, as it may
23344     * not have been created or may have been deleted, at any time, by
23345     * the map. <b>Do not modify this object</b> (move, resize,
23346     * show, hide, etc.), as the map is controlling it. This
23347     * function is for querying, emitting custom signals or hooking
23348     * lower level callbacks for events on that object. Do not delete
23349     * this object under any circumstances.
23350     *
23351     * @ingroup Map
23352     */
23353    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23354
23355    /**
23356     * Update the marker
23357     *
23358     * @param marker The marker to be updated.
23359     *
23360     * If a content is set to this marker, it will call function to delete it,
23361     * #ElmMapMarkerDelFunc, and then will fetch the content again with
23362     * #ElmMapMarkerGetFunc.
23363     *
23364     * These functions are set for the marker class with
23365     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23366     *
23367     * @ingroup Map
23368     */
23369    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23370
23371    /**
23372     * Close all the bubbles opened by the user.
23373     *
23374     * @param obj The map object.
23375     *
23376     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23377     * when the user clicks on a marker.
23378     *
23379     * This functions is set for the marker class with
23380     * elm_map_marker_class_get_cb_set().
23381     *
23382     * @ingroup Map
23383     */
23384    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23385
23386    /**
23387     * Create a new group class.
23388     *
23389     * @param obj The map object.
23390     * @return Returns the new group class.
23391     *
23392     * Each marker must be associated to a group class. Markers in the same
23393     * group are grouped if they are close.
23394     *
23395     * The group class defines the style of the marker when a marker is grouped
23396     * to others markers. When it is alone, another class will be used.
23397     *
23398     * A group class will need to be provided when creating a marker with
23399     * elm_map_marker_add().
23400     *
23401     * Some properties and functions can be set by class, as:
23402     * - style, with elm_map_group_class_style_set()
23403     * - data - to be associated to the group class. It can be set using
23404     *   elm_map_group_class_data_set().
23405     * - min zoom to display markers, set with
23406     *   elm_map_group_class_zoom_displayed_set().
23407     * - max zoom to group markers, set using
23408     *   elm_map_group_class_zoom_grouped_set().
23409     * - visibility - set if markers will be visible or not, set with
23410     *   elm_map_group_class_hide_set().
23411     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23412     *   It can be set using elm_map_group_class_icon_cb_set().
23413     *
23414     * @see elm_map_marker_add()
23415     * @see elm_map_group_class_style_set()
23416     * @see elm_map_group_class_data_set()
23417     * @see elm_map_group_class_zoom_displayed_set()
23418     * @see elm_map_group_class_zoom_grouped_set()
23419     * @see elm_map_group_class_hide_set()
23420     * @see elm_map_group_class_icon_cb_set()
23421     *
23422     * @ingroup Map
23423     */
23424    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23425
23426    /**
23427     * Set the marker's style of a group class.
23428     *
23429     * @param clas The group class.
23430     * @param style The style to be used by markers.
23431     *
23432     * Each marker must be associated to a group class, and will use the style
23433     * defined by such class when grouped to other markers.
23434     *
23435     * The following styles are provided by default theme:
23436     * @li @c radio - blue circle
23437     * @li @c radio2 - green circle
23438     * @li @c empty
23439     *
23440     * @see elm_map_group_class_new() for more details.
23441     * @see elm_map_marker_add()
23442     *
23443     * @ingroup Map
23444     */
23445    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23446
23447    /**
23448     * Set the icon callback function of a group class.
23449     *
23450     * @param clas The group class.
23451     * @param icon_get The callback function that will return the icon.
23452     *
23453     * Each marker must be associated to a group class, and it can display a
23454     * custom icon. The function @p icon_get must return this icon.
23455     *
23456     * @see elm_map_group_class_new() for more details.
23457     * @see elm_map_marker_add()
23458     *
23459     * @ingroup Map
23460     */
23461    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23462
23463    /**
23464     * Set the data associated to the group class.
23465     *
23466     * @param clas The group class.
23467     * @param data The new user data.
23468     *
23469     * This data will be passed for callback functions, like icon get callback,
23470     * that can be set with elm_map_group_class_icon_cb_set().
23471     *
23472     * If a data was previously set, the object will lose the pointer for it,
23473     * so if needs to be freed, you must do it yourself.
23474     *
23475     * @see elm_map_group_class_new() for more details.
23476     * @see elm_map_group_class_icon_cb_set()
23477     * @see elm_map_marker_add()
23478     *
23479     * @ingroup Map
23480     */
23481    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23482
23483    /**
23484     * Set the minimum zoom from where the markers are displayed.
23485     *
23486     * @param clas The group class.
23487     * @param zoom The minimum zoom.
23488     *
23489     * Markers only will be displayed when the map is displayed at @p zoom
23490     * or bigger.
23491     *
23492     * @see elm_map_group_class_new() for more details.
23493     * @see elm_map_marker_add()
23494     *
23495     * @ingroup Map
23496     */
23497    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23498
23499    /**
23500     * Set the zoom from where the markers are no more grouped.
23501     *
23502     * @param clas The group class.
23503     * @param zoom The maximum zoom.
23504     *
23505     * Markers only will be grouped when the map is displayed at
23506     * less than @p zoom.
23507     *
23508     * @see elm_map_group_class_new() for more details.
23509     * @see elm_map_marker_add()
23510     *
23511     * @ingroup Map
23512     */
23513    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23514
23515    /**
23516     * Set if the markers associated to the group class @clas are hidden or not.
23517     *
23518     * @param clas The group class.
23519     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23520     * to show them.
23521     *
23522     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23523     * is to show them.
23524     *
23525     * @ingroup Map
23526     */
23527    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23528
23529    /**
23530     * Create a new marker class.
23531     *
23532     * @param obj The map object.
23533     * @return Returns the new group class.
23534     *
23535     * Each marker must be associated to a class.
23536     *
23537     * The marker class defines the style of the marker when a marker is
23538     * displayed alone, i.e., not grouped to to others markers. When grouped
23539     * it will use group class style.
23540     *
23541     * A marker class will need to be provided when creating a marker with
23542     * elm_map_marker_add().
23543     *
23544     * Some properties and functions can be set by class, as:
23545     * - style, with elm_map_marker_class_style_set()
23546     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23547     *   It can be set using elm_map_marker_class_icon_cb_set().
23548     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23549     *   Set using elm_map_marker_class_get_cb_set().
23550     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23551     *   Set using elm_map_marker_class_del_cb_set().
23552     *
23553     * @see elm_map_marker_add()
23554     * @see elm_map_marker_class_style_set()
23555     * @see elm_map_marker_class_icon_cb_set()
23556     * @see elm_map_marker_class_get_cb_set()
23557     * @see elm_map_marker_class_del_cb_set()
23558     *
23559     * @ingroup Map
23560     */
23561    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23562
23563    /**
23564     * Set the marker's style of a marker class.
23565     *
23566     * @param clas The marker class.
23567     * @param style The style to be used by markers.
23568     *
23569     * Each marker must be associated to a marker class, and will use the style
23570     * defined by such class when alone, i.e., @b not grouped to other markers.
23571     *
23572     * The following styles are provided by default theme:
23573     * @li @c radio
23574     * @li @c radio2
23575     * @li @c empty
23576     *
23577     * @see elm_map_marker_class_new() for more details.
23578     * @see elm_map_marker_add()
23579     *
23580     * @ingroup Map
23581     */
23582    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23583
23584    /**
23585     * Set the icon callback function of a marker class.
23586     *
23587     * @param clas The marker class.
23588     * @param icon_get The callback function that will return the icon.
23589     *
23590     * Each marker must be associated to a marker class, and it can display a
23591     * custom icon. The function @p icon_get must return this icon.
23592     *
23593     * @see elm_map_marker_class_new() for more details.
23594     * @see elm_map_marker_add()
23595     *
23596     * @ingroup Map
23597     */
23598    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23599
23600    /**
23601     * Set the bubble content callback function of a marker class.
23602     *
23603     * @param clas The marker class.
23604     * @param get The callback function that will return the content.
23605     *
23606     * Each marker must be associated to a marker class, and it can display a
23607     * a content on a bubble that opens when the user click over the marker.
23608     * The function @p get must return this content object.
23609     *
23610     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23611     * can be used.
23612     *
23613     * @see elm_map_marker_class_new() for more details.
23614     * @see elm_map_marker_class_del_cb_set()
23615     * @see elm_map_marker_add()
23616     *
23617     * @ingroup Map
23618     */
23619    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23620
23621    /**
23622     * Set the callback function used to delete bubble content of a marker class.
23623     *
23624     * @param clas The marker class.
23625     * @param del The callback function that will delete the content.
23626     *
23627     * Each marker must be associated to a marker class, and it can display a
23628     * a content on a bubble that opens when the user click over the marker.
23629     * The function to return such content can be set with
23630     * elm_map_marker_class_get_cb_set().
23631     *
23632     * If this content must be freed, a callback function need to be
23633     * set for that task with this function.
23634     *
23635     * If this callback is defined it will have to delete (or not) the
23636     * object inside, but if the callback is not defined the object will be
23637     * destroyed with evas_object_del().
23638     *
23639     * @see elm_map_marker_class_new() for more details.
23640     * @see elm_map_marker_class_get_cb_set()
23641     * @see elm_map_marker_add()
23642     *
23643     * @ingroup Map
23644     */
23645    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23646
23647    /**
23648     * Get the list of available sources.
23649     *
23650     * @param obj The map object.
23651     * @return The source names list.
23652     *
23653     * It will provide a list with all available sources, that can be set as
23654     * current source with elm_map_source_name_set(), or get with
23655     * elm_map_source_name_get().
23656     *
23657     * Available sources:
23658     * @li "Mapnik"
23659     * @li "Osmarender"
23660     * @li "CycleMap"
23661     * @li "Maplint"
23662     *
23663     * @see elm_map_source_name_set() for more details.
23664     * @see elm_map_source_name_get()
23665     *
23666     * @ingroup Map
23667     */
23668    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23669
23670    /**
23671     * Set the source of the map.
23672     *
23673     * @param obj The map object.
23674     * @param source The source to be used.
23675     *
23676     * Map widget retrieves images that composes the map from a web service.
23677     * This web service can be set with this method.
23678     *
23679     * A different service can return a different maps with different
23680     * information and it can use different zoom values.
23681     *
23682     * The @p source_name need to match one of the names provided by
23683     * elm_map_source_names_get().
23684     *
23685     * The current source can be get using elm_map_source_name_get().
23686     *
23687     * @see elm_map_source_names_get()
23688     * @see elm_map_source_name_get()
23689     *
23690     *
23691     * @ingroup Map
23692     */
23693    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23694
23695    /**
23696     * Get the name of currently used source.
23697     *
23698     * @param obj The map object.
23699     * @return Returns the name of the source in use.
23700     *
23701     * @see elm_map_source_name_set() for more details.
23702     *
23703     * @ingroup Map
23704     */
23705    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23706
23707    /**
23708     * Set the source of the route service to be used by the map.
23709     *
23710     * @param obj The map object.
23711     * @param source The route service to be used, being it one of
23712     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23713     * and #ELM_MAP_ROUTE_SOURCE_ORS.
23714     *
23715     * Each one has its own algorithm, so the route retrieved may
23716     * differ depending on the source route. Now, only the default is working.
23717     *
23718     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23719     * http://www.yournavigation.org/.
23720     *
23721     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23722     * assumptions. Its routing core is based on Contraction Hierarchies.
23723     *
23724     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23725     *
23726     * @see elm_map_route_source_get().
23727     *
23728     * @ingroup Map
23729     */
23730    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23731
23732    /**
23733     * Get the current route source.
23734     *
23735     * @param obj The map object.
23736     * @return The source of the route service used by the map.
23737     *
23738     * @see elm_map_route_source_set() for details.
23739     *
23740     * @ingroup Map
23741     */
23742    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23743
23744    /**
23745     * Set the minimum zoom of the source.
23746     *
23747     * @param obj The map object.
23748     * @param zoom New minimum zoom value to be used.
23749     *
23750     * By default, it's 0.
23751     *
23752     * @ingroup Map
23753     */
23754    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23755
23756    /**
23757     * Get the minimum zoom of the source.
23758     *
23759     * @param obj The map object.
23760     * @return Returns the minimum zoom of the source.
23761     *
23762     * @see elm_map_source_zoom_min_set() for details.
23763     *
23764     * @ingroup Map
23765     */
23766    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23767
23768    /**
23769     * Set the maximum zoom of the source.
23770     *
23771     * @param obj The map object.
23772     * @param zoom New maximum zoom value to be used.
23773     *
23774     * By default, it's 18.
23775     *
23776     * @ingroup Map
23777     */
23778    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23779
23780    /**
23781     * Get the maximum zoom of the source.
23782     *
23783     * @param obj The map object.
23784     * @return Returns the maximum zoom of the source.
23785     *
23786     * @see elm_map_source_zoom_min_set() for details.
23787     *
23788     * @ingroup Map
23789     */
23790    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23791
23792    /**
23793     * Set the user agent used by the map object to access routing services.
23794     *
23795     * @param obj The map object.
23796     * @param user_agent The user agent to be used by the map.
23797     *
23798     * User agent is a client application implementing a network protocol used
23799     * in communications within a clientā€“server distributed computing system
23800     *
23801     * The @p user_agent identification string will transmitted in a header
23802     * field @c User-Agent.
23803     *
23804     * @see elm_map_user_agent_get()
23805     *
23806     * @ingroup Map
23807     */
23808    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23809
23810    /**
23811     * Get the user agent used by the map object.
23812     *
23813     * @param obj The map object.
23814     * @return The user agent identification string used by the map.
23815     *
23816     * @see elm_map_user_agent_set() for details.
23817     *
23818     * @ingroup Map
23819     */
23820    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23821
23822    /**
23823     * Add a new route to the map object.
23824     *
23825     * @param obj The map object.
23826     * @param type The type of transport to be considered when tracing a route.
23827     * @param method The routing method, what should be priorized.
23828     * @param flon The start longitude.
23829     * @param flat The start latitude.
23830     * @param tlon The destination longitude.
23831     * @param tlat The destination latitude.
23832     *
23833     * @return The created route or @c NULL upon failure.
23834     *
23835     * A route will be traced by point on coordinates (@p flat, @p flon)
23836     * to point on coordinates (@p tlat, @p tlon), using the route service
23837     * set with elm_map_route_source_set().
23838     *
23839     * It will take @p type on consideration to define the route,
23840     * depending if the user will be walking or driving, the route may vary.
23841     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23842     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23843     *
23844     * Another parameter is what the route should priorize, the minor distance
23845     * or the less time to be spend on the route. So @p method should be one
23846     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23847     *
23848     * Routes created with this method can be deleted with
23849     * elm_map_route_remove(), colored with elm_map_route_color_set(),
23850     * and distance can be get with elm_map_route_distance_get().
23851     *
23852     * @see elm_map_route_remove()
23853     * @see elm_map_route_color_set()
23854     * @see elm_map_route_distance_get()
23855     * @see elm_map_route_source_set()
23856     *
23857     * @ingroup Map
23858     */
23859    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);
23860
23861    /**
23862     * Remove a route from the map.
23863     *
23864     * @param route The route to remove.
23865     *
23866     * @see elm_map_route_add()
23867     *
23868     * @ingroup Map
23869     */
23870    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23871
23872    /**
23873     * Set the route color.
23874     *
23875     * @param route The route object.
23876     * @param r Red channel value, from 0 to 255.
23877     * @param g Green channel value, from 0 to 255.
23878     * @param b Blue channel value, from 0 to 255.
23879     * @param a Alpha channel value, from 0 to 255.
23880     *
23881     * It uses an additive color model, so each color channel represents
23882     * how much of each primary colors must to be used. 0 represents
23883     * ausence of this color, so if all of the three are set to 0,
23884     * the color will be black.
23885     *
23886     * These component values should be integers in the range 0 to 255,
23887     * (single 8-bit byte).
23888     *
23889     * This sets the color used for the route. By default, it is set to
23890     * solid red (r = 255, g = 0, b = 0, a = 255).
23891     *
23892     * For alpha channel, 0 represents completely transparent, and 255, opaque.
23893     *
23894     * @see elm_map_route_color_get()
23895     *
23896     * @ingroup Map
23897     */
23898    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23899
23900    /**
23901     * Get the route color.
23902     *
23903     * @param route The route object.
23904     * @param r Pointer where to store the red channel value.
23905     * @param g Pointer where to store the green channel value.
23906     * @param b Pointer where to store the blue channel value.
23907     * @param a Pointer where to store the alpha channel value.
23908     *
23909     * @see elm_map_route_color_set() for details.
23910     *
23911     * @ingroup Map
23912     */
23913    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23914
23915    /**
23916     * Get the route distance in kilometers.
23917     *
23918     * @param route The route object.
23919     * @return The distance of route (unit : km).
23920     *
23921     * @ingroup Map
23922     */
23923    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23924
23925    /**
23926     * Get the information of route nodes.
23927     *
23928     * @param route The route object.
23929     * @return Returns a string with the nodes of route.
23930     *
23931     * @ingroup Map
23932     */
23933    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23934
23935    /**
23936     * Get the information of route waypoint.
23937     *
23938     * @param route the route object.
23939     * @return Returns a string with information about waypoint of route.
23940     *
23941     * @ingroup Map
23942     */
23943    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23944
23945    /**
23946     * Get the address of the name.
23947     *
23948     * @param name The name handle.
23949     * @return Returns the address string of @p name.
23950     *
23951     * This gets the coordinates of the @p name, created with one of the
23952     * conversion functions.
23953     *
23954     * @see elm_map_utils_convert_name_into_coord()
23955     * @see elm_map_utils_convert_coord_into_name()
23956     *
23957     * @ingroup Map
23958     */
23959    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23960
23961    /**
23962     * Get the current coordinates of the name.
23963     *
23964     * @param name The name handle.
23965     * @param lat Pointer where to store the latitude.
23966     * @param lon Pointer where to store The longitude.
23967     *
23968     * This gets the coordinates of the @p name, created with one of the
23969     * conversion functions.
23970     *
23971     * @see elm_map_utils_convert_name_into_coord()
23972     * @see elm_map_utils_convert_coord_into_name()
23973     *
23974     * @ingroup Map
23975     */
23976    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23977
23978    /**
23979     * Remove a name from the map.
23980     *
23981     * @param name The name to remove.
23982     *
23983     * Basically the struct handled by @p name will be freed, so convertions
23984     * between address and coordinates will be lost.
23985     *
23986     * @see elm_map_utils_convert_name_into_coord()
23987     * @see elm_map_utils_convert_coord_into_name()
23988     *
23989     * @ingroup Map
23990     */
23991    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23992
23993    /**
23994     * Rotate the map.
23995     *
23996     * @param obj The map object.
23997     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23998     * @param cx Rotation's center horizontal position.
23999     * @param cy Rotation's center vertical position.
24000     *
24001     * @see elm_map_rotate_get()
24002     *
24003     * @ingroup Map
24004     */
24005    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
24006
24007    /**
24008     * Get the rotate degree of the map
24009     *
24010     * @param obj The map object
24011     * @param degree Pointer where to store degrees from 0.0 to 360.0
24012     * to rotate arount Z axis.
24013     * @param cx Pointer where to store rotation's center horizontal position.
24014     * @param cy Pointer where to store rotation's center vertical position.
24015     *
24016     * @see elm_map_rotate_set() to set map rotation.
24017     *
24018     * @ingroup Map
24019     */
24020    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);
24021
24022    /**
24023     * Enable or disable mouse wheel to be used to zoom in / out the map.
24024     *
24025     * @param obj The map object.
24026     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
24027     * to enable it.
24028     *
24029     * Mouse wheel can be used for the user to zoom in or zoom out the map.
24030     *
24031     * It's disabled by default.
24032     *
24033     * @see elm_map_wheel_disabled_get()
24034     *
24035     * @ingroup Map
24036     */
24037    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24038
24039    /**
24040     * Get a value whether mouse wheel is enabled or not.
24041     *
24042     * @param obj The map object.
24043     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
24044     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24045     *
24046     * Mouse wheel can be used for the user to zoom in or zoom out the map.
24047     *
24048     * @see elm_map_wheel_disabled_set() for details.
24049     *
24050     * @ingroup Map
24051     */
24052    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24053
24054 #ifdef ELM_EMAP
24055    /**
24056     * Add a track on the map
24057     *
24058     * @param obj The map object.
24059     * @param emap The emap route object.
24060     * @return The route object. This is an elm object of type Route.
24061     *
24062     * @see elm_route_add() for details.
24063     *
24064     * @ingroup Map
24065     */
24066    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
24067 #endif
24068
24069    /**
24070     * Remove a track from the map
24071     *
24072     * @param obj The map object.
24073     * @param route The track to remove.
24074     *
24075     * @ingroup Map
24076     */
24077    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
24078
24079    /**
24080     * @}
24081     */
24082
24083    /* Route */
24084    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
24085 #ifdef ELM_EMAP
24086    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
24087 #endif
24088    EAPI double elm_route_lon_min_get(Evas_Object *obj);
24089    EAPI double elm_route_lat_min_get(Evas_Object *obj);
24090    EAPI double elm_route_lon_max_get(Evas_Object *obj);
24091    EAPI double elm_route_lat_max_get(Evas_Object *obj);
24092
24093
24094    /**
24095     * @defgroup Panel Panel
24096     *
24097     * @image html img/widget/panel/preview-00.png
24098     * @image latex img/widget/panel/preview-00.eps
24099     *
24100     * @brief A panel is a type of animated container that contains subobjects.
24101     * It can be expanded or contracted by clicking the button on it's edge.
24102     *
24103     * Orientations are as follows:
24104     * @li ELM_PANEL_ORIENT_TOP
24105     * @li ELM_PANEL_ORIENT_LEFT
24106     * @li ELM_PANEL_ORIENT_RIGHT
24107     *
24108     * Default contents parts of the panel widget that you can use for are:
24109     * @li "default" - A content of the panel
24110     *
24111     * @ref tutorial_panel shows one way to use this widget.
24112     * @{
24113     */
24114    typedef enum _Elm_Panel_Orient
24115      {
24116         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
24117         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
24118         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
24119         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
24120      } Elm_Panel_Orient;
24121    /**
24122     * @brief Adds a panel object
24123     *
24124     * @param parent The parent object
24125     *
24126     * @return The panel object, or NULL on failure
24127     */
24128    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24129    /**
24130     * @brief Sets the orientation of the panel
24131     *
24132     * @param parent The parent object
24133     * @param orient The panel orientation. Can be one of the following:
24134     * @li ELM_PANEL_ORIENT_TOP
24135     * @li ELM_PANEL_ORIENT_LEFT
24136     * @li ELM_PANEL_ORIENT_RIGHT
24137     *
24138     * Sets from where the panel will (dis)appear.
24139     */
24140    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24141    /**
24142     * @brief Get the orientation of the panel.
24143     *
24144     * @param obj The panel object
24145     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24146     */
24147    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24148    /**
24149     * @brief Set the content of the panel.
24150     *
24151     * @param obj The panel object
24152     * @param content The panel content
24153     *
24154     * Once the content object is set, a previously set one will be deleted.
24155     * If you want to keep that old content object, use the
24156     * elm_panel_content_unset() function.
24157     *
24158     * @deprecated use elm_object_content_set() instead
24159     *
24160     */
24161    EINA_DEPRECATED EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24162    /**
24163     * @brief Get the content of the panel.
24164     *
24165     * @param obj The panel object
24166     * @return The content that is being used
24167     *
24168     * Return the content object which is set for this widget.
24169     *
24170     * @see elm_panel_content_set()
24171     *
24172     * @deprecated use elm_object_content_get() instead
24173     *
24174     */
24175    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24176    /**
24177     * @brief Unset the content of the panel.
24178     *
24179     * @param obj The panel object
24180     * @return The content that was being used
24181     *
24182     * Unparent and return the content object which was set for this widget.
24183     *
24184     * @see elm_panel_content_set()
24185     *
24186     * @deprecated use elm_object_content_unset() instead
24187     *
24188     */
24189    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24190    /**
24191     * @brief Set the state of the panel.
24192     *
24193     * @param obj The panel object
24194     * @param hidden If true, the panel will run the animation to contract
24195     */
24196    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24197    /**
24198     * @brief Get the state of the panel.
24199     *
24200     * @param obj The panel object
24201     * @param hidden If true, the panel is in the "hide" state
24202     */
24203    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24204    /**
24205     * @brief Toggle the hidden state of the panel from code
24206     *
24207     * @param obj The panel object
24208     */
24209    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24210    /**
24211     * @}
24212     */
24213
24214    /**
24215     * @defgroup Panes Panes
24216     * @ingroup Elementary
24217     *
24218     * @image html img/widget/panes/preview-00.png
24219     * @image latex img/widget/panes/preview-00.eps width=\textwidth
24220     *
24221     * @image html img/panes.png
24222     * @image latex img/panes.eps width=\textwidth
24223     *
24224     * The panes adds a dragable bar between two contents. When dragged
24225     * this bar will resize contents size.
24226     *
24227     * Panes can be displayed vertically or horizontally, and contents
24228     * size proportion can be customized (homogeneous by default).
24229     *
24230     * Smart callbacks one can listen to:
24231     * - "press" - The panes has been pressed (button wasn't released yet).
24232     * - "unpressed" - The panes was released after being pressed.
24233     * - "clicked" - The panes has been clicked>
24234     * - "clicked,double" - The panes has been double clicked
24235     *
24236     * Available styles for it:
24237     * - @c "default"
24238     *
24239     * Default contents parts of the panes widget that you can use for are:
24240     * @li "left" - A leftside content of the panes
24241     * @li "right" - A rightside content of the panes
24242     *
24243     * If panes is displayed vertically, left content will be displayed at
24244     * top.
24245     *
24246     * Here is an example on its usage:
24247     * @li @ref panes_example
24248     */
24249
24250    /**
24251     * @addtogroup Panes
24252     * @{
24253     */
24254
24255    /**
24256     * Add a new panes widget to the given parent Elementary
24257     * (container) object.
24258     *
24259     * @param parent The parent object.
24260     * @return a new panes widget handle or @c NULL, on errors.
24261     *
24262     * This function inserts a new panes widget on the canvas.
24263     *
24264     * @ingroup Panes
24265     */
24266    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24267
24268    /**
24269     * Set the left content of the panes widget.
24270     *
24271     * @param obj The panes object.
24272     * @param content The new left content object.
24273     *
24274     * Once the content object is set, a previously set one will be deleted.
24275     * If you want to keep that old content object, use the
24276     * elm_panes_content_left_unset() function.
24277     *
24278     * If panes is displayed vertically, left content will be displayed at
24279     * top.
24280     *
24281     * @see elm_panes_content_left_get()
24282     * @see elm_panes_content_right_set() to set content on the other side.
24283     *
24284     * @deprecated use elm_object_part_content_set() instead
24285     *
24286     * @ingroup Panes
24287     */
24288    EINA_DEPRECATED EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24289
24290    /**
24291     * Set the right content of the panes widget.
24292     *
24293     * @param obj The panes object.
24294     * @param content The new right content object.
24295     *
24296     * Once the content object is set, a previously set one will be deleted.
24297     * If you want to keep that old content object, use the
24298     * elm_panes_content_right_unset() function.
24299     *
24300     * If panes is displayed vertically, left content will be displayed at
24301     * bottom.
24302     *
24303     * @see elm_panes_content_right_get()
24304     * @see elm_panes_content_left_set() to set content on the other side.
24305     *
24306     * @deprecated use elm_object_part_content_set() instead
24307     *
24308     * @ingroup Panes
24309     */
24310    EINA_DEPRECATED EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24311
24312    /**
24313     * Get the left content of the panes.
24314     *
24315     * @param obj The panes object.
24316     * @return The left content object that is being used.
24317     *
24318     * Return the left content object which is set for this widget.
24319     *
24320     * @see elm_panes_content_left_set() for details.
24321     *
24322     * @deprecated use elm_object_part_content_get() instead
24323     *
24324     * @ingroup Panes
24325     */
24326    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24327
24328    /**
24329     * Get the right content of the panes.
24330     *
24331     * @param obj The panes object
24332     * @return The right content object that is being used
24333     *
24334     * Return the right content object which is set for this widget.
24335     *
24336     * @see elm_panes_content_right_set() for details.
24337     *
24338     * @deprecated use elm_object_part_content_get() instead
24339     *
24340     * @ingroup Panes
24341     */
24342    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24343
24344    /**
24345     * Unset the left content used for the panes.
24346     *
24347     * @param obj The panes object.
24348     * @return The left content object that was being used.
24349     *
24350     * Unparent and return the left content object which was set for this widget.
24351     *
24352     * @see elm_panes_content_left_set() for details.
24353     * @see elm_panes_content_left_get().
24354     *
24355     * @deprecated use elm_object_part_content_unset() instead
24356     *
24357     * @ingroup Panes
24358     */
24359    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24360
24361    /**
24362     * Unset the right content used for the panes.
24363     *
24364     * @param obj The panes object.
24365     * @return The right content object that was being used.
24366     *
24367     * Unparent and return the right content object which was set for this
24368     * widget.
24369     *
24370     * @see elm_panes_content_right_set() for details.
24371     * @see elm_panes_content_right_get().
24372     *
24373     * @deprecated use elm_object_part_content_unset() instead
24374     *
24375     * @ingroup Panes
24376     */
24377    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24378
24379    /**
24380     * Get the size proportion of panes widget's left side.
24381     *
24382     * @param obj The panes object.
24383     * @return float value between 0.0 and 1.0 representing size proportion
24384     * of left side.
24385     *
24386     * @see elm_panes_content_left_size_set() for more details.
24387     *
24388     * @ingroup Panes
24389     */
24390    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24391
24392    /**
24393     * Set the size proportion of panes widget's left side.
24394     *
24395     * @param obj The panes object.
24396     * @param size Value between 0.0 and 1.0 representing size proportion
24397     * of left side.
24398     *
24399     * By default it's homogeneous, i.e., both sides have the same size.
24400     *
24401     * If something different is required, it can be set with this function.
24402     * For example, if the left content should be displayed over
24403     * 75% of the panes size, @p size should be passed as @c 0.75.
24404     * This way, right content will be resized to 25% of panes size.
24405     *
24406     * If displayed vertically, left content is displayed at top, and
24407     * right content at bottom.
24408     *
24409     * @note This proportion will change when user drags the panes bar.
24410     *
24411     * @see elm_panes_content_left_size_get()
24412     *
24413     * @ingroup Panes
24414     */
24415    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24416
24417   /**
24418    * Set the orientation of a given panes widget.
24419    *
24420    * @param obj The panes object.
24421    * @param horizontal Use @c EINA_TRUE to make @p obj to be
24422    * @b horizontal, @c EINA_FALSE to make it @b vertical.
24423    *
24424    * Use this function to change how your panes is to be
24425    * disposed: vertically or horizontally.
24426    *
24427    * By default it's displayed horizontally.
24428    *
24429    * @see elm_panes_horizontal_get()
24430    *
24431    * @ingroup Panes
24432    */
24433    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24434
24435    /**
24436     * Retrieve the orientation of a given panes widget.
24437     *
24438     * @param obj The panes object.
24439     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24440     * @c EINA_FALSE if it's @b vertical (and on errors).
24441     *
24442     * @see elm_panes_horizontal_set() for more details.
24443     *
24444     * @ingroup Panes
24445     */
24446    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24447    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24448    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24449
24450    /**
24451     * @}
24452     */
24453
24454    /**
24455     * @defgroup Flip Flip
24456     *
24457     * @image html img/widget/flip/preview-00.png
24458     * @image latex img/widget/flip/preview-00.eps
24459     *
24460     * This widget holds 2 content objects(Evas_Object): one on the front and one
24461     * on the back. It allows you to flip from front to back and vice-versa using
24462     * various animations.
24463     *
24464     * If either the front or back contents are not set the flip will treat that
24465     * as transparent. So if you wore to set the front content but not the back,
24466     * and then call elm_flip_go() you would see whatever is below the flip.
24467     *
24468     * For a list of supported animations see elm_flip_go().
24469     *
24470     * Signals that you can add callbacks for are:
24471     * "animate,begin" - when a flip animation was started
24472     * "animate,done" - when a flip animation is finished
24473     *
24474     * @ref tutorial_flip show how to use most of the API.
24475     *
24476     * @{
24477     */
24478    typedef enum _Elm_Flip_Mode
24479      {
24480         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24481         ELM_FLIP_ROTATE_X_CENTER_AXIS,
24482         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24483         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24484         ELM_FLIP_CUBE_LEFT,
24485         ELM_FLIP_CUBE_RIGHT,
24486         ELM_FLIP_CUBE_UP,
24487         ELM_FLIP_CUBE_DOWN,
24488         ELM_FLIP_PAGE_LEFT,
24489         ELM_FLIP_PAGE_RIGHT,
24490         ELM_FLIP_PAGE_UP,
24491         ELM_FLIP_PAGE_DOWN
24492      } Elm_Flip_Mode;
24493    typedef enum _Elm_Flip_Interaction
24494      {
24495         ELM_FLIP_INTERACTION_NONE,
24496         ELM_FLIP_INTERACTION_ROTATE,
24497         ELM_FLIP_INTERACTION_CUBE,
24498         ELM_FLIP_INTERACTION_PAGE
24499      } Elm_Flip_Interaction;
24500    typedef enum _Elm_Flip_Direction
24501      {
24502         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24503         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24504         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24505         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24506      } Elm_Flip_Direction;
24507    /**
24508     * @brief Add a new flip to the parent
24509     *
24510     * @param parent The parent object
24511     * @return The new object or NULL if it cannot be created
24512     */
24513    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24514    /**
24515     * @brief Set the front content of the flip widget.
24516     *
24517     * @param obj The flip object
24518     * @param content The new front content object
24519     *
24520     * Once the content object is set, a previously set one will be deleted.
24521     * If you want to keep that old content object, use the
24522     * elm_flip_content_front_unset() function.
24523     */
24524    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24525    /**
24526     * @brief Set the back content of the flip widget.
24527     *
24528     * @param obj The flip object
24529     * @param content The new back content object
24530     *
24531     * Once the content object is set, a previously set one will be deleted.
24532     * If you want to keep that old content object, use the
24533     * elm_flip_content_back_unset() function.
24534     */
24535    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24536    /**
24537     * @brief Get the front content used for the flip
24538     *
24539     * @param obj The flip object
24540     * @return The front content object that is being used
24541     *
24542     * Return the front content object which is set for this widget.
24543     */
24544    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24545    /**
24546     * @brief Get the back content used for the flip
24547     *
24548     * @param obj The flip object
24549     * @return The back content object that is being used
24550     *
24551     * Return the back content object which is set for this widget.
24552     */
24553    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24554    /**
24555     * @brief Unset the front content used for the flip
24556     *
24557     * @param obj The flip object
24558     * @return The front content object that was being used
24559     *
24560     * Unparent and return the front content object which was set for this widget.
24561     */
24562    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24563    /**
24564     * @brief Unset the back content used for the flip
24565     *
24566     * @param obj The flip object
24567     * @return The back content object that was being used
24568     *
24569     * Unparent and return the back content object which was set for this widget.
24570     */
24571    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24572    /**
24573     * @brief Get flip front visibility state
24574     *
24575     * @param obj The flip objct
24576     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24577     * showing.
24578     */
24579    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24580    /**
24581     * @brief Set flip perspective
24582     *
24583     * @param obj The flip object
24584     * @param foc The coordinate to set the focus on
24585     * @param x The X coordinate
24586     * @param y The Y coordinate
24587     *
24588     * @warning This function currently does nothing.
24589     */
24590    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24591    /**
24592     * @brief Runs the flip animation
24593     *
24594     * @param obj The flip object
24595     * @param mode The mode type
24596     *
24597     * Flips the front and back contents using the @p mode animation. This
24598     * efectively hides the currently visible content and shows the hidden one.
24599     *
24600     * There a number of possible animations to use for the flipping:
24601     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24602     * around a horizontal axis in the middle of its height, the other content
24603     * is shown as the other side of the flip.
24604     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24605     * around a vertical axis in the middle of its width, the other content is
24606     * shown as the other side of the flip.
24607     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24608     * around a diagonal axis in the middle of its width, the other content is
24609     * shown as the other side of the flip.
24610     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24611     * around a diagonal axis in the middle of its height, the other content is
24612     * shown as the other side of the flip.
24613     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24614     * as if the flip was a cube, the other content is show as the right face of
24615     * the cube.
24616     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24617     * right as if the flip was a cube, the other content is show as the left
24618     * face of the cube.
24619     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24620     * flip was a cube, the other content is show as the bottom face of the cube.
24621     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24622     * the flip was a cube, the other content is show as the upper face of the
24623     * cube.
24624     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24625     * if the flip was a book, the other content is shown as the page below that.
24626     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24627     * as if the flip was a book, the other content is shown as the page below
24628     * that.
24629     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24630     * flip was a book, the other content is shown as the page below that.
24631     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24632     * flip was a book, the other content is shown as the page below that.
24633     *
24634     * @image html elm_flip.png
24635     * @image latex elm_flip.eps width=\textwidth
24636     */
24637    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24638    /**
24639     * @brief Set the interactive flip mode
24640     *
24641     * @param obj The flip object
24642     * @param mode The interactive flip mode to use
24643     *
24644     * This sets if the flip should be interactive (allow user to click and
24645     * drag a side of the flip to reveal the back page and cause it to flip).
24646     * By default a flip is not interactive. You may also need to set which
24647     * sides of the flip are "active" for flipping and how much space they use
24648     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24649     * and elm_flip_interacton_direction_hitsize_set()
24650     *
24651     * The four avilable mode of interaction are:
24652     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24653     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24654     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24655     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24656     *
24657     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24658     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24659     * happen, those can only be acheived with elm_flip_go();
24660     */
24661    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24662    /**
24663     * @brief Get the interactive flip mode
24664     *
24665     * @param obj The flip object
24666     * @return The interactive flip mode
24667     *
24668     * Returns the interactive flip mode set by elm_flip_interaction_set()
24669     */
24670    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24671    /**
24672     * @brief Set which directions of the flip respond to interactive flip
24673     *
24674     * @param obj The flip object
24675     * @param dir The direction to change
24676     * @param enabled If that direction is enabled or not
24677     *
24678     * By default all directions are disabled, so you may want to enable the
24679     * desired directions for flipping if you need interactive flipping. You must
24680     * call this function once for each direction that should be enabled.
24681     *
24682     * @see elm_flip_interaction_set()
24683     */
24684    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24685    /**
24686     * @brief Get the enabled state of that flip direction
24687     *
24688     * @param obj The flip object
24689     * @param dir The direction to check
24690     * @return If that direction is enabled or not
24691     *
24692     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24693     *
24694     * @see elm_flip_interaction_set()
24695     */
24696    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24697    /**
24698     * @brief Set the amount of the flip that is sensitive to interactive flip
24699     *
24700     * @param obj The flip object
24701     * @param dir The direction to modify
24702     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24703     *
24704     * Set the amount of the flip that is sensitive to interactive flip, with 0
24705     * representing no area in the flip and 1 representing the entire flip. There
24706     * is however a consideration to be made in that the area will never be
24707     * smaller than the finger size set(as set in your Elementary configuration).
24708     *
24709     * @see elm_flip_interaction_set()
24710     */
24711    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24712    /**
24713     * @brief Get the amount of the flip that is sensitive to interactive flip
24714     *
24715     * @param obj The flip object
24716     * @param dir The direction to check
24717     * @return The size set for that direction
24718     *
24719     * Returns the amount os sensitive area set by
24720     * elm_flip_interacton_direction_hitsize_set().
24721     */
24722    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24723    /**
24724     * @}
24725     */
24726
24727    /* scrolledentry */
24728    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24729    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24730    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24731    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24732    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24733    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24734    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24735    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24736    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24737    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24738    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24739    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24740    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24741    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24742    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24743    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24744    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24745    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24746    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24747    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24748    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24749    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24750    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24751    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24752    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24753    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24754    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24755    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24756    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24757    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24758    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24759    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24760    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24761    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24762    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24763    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);
24764    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24765    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24766    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);
24767    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24768    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);
24769    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24770    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24771    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24772    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24773    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24774    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24775    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24776    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24777    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);
24778    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);
24779    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);
24780    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);
24781    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);
24782    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);
24783    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24784    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24785    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24786    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24787    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24788    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24789    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24790
24791    /**
24792     * @defgroup Conformant Conformant
24793     * @ingroup Elementary
24794     *
24795     * @image html img/widget/conformant/preview-00.png
24796     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24797     *
24798     * @image html img/conformant.png
24799     * @image latex img/conformant.eps width=\textwidth
24800     *
24801     * The aim is to provide a widget that can be used in elementary apps to
24802     * account for space taken up by the indicator, virtual keypad & softkey
24803     * windows when running the illume2 module of E17.
24804     *
24805     * So conformant content will be sized and positioned considering the
24806     * space required for such stuff, and when they popup, as a keyboard
24807     * shows when an entry is selected, conformant content won't change.
24808     *
24809     * Available styles for it:
24810     * - @c "default"
24811     *
24812     * Default contents parts of the conformant widget that you can use for are:
24813     * @li "default" - A content of the conformant
24814     *
24815     * See how to use this widget in this example:
24816     * @ref conformant_example
24817     */
24818
24819    /**
24820     * @addtogroup Conformant
24821     * @{
24822     */
24823
24824    /**
24825     * Add a new conformant widget to the given parent Elementary
24826     * (container) object.
24827     *
24828     * @param parent The parent object.
24829     * @return A new conformant widget handle or @c NULL, on errors.
24830     *
24831     * This function inserts a new conformant widget on the canvas.
24832     *
24833     * @ingroup Conformant
24834     */
24835    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24836
24837    /**
24838     * Set the content of the conformant widget.
24839     *
24840     * @param obj The conformant object.
24841     * @param content The content to be displayed by the conformant.
24842     *
24843     * Content will be sized and positioned considering the space required
24844     * to display a virtual keyboard. So it won't fill all the conformant
24845     * size. This way is possible to be sure that content won't resize
24846     * or be re-positioned after the keyboard is displayed.
24847     *
24848     * Once the content object is set, a previously set one will be deleted.
24849     * If you want to keep that old content object, use the
24850     * elm_object_content_unset() function.
24851     *
24852     * @see elm_object_content_unset()
24853     * @see elm_object_content_get()
24854     *
24855     * @deprecated use elm_object_content_set() instead
24856     *
24857     * @ingroup Conformant
24858     */
24859    EINA_DEPRECATED EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24860
24861    /**
24862     * Get the content of the conformant widget.
24863     *
24864     * @param obj The conformant object.
24865     * @return The content that is being used.
24866     *
24867     * Return the content object which is set for this widget.
24868     * It won't be unparent from conformant. For that, use
24869     * elm_object_content_unset().
24870     *
24871     * @see elm_object_content_set().
24872     * @see elm_object_content_unset()
24873     *
24874     * @deprecated use elm_object_content_get() instead
24875     *
24876     * @ingroup Conformant
24877     */
24878    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24879
24880    /**
24881     * Unset the content of the conformant widget.
24882     *
24883     * @param obj The conformant object.
24884     * @return The content that was being used.
24885     *
24886     * Unparent and return the content object which was set for this widget.
24887     *
24888     * @see elm_object_content_set().
24889     *
24890     * @deprecated use elm_object_content_unset() instead
24891     *
24892     * @ingroup Conformant
24893     */
24894    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24895
24896    /**
24897     * Returns the Evas_Object that represents the content area.
24898     *
24899     * @param obj The conformant object.
24900     * @return The content area of the widget.
24901     *
24902     * @ingroup Conformant
24903     */
24904    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24905
24906    /**
24907     * @}
24908     */
24909
24910    /**
24911     * @defgroup Mapbuf Mapbuf
24912     * @ingroup Elementary
24913     *
24914     * @image html img/widget/mapbuf/preview-00.png
24915     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24916     *
24917     * This holds one content object and uses an Evas Map of transformation
24918     * points to be later used with this content. So the content will be
24919     * moved, resized, etc as a single image. So it will improve performance
24920     * when you have a complex interafce, with a lot of elements, and will
24921     * need to resize or move it frequently (the content object and its
24922     * children).
24923     *
24924     * Default contents parts of the mapbuf widget that you can use for are:
24925     * @li "default" - A content of the mapbuf
24926     *
24927     * To enable map, elm_mapbuf_enabled_set() should be used.
24928     *
24929     * See how to use this widget in this example:
24930     * @ref mapbuf_example
24931     */
24932
24933    /**
24934     * @addtogroup Mapbuf
24935     * @{
24936     */
24937
24938    /**
24939     * Add a new mapbuf widget to the given parent Elementary
24940     * (container) object.
24941     *
24942     * @param parent The parent object.
24943     * @return A new mapbuf widget handle or @c NULL, on errors.
24944     *
24945     * This function inserts a new mapbuf widget on the canvas.
24946     *
24947     * @ingroup Mapbuf
24948     */
24949    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24950
24951    /**
24952     * Set the content of the mapbuf.
24953     *
24954     * @param obj The mapbuf object.
24955     * @param content The content that will be filled in this mapbuf object.
24956     *
24957     * Once the content object is set, a previously set one will be deleted.
24958     * If you want to keep that old content object, use the
24959     * elm_mapbuf_content_unset() function.
24960     *
24961     * To enable map, elm_mapbuf_enabled_set() should be used.
24962     *
24963     * @deprecated use elm_object_content_set() instead
24964     *
24965     * @ingroup Mapbuf
24966     */
24967    EINA_DEPRECATED EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24968
24969    /**
24970     * Get the content of the mapbuf.
24971     *
24972     * @param obj The mapbuf object.
24973     * @return The content that is being used.
24974     *
24975     * Return the content object which is set for this widget.
24976     *
24977     * @see elm_mapbuf_content_set() for details.
24978     *
24979     * @deprecated use elm_object_content_get() instead
24980     *
24981     * @ingroup Mapbuf
24982     */
24983    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24984
24985    /**
24986     * Unset the content of the mapbuf.
24987     *
24988     * @param obj The mapbuf object.
24989     * @return The content that was being used.
24990     *
24991     * Unparent and return the content object which was set for this widget.
24992     *
24993     * @see elm_mapbuf_content_set() for details.
24994     *
24995     * @deprecated use elm_object_content_unset() instead
24996     *
24997     * @ingroup Mapbuf
24998     */
24999    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25000
25001    /**
25002     * Enable or disable the map.
25003     *
25004     * @param obj The mapbuf object.
25005     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
25006     *
25007     * This enables the map that is set or disables it. On enable, the object
25008     * geometry will be saved, and the new geometry will change (position and
25009     * size) to reflect the map geometry set.
25010     *
25011     * Also, when enabled, alpha and smooth states will be used, so if the
25012     * content isn't solid, alpha should be enabled, for example, otherwise
25013     * a black retangle will fill the content.
25014     *
25015     * When disabled, the stored map will be freed and geometry prior to
25016     * enabling the map will be restored.
25017     *
25018     * It's disabled by default.
25019     *
25020     * @see elm_mapbuf_alpha_set()
25021     * @see elm_mapbuf_smooth_set()
25022     *
25023     * @ingroup Mapbuf
25024     */
25025    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25026
25027    /**
25028     * Get a value whether map is enabled or not.
25029     *
25030     * @param obj The mapbuf object.
25031     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
25032     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25033     *
25034     * @see elm_mapbuf_enabled_set() for details.
25035     *
25036     * @ingroup Mapbuf
25037     */
25038    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25039
25040    /**
25041     * Enable or disable smooth map rendering.
25042     *
25043     * @param obj The mapbuf object.
25044     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
25045     * to disable it.
25046     *
25047     * This sets smoothing for map rendering. If the object is a type that has
25048     * its own smoothing settings, then both the smooth settings for this object
25049     * and the map must be turned off.
25050     *
25051     * By default smooth maps are enabled.
25052     *
25053     * @ingroup Mapbuf
25054     */
25055    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
25056
25057    /**
25058     * Get a value whether smooth map rendering is enabled or not.
25059     *
25060     * @param obj The mapbuf object.
25061     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
25062     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25063     *
25064     * @see elm_mapbuf_smooth_set() for details.
25065     *
25066     * @ingroup Mapbuf
25067     */
25068    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25069
25070    /**
25071     * Set or unset alpha flag for map rendering.
25072     *
25073     * @param obj The mapbuf object.
25074     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
25075     * to disable it.
25076     *
25077     * This sets alpha flag for map rendering. If the object is a type that has
25078     * its own alpha settings, then this will take precedence. Only image objects
25079     * have this currently. It stops alpha blending of the map area, and is
25080     * useful if you know the object and/or all sub-objects is 100% solid.
25081     *
25082     * Alpha is enabled by default.
25083     *
25084     * @ingroup Mapbuf
25085     */
25086    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
25087
25088    /**
25089     * Get a value whether alpha blending is enabled or not.
25090     *
25091     * @param obj The mapbuf object.
25092     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
25093     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25094     *
25095     * @see elm_mapbuf_alpha_set() for details.
25096     *
25097     * @ingroup Mapbuf
25098     */
25099    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25100
25101    /**
25102     * @}
25103     */
25104
25105    /**
25106     * @defgroup Flipselector Flip Selector
25107     *
25108     * @image html img/widget/flipselector/preview-00.png
25109     * @image latex img/widget/flipselector/preview-00.eps
25110     *
25111     * A flip selector is a widget to show a set of @b text items, one
25112     * at a time, with the same sheet switching style as the @ref Clock
25113     * "clock" widget, when one changes the current displaying sheet
25114     * (thus, the "flip" in the name).
25115     *
25116     * User clicks to flip sheets which are @b held for some time will
25117     * make the flip selector to flip continuosly and automatically for
25118     * the user. The interval between flips will keep growing in time,
25119     * so that it helps the user to reach an item which is distant from
25120     * the current selection.
25121     *
25122     * Smart callbacks one can register to:
25123     * - @c "selected" - when the widget's selected text item is changed
25124     * - @c "overflowed" - when the widget's current selection is changed
25125     *   from the first item in its list to the last
25126     * - @c "underflowed" - when the widget's current selection is changed
25127     *   from the last item in its list to the first
25128     *
25129     * Available styles for it:
25130     * - @c "default"
25131     *
25132          * To set/get the label of the flipselector item, you can use
25133          * elm_object_item_text_set/get APIs.
25134          * Once the text is set, a previously set one will be deleted.
25135          *
25136     * Here is an example on its usage:
25137     * @li @ref flipselector_example
25138     */
25139
25140    /**
25141     * @addtogroup Flipselector
25142     * @{
25143     */
25144
25145    /**
25146     * Add a new flip selector widget to the given parent Elementary
25147     * (container) widget
25148     *
25149     * @param parent The parent object
25150     * @return a new flip selector widget handle or @c NULL, on errors
25151     *
25152     * This function inserts a new flip selector widget on the canvas.
25153     *
25154     * @ingroup Flipselector
25155     */
25156    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25157
25158    /**
25159     * Programmatically select the next item of a flip selector widget
25160     *
25161     * @param obj The flipselector object
25162     *
25163     * @note The selection will be animated. Also, if it reaches the
25164     * end of its list of member items, it will continue with the first
25165     * one onwards.
25166     *
25167     * @ingroup Flipselector
25168     */
25169    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25170
25171    /**
25172     * Programmatically select the previous item of a flip selector
25173     * widget
25174     *
25175     * @param obj The flipselector object
25176     *
25177     * @note The selection will be animated.  Also, if it reaches the
25178     * beginning of its list of member items, it will continue with the
25179     * last one backwards.
25180     *
25181     * @ingroup Flipselector
25182     */
25183    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25184
25185    /**
25186     * Append a (text) item to a flip selector widget
25187     *
25188     * @param obj The flipselector object
25189     * @param label The (text) label of the new item
25190     * @param func Convenience callback function to take place when
25191     * item is selected
25192     * @param data Data passed to @p func, above
25193     * @return A handle to the item added or @c NULL, on errors
25194     *
25195     * The widget's list of labels to show will be appended with the
25196     * given value. If the user wishes so, a callback function pointer
25197     * can be passed, which will get called when this same item is
25198     * selected.
25199     *
25200     * @note The current selection @b won't be modified by appending an
25201     * element to the list.
25202     *
25203     * @note The maximum length of the text label is going to be
25204     * determined <b>by the widget's theme</b>. Strings larger than
25205     * that value are going to be @b truncated.
25206     *
25207     * @ingroup Flipselector
25208     */
25209    EAPI Elm_Object_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25210
25211    /**
25212     * Prepend a (text) item to a flip selector widget
25213     *
25214     * @param obj The flipselector object
25215     * @param label The (text) label of the new item
25216     * @param func Convenience callback function to take place when
25217     * item is selected
25218     * @param data Data passed to @p func, above
25219     * @return A handle to the item added or @c NULL, on errors
25220     *
25221     * The widget's list of labels to show will be prepended with the
25222     * given value. If the user wishes so, a callback function pointer
25223     * can be passed, which will get called when this same item is
25224     * selected.
25225     *
25226     * @note The current selection @b won't be modified by prepending
25227     * an element to the list.
25228     *
25229     * @note The maximum length of the text label is going to be
25230     * determined <b>by the widget's theme</b>. Strings larger than
25231     * that value are going to be @b truncated.
25232     *
25233     * @ingroup Flipselector
25234     */
25235    EAPI Elm_Object_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25236
25237    /**
25238     * Get the internal list of items in a given flip selector widget.
25239     *
25240     * @param obj The flipselector object
25241     * @return The list of items (#Elm_Object_Item as data) or
25242     * @c NULL on errors.
25243     *
25244     * This list is @b not to be modified in any way and must not be
25245     * freed. Use the list members with functions like
25246     * elm_object_item_text_set(),
25247     * elm_object_item_text_get(),
25248     * elm_flipselector_item_del(),
25249     * elm_flipselector_item_selected_get(),
25250     * elm_flipselector_item_selected_set().
25251     *
25252     * @warning This list is only valid until @p obj object's internal
25253     * items list is changed. It should be fetched again with another
25254     * call to this function when changes happen.
25255     *
25256     * @ingroup Flipselector
25257     */
25258    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25259
25260    /**
25261     * Get the first item in the given flip selector widget's list of
25262     * items.
25263     *
25264     * @param obj The flipselector object
25265     * @return The first item or @c NULL, if it has no items (and on
25266     * errors)
25267     *
25268     * @see elm_flipselector_item_append()
25269     * @see elm_flipselector_last_item_get()
25270     *
25271     * @ingroup Flipselector
25272     */
25273    EAPI Elm_Object_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25274
25275    /**
25276     * Get the last item in the given flip selector widget's list of
25277     * items.
25278     *
25279     * @param obj The flipselector object
25280     * @return The last item or @c NULL, if it has no items (and on
25281     * errors)
25282     *
25283     * @see elm_flipselector_item_prepend()
25284     * @see elm_flipselector_first_item_get()
25285     *
25286     * @ingroup Flipselector
25287     */
25288    EAPI Elm_Object_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25289
25290    /**
25291     * Get the currently selected item in a flip selector widget.
25292     *
25293     * @param obj The flipselector object
25294     * @return The selected item or @c NULL, if the widget has no items
25295     * (and on erros)
25296     *
25297     * @ingroup Flipselector
25298     */
25299    EAPI Elm_Object_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25300
25301    /**
25302     * Set whether a given flip selector widget's item should be the
25303     * currently selected one.
25304     *
25305     * @param it The flip selector item
25306     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25307     *
25308     * This sets whether @p item is or not the selected (thus, under
25309     * display) one. If @p item is different than one under display,
25310     * the latter will be unselected. If the @p item is set to be
25311     * unselected, on the other hand, the @b first item in the widget's
25312     * internal members list will be the new selected one.
25313     *
25314     * @see elm_flipselector_item_selected_get()
25315     *
25316     * @ingroup Flipselector
25317     */
25318    EAPI void                       elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25319
25320    /**
25321     * Get whether a given flip selector widget's item is the currently
25322     * selected one.
25323     *
25324     * @param it The flip selector item
25325     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25326     * (or on errors).
25327     *
25328     * @see elm_flipselector_item_selected_set()
25329     *
25330     * @ingroup Flipselector
25331     */
25332    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25333
25334    /**
25335     * Delete a given item from a flip selector widget.
25336     *
25337     * @param it The item to delete
25338     *
25339     * @ingroup Flipselector
25340     */
25341    EAPI void                       elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25342
25343    /**
25344     * Get the label of a given flip selector widget's item.
25345     *
25346     * @param it The item to get label from
25347     * @return The text label of @p item or @c NULL, on errors
25348     *
25349     * @see elm_object_item_text_set()
25350     *
25351     * @deprecated see elm_object_item_text_get() instead
25352     * @ingroup Flipselector
25353     */
25354    EINA_DEPRECATED EAPI const char                *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25355
25356    /**
25357     * Set the label of a given flip selector widget's item.
25358     *
25359     * @param it The item to set label on
25360     * @param label The text label string, in UTF-8 encoding
25361     *
25362     * @see elm_object_item_text_get()
25363     *
25364          * @deprecated see elm_object_item_text_set() instead
25365     * @ingroup Flipselector
25366     */
25367    EINA_DEPRECATED EAPI void                       elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25368
25369    /**
25370     * Gets the item before @p item in a flip selector widget's
25371     * internal list of items.
25372     *
25373     * @param it The item to fetch previous from
25374     * @return The item before the @p item, in its parent's list. If
25375     *         there is no previous item for @p item or there's an
25376     *         error, @c NULL is returned.
25377     *
25378     * @see elm_flipselector_item_next_get()
25379     *
25380     * @ingroup Flipselector
25381     */
25382    EAPI Elm_Object_Item     *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25383
25384    /**
25385     * Gets the item after @p item in a flip selector widget's
25386     * internal list of items.
25387     *
25388     * @param it The item to fetch next from
25389     * @return The item after the @p item, in its parent's list. If
25390     *         there is no next item for @p item or there's an
25391     *         error, @c NULL is returned.
25392     *
25393     * @see elm_flipselector_item_next_get()
25394     *
25395     * @ingroup Flipselector
25396     */
25397    EAPI Elm_Object_Item     *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25398
25399    /**
25400     * Set the interval on time updates for an user mouse button hold
25401     * on a flip selector widget.
25402     *
25403     * @param obj The flip selector object
25404     * @param interval The (first) interval value in seconds
25405     *
25406     * This interval value is @b decreased while the user holds the
25407     * mouse pointer either flipping up or flipping doww a given flip
25408     * selector.
25409     *
25410     * This helps the user to get to a given item distant from the
25411     * current one easier/faster, as it will start to flip quicker and
25412     * quicker on mouse button holds.
25413     *
25414     * The calculation for the next flip interval value, starting from
25415     * the one set with this call, is the previous interval divided by
25416     * 1.05, so it decreases a little bit.
25417     *
25418     * The default starting interval value for automatic flips is
25419     * @b 0.85 seconds.
25420     *
25421     * @see elm_flipselector_interval_get()
25422     *
25423     * @ingroup Flipselector
25424     */
25425    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25426
25427    /**
25428     * Get the interval on time updates for an user mouse button hold
25429     * on a flip selector widget.
25430     *
25431     * @param obj The flip selector object
25432     * @return The (first) interval value, in seconds, set on it
25433     *
25434     * @see elm_flipselector_interval_set() for more details
25435     *
25436     * @ingroup Flipselector
25437     */
25438    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25439    /**
25440     * @}
25441     */
25442
25443    /**
25444     * @addtogroup Calendar
25445     * @{
25446     */
25447
25448    /**
25449     * @enum _Elm_Calendar_Mark_Repeat
25450     * @typedef Elm_Calendar_Mark_Repeat
25451     *
25452     * Event periodicity, used to define if a mark should be repeated
25453     * @b beyond event's day. It's set when a mark is added.
25454     *
25455     * So, for a mark added to 13th May with periodicity set to WEEKLY,
25456     * there will be marks every week after this date. Marks will be displayed
25457     * at 13th, 20th, 27th, 3rd June ...
25458     *
25459     * Values don't work as bitmask, only one can be choosen.
25460     *
25461     * @see elm_calendar_mark_add()
25462     *
25463     * @ingroup Calendar
25464     */
25465    typedef enum _Elm_Calendar_Mark_Repeat
25466      {
25467         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25468         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25469         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25470         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*/
25471         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. */
25472      } Elm_Calendar_Mark_Repeat;
25473
25474    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(). */
25475
25476    /**
25477     * Add a new calendar widget to the given parent Elementary
25478     * (container) object.
25479     *
25480     * @param parent The parent object.
25481     * @return a new calendar widget handle or @c NULL, on errors.
25482     *
25483     * This function inserts a new calendar widget on the canvas.
25484     *
25485     * @ref calendar_example_01
25486     *
25487     * @ingroup Calendar
25488     */
25489    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25490
25491    /**
25492     * Get weekdays names displayed by the calendar.
25493     *
25494     * @param obj The calendar object.
25495     * @return Array of seven strings to be used as weekday names.
25496     *
25497     * By default, weekdays abbreviations get from system are displayed:
25498     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25499     * The first string is related to Sunday, the second to Monday...
25500     *
25501     * @see elm_calendar_weekdays_name_set()
25502     *
25503     * @ref calendar_example_05
25504     *
25505     * @ingroup Calendar
25506     */
25507    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25508
25509    /**
25510     * Set weekdays names to be displayed by the calendar.
25511     *
25512     * @param obj The calendar object.
25513     * @param weekdays Array of seven strings to be used as weekday names.
25514     * @warning It must have 7 elements, or it will access invalid memory.
25515     * @warning The strings must be NULL terminated ('@\0').
25516     *
25517     * By default, weekdays abbreviations get from system are displayed:
25518     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25519     *
25520     * The first string should be related to Sunday, the second to Monday...
25521     *
25522     * The usage should be like this:
25523     * @code
25524     *   const char *weekdays[] =
25525     *   {
25526     *      "Sunday", "Monday", "Tuesday", "Wednesday",
25527     *      "Thursday", "Friday", "Saturday"
25528     *   };
25529     *   elm_calendar_weekdays_names_set(calendar, weekdays);
25530     * @endcode
25531     *
25532     * @see elm_calendar_weekdays_name_get()
25533     *
25534     * @ref calendar_example_02
25535     *
25536     * @ingroup Calendar
25537     */
25538    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25539
25540    /**
25541     * Set the minimum and maximum values for the year
25542     *
25543     * @param obj The calendar object
25544     * @param min The minimum year, greater than 1901;
25545     * @param max The maximum year;
25546     *
25547     * Maximum must be greater than minimum, except if you don't wan't to set
25548     * maximum year.
25549     * Default values are 1902 and -1.
25550     *
25551     * If the maximum year is a negative value, it will be limited depending
25552     * on the platform architecture (year 2037 for 32 bits);
25553     *
25554     * @see elm_calendar_min_max_year_get()
25555     *
25556     * @ref calendar_example_03
25557     *
25558     * @ingroup Calendar
25559     */
25560    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25561
25562    /**
25563     * Get the minimum and maximum values for the year
25564     *
25565     * @param obj The calendar object.
25566     * @param min The minimum year.
25567     * @param max The maximum year.
25568     *
25569     * Default values are 1902 and -1.
25570     *
25571     * @see elm_calendar_min_max_year_get() for more details.
25572     *
25573     * @ref calendar_example_05
25574     *
25575     * @ingroup Calendar
25576     */
25577    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25578
25579    /**
25580     * Enable or disable day selection
25581     *
25582     * @param obj The calendar object.
25583     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25584     * disable it.
25585     *
25586     * Enabled by default. If disabled, the user still can select months,
25587     * but not days. Selected days are highlighted on calendar.
25588     * It should be used if you won't need such selection for the widget usage.
25589     *
25590     * When a day is selected, or month is changed, smart callbacks for
25591     * signal "changed" will be called.
25592     *
25593     * @see elm_calendar_day_selection_enable_get()
25594     *
25595     * @ref calendar_example_04
25596     *
25597     * @ingroup Calendar
25598     */
25599    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25600
25601    /**
25602     * Get a value whether day selection is enabled or not.
25603     *
25604     * @see elm_calendar_day_selection_enable_set() for details.
25605     *
25606     * @param obj The calendar object.
25607     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25608     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25609     *
25610     * @ref calendar_example_05
25611     *
25612     * @ingroup Calendar
25613     */
25614    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25615
25616
25617    /**
25618     * Set selected date to be highlighted on calendar.
25619     *
25620     * @param obj The calendar object.
25621     * @param selected_time A @b tm struct to represent the selected date.
25622     *
25623     * Set the selected date, changing the displayed month if needed.
25624     * Selected date changes when the user goes to next/previous month or
25625     * select a day pressing over it on calendar.
25626     *
25627     * @see elm_calendar_selected_time_get()
25628     *
25629     * @ref calendar_example_04
25630     *
25631     * @ingroup Calendar
25632     */
25633    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25634
25635    /**
25636     * Get selected date.
25637     *
25638     * @param obj The calendar object
25639     * @param selected_time A @b tm struct to point to selected date
25640     * @return EINA_FALSE means an error ocurred and returned time shouldn't
25641     * be considered.
25642     *
25643     * Get date selected by the user or set by function
25644     * elm_calendar_selected_time_set().
25645     * Selected date changes when the user goes to next/previous month or
25646     * select a day pressing over it on calendar.
25647     *
25648     * @see elm_calendar_selected_time_get()
25649     *
25650     * @ref calendar_example_05
25651     *
25652     * @ingroup Calendar
25653     */
25654    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25655
25656    /**
25657     * Set a function to format the string that will be used to display
25658     * month and year;
25659     *
25660     * @param obj The calendar object
25661     * @param format_function Function to set the month-year string given
25662     * the selected date
25663     *
25664     * By default it uses strftime with "%B %Y" format string.
25665     * It should allocate the memory that will be used by the string,
25666     * that will be freed by the widget after usage.
25667     * A pointer to the string and a pointer to the time struct will be provided.
25668     *
25669     * Example:
25670     * @code
25671     * static char *
25672     * _format_month_year(struct tm *selected_time)
25673     * {
25674     *    char buf[32];
25675     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25676     *    return strdup(buf);
25677     * }
25678     *
25679     * elm_calendar_format_function_set(calendar, _format_month_year);
25680     * @endcode
25681     *
25682     * @ref calendar_example_02
25683     *
25684     * @ingroup Calendar
25685     */
25686    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25687
25688    /**
25689     * Add a new mark to the calendar
25690     *
25691     * @param obj The calendar object
25692     * @param mark_type A string used to define the type of mark. It will be
25693     * emitted to the theme, that should display a related modification on these
25694     * days representation.
25695     * @param mark_time A time struct to represent the date of inclusion of the
25696     * mark. For marks that repeats it will just be displayed after the inclusion
25697     * date in the calendar.
25698     * @param repeat Repeat the event following this periodicity. Can be a unique
25699     * mark (that don't repeat), daily, weekly, monthly or annually.
25700     * @return The created mark or @p NULL upon failure.
25701     *
25702     * Add a mark that will be drawn in the calendar respecting the insertion
25703     * time and periodicity. It will emit the type as signal to the widget theme.
25704     * Default theme supports "holiday" and "checked", but it can be extended.
25705     *
25706     * It won't immediately update the calendar, drawing the marks.
25707     * For this, call elm_calendar_marks_draw(). However, when user selects
25708     * next or previous month calendar forces marks drawn.
25709     *
25710     * Marks created with this method can be deleted with
25711     * elm_calendar_mark_del().
25712     *
25713     * Example
25714     * @code
25715     * struct tm selected_time;
25716     * time_t current_time;
25717     *
25718     * current_time = time(NULL) + 5 * 84600;
25719     * localtime_r(&current_time, &selected_time);
25720     * elm_calendar_mark_add(cal, "holiday", selected_time,
25721     *     ELM_CALENDAR_ANNUALLY);
25722     *
25723     * current_time = time(NULL) + 1 * 84600;
25724     * localtime_r(&current_time, &selected_time);
25725     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25726     *
25727     * elm_calendar_marks_draw(cal);
25728     * @endcode
25729     *
25730     * @see elm_calendar_marks_draw()
25731     * @see elm_calendar_mark_del()
25732     *
25733     * @ref calendar_example_06
25734     *
25735     * @ingroup Calendar
25736     */
25737    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);
25738
25739    /**
25740     * Delete mark from the calendar.
25741     *
25742     * @param mark The mark to be deleted.
25743     *
25744     * If deleting all calendar marks is required, elm_calendar_marks_clear()
25745     * should be used instead of getting marks list and deleting each one.
25746     *
25747     * @see elm_calendar_mark_add()
25748     *
25749     * @ref calendar_example_06
25750     *
25751     * @ingroup Calendar
25752     */
25753    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25754
25755    /**
25756     * Remove all calendar's marks
25757     *
25758     * @param obj The calendar object.
25759     *
25760     * @see elm_calendar_mark_add()
25761     * @see elm_calendar_mark_del()
25762     *
25763     * @ingroup Calendar
25764     */
25765    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25766
25767
25768    /**
25769     * Get a list of all the calendar marks.
25770     *
25771     * @param obj The calendar object.
25772     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25773     *
25774     * @see elm_calendar_mark_add()
25775     * @see elm_calendar_mark_del()
25776     * @see elm_calendar_marks_clear()
25777     *
25778     * @ingroup Calendar
25779     */
25780    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25781
25782    /**
25783     * Draw calendar marks.
25784     *
25785     * @param obj The calendar object.
25786     *
25787     * Should be used after adding, removing or clearing marks.
25788     * It will go through the entire marks list updating the calendar.
25789     * If lots of marks will be added, add all the marks and then call
25790     * this function.
25791     *
25792     * When the month is changed, i.e. user selects next or previous month,
25793     * marks will be drawed.
25794     *
25795     * @see elm_calendar_mark_add()
25796     * @see elm_calendar_mark_del()
25797     * @see elm_calendar_marks_clear()
25798     *
25799     * @ref calendar_example_06
25800     *
25801     * @ingroup Calendar
25802     */
25803    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25804
25805    /**
25806     * Set a day text color to the same that represents Saturdays.
25807     *
25808     * @param obj The calendar object.
25809     * @param pos The text position. Position is the cell counter, from left
25810     * to right, up to down. It starts on 0 and ends on 41.
25811     *
25812     * @deprecated use elm_calendar_mark_add() instead like:
25813     *
25814     * @code
25815     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25816     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25817     * @endcode
25818     *
25819     * @see elm_calendar_mark_add()
25820     *
25821     * @ingroup Calendar
25822     */
25823    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25824
25825    /**
25826     * Set a day text color to the same that represents Sundays.
25827     *
25828     * @param obj The calendar object.
25829     * @param pos The text position. Position is the cell counter, from left
25830     * to right, up to down. It starts on 0 and ends on 41.
25831
25832     * @deprecated use elm_calendar_mark_add() instead like:
25833     *
25834     * @code
25835     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25836     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25837     * @endcode
25838     *
25839     * @see elm_calendar_mark_add()
25840     *
25841     * @ingroup Calendar
25842     */
25843    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25844
25845    /**
25846     * Set a day text color to the same that represents Weekdays.
25847     *
25848     * @param obj The calendar object
25849     * @param pos The text position. Position is the cell counter, from left
25850     * to right, up to down. It starts on 0 and ends on 41.
25851     *
25852     * @deprecated use elm_calendar_mark_add() instead like:
25853     *
25854     * @code
25855     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25856     *
25857     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25858     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25859     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25860     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25861     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25862     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25863     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25864     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25865     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25866     * @endcode
25867     *
25868     * @see elm_calendar_mark_add()
25869     *
25870     * @ingroup Calendar
25871     */
25872    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25873
25874    /**
25875     * Set the interval on time updates for an user mouse button hold
25876     * on calendar widgets' month selection.
25877     *
25878     * @param obj The calendar object
25879     * @param interval The (first) interval value in seconds
25880     *
25881     * This interval value is @b decreased while the user holds the
25882     * mouse pointer either selecting next or previous month.
25883     *
25884     * This helps the user to get to a given month distant from the
25885     * current one easier/faster, as it will start to change quicker and
25886     * quicker on mouse button holds.
25887     *
25888     * The calculation for the next change interval value, starting from
25889     * the one set with this call, is the previous interval divided by
25890     * 1.05, so it decreases a little bit.
25891     *
25892     * The default starting interval value for automatic changes is
25893     * @b 0.85 seconds.
25894     *
25895     * @see elm_calendar_interval_get()
25896     *
25897     * @ingroup Calendar
25898     */
25899    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25900
25901    /**
25902     * Get the interval on time updates for an user mouse button hold
25903     * on calendar widgets' month selection.
25904     *
25905     * @param obj The calendar object
25906     * @return The (first) interval value, in seconds, set on it
25907     *
25908     * @see elm_calendar_interval_set() for more details
25909     *
25910     * @ingroup Calendar
25911     */
25912    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25913
25914    /**
25915     * @}
25916     */
25917
25918    /**
25919     * @defgroup Diskselector Diskselector
25920     * @ingroup Elementary
25921     *
25922     * @image html img/widget/diskselector/preview-00.png
25923     * @image latex img/widget/diskselector/preview-00.eps
25924     *
25925     * A diskselector is a kind of list widget. It scrolls horizontally,
25926     * and can contain label and icon objects. Three items are displayed
25927     * with the selected one in the middle.
25928     *
25929     * It can act like a circular list with round mode and labels can be
25930     * reduced for a defined length for side items.
25931     *
25932     * Smart callbacks one can listen to:
25933     * - "selected" - when item is selected, i.e. scroller stops.
25934     *
25935     * Available styles for it:
25936     * - @c "default"
25937     *
25938     * List of examples:
25939     * @li @ref diskselector_example_01
25940     * @li @ref diskselector_example_02
25941     */
25942
25943    /**
25944     * @addtogroup Diskselector
25945     * @{
25946     */
25947
25948    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(). */
25949
25950    /**
25951     * Add a new diskselector widget to the given parent Elementary
25952     * (container) object.
25953     *
25954     * @param parent The parent object.
25955     * @return a new diskselector widget handle or @c NULL, on errors.
25956     *
25957     * This function inserts a new diskselector widget on the canvas.
25958     *
25959     * @ingroup Diskselector
25960     */
25961    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25962
25963    /**
25964     * Enable or disable round mode.
25965     *
25966     * @param obj The diskselector object.
25967     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25968     * disable it.
25969     *
25970     * Disabled by default. If round mode is enabled the items list will
25971     * work like a circle list, so when the user reaches the last item,
25972     * the first one will popup.
25973     *
25974     * @see elm_diskselector_round_get()
25975     *
25976     * @ingroup Diskselector
25977     */
25978    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25979
25980    /**
25981     * Get a value whether round mode is enabled or not.
25982     *
25983     * @see elm_diskselector_round_set() for details.
25984     *
25985     * @param obj The diskselector object.
25986     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25987     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25988     *
25989     * @ingroup Diskselector
25990     */
25991    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25992
25993    /**
25994     * Get the side labels max length.
25995     *
25996     * @deprecated use elm_diskselector_side_label_length_get() instead:
25997     *
25998     * @param obj The diskselector object.
25999     * @return The max length defined for side labels, or 0 if not a valid
26000     * diskselector.
26001     *
26002     * @ingroup Diskselector
26003     */
26004    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26005
26006    /**
26007     * Set the side labels max length.
26008     *
26009     * @deprecated use elm_diskselector_side_label_length_set() instead:
26010     *
26011     * @param obj The diskselector object.
26012     * @param len The max length defined for side labels.
26013     *
26014     * @ingroup Diskselector
26015     */
26016    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26017
26018    /**
26019     * Get the side labels max length.
26020     *
26021     * @see elm_diskselector_side_label_length_set() for details.
26022     *
26023     * @param obj The diskselector object.
26024     * @return The max length defined for side labels, or 0 if not a valid
26025     * diskselector.
26026     *
26027     * @ingroup Diskselector
26028     */
26029    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26030
26031    /**
26032     * Set the side labels max length.
26033     *
26034     * @param obj The diskselector object.
26035     * @param len The max length defined for side labels.
26036     *
26037     * Length is the number of characters of items' label that will be
26038     * visible when it's set on side positions. It will just crop
26039     * the string after defined size. E.g.:
26040     *
26041     * An item with label "January" would be displayed on side position as
26042     * "Jan" if max length is set to 3, or "Janu", if this property
26043     * is set to 4.
26044     *
26045     * When it's selected, the entire label will be displayed, except for
26046     * width restrictions. In this case label will be cropped and "..."
26047     * will be concatenated.
26048     *
26049     * Default side label max length is 3.
26050     *
26051     * This property will be applyed over all items, included before or
26052     * later this function call.
26053     *
26054     * @ingroup Diskselector
26055     */
26056    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26057
26058    /**
26059     * Set the number of items to be displayed.
26060     *
26061     * @param obj The diskselector object.
26062     * @param num The number of items the diskselector will display.
26063     *
26064     * Default value is 3, and also it's the minimun. If @p num is less
26065     * than 3, it will be set to 3.
26066     *
26067     * Also, it can be set on theme, using data item @c display_item_num
26068     * on group "elm/diskselector/item/X", where X is style set.
26069     * E.g.:
26070     *
26071     * group { name: "elm/diskselector/item/X";
26072     * data {
26073     *     item: "display_item_num" "5";
26074     *     }
26075     *
26076     * @ingroup Diskselector
26077     */
26078    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
26079
26080    /**
26081     * Get the number of items in the diskselector object.
26082     *
26083     * @param obj The diskselector object.
26084     *
26085     * @ingroup Diskselector
26086     */
26087    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26088
26089    /**
26090     * Set bouncing behaviour when the scrolled content reaches an edge.
26091     *
26092     * Tell the internal scroller object whether it should bounce or not
26093     * when it reaches the respective edges for each axis.
26094     *
26095     * @param obj The diskselector object.
26096     * @param h_bounce Whether to bounce or not in the horizontal axis.
26097     * @param v_bounce Whether to bounce or not in the vertical axis.
26098     *
26099     * @see elm_scroller_bounce_set()
26100     *
26101     * @ingroup Diskselector
26102     */
26103    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
26104
26105    /**
26106     * Get the bouncing behaviour of the internal scroller.
26107     *
26108     * Get whether the internal scroller should bounce when the edge of each
26109     * axis is reached scrolling.
26110     *
26111     * @param obj The diskselector object.
26112     * @param h_bounce Pointer where to store the bounce state of the horizontal
26113     * axis.
26114     * @param v_bounce Pointer where to store the bounce state of the vertical
26115     * axis.
26116     *
26117     * @see elm_scroller_bounce_get()
26118     * @see elm_diskselector_bounce_set()
26119     *
26120     * @ingroup Diskselector
26121     */
26122    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
26123
26124    /**
26125     * Get the scrollbar policy.
26126     *
26127     * @see elm_diskselector_scroller_policy_get() for details.
26128     *
26129     * @param obj The diskselector object.
26130     * @param policy_h Pointer where to store horizontal scrollbar policy.
26131     * @param policy_v Pointer where to store vertical scrollbar policy.
26132     *
26133     * @ingroup Diskselector
26134     */
26135    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);
26136
26137    /**
26138     * Set the scrollbar policy.
26139     *
26140     * @param obj The diskselector object.
26141     * @param policy_h Horizontal scrollbar policy.
26142     * @param policy_v Vertical scrollbar policy.
26143     *
26144     * This sets the scrollbar visibility policy for the given scroller.
26145     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26146     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26147     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26148     * This applies respectively for the horizontal and vertical scrollbars.
26149     *
26150     * The both are disabled by default, i.e., are set to
26151     * #ELM_SCROLLER_POLICY_OFF.
26152     *
26153     * @ingroup Diskselector
26154     */
26155    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26156
26157    /**
26158     * Remove all diskselector's items.
26159     *
26160     * @param obj The diskselector object.
26161     *
26162     * @see elm_diskselector_item_del()
26163     * @see elm_diskselector_item_append()
26164     *
26165     * @ingroup Diskselector
26166     */
26167    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26168
26169    /**
26170     * Get a list of all the diskselector items.
26171     *
26172     * @param obj The diskselector object.
26173     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26174     * or @c NULL on failure.
26175     *
26176     * @see elm_diskselector_item_append()
26177     * @see elm_diskselector_item_del()
26178     * @see elm_diskselector_clear()
26179     *
26180     * @ingroup Diskselector
26181     */
26182    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26183
26184    /**
26185     * Appends a new item to the diskselector object.
26186     *
26187     * @param obj The diskselector object.
26188     * @param label The label of the diskselector item.
26189     * @param icon The icon object to use at left side of the item. An
26190     * icon can be any Evas object, but usually it is an icon created
26191     * with elm_icon_add().
26192     * @param func The function to call when the item is selected.
26193     * @param data The data to associate with the item for related callbacks.
26194     *
26195     * @return The created item or @c NULL upon failure.
26196     *
26197     * A new item will be created and appended to the diskselector, i.e., will
26198     * be set as last item. Also, if there is no selected item, it will
26199     * be selected. This will always happens for the first appended item.
26200     *
26201     * If no icon is set, label will be centered on item position, otherwise
26202     * the icon will be placed at left of the label, that will be shifted
26203     * to the right.
26204     *
26205     * Items created with this method can be deleted with
26206     * elm_diskselector_item_del().
26207     *
26208     * Associated @p data can be properly freed when item is deleted if a
26209     * callback function is set with elm_diskselector_item_del_cb_set().
26210     *
26211     * If a function is passed as argument, it will be called everytime this item
26212     * is selected, i.e., the user stops the diskselector with this
26213     * item on center position. If such function isn't needed, just passing
26214     * @c NULL as @p func is enough. The same should be done for @p data.
26215     *
26216     * Simple example (with no function callback or data associated):
26217     * @code
26218     * disk = elm_diskselector_add(win);
26219     * ic = elm_icon_add(win);
26220     * elm_icon_file_set(ic, "path/to/image", NULL);
26221     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26222     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26223     * @endcode
26224     *
26225     * @see elm_diskselector_item_del()
26226     * @see elm_diskselector_item_del_cb_set()
26227     * @see elm_diskselector_clear()
26228     * @see elm_icon_add()
26229     *
26230     * @ingroup Diskselector
26231     */
26232    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);
26233
26234
26235    /**
26236     * Delete them item from the diskselector.
26237     *
26238     * @param it The item of diskselector to be deleted.
26239     *
26240     * If deleting all diskselector items is required, elm_diskselector_clear()
26241     * should be used instead of getting items list and deleting each one.
26242     *
26243     * @see elm_diskselector_clear()
26244     * @see elm_diskselector_item_append()
26245     * @see elm_diskselector_item_del_cb_set()
26246     *
26247     * @ingroup Diskselector
26248     */
26249    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26250
26251    /**
26252     * Set the function called when a diskselector item is freed.
26253     *
26254     * @param it The item to set the callback on
26255     * @param func The function called
26256     *
26257     * If there is a @p func, then it will be called prior item's memory release.
26258     * That will be called with the following arguments:
26259     * @li item's data;
26260     * @li item's Evas object;
26261     * @li item itself;
26262     *
26263     * This way, a data associated to a diskselector item could be properly
26264     * freed.
26265     *
26266     * @ingroup Diskselector
26267     */
26268    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26269
26270    /**
26271     * Get the data associated to the item.
26272     *
26273     * @param it The diskselector item
26274     * @return The data associated to @p it
26275     *
26276     * The return value is a pointer to data associated to @p item when it was
26277     * created, with function elm_diskselector_item_append(). If no data
26278     * was passed as argument, it will return @c NULL.
26279     *
26280     * @see elm_diskselector_item_append()
26281     *
26282     * @ingroup Diskselector
26283     */
26284    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26285
26286    /**
26287     * Set the icon associated to the item.
26288     *
26289     * @param it The diskselector item
26290     * @param icon The icon object to associate with @p it
26291     *
26292     * The icon object to use at left side of the item. An
26293     * icon can be any Evas object, but usually it is an icon created
26294     * with elm_icon_add().
26295     *
26296     * Once the icon object is set, a previously set one will be deleted.
26297     * @warning Setting the same icon for two items will cause the icon to
26298     * dissapear from the first item.
26299     *
26300     * If an icon was passed as argument on item creation, with function
26301     * elm_diskselector_item_append(), it will be already
26302     * associated to the item.
26303     *
26304     * @see elm_diskselector_item_append()
26305     * @see elm_diskselector_item_icon_get()
26306     *
26307     * @ingroup Diskselector
26308     */
26309    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26310
26311    /**
26312     * Get the icon associated to the item.
26313     *
26314     * @param it The diskselector item
26315     * @return The icon associated to @p it
26316     *
26317     * The return value is a pointer to the icon associated to @p item when it was
26318     * created, with function elm_diskselector_item_append(), or later
26319     * with function elm_diskselector_item_icon_set. If no icon
26320     * was passed as argument, it will return @c NULL.
26321     *
26322     * @see elm_diskselector_item_append()
26323     * @see elm_diskselector_item_icon_set()
26324     *
26325     * @ingroup Diskselector
26326     */
26327    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26328
26329    /**
26330     * Set the label of item.
26331     *
26332     * @param it The item of diskselector.
26333     * @param label The label of item.
26334     *
26335     * The label to be displayed by the item.
26336     *
26337     * If no icon is set, label will be centered on item position, otherwise
26338     * the icon will be placed at left of the label, that will be shifted
26339     * to the right.
26340     *
26341     * An item with label "January" would be displayed on side position as
26342     * "Jan" if max length is set to 3 with function
26343     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26344     * is set to 4.
26345     *
26346     * When this @p item is selected, the entire label will be displayed,
26347     * except for width restrictions.
26348     * In this case label will be cropped and "..." will be concatenated,
26349     * but only for display purposes. It will keep the entire string, so
26350     * if diskselector is resized the remaining characters will be displayed.
26351     *
26352     * If a label was passed as argument on item creation, with function
26353     * elm_diskselector_item_append(), it will be already
26354     * displayed by the item.
26355     *
26356     * @see elm_diskselector_side_label_lenght_set()
26357     * @see elm_diskselector_item_label_get()
26358     * @see elm_diskselector_item_append()
26359     *
26360     * @ingroup Diskselector
26361     */
26362    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26363
26364    /**
26365     * Get the label of item.
26366     *
26367     * @param it The item of diskselector.
26368     * @return The label of item.
26369     *
26370     * The return value is a pointer to the label associated to @p item when it was
26371     * created, with function elm_diskselector_item_append(), or later
26372     * with function elm_diskselector_item_label_set. If no label
26373     * was passed as argument, it will return @c NULL.
26374     *
26375     * @see elm_diskselector_item_label_set() for more details.
26376     * @see elm_diskselector_item_append()
26377     *
26378     * @ingroup Diskselector
26379     */
26380    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26381
26382    /**
26383     * Get the selected item.
26384     *
26385     * @param obj The diskselector object.
26386     * @return The selected diskselector item.
26387     *
26388     * The selected item can be unselected with function
26389     * elm_diskselector_item_selected_set(), and the first item of
26390     * diskselector will be selected.
26391     *
26392     * The selected item always will be centered on diskselector, with
26393     * full label displayed, i.e., max lenght set to side labels won't
26394     * apply on the selected item. More details on
26395     * elm_diskselector_side_label_length_set().
26396     *
26397     * @ingroup Diskselector
26398     */
26399    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26400
26401    /**
26402     * Set the selected state of an item.
26403     *
26404     * @param it The diskselector item
26405     * @param selected The selected state
26406     *
26407     * This sets the selected state of the given item @p it.
26408     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26409     *
26410     * If a new item is selected the previosly selected will be unselected.
26411     * Previoulsy selected item can be get with function
26412     * elm_diskselector_selected_item_get().
26413     *
26414     * If the item @p it is unselected, the first item of diskselector will
26415     * be selected.
26416     *
26417     * Selected items will be visible on center position of diskselector.
26418     * So if it was on another position before selected, or was invisible,
26419     * diskselector will animate items until the selected item reaches center
26420     * position.
26421     *
26422     * @see elm_diskselector_item_selected_get()
26423     * @see elm_diskselector_selected_item_get()
26424     *
26425     * @ingroup Diskselector
26426     */
26427    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26428
26429    /*
26430     * Get whether the @p item is selected or not.
26431     *
26432     * @param it The diskselector item.
26433     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26434     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26435     *
26436     * @see elm_diskselector_selected_item_set() for details.
26437     * @see elm_diskselector_item_selected_get()
26438     *
26439     * @ingroup Diskselector
26440     */
26441    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26442
26443    /**
26444     * Get the first item of the diskselector.
26445     *
26446     * @param obj The diskselector object.
26447     * @return The first item, or @c NULL if none.
26448     *
26449     * The list of items follows append order. So it will return the first
26450     * item appended to the widget that wasn't deleted.
26451     *
26452     * @see elm_diskselector_item_append()
26453     * @see elm_diskselector_items_get()
26454     *
26455     * @ingroup Diskselector
26456     */
26457    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26458
26459    /**
26460     * Get the last item of the diskselector.
26461     *
26462     * @param obj The diskselector object.
26463     * @return The last item, or @c NULL if none.
26464     *
26465     * The list of items follows append order. So it will return last first
26466     * item appended to the widget that wasn't deleted.
26467     *
26468     * @see elm_diskselector_item_append()
26469     * @see elm_diskselector_items_get()
26470     *
26471     * @ingroup Diskselector
26472     */
26473    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26474
26475    /**
26476     * Get the item before @p item in diskselector.
26477     *
26478     * @param it The diskselector item.
26479     * @return The item before @p item, or @c NULL if none or on failure.
26480     *
26481     * The list of items follows append order. So it will return item appended
26482     * just before @p item and that wasn't deleted.
26483     *
26484     * If it is the first item, @c NULL will be returned.
26485     * First item can be get by elm_diskselector_first_item_get().
26486     *
26487     * @see elm_diskselector_item_append()
26488     * @see elm_diskselector_items_get()
26489     *
26490     * @ingroup Diskselector
26491     */
26492    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26493
26494    /**
26495     * Get the item after @p item in diskselector.
26496     *
26497     * @param it The diskselector item.
26498     * @return The item after @p item, or @c NULL if none or on failure.
26499     *
26500     * The list of items follows append order. So it will return item appended
26501     * just after @p item and that wasn't deleted.
26502     *
26503     * If it is the last item, @c NULL will be returned.
26504     * Last item can be get by elm_diskselector_last_item_get().
26505     *
26506     * @see elm_diskselector_item_append()
26507     * @see elm_diskselector_items_get()
26508     *
26509     * @ingroup Diskselector
26510     */
26511    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26512
26513    /**
26514     * Set the text to be shown in the diskselector item.
26515     *
26516     * @param item Target item
26517     * @param text The text to set in the content
26518     *
26519     * Setup the text as tooltip to object. The item can have only one tooltip,
26520     * so any previous tooltip data is removed.
26521     *
26522     * @see elm_object_tooltip_text_set() for more details.
26523     *
26524     * @ingroup Diskselector
26525     */
26526    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26527
26528    /**
26529     * Set the content to be shown in the tooltip item.
26530     *
26531     * Setup the tooltip to item. The item can have only one tooltip,
26532     * so any previous tooltip data is removed. @p func(with @p data) will
26533     * be called every time that need show the tooltip and it should
26534     * return a valid Evas_Object. This object is then managed fully by
26535     * tooltip system and is deleted when the tooltip is gone.
26536     *
26537     * @param item the diskselector item being attached a tooltip.
26538     * @param func the function used to create the tooltip contents.
26539     * @param data what to provide to @a func as callback data/context.
26540     * @param del_cb called when data is not needed anymore, either when
26541     *        another callback replaces @p func, the tooltip is unset with
26542     *        elm_diskselector_item_tooltip_unset() or the owner @a item
26543     *        dies. This callback receives as the first parameter the
26544     *        given @a data, and @c event_info is the item.
26545     *
26546     * @see elm_object_tooltip_content_cb_set() for more details.
26547     *
26548     * @ingroup Diskselector
26549     */
26550    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);
26551
26552    /**
26553     * Unset tooltip from item.
26554     *
26555     * @param item diskselector item to remove previously set tooltip.
26556     *
26557     * Remove tooltip from item. The callback provided as del_cb to
26558     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26559     * it is not used anymore.
26560     *
26561     * @see elm_object_tooltip_unset() for more details.
26562     * @see elm_diskselector_item_tooltip_content_cb_set()
26563     *
26564     * @ingroup Diskselector
26565     */
26566    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26567
26568
26569    /**
26570     * Sets a different style for this item tooltip.
26571     *
26572     * @note before you set a style you should define a tooltip with
26573     *       elm_diskselector_item_tooltip_content_cb_set() or
26574     *       elm_diskselector_item_tooltip_text_set()
26575     *
26576     * @param item diskselector item with tooltip already set.
26577     * @param style the theme style to use (default, transparent, ...)
26578     *
26579     * @see elm_object_tooltip_style_set() for more details.
26580     *
26581     * @ingroup Diskselector
26582     */
26583    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26584
26585    /**
26586     * Get the style for this item tooltip.
26587     *
26588     * @param item diskselector item with tooltip already set.
26589     * @return style the theme style in use, defaults to "default". If the
26590     *         object does not have a tooltip set, then NULL is returned.
26591     *
26592     * @see elm_object_tooltip_style_get() for more details.
26593     * @see elm_diskselector_item_tooltip_style_set()
26594     *
26595     * @ingroup Diskselector
26596     */
26597    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26598
26599    /**
26600     * Set the cursor to be shown when mouse is over the diskselector item
26601     *
26602     * @param item Target item
26603     * @param cursor the cursor name to be used.
26604     *
26605     * @see elm_object_cursor_set() for more details.
26606     *
26607     * @ingroup Diskselector
26608     */
26609    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26610
26611    /**
26612     * Get the cursor to be shown when mouse is over the diskselector item
26613     *
26614     * @param item diskselector item with cursor already set.
26615     * @return the cursor name.
26616     *
26617     * @see elm_object_cursor_get() for more details.
26618     * @see elm_diskselector_cursor_set()
26619     *
26620     * @ingroup Diskselector
26621     */
26622    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26623
26624
26625    /**
26626     * Unset the cursor to be shown when mouse is over the diskselector item
26627     *
26628     * @param item Target item
26629     *
26630     * @see elm_object_cursor_unset() for more details.
26631     * @see elm_diskselector_cursor_set()
26632     *
26633     * @ingroup Diskselector
26634     */
26635    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26636
26637    /**
26638     * Sets a different style for this item cursor.
26639     *
26640     * @note before you set a style you should define a cursor with
26641     *       elm_diskselector_item_cursor_set()
26642     *
26643     * @param item diskselector item with cursor already set.
26644     * @param style the theme style to use (default, transparent, ...)
26645     *
26646     * @see elm_object_cursor_style_set() for more details.
26647     *
26648     * @ingroup Diskselector
26649     */
26650    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26651
26652
26653    /**
26654     * Get the style for this item cursor.
26655     *
26656     * @param item diskselector item with cursor already set.
26657     * @return style the theme style in use, defaults to "default". If the
26658     *         object does not have a cursor set, then @c NULL is returned.
26659     *
26660     * @see elm_object_cursor_style_get() for more details.
26661     * @see elm_diskselector_item_cursor_style_set()
26662     *
26663     * @ingroup Diskselector
26664     */
26665    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26666
26667
26668    /**
26669     * Set if the cursor set should be searched on the theme or should use
26670     * the provided by the engine, only.
26671     *
26672     * @note before you set if should look on theme you should define a cursor
26673     * with elm_diskselector_item_cursor_set().
26674     * By default it will only look for cursors provided by the engine.
26675     *
26676     * @param item widget item with cursor already set.
26677     * @param engine_only boolean to define if cursors set with
26678     * elm_diskselector_item_cursor_set() should be searched only
26679     * between cursors provided by the engine or searched on widget's
26680     * theme as well.
26681     *
26682     * @see elm_object_cursor_engine_only_set() for more details.
26683     *
26684     * @ingroup Diskselector
26685     */
26686    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26687
26688    /**
26689     * Get the cursor engine only usage for this item cursor.
26690     *
26691     * @param item widget item with cursor already set.
26692     * @return engine_only boolean to define it cursors should be looked only
26693     * between the provided by the engine or searched on widget's theme as well.
26694     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26695     *
26696     * @see elm_object_cursor_engine_only_get() for more details.
26697     * @see elm_diskselector_item_cursor_engine_only_set()
26698     *
26699     * @ingroup Diskselector
26700     */
26701    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26702
26703    /**
26704     * @}
26705     */
26706
26707    /**
26708     * @defgroup Colorselector Colorselector
26709     *
26710     * @{
26711     *
26712     * @image html img/widget/colorselector/preview-00.png
26713     * @image latex img/widget/colorselector/preview-00.eps
26714     *
26715     * @brief Widget for user to select a color.
26716     *
26717     * Signals that you can add callbacks for are:
26718     * "changed" - When the color value changes(event_info is NULL).
26719     *
26720     * See @ref tutorial_colorselector.
26721     */
26722    /**
26723     * @brief Add a new colorselector to the parent
26724     *
26725     * @param parent The parent object
26726     * @return The new object or NULL if it cannot be created
26727     *
26728     * @ingroup Colorselector
26729     */
26730    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26731    /**
26732     * Set a color for the colorselector
26733     *
26734     * @param obj   Colorselector object
26735     * @param r     r-value of color
26736     * @param g     g-value of color
26737     * @param b     b-value of color
26738     * @param a     a-value of color
26739     *
26740     * @ingroup Colorselector
26741     */
26742    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26743    /**
26744     * Get a color from the colorselector
26745     *
26746     * @param obj   Colorselector object
26747     * @param r     integer pointer for r-value of color
26748     * @param g     integer pointer for g-value of color
26749     * @param b     integer pointer for b-value of color
26750     * @param a     integer pointer for a-value of color
26751     *
26752     * @ingroup Colorselector
26753     */
26754    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26755    /**
26756     * @}
26757     */
26758
26759    /**
26760     * @defgroup Ctxpopup Ctxpopup
26761     *
26762     * @image html img/widget/ctxpopup/preview-00.png
26763     * @image latex img/widget/ctxpopup/preview-00.eps
26764     *
26765     * @brief Context popup widet.
26766     *
26767     * A ctxpopup is a widget that, when shown, pops up a list of items.
26768     * It automatically chooses an area inside its parent object's view
26769     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26770     * optimally fit into it. In the default theme, it will also point an
26771     * arrow to it's top left position at the time one shows it. Ctxpopup
26772     * items have a label and/or an icon. It is intended for a small
26773     * number of items (hence the use of list, not genlist).
26774     *
26775     * @note Ctxpopup is a especialization of @ref Hover.
26776     *
26777     * Signals that you can add callbacks for are:
26778     * "dismissed" - the ctxpopup was dismissed
26779     *
26780     * Default contents parts of the ctxpopup widget that you can use for are:
26781     * @li "default" - A content of the ctxpopup
26782     *
26783     * Default contents parts of the naviframe items that you can use for are:
26784     * @li "icon" - An icon in the title area
26785     *
26786     * Default text parts of the naviframe items that you can use for are:
26787     * @li "default" - Title label in the title area
26788     *
26789     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26790     * @{
26791     */
26792    typedef enum _Elm_Ctxpopup_Direction
26793      {
26794         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26795                                           area */
26796         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26797                                            the clicked area */
26798         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26799                                           the clicked area */
26800         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26801                                         area */
26802         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26803      } Elm_Ctxpopup_Direction;
26804
26805    /**
26806     * @brief Add a new Ctxpopup object to the parent.
26807     *
26808     * @param parent Parent object
26809     * @return New object or @c NULL, if it cannot be created
26810     */
26811    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26812    /**
26813     * @brief Set the Ctxpopup's parent
26814     *
26815     * @param obj The ctxpopup object
26816     * @param area The parent to use
26817     *
26818     * Set the parent object.
26819     *
26820     * @note elm_ctxpopup_add() will automatically call this function
26821     * with its @c parent argument.
26822     *
26823     * @see elm_ctxpopup_add()
26824     * @see elm_hover_parent_set()
26825     */
26826    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26827    /**
26828     * @brief Get the Ctxpopup's parent
26829     *
26830     * @param obj The ctxpopup object
26831     *
26832     * @see elm_ctxpopup_hover_parent_set() for more information
26833     */
26834    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26835    /**
26836     * @brief Clear all items in the given ctxpopup object.
26837     *
26838     * @param obj Ctxpopup object
26839     */
26840    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26841    /**
26842     * @brief Change the ctxpopup's orientation to horizontal or vertical.
26843     *
26844     * @param obj Ctxpopup object
26845     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26846     */
26847    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26848    /**
26849     * @brief Get the value of current ctxpopup object's orientation.
26850     *
26851     * @param obj Ctxpopup object
26852     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26853     *
26854     * @see elm_ctxpopup_horizontal_set()
26855     */
26856    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26857    /**
26858     * @brief Add a new item to a ctxpopup object.
26859     *
26860     * @param obj Ctxpopup object
26861     * @param icon Icon to be set on new item
26862     * @param label The Label of the new item
26863     * @param func Convenience function called when item selected
26864     * @param data Data passed to @p func
26865     * @return A handle to the item added or @c NULL, on errors
26866     *
26867     * @warning Ctxpopup can't hold both an item list and a content at the same
26868     * time. When an item is added, any previous content will be removed.
26869     *
26870     * @see elm_ctxpopup_content_set()
26871     */
26872    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);
26873    /**
26874     * @brief Delete the given item in a ctxpopup object.
26875     *
26876     * @param it Ctxpopup item to be deleted
26877     *
26878     * @see elm_ctxpopup_item_append()
26879     */
26880    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26881    /**
26882     * @brief Set the ctxpopup item's state as disabled or enabled.
26883     *
26884     * @param it Ctxpopup item to be enabled/disabled
26885     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26886     *
26887     * When disabled the item is greyed out to indicate it's state.
26888     * @deprecated use elm_object_item_disabled_set() instead
26889     */
26890    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26891    /**
26892     * @brief Get the ctxpopup item's disabled/enabled state.
26893     *
26894     * @param it Ctxpopup item to be enabled/disabled
26895     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26896     *
26897     * @see elm_ctxpopup_item_disabled_set()
26898     * @deprecated use elm_object_item_disabled_get() instead
26899     */
26900    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26901    /**
26902     * @brief Get the icon object for the given ctxpopup item.
26903     *
26904     * @param it Ctxpopup item
26905     * @return icon object or @c NULL, if the item does not have icon or an error
26906     * occurred
26907     *
26908     * @see elm_ctxpopup_item_append()
26909     * @see elm_ctxpopup_item_icon_set()
26910     *
26911     * @deprecated use elm_object_item_part_content_get() instead
26912     */
26913    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26914    /**
26915     * @brief Sets the side icon associated with the ctxpopup item
26916     *
26917     * @param it Ctxpopup item
26918     * @param icon Icon object to be set
26919     *
26920     * Once the icon object is set, a previously set one will be deleted.
26921     * @warning Setting the same icon for two items will cause the icon to
26922     * dissapear from the first item.
26923     *
26924     * @see elm_ctxpopup_item_append()
26925     *
26926     * @deprecated use elm_object_item_part_content_set() instead
26927     *
26928     */
26929    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26930    /**
26931     * @brief Get the label for the given ctxpopup item.
26932     *
26933     * @param it Ctxpopup item
26934     * @return label string or @c NULL, if the item does not have label or an
26935     * error occured
26936     *
26937     * @see elm_ctxpopup_item_append()
26938     * @see elm_ctxpopup_item_label_set()
26939     *
26940     * @deprecated use elm_object_item_text_get() instead
26941     */
26942    EINA_DEPRECATED EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26943    /**
26944     * @brief (Re)set the label on the given ctxpopup item.
26945     *
26946     * @param it Ctxpopup item
26947     * @param label String to set as label
26948     *
26949     * @deprecated use elm_object_item_text_set() instead
26950     */
26951    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26952    /**
26953     * @brief Set an elm widget as the content of the ctxpopup.
26954     *
26955     * @param obj Ctxpopup object
26956     * @param content Content to be swallowed
26957     *
26958     * If the content object is already set, a previous one will bedeleted. If
26959     * you want to keep that old content object, use the
26960     * elm_ctxpopup_content_unset() function.
26961     *
26962     * @warning Ctxpopup can't hold both a item list and a content at the same
26963     * time. When a content is set, any previous items will be removed.
26964     *
26965     * @deprecated use elm_object_content_set() instead
26966     *
26967     */
26968    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26969    /**
26970     * @brief Unset the ctxpopup content
26971     *
26972     * @param obj Ctxpopup object
26973     * @return The content that was being used
26974     *
26975     * Unparent and return the content object which was set for this widget.
26976     *
26977     * @deprecated use elm_object_content_unset()
26978     *
26979     * @see elm_ctxpopup_content_set()
26980     *
26981     * @deprecated use elm_object_content_unset() instead
26982     *
26983     */
26984    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26985    /**
26986     * @brief Set the direction priority of a ctxpopup.
26987     *
26988     * @param obj Ctxpopup object
26989     * @param first 1st priority of direction
26990     * @param second 2nd priority of direction
26991     * @param third 3th priority of direction
26992     * @param fourth 4th priority of direction
26993     *
26994     * This functions gives a chance to user to set the priority of ctxpopup
26995     * showing direction. This doesn't guarantee the ctxpopup will appear in the
26996     * requested direction.
26997     *
26998     * @see Elm_Ctxpopup_Direction
26999     */
27000    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);
27001    /**
27002     * @brief Get the direction priority of a ctxpopup.
27003     *
27004     * @param obj Ctxpopup object
27005     * @param first 1st priority of direction to be returned
27006     * @param second 2nd priority of direction to be returned
27007     * @param third 3th priority of direction to be returned
27008     * @param fourth 4th priority of direction to be returned
27009     *
27010     * @see elm_ctxpopup_direction_priority_set() for more information.
27011     */
27012    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);
27013
27014    /**
27015     * @brief Get the current direction of a ctxpopup.
27016     *
27017     * @param obj Ctxpopup object
27018     * @return current direction of a ctxpopup
27019     *
27020     * @warning Once the ctxpopup showed up, the direction would be determined
27021     */
27022    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27023
27024    /**
27025     * @}
27026     */
27027
27028    /* transit */
27029    /**
27030     *
27031     * @defgroup Transit Transit
27032     * @ingroup Elementary
27033     *
27034     * Transit is designed to apply various animated transition effects to @c
27035     * Evas_Object, such like translation, rotation, etc. For using these
27036     * effects, create an @ref Elm_Transit and add the desired transition effects.
27037     *
27038     * Once the effects are added into transit, they will be automatically
27039     * managed (their callback will be called until the duration is ended, and
27040     * they will be deleted on completion).
27041     *
27042     * Example:
27043     * @code
27044     * Elm_Transit *trans = elm_transit_add();
27045     * elm_transit_object_add(trans, obj);
27046     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
27047     * elm_transit_duration_set(transit, 1);
27048     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
27049     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
27050     * elm_transit_repeat_times_set(transit, 3);
27051     * @endcode
27052     *
27053     * Some transition effects are used to change the properties of objects. They
27054     * are:
27055     * @li @ref elm_transit_effect_translation_add
27056     * @li @ref elm_transit_effect_color_add
27057     * @li @ref elm_transit_effect_rotation_add
27058     * @li @ref elm_transit_effect_wipe_add
27059     * @li @ref elm_transit_effect_zoom_add
27060     * @li @ref elm_transit_effect_resizing_add
27061     *
27062     * Other transition effects are used to make one object disappear and another
27063     * object appear on its old place. These effects are:
27064     *
27065     * @li @ref elm_transit_effect_flip_add
27066     * @li @ref elm_transit_effect_resizable_flip_add
27067     * @li @ref elm_transit_effect_fade_add
27068     * @li @ref elm_transit_effect_blend_add
27069     *
27070     * It's also possible to make a transition chain with @ref
27071     * elm_transit_chain_transit_add.
27072     *
27073     * @warning We strongly recommend to use elm_transit just when edje can not do
27074     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
27075     * animations can be manipulated inside the theme.
27076     *
27077     * List of examples:
27078     * @li @ref transit_example_01_explained
27079     * @li @ref transit_example_02_explained
27080     * @li @ref transit_example_03_c
27081     * @li @ref transit_example_04_c
27082     *
27083     * @{
27084     */
27085
27086    /**
27087     * @enum Elm_Transit_Tween_Mode
27088     *
27089     * The type of acceleration used in the transition.
27090     */
27091    typedef enum
27092      {
27093         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
27094         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
27095                                              over time, then decrease again
27096                                              and stop slowly */
27097         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
27098                                              speed over time */
27099         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
27100                                             over time */
27101      } Elm_Transit_Tween_Mode;
27102
27103    /**
27104     * @enum Elm_Transit_Effect_Flip_Axis
27105     *
27106     * The axis where flip effect should be applied.
27107     */
27108    typedef enum
27109      {
27110         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
27111         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
27112      } Elm_Transit_Effect_Flip_Axis;
27113    /**
27114     * @enum Elm_Transit_Effect_Wipe_Dir
27115     *
27116     * The direction where the wipe effect should occur.
27117     */
27118    typedef enum
27119      {
27120         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
27121         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
27122         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
27123         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
27124      } Elm_Transit_Effect_Wipe_Dir;
27125    /** @enum Elm_Transit_Effect_Wipe_Type
27126     *
27127     * Whether the wipe effect should show or hide the object.
27128     */
27129    typedef enum
27130      {
27131         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
27132                                              animation */
27133         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
27134                                             animation */
27135      } Elm_Transit_Effect_Wipe_Type;
27136
27137    /**
27138     * @typedef Elm_Transit
27139     *
27140     * The Transit created with elm_transit_add(). This type has the information
27141     * about the objects which the transition will be applied, and the
27142     * transition effects that will be used. It also contains info about
27143     * duration, number of repetitions, auto-reverse, etc.
27144     */
27145    typedef struct _Elm_Transit Elm_Transit;
27146    typedef void Elm_Transit_Effect;
27147    /**
27148     * @typedef Elm_Transit_Effect_Transition_Cb
27149     *
27150     * Transition callback called for this effect on each transition iteration.
27151     */
27152    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27153    /**
27154     * Elm_Transit_Effect_End_Cb
27155     *
27156     * Transition callback called for this effect when the transition is over.
27157     */
27158    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27159
27160    /**
27161     * Elm_Transit_Del_Cb
27162     *
27163     * A callback called when the transit is deleted.
27164     */
27165    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27166
27167    /**
27168     * Add new transit.
27169     *
27170     * @note Is not necessary to delete the transit object, it will be deleted at
27171     * the end of its operation.
27172     * @note The transit will start playing when the program enter in the main loop, is not
27173     * necessary to give a start to the transit.
27174     *
27175     * @return The transit object.
27176     *
27177     * @ingroup Transit
27178     */
27179    EAPI Elm_Transit                *elm_transit_add(void);
27180
27181    /**
27182     * Stops the animation and delete the @p transit object.
27183     *
27184     * Call this function if you wants to stop the animation before the duration
27185     * time. Make sure the @p transit object is still alive with
27186     * elm_transit_del_cb_set() function.
27187     * All added effects will be deleted, calling its repective data_free_cb
27188     * functions. The function setted by elm_transit_del_cb_set() will be called.
27189     *
27190     * @see elm_transit_del_cb_set()
27191     *
27192     * @param transit The transit object to be deleted.
27193     *
27194     * @ingroup Transit
27195     * @warning Just call this function if you are sure the transit is alive.
27196     */
27197    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27198
27199    /**
27200     * Add a new effect to the transit.
27201     *
27202     * @note The cb function and the data are the key to the effect. If you try to
27203     * add an already added effect, nothing is done.
27204     * @note After the first addition of an effect in @p transit, if its
27205     * effect list become empty again, the @p transit will be killed by
27206     * elm_transit_del(transit) function.
27207     *
27208     * Exemple:
27209     * @code
27210     * Elm_Transit *transit = elm_transit_add();
27211     * elm_transit_effect_add(transit,
27212     *                        elm_transit_effect_blend_op,
27213     *                        elm_transit_effect_blend_context_new(),
27214     *                        elm_transit_effect_blend_context_free);
27215     * @endcode
27216     *
27217     * @param transit The transit object.
27218     * @param transition_cb The operation function. It is called when the
27219     * animation begins, it is the function that actually performs the animation.
27220     * It is called with the @p data, @p transit and the time progression of the
27221     * animation (a double value between 0.0 and 1.0).
27222     * @param effect The context data of the effect.
27223     * @param end_cb The function to free the context data, it will be called
27224     * at the end of the effect, it must finalize the animation and free the
27225     * @p data.
27226     *
27227     * @ingroup Transit
27228     * @warning The transit free the context data at the and of the transition with
27229     * the data_free_cb function, do not use the context data in another transit.
27230     */
27231    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);
27232
27233    /**
27234     * Delete an added effect.
27235     *
27236     * This function will remove the effect from the @p transit, calling the
27237     * data_free_cb to free the @p data.
27238     *
27239     * @see elm_transit_effect_add()
27240     *
27241     * @note If the effect is not found, nothing is done.
27242     * @note If the effect list become empty, this function will call
27243     * elm_transit_del(transit), that is, it will kill the @p transit.
27244     *
27245     * @param transit The transit object.
27246     * @param transition_cb The operation function.
27247     * @param effect The context data of the effect.
27248     *
27249     * @ingroup Transit
27250     */
27251    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);
27252
27253    /**
27254     * Add new object to apply the effects.
27255     *
27256     * @note After the first addition of an object in @p transit, if its
27257     * object list become empty again, the @p transit will be killed by
27258     * elm_transit_del(transit) function.
27259     * @note If the @p obj belongs to another transit, the @p obj will be
27260     * removed from it and it will only belong to the @p transit. If the old
27261     * transit stays without objects, it will die.
27262     * @note When you add an object into the @p transit, its state from
27263     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27264     * transit ends, if you change this state whith evas_object_pass_events_set()
27265     * after add the object, this state will change again when @p transit stops to
27266     * run.
27267     *
27268     * @param transit The transit object.
27269     * @param obj Object to be animated.
27270     *
27271     * @ingroup Transit
27272     * @warning It is not allowed to add a new object after transit begins to go.
27273     */
27274    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27275
27276    /**
27277     * Removes an added object from the transit.
27278     *
27279     * @note If the @p obj is not in the @p transit, nothing is done.
27280     * @note If the list become empty, this function will call
27281     * elm_transit_del(transit), that is, it will kill the @p transit.
27282     *
27283     * @param transit The transit object.
27284     * @param obj Object to be removed from @p transit.
27285     *
27286     * @ingroup Transit
27287     * @warning It is not allowed to remove objects after transit begins to go.
27288     */
27289    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27290
27291    /**
27292     * Get the objects of the transit.
27293     *
27294     * @param transit The transit object.
27295     * @return a Eina_List with the objects from the transit.
27296     *
27297     * @ingroup Transit
27298     */
27299    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27300
27301    /**
27302     * Enable/disable keeping up the objects states.
27303     * If it is not kept, the objects states will be reset when transition ends.
27304     *
27305     * @note @p transit can not be NULL.
27306     * @note One state includes geometry, color, map data.
27307     *
27308     * @param transit The transit object.
27309     * @param state_keep Keeping or Non Keeping.
27310     *
27311     * @ingroup Transit
27312     */
27313    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27314
27315    /**
27316     * Get a value whether the objects states will be reset or not.
27317     *
27318     * @note @p transit can not be NULL
27319     *
27320     * @see elm_transit_objects_final_state_keep_set()
27321     *
27322     * @param transit The transit object.
27323     * @return EINA_TRUE means the states of the objects will be reset.
27324     * If @p transit is NULL, EINA_FALSE is returned
27325     *
27326     * @ingroup Transit
27327     */
27328    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27329
27330    /**
27331     * Set the event enabled when transit is operating.
27332     *
27333     * If @p enabled is EINA_TRUE, the objects of the transit will receives
27334     * events from mouse and keyboard during the animation.
27335     * @note When you add an object with elm_transit_object_add(), its state from
27336     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27337     * transit ends, if you change this state with evas_object_pass_events_set()
27338     * after adding the object, this state will change again when @p transit stops
27339     * to run.
27340     *
27341     * @param transit The transit object.
27342     * @param enabled Events are received when enabled is @c EINA_TRUE, and
27343     * ignored otherwise.
27344     *
27345     * @ingroup Transit
27346     */
27347    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27348
27349    /**
27350     * Get the value of event enabled status.
27351     *
27352     * @see elm_transit_event_enabled_set()
27353     *
27354     * @param transit The Transit object
27355     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27356     * EINA_FALSE is returned
27357     *
27358     * @ingroup Transit
27359     */
27360    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27361
27362    /**
27363     * Set the user-callback function when the transit is deleted.
27364     *
27365     * @note Using this function twice will overwrite the first function setted.
27366     * @note the @p transit object will be deleted after call @p cb function.
27367     *
27368     * @param transit The transit object.
27369     * @param cb Callback function pointer. This function will be called before
27370     * the deletion of the transit.
27371     * @param data Callback funtion user data. It is the @p op parameter.
27372     *
27373     * @ingroup Transit
27374     */
27375    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27376
27377    /**
27378     * Set reverse effect automatically.
27379     *
27380     * If auto reverse is setted, after running the effects with the progress
27381     * parameter from 0 to 1, it will call the effecs again with the progress
27382     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27383     * where the duration was setted with the function elm_transit_add and
27384     * the repeat with the function elm_transit_repeat_times_set().
27385     *
27386     * @param transit The transit object.
27387     * @param reverse EINA_TRUE means the auto_reverse is on.
27388     *
27389     * @ingroup Transit
27390     */
27391    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27392
27393    /**
27394     * Get if the auto reverse is on.
27395     *
27396     * @see elm_transit_auto_reverse_set()
27397     *
27398     * @param transit The transit object.
27399     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27400     * EINA_FALSE is returned
27401     *
27402     * @ingroup Transit
27403     */
27404    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27405
27406    /**
27407     * Set the transit repeat count. Effect will be repeated by repeat count.
27408     *
27409     * This function sets the number of repetition the transit will run after
27410     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27411     * If the @p repeat is a negative number, it will repeat infinite times.
27412     *
27413     * @note If this function is called during the transit execution, the transit
27414     * will run @p repeat times, ignoring the times it already performed.
27415     *
27416     * @param transit The transit object
27417     * @param repeat Repeat count
27418     *
27419     * @ingroup Transit
27420     */
27421    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27422
27423    /**
27424     * Get the transit repeat count.
27425     *
27426     * @see elm_transit_repeat_times_set()
27427     *
27428     * @param transit The Transit object.
27429     * @return The repeat count. If @p transit is NULL
27430     * 0 is returned
27431     *
27432     * @ingroup Transit
27433     */
27434    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27435
27436    /**
27437     * Set the transit animation acceleration type.
27438     *
27439     * This function sets the tween mode of the transit that can be:
27440     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27441     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27442     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27443     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27444     *
27445     * @param transit The transit object.
27446     * @param tween_mode The tween type.
27447     *
27448     * @ingroup Transit
27449     */
27450    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27451
27452    /**
27453     * Get the transit animation acceleration type.
27454     *
27455     * @note @p transit can not be NULL
27456     *
27457     * @param transit The transit object.
27458     * @return The tween type. If @p transit is NULL
27459     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27460     *
27461     * @ingroup Transit
27462     */
27463    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27464
27465    /**
27466     * Set the transit animation time
27467     *
27468     * @note @p transit can not be NULL
27469     *
27470     * @param transit The transit object.
27471     * @param duration The animation time.
27472     *
27473     * @ingroup Transit
27474     */
27475    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27476
27477    /**
27478     * Get the transit animation time
27479     *
27480     * @note @p transit can not be NULL
27481     *
27482     * @param transit The transit object.
27483     *
27484     * @return The transit animation time.
27485     *
27486     * @ingroup Transit
27487     */
27488    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27489
27490    /**
27491     * Starts the transition.
27492     * Once this API is called, the transit begins to measure the time.
27493     *
27494     * @note @p transit can not be NULL
27495     *
27496     * @param transit The transit object.
27497     *
27498     * @ingroup Transit
27499     */
27500    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27501
27502    /**
27503     * Pause/Resume the transition.
27504     *
27505     * If you call elm_transit_go again, the transit will be started from the
27506     * beginning, and will be unpaused.
27507     *
27508     * @note @p transit can not be NULL
27509     *
27510     * @param transit The transit object.
27511     * @param paused Whether the transition should be paused or not.
27512     *
27513     * @ingroup Transit
27514     */
27515    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27516
27517    /**
27518     * Get the value of paused status.
27519     *
27520     * @see elm_transit_paused_set()
27521     *
27522     * @note @p transit can not be NULL
27523     *
27524     * @param transit The transit object.
27525     * @return EINA_TRUE means transition is paused. If @p transit is NULL
27526     * EINA_FALSE is returned
27527     *
27528     * @ingroup Transit
27529     */
27530    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27531
27532    /**
27533     * Get the time progression of the animation (a double value between 0.0 and 1.0).
27534     *
27535     * The value returned is a fraction (current time / total time). It
27536     * represents the progression position relative to the total.
27537     *
27538     * @note @p transit can not be NULL
27539     *
27540     * @param transit The transit object.
27541     *
27542     * @return The time progression value. If @p transit is NULL
27543     * 0 is returned
27544     *
27545     * @ingroup Transit
27546     */
27547    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27548
27549    /**
27550     * Makes the chain relationship between two transits.
27551     *
27552     * @note @p transit can not be NULL. Transit would have multiple chain transits.
27553     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27554     *
27555     * @param transit The transit object.
27556     * @param chain_transit The chain transit object. This transit will be operated
27557     *        after transit is done.
27558     *
27559     * This function adds @p chain_transit transition to a chain after the @p
27560     * transit, and will be started as soon as @p transit ends. See @ref
27561     * transit_example_02_explained for a full example.
27562     *
27563     * @ingroup Transit
27564     */
27565    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27566
27567    /**
27568     * Cut off the chain relationship between two transits.
27569     *
27570     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27571     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27572     *
27573     * @param transit The transit object.
27574     * @param chain_transit The chain transit object.
27575     *
27576     * This function remove the @p chain_transit transition from the @p transit.
27577     *
27578     * @ingroup Transit
27579     */
27580    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27581
27582    /**
27583     * Get the current chain transit list.
27584     *
27585     * @note @p transit can not be NULL.
27586     *
27587     * @param transit The transit object.
27588     * @return chain transit list.
27589     *
27590     * @ingroup Transit
27591     */
27592    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
27593
27594    /**
27595     * Add the Resizing Effect to Elm_Transit.
27596     *
27597     * @note This API is one of the facades. It creates resizing effect context
27598     * and add it's required APIs to elm_transit_effect_add.
27599     *
27600     * @see elm_transit_effect_add()
27601     *
27602     * @param transit Transit object.
27603     * @param from_w Object width size when effect begins.
27604     * @param from_h Object height size when effect begins.
27605     * @param to_w Object width size when effect ends.
27606     * @param to_h Object height size when effect ends.
27607     * @return Resizing effect context data.
27608     *
27609     * @ingroup Transit
27610     */
27611    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);
27612
27613    /**
27614     * Add the Translation Effect to Elm_Transit.
27615     *
27616     * @note This API is one of the facades. It creates translation effect context
27617     * and add it's required APIs to elm_transit_effect_add.
27618     *
27619     * @see elm_transit_effect_add()
27620     *
27621     * @param transit Transit object.
27622     * @param from_dx X Position variation when effect begins.
27623     * @param from_dy Y Position variation when effect begins.
27624     * @param to_dx X Position variation when effect ends.
27625     * @param to_dy Y Position variation when effect ends.
27626     * @return Translation effect context data.
27627     *
27628     * @ingroup Transit
27629     * @warning It is highly recommended just create a transit with this effect when
27630     * the window that the objects of the transit belongs has already been created.
27631     * This is because this effect needs the geometry information about the objects,
27632     * and if the window was not created yet, it can get a wrong information.
27633     */
27634    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);
27635
27636    /**
27637     * Add the Zoom Effect to Elm_Transit.
27638     *
27639     * @note This API is one of the facades. It creates zoom effect context
27640     * and add it's required APIs to elm_transit_effect_add.
27641     *
27642     * @see elm_transit_effect_add()
27643     *
27644     * @param transit Transit object.
27645     * @param from_rate Scale rate when effect begins (1 is current rate).
27646     * @param to_rate Scale rate when effect ends.
27647     * @return Zoom effect context data.
27648     *
27649     * @ingroup Transit
27650     * @warning It is highly recommended just create a transit with this effect when
27651     * the window that the objects of the transit belongs has already been created.
27652     * This is because this effect needs the geometry information about the objects,
27653     * and if the window was not created yet, it can get a wrong information.
27654     */
27655    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27656
27657    /**
27658     * Add the Flip Effect to Elm_Transit.
27659     *
27660     * @note This API is one of the facades. It creates flip effect context
27661     * and add it's required APIs to elm_transit_effect_add.
27662     * @note This effect is applied to each pair of objects in the order they are listed
27663     * in the transit list of objects. The first object in the pair will be the
27664     * "front" object and the second will be the "back" object.
27665     *
27666     * @see elm_transit_effect_add()
27667     *
27668     * @param transit Transit object.
27669     * @param axis Flipping Axis(X or Y).
27670     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27671     * @return Flip effect context data.
27672     *
27673     * @ingroup Transit
27674     * @warning It is highly recommended just create a transit with this effect when
27675     * the window that the objects of the transit belongs has already been created.
27676     * This is because this effect needs the geometry information about the objects,
27677     * and if the window was not created yet, it can get a wrong information.
27678     */
27679    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27680
27681    /**
27682     * Add the Resizable Flip Effect to Elm_Transit.
27683     *
27684     * @note This API is one of the facades. It creates resizable flip effect context
27685     * and add it's required APIs to elm_transit_effect_add.
27686     * @note This effect is applied to each pair of objects in the order they are listed
27687     * in the transit list of objects. The first object in the pair will be the
27688     * "front" object and the second will be the "back" object.
27689     *
27690     * @see elm_transit_effect_add()
27691     *
27692     * @param transit Transit object.
27693     * @param axis Flipping Axis(X or Y).
27694     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27695     * @return Resizable flip effect context data.
27696     *
27697     * @ingroup Transit
27698     * @warning It is highly recommended just create a transit with this effect when
27699     * the window that the objects of the transit belongs has already been created.
27700     * This is because this effect needs the geometry information about the objects,
27701     * and if the window was not created yet, it can get a wrong information.
27702     */
27703    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27704
27705    /**
27706     * Add the Wipe Effect to Elm_Transit.
27707     *
27708     * @note This API is one of the facades. It creates wipe effect context
27709     * and add it's required APIs to elm_transit_effect_add.
27710     *
27711     * @see elm_transit_effect_add()
27712     *
27713     * @param transit Transit object.
27714     * @param type Wipe type. Hide or show.
27715     * @param dir Wipe Direction.
27716     * @return Wipe effect context data.
27717     *
27718     * @ingroup Transit
27719     * @warning It is highly recommended just create a transit with this effect when
27720     * the window that the objects of the transit belongs has already been created.
27721     * This is because this effect needs the geometry information about the objects,
27722     * and if the window was not created yet, it can get a wrong information.
27723     */
27724    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27725
27726    /**
27727     * Add the Color Effect to Elm_Transit.
27728     *
27729     * @note This API is one of the facades. It creates color effect context
27730     * and add it's required APIs to elm_transit_effect_add.
27731     *
27732     * @see elm_transit_effect_add()
27733     *
27734     * @param transit        Transit object.
27735     * @param  from_r        RGB R when effect begins.
27736     * @param  from_g        RGB G when effect begins.
27737     * @param  from_b        RGB B when effect begins.
27738     * @param  from_a        RGB A when effect begins.
27739     * @param  to_r          RGB R when effect ends.
27740     * @param  to_g          RGB G when effect ends.
27741     * @param  to_b          RGB B when effect ends.
27742     * @param  to_a          RGB A when effect ends.
27743     * @return               Color effect context data.
27744     *
27745     * @ingroup Transit
27746     */
27747    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);
27748
27749    /**
27750     * Add the Fade Effect to Elm_Transit.
27751     *
27752     * @note This API is one of the facades. It creates fade effect context
27753     * and add it's required APIs to elm_transit_effect_add.
27754     * @note This effect is applied to each pair of objects in the order they are listed
27755     * in the transit list of objects. The first object in the pair will be the
27756     * "before" object and the second will be the "after" object.
27757     *
27758     * @see elm_transit_effect_add()
27759     *
27760     * @param transit Transit object.
27761     * @return Fade effect context data.
27762     *
27763     * @ingroup Transit
27764     * @warning It is highly recommended just create a transit with this effect when
27765     * the window that the objects of the transit belongs has already been created.
27766     * This is because this effect needs the color information about the objects,
27767     * and if the window was not created yet, it can get a wrong information.
27768     */
27769    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27770
27771    /**
27772     * Add the Blend Effect to Elm_Transit.
27773     *
27774     * @note This API is one of the facades. It creates blend effect context
27775     * and add it's required APIs to elm_transit_effect_add.
27776     * @note This effect is applied to each pair of objects in the order they are listed
27777     * in the transit list of objects. The first object in the pair will be the
27778     * "before" object and the second will be the "after" object.
27779     *
27780     * @see elm_transit_effect_add()
27781     *
27782     * @param transit Transit object.
27783     * @return Blend effect context data.
27784     *
27785     * @ingroup Transit
27786     * @warning It is highly recommended just create a transit with this effect when
27787     * the window that the objects of the transit belongs has already been created.
27788     * This is because this effect needs the color information about the objects,
27789     * and if the window was not created yet, it can get a wrong information.
27790     */
27791    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27792
27793    /**
27794     * Add the Rotation Effect to Elm_Transit.
27795     *
27796     * @note This API is one of the facades. It creates rotation effect context
27797     * and add it's required APIs to elm_transit_effect_add.
27798     *
27799     * @see elm_transit_effect_add()
27800     *
27801     * @param transit Transit object.
27802     * @param from_degree Degree when effect begins.
27803     * @param to_degree Degree when effect is ends.
27804     * @return Rotation effect context data.
27805     *
27806     * @ingroup Transit
27807     * @warning It is highly recommended just create a transit with this effect when
27808     * the window that the objects of the transit belongs has already been created.
27809     * This is because this effect needs the geometry information about the objects,
27810     * and if the window was not created yet, it can get a wrong information.
27811     */
27812    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27813
27814    /**
27815     * Add the ImageAnimation Effect to Elm_Transit.
27816     *
27817     * @note This API is one of the facades. It creates image animation effect context
27818     * and add it's required APIs to elm_transit_effect_add.
27819     * The @p images parameter is a list images paths. This list and
27820     * its contents will be deleted at the end of the effect by
27821     * elm_transit_effect_image_animation_context_free() function.
27822     *
27823     * Example:
27824     * @code
27825     * char buf[PATH_MAX];
27826     * Eina_List *images = NULL;
27827     * Elm_Transit *transi = elm_transit_add();
27828     *
27829     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27830     * images = eina_list_append(images, eina_stringshare_add(buf));
27831     *
27832     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27833     * images = eina_list_append(images, eina_stringshare_add(buf));
27834     * elm_transit_effect_image_animation_add(transi, images);
27835     *
27836     * @endcode
27837     *
27838     * @see elm_transit_effect_add()
27839     *
27840     * @param transit Transit object.
27841     * @param images Eina_List of images file paths. This list and
27842     * its contents will be deleted at the end of the effect by
27843     * elm_transit_effect_image_animation_context_free() function.
27844     * @return Image Animation effect context data.
27845     *
27846     * @ingroup Transit
27847     */
27848    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27849    /**
27850     * @}
27851     */
27852
27853    typedef struct _Elm_Store                      Elm_Store;
27854    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
27855    typedef struct _Elm_Store_Item                 Elm_Store_Item;
27856    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
27857    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
27858    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27859    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
27860    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
27861    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
27862    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
27863    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
27864
27865    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27866    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27867    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27868    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27869
27870    typedef enum
27871      {
27872         ELM_STORE_ITEM_MAPPING_NONE = 0,
27873         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27874         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27875         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27876         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27877         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27878         // can add more here as needed by common apps
27879         ELM_STORE_ITEM_MAPPING_LAST
27880      } Elm_Store_Item_Mapping_Type;
27881
27882    struct _Elm_Store_Item_Mapping_Icon
27883      {
27884         // FIXME: allow edje file icons
27885         int                   w, h;
27886         Elm_Icon_Lookup_Order lookup_order;
27887         Eina_Bool             standard_name : 1;
27888         Eina_Bool             no_scale : 1;
27889         Eina_Bool             smooth : 1;
27890         Eina_Bool             scale_up : 1;
27891         Eina_Bool             scale_down : 1;
27892      };
27893
27894    struct _Elm_Store_Item_Mapping_Empty
27895      {
27896         Eina_Bool             dummy;
27897      };
27898
27899    struct _Elm_Store_Item_Mapping_Photo
27900      {
27901         int                   size;
27902      };
27903
27904    struct _Elm_Store_Item_Mapping_Custom
27905      {
27906         Elm_Store_Item_Mapping_Cb func;
27907      };
27908
27909    struct _Elm_Store_Item_Mapping
27910      {
27911         Elm_Store_Item_Mapping_Type     type;
27912         const char                     *part;
27913         int                             offset;
27914         union
27915           {
27916              Elm_Store_Item_Mapping_Empty  empty;
27917              Elm_Store_Item_Mapping_Icon   icon;
27918              Elm_Store_Item_Mapping_Photo  photo;
27919              Elm_Store_Item_Mapping_Custom custom;
27920              // add more types here
27921           } details;
27922      };
27923
27924    struct _Elm_Store_Item_Info
27925      {
27926         Elm_Genlist_Item_Class       *item_class;
27927         const Elm_Store_Item_Mapping *mapping;
27928         void                         *data;
27929         char                         *sort_id;
27930      };
27931
27932    struct _Elm_Store_Item_Info_Filesystem
27933      {
27934         Elm_Store_Item_Info  base;
27935         char                *path;
27936      };
27937
27938 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27939 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27940
27941    EAPI void                    elm_store_free(Elm_Store *st);
27942
27943    EAPI Elm_Store              *elm_store_filesystem_new(void);
27944    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27945    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27946    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27947
27948    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27949
27950    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27951    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27952    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27953    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27954    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27955    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27956
27957    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27958    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27959    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27960    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27961    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27962    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27963    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27964
27965    /**
27966     * @defgroup SegmentControl SegmentControl
27967     * @ingroup Elementary
27968     *
27969     * @image html img/widget/segment_control/preview-00.png
27970     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27971     *
27972     * @image html img/segment_control.png
27973     * @image latex img/segment_control.eps width=\textwidth
27974     *
27975     * Segment control widget is a horizontal control made of multiple segment
27976     * items, each segment item functioning similar to discrete two state button.
27977     * A segment control groups the items together and provides compact
27978     * single button with multiple equal size segments.
27979     *
27980     * Segment item size is determined by base widget
27981     * size and the number of items added.
27982     * Only one segment item can be at selected state. A segment item can display
27983     * combination of Text and any Evas_Object like Images or other widget.
27984     *
27985     * Smart callbacks one can listen to:
27986     * - "changed" - When the user clicks on a segment item which is not
27987     *   previously selected and get selected. The event_info parameter is the
27988     *   segment item pointer.
27989     *
27990     * Available styles for it:
27991     * - @c "default"
27992     *
27993     * Here is an example on its usage:
27994     * @li @ref segment_control_example
27995     */
27996
27997    /**
27998     * @addtogroup SegmentControl
27999     * @{
28000     */
28001
28002    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
28003
28004    /**
28005     * Add a new segment control widget to the given parent Elementary
28006     * (container) object.
28007     *
28008     * @param parent The parent object.
28009     * @return a new segment control widget handle or @c NULL, on errors.
28010     *
28011     * This function inserts a new segment control widget on the canvas.
28012     *
28013     * @ingroup SegmentControl
28014     */
28015    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28016
28017    /**
28018     * Append a new item to the segment control object.
28019     *
28020     * @param obj The segment control object.
28021     * @param icon The icon object to use for the left side of the item. An
28022     * icon can be any Evas object, but usually it is an icon created
28023     * with elm_icon_add().
28024     * @param label The label of the item.
28025     *        Note that, NULL is different from empty string "".
28026     * @return The created item or @c NULL upon failure.
28027     *
28028     * A new item will be created and appended to the segment control, i.e., will
28029     * be set as @b last item.
28030     *
28031     * If it should be inserted at another position,
28032     * elm_segment_control_item_insert_at() should be used instead.
28033     *
28034     * Items created with this function can be deleted with function
28035     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28036     *
28037     * @note @p label set to @c NULL is different from empty string "".
28038     * If an item
28039     * only has icon, it will be displayed bigger and centered. If it has
28040     * icon and label, even that an empty string, icon will be smaller and
28041     * positioned at left.
28042     *
28043     * Simple example:
28044     * @code
28045     * sc = elm_segment_control_add(win);
28046     * ic = elm_icon_add(win);
28047     * elm_icon_file_set(ic, "path/to/image", NULL);
28048     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
28049     * elm_segment_control_item_add(sc, ic, "label");
28050     * evas_object_show(sc);
28051     * @endcode
28052     *
28053     * @see elm_segment_control_item_insert_at()
28054     * @see elm_segment_control_item_del()
28055     *
28056     * @ingroup SegmentControl
28057     */
28058    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
28059
28060    /**
28061     * Insert a new item to the segment control object at specified position.
28062     *
28063     * @param obj The segment control object.
28064     * @param icon The icon object to use for the left side of the item. An
28065     * icon can be any Evas object, but usually it is an icon created
28066     * with elm_icon_add().
28067     * @param label The label of the item.
28068     * @param index Item position. Value should be between 0 and items count.
28069     * @return The created item or @c NULL upon failure.
28070
28071     * Index values must be between @c 0, when item will be prepended to
28072     * segment control, and items count, that can be get with
28073     * elm_segment_control_item_count_get(), case when item will be appended
28074     * to segment control, just like elm_segment_control_item_add().
28075     *
28076     * Items created with this function can be deleted with function
28077     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28078     *
28079     * @note @p label set to @c NULL is different from empty string "".
28080     * If an item
28081     * only has icon, it will be displayed bigger and centered. If it has
28082     * icon and label, even that an empty string, icon will be smaller and
28083     * positioned at left.
28084     *
28085     * @see elm_segment_control_item_add()
28086     * @see elm_segment_control_item_count_get()
28087     * @see elm_segment_control_item_del()
28088     *
28089     * @ingroup SegmentControl
28090     */
28091    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);
28092
28093    /**
28094     * Remove a segment control item from its parent, deleting it.
28095     *
28096     * @param it The item to be removed.
28097     *
28098     * Items can be added with elm_segment_control_item_add() or
28099     * elm_segment_control_item_insert_at().
28100     *
28101     * @ingroup SegmentControl
28102     */
28103    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28104
28105    /**
28106     * Remove a segment control item at given index from its parent,
28107     * deleting it.
28108     *
28109     * @param obj The segment control object.
28110     * @param index The position of the segment control item to be deleted.
28111     *
28112     * Items can be added with elm_segment_control_item_add() or
28113     * elm_segment_control_item_insert_at().
28114     *
28115     * @ingroup SegmentControl
28116     */
28117    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28118
28119    /**
28120     * Get the Segment items count from segment control.
28121     *
28122     * @param obj The segment control object.
28123     * @return Segment items count.
28124     *
28125     * It will just return the number of items added to segment control @p obj.
28126     *
28127     * @ingroup SegmentControl
28128     */
28129    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28130
28131    /**
28132     * Get the item placed at specified index.
28133     *
28134     * @param obj The segment control object.
28135     * @param index The index of the segment item.
28136     * @return The segment control item or @c NULL on failure.
28137     *
28138     * Index is the position of an item in segment control widget. Its
28139     * range is from @c 0 to <tt> count - 1 </tt>.
28140     * Count is the number of items, that can be get with
28141     * elm_segment_control_item_count_get().
28142     *
28143     * @ingroup SegmentControl
28144     */
28145    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28146
28147    /**
28148     * Get the label of item.
28149     *
28150     * @param obj The segment control object.
28151     * @param index The index of the segment item.
28152     * @return The label of the item at @p index.
28153     *
28154     * The return value is a pointer to the label associated to the item when
28155     * it was created, with function elm_segment_control_item_add(), or later
28156     * with function elm_segment_control_item_label_set. If no label
28157     * was passed as argument, it will return @c NULL.
28158     *
28159     * @see elm_segment_control_item_label_set() for more details.
28160     * @see elm_segment_control_item_add()
28161     *
28162     * @ingroup SegmentControl
28163     */
28164    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28165
28166    /**
28167     * Set the label of item.
28168     *
28169     * @param it The item of segment control.
28170     * @param text The label of item.
28171     *
28172     * The label to be displayed by the item.
28173     * Label will be at right of the icon (if set).
28174     *
28175     * If a label was passed as argument on item creation, with function
28176     * elm_control_segment_item_add(), it will be already
28177     * displayed by the item.
28178     *
28179     * @see elm_segment_control_item_label_get()
28180     * @see elm_segment_control_item_add()
28181     *
28182     * @ingroup SegmentControl
28183     */
28184    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28185
28186    /**
28187     * Get the icon associated to the item.
28188     *
28189     * @param obj The segment control object.
28190     * @param index The index of the segment item.
28191     * @return The left side icon associated to the item at @p index.
28192     *
28193     * The return value is a pointer to the icon associated to the item when
28194     * it was created, with function elm_segment_control_item_add(), or later
28195     * with function elm_segment_control_item_icon_set(). If no icon
28196     * was passed as argument, it will return @c NULL.
28197     *
28198     * @see elm_segment_control_item_add()
28199     * @see elm_segment_control_item_icon_set()
28200     *
28201     * @ingroup SegmentControl
28202     */
28203    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28204
28205    /**
28206     * Set the icon associated to the item.
28207     *
28208     * @param it The segment control item.
28209     * @param icon The icon object to associate with @p it.
28210     *
28211     * The icon object to use at left side of the item. An
28212     * icon can be any Evas object, but usually it is an icon created
28213     * with elm_icon_add().
28214     *
28215     * Once the icon object is set, a previously set one will be deleted.
28216     * @warning Setting the same icon for two items will cause the icon to
28217     * dissapear from the first item.
28218     *
28219     * If an icon was passed as argument on item creation, with function
28220     * elm_segment_control_item_add(), it will be already
28221     * associated to the item.
28222     *
28223     * @see elm_segment_control_item_add()
28224     * @see elm_segment_control_item_icon_get()
28225     *
28226     * @ingroup SegmentControl
28227     */
28228    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28229
28230    /**
28231     * Get the index of an item.
28232     *
28233     * @param it The segment control item.
28234     * @return The position of item in segment control widget.
28235     *
28236     * Index is the position of an item in segment control widget. Its
28237     * range is from @c 0 to <tt> count - 1 </tt>.
28238     * Count is the number of items, that can be get with
28239     * elm_segment_control_item_count_get().
28240     *
28241     * @ingroup SegmentControl
28242     */
28243    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28244
28245    /**
28246     * Get the base object of the item.
28247     *
28248     * @param it The segment control item.
28249     * @return The base object associated with @p it.
28250     *
28251     * Base object is the @c Evas_Object that represents that item.
28252     *
28253     * @ingroup SegmentControl
28254     */
28255    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28256
28257    /**
28258     * Get the selected item.
28259     *
28260     * @param obj The segment control object.
28261     * @return The selected item or @c NULL if none of segment items is
28262     * selected.
28263     *
28264     * The selected item can be unselected with function
28265     * elm_segment_control_item_selected_set().
28266     *
28267     * The selected item always will be highlighted on segment control.
28268     *
28269     * @ingroup SegmentControl
28270     */
28271    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28272
28273    /**
28274     * Set the selected state of an item.
28275     *
28276     * @param it The segment control item
28277     * @param select The selected state
28278     *
28279     * This sets the selected state of the given item @p it.
28280     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28281     *
28282     * If a new item is selected the previosly selected will be unselected.
28283     * Previoulsy selected item can be get with function
28284     * elm_segment_control_item_selected_get().
28285     *
28286     * The selected item always will be highlighted on segment control.
28287     *
28288     * @see elm_segment_control_item_selected_get()
28289     *
28290     * @ingroup SegmentControl
28291     */
28292    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28293
28294    /**
28295     * @}
28296     */
28297
28298    /**
28299     * @defgroup Grid Grid
28300     *
28301     * The grid is a grid layout widget that lays out a series of children as a
28302     * fixed "grid" of widgets using a given percentage of the grid width and
28303     * height each using the child object.
28304     *
28305     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28306     * widgets size itself. The default is 100 x 100, so that means the
28307     * position and sizes of children will effectively be percentages (0 to 100)
28308     * of the width or height of the grid widget
28309     *
28310     * @{
28311     */
28312
28313    /**
28314     * Add a new grid to the parent
28315     *
28316     * @param parent The parent object
28317     * @return The new object or NULL if it cannot be created
28318     *
28319     * @ingroup Grid
28320     */
28321    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28322
28323    /**
28324     * Set the virtual size of the grid
28325     *
28326     * @param obj The grid object
28327     * @param w The virtual width of the grid
28328     * @param h The virtual height of the grid
28329     *
28330     * @ingroup Grid
28331     */
28332    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
28333
28334    /**
28335     * Get the virtual size of the grid
28336     *
28337     * @param obj The grid object
28338     * @param w Pointer to integer to store the virtual width of the grid
28339     * @param h Pointer to integer to store the virtual height of the grid
28340     *
28341     * @ingroup Grid
28342     */
28343    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28344
28345    /**
28346     * Pack child at given position and size
28347     *
28348     * @param obj The grid object
28349     * @param subobj The child to pack
28350     * @param x The virtual x coord at which to pack it
28351     * @param y The virtual y coord at which to pack it
28352     * @param w The virtual width at which to pack it
28353     * @param h The virtual height at which to pack it
28354     *
28355     * @ingroup Grid
28356     */
28357    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28358
28359    /**
28360     * Unpack a child from a grid object
28361     *
28362     * @param obj The grid object
28363     * @param subobj The child to unpack
28364     *
28365     * @ingroup Grid
28366     */
28367    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28368
28369    /**
28370     * Faster way to remove all child objects from a grid object.
28371     *
28372     * @param obj The grid object
28373     * @param clear If true, it will delete just removed children
28374     *
28375     * @ingroup Grid
28376     */
28377    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28378
28379    /**
28380     * Set packing of an existing child at to position and size
28381     *
28382     * @param subobj The child to set packing of
28383     * @param x The virtual x coord at which to pack it
28384     * @param y The virtual y coord at which to pack it
28385     * @param w The virtual width at which to pack it
28386     * @param h The virtual height at which to pack it
28387     *
28388     * @ingroup Grid
28389     */
28390    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28391
28392    /**
28393     * get packing of a child
28394     *
28395     * @param subobj The child to query
28396     * @param x Pointer to integer to store the virtual x coord
28397     * @param y Pointer to integer to store the virtual y coord
28398     * @param w Pointer to integer to store the virtual width
28399     * @param h Pointer to integer to store the virtual height
28400     *
28401     * @ingroup Grid
28402     */
28403    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28404
28405    /**
28406     * @}
28407     */
28408
28409    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28410    EINA_DEPRECATED EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28411    EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28412    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28413    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
28414    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
28415
28416    /**
28417     * @defgroup Video Video
28418     *
28419     * @addtogroup Video
28420     * @{
28421     *
28422     * Elementary comes with two object that help design application that need
28423     * to display video. The main one, Elm_Video, display a video by using Emotion.
28424     * It does embedded the video inside an Edje object, so you can do some
28425     * animation depending on the video state change. It does also implement a
28426     * ressource management policy to remove this burden from the application writer.
28427     *
28428     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28429     * It take care of updating its content according to Emotion event and provide a
28430     * way to theme itself. It also does automatically raise the priority of the
28431     * linked Elm_Video so it will use the video decoder if available. It also does
28432     * activate the remember function on the linked Elm_Video object.
28433     *
28434     * Signals that you can add callback for are :
28435     *
28436     * "forward,clicked" - the user clicked the forward button.
28437     * "info,clicked" - the user clicked the info button.
28438     * "next,clicked" - the user clicked the next button.
28439     * "pause,clicked" - the user clicked the pause button.
28440     * "play,clicked" - the user clicked the play button.
28441     * "prev,clicked" - the user clicked the prev button.
28442     * "rewind,clicked" - the user clicked the rewind button.
28443     * "stop,clicked" - the user clicked the stop button.
28444     *
28445     * Default contents parts of the player widget that you can use for are:
28446     * @li "video" - A video of the player
28447     *
28448     */
28449
28450    /**
28451     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28452     *
28453     * @param parent The parent object
28454     * @return a new player widget handle or @c NULL, on errors.
28455     *
28456     * This function inserts a new player widget on the canvas.
28457     *
28458     * @see elm_object_part_content_set()
28459     *
28460     * @ingroup Video
28461     */
28462    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28463
28464    /**
28465     * @brief Link a Elm_Payer with an Elm_Video object.
28466     *
28467     * @param player the Elm_Player object.
28468     * @param video The Elm_Video object.
28469     *
28470     * This mean that action on the player widget will affect the
28471     * video object and the state of the video will be reflected in
28472     * the player itself.
28473     *
28474     * @see elm_player_add()
28475     * @see elm_video_add()
28476     * @deprecated use elm_object_part_content_set() instead
28477     *
28478     * @ingroup Video
28479     */
28480    EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28481
28482    /**
28483     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28484     *
28485     * @param parent The parent object
28486     * @return a new video widget handle or @c NULL, on errors.
28487     *
28488     * This function inserts a new video widget on the canvas.
28489     *
28490     * @seeelm_video_file_set()
28491     * @see elm_video_uri_set()
28492     *
28493     * @ingroup Video
28494     */
28495    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28496
28497    /**
28498     * @brief Define the file that will be the video source.
28499     *
28500     * @param video The video object to define the file for.
28501     * @param filename The file to target.
28502     *
28503     * This function will explicitly define a filename as a source
28504     * for the video of the Elm_Video object.
28505     *
28506     * @see elm_video_uri_set()
28507     * @see elm_video_add()
28508     * @see elm_player_add()
28509     *
28510     * @ingroup Video
28511     */
28512    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28513
28514    /**
28515     * @brief Define the uri that will be the video source.
28516     *
28517     * @param video The video object to define the file for.
28518     * @param uri The uri to target.
28519     *
28520     * This function will define an uri as a source for the video of the
28521     * Elm_Video object. URI could be remote source of video, like http:// or local source
28522     * like for example WebCam who are most of the time v4l2:// (but that depend and
28523     * you should use Emotion API to request and list the available Webcam on your system).
28524     *
28525     * @see elm_video_file_set()
28526     * @see elm_video_add()
28527     * @see elm_player_add()
28528     *
28529     * @ingroup Video
28530     */
28531    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28532
28533    /**
28534     * @brief Get the underlying Emotion object.
28535     *
28536     * @param video The video object to proceed the request on.
28537     * @return the underlying Emotion object.
28538     *
28539     * @ingroup Video
28540     */
28541    EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28542
28543    /**
28544     * @brief Start to play the video
28545     *
28546     * @param video The video object to proceed the request on.
28547     *
28548     * Start to play the video and cancel all suspend state.
28549     *
28550     * @ingroup Video
28551     */
28552    EAPI void elm_video_play(Evas_Object *video);
28553
28554    /**
28555     * @brief Pause the video
28556     *
28557     * @param video The video object to proceed the request on.
28558     *
28559     * Pause the video and start a timer to trigger suspend mode.
28560     *
28561     * @ingroup Video
28562     */
28563    EAPI void elm_video_pause(Evas_Object *video);
28564
28565    /**
28566     * @brief Stop the video
28567     *
28568     * @param video The video object to proceed the request on.
28569     *
28570     * Stop the video and put the emotion in deep sleep mode.
28571     *
28572     * @ingroup Video
28573     */
28574    EAPI void elm_video_stop(Evas_Object *video);
28575
28576    /**
28577     * @brief Is the video actually playing.
28578     *
28579     * @param video The video object to proceed the request on.
28580     * @return EINA_TRUE if the video is actually playing.
28581     *
28582     * You should consider watching event on the object instead of polling
28583     * the object state.
28584     *
28585     * @ingroup Video
28586     */
28587    EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28588
28589    /**
28590     * @brief Is it possible to seek inside the video.
28591     *
28592     * @param video The video object to proceed the request on.
28593     * @return EINA_TRUE if is possible to seek inside the video.
28594     *
28595     * @ingroup Video
28596     */
28597    EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28598
28599    /**
28600     * @brief Is the audio muted.
28601     *
28602     * @param video The video object to proceed the request on.
28603     * @return EINA_TRUE if the audio is muted.
28604     *
28605     * @ingroup Video
28606     */
28607    EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28608
28609    /**
28610     * @brief Change the mute state of the Elm_Video object.
28611     *
28612     * @param video The video object to proceed the request on.
28613     * @param mute The new mute state.
28614     *
28615     * @ingroup Video
28616     */
28617    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28618
28619    /**
28620     * @brief Get the audio level of the current video.
28621     *
28622     * @param video The video object to proceed the request on.
28623     * @return the current audio level.
28624     *
28625     * @ingroup Video
28626     */
28627    EAPI double elm_video_audio_level_get(const Evas_Object *video);
28628
28629    /**
28630     * @brief Set the audio level of anElm_Video object.
28631     *
28632     * @param video The video object to proceed the request on.
28633     * @param volume The new audio volume.
28634     *
28635     * @ingroup Video
28636     */
28637    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28638
28639    EAPI double elm_video_play_position_get(const Evas_Object *video);
28640    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28641    EAPI double elm_video_play_length_get(const Evas_Object *video);
28642    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28643    EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28644    EAPI const char *elm_video_title_get(const Evas_Object *video);
28645    /**
28646     * @}
28647     */
28648
28649    /**
28650     * @defgroup Naviframe Naviframe
28651     * @ingroup Elementary
28652     *
28653     * @brief Naviframe is a kind of view manager for the applications.
28654     *
28655     * Naviframe provides functions to switch different pages with stack
28656     * mechanism. It means if one page(item) needs to be changed to the new one,
28657     * then naviframe would push the new page to it's internal stack. Of course,
28658     * it can be back to the previous page by popping the top page. Naviframe
28659     * provides some transition effect while the pages are switching (same as
28660     * pager).
28661     *
28662     * Since each item could keep the different styles, users could keep the
28663     * same look & feel for the pages or different styles for the items in it's
28664     * application.
28665     *
28666     * Signals that you can add callback for are:
28667     * @li "transition,finished" - When the transition is finished in changing
28668     *     the item
28669     * @li "title,clicked" - User clicked title area
28670     *
28671     * Default contents parts of the naviframe items that you can use for are:
28672     * @li "default" - A main content of the page
28673     * @li "icon" - An icon in the title area
28674     * @li "prev_btn" - A button to go to the previous page
28675     * @li "next_btn" - A button to go to the next page
28676     *
28677     * Default text parts of the naviframe items that you can use for are:
28678     * @li "default" - Title label in the title area
28679     * @li "subtitle" - Sub-title label in the title area
28680     *
28681     * @ref tutorial_naviframe gives a good overview of the usage of the API.
28682     */
28683
28684    /**
28685     * @addtogroup Naviframe
28686     * @{
28687     */
28688
28689    /**
28690     * @brief Add a new Naviframe object to the parent.
28691     *
28692     * @param parent Parent object
28693     * @return New object or @c NULL, if it cannot be created
28694     *
28695     * @ingroup Naviframe
28696     */
28697    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28698    /**
28699     * @brief Push a new item to the top of the naviframe stack (and show it).
28700     *
28701     * @param obj The naviframe object
28702     * @param title_label The label in the title area. The name of the title
28703     *        label part is "elm.text.title"
28704     * @param prev_btn The button to go to the previous item. If it is NULL,
28705     *        then naviframe will create a back button automatically. The name of
28706     *        the prev_btn part is "elm.swallow.prev_btn"
28707     * @param next_btn The button to go to the next item. Or It could be just an
28708     *        extra function button. The name of the next_btn part is
28709     *        "elm.swallow.next_btn"
28710     * @param content The main content object. The name of content part is
28711     *        "elm.swallow.content"
28712     * @param item_style The current item style name. @c NULL would be default.
28713     * @return The created item or @c NULL upon failure.
28714     *
28715     * The item pushed becomes one page of the naviframe, this item will be
28716     * deleted when it is popped.
28717     *
28718     * @see also elm_naviframe_item_style_set()
28719     * @see also elm_naviframe_item_insert_before()
28720     * @see also elm_naviframe_item_insert_after()
28721     *
28722     * The following styles are available for this item:
28723     * @li @c "default"
28724     *
28725     * @ingroup Naviframe
28726     */
28727    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);
28728     /**
28729     * @brief Insert a new item into the naviframe before item @p before.
28730     *
28731     * @param before The naviframe item to insert before.
28732     * @param title_label The label in the title area. The name of the title
28733     *        label part is "elm.text.title"
28734     * @param prev_btn The button to go to the previous item. If it is NULL,
28735     *        then naviframe will create a back button automatically. The name of
28736     *        the prev_btn part is "elm.swallow.prev_btn"
28737     * @param next_btn The button to go to the next item. Or It could be just an
28738     *        extra function button. The name of the next_btn part is
28739     *        "elm.swallow.next_btn"
28740     * @param content The main content object. The name of content part is
28741     *        "elm.swallow.content"
28742     * @param item_style The current item style name. @c NULL would be default.
28743     * @return The created item or @c NULL upon failure.
28744     *
28745     * The item is inserted into the naviframe straight away without any
28746     * transition operations. This item will be deleted when it is popped.
28747     *
28748     * @see also elm_naviframe_item_style_set()
28749     * @see also elm_naviframe_item_push()
28750     * @see also elm_naviframe_item_insert_after()
28751     *
28752     * The following styles are available for this item:
28753     * @li @c "default"
28754     *
28755     * @ingroup Naviframe
28756     */
28757    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);
28758    /**
28759     * @brief Insert a new item into the naviframe after item @p after.
28760     *
28761     * @param after The naviframe item to insert after.
28762     * @param title_label The label in the title area. The name of the title
28763     *        label part is "elm.text.title"
28764     * @param prev_btn The button to go to the previous item. If it is NULL,
28765     *        then naviframe will create a back button automatically. The name of
28766     *        the prev_btn part is "elm.swallow.prev_btn"
28767     * @param next_btn The button to go to the next item. Or It could be just an
28768     *        extra function button. The name of the next_btn part is
28769     *        "elm.swallow.next_btn"
28770     * @param content The main content object. The name of content part is
28771     *        "elm.swallow.content"
28772     * @param item_style The current item style name. @c NULL would be default.
28773     * @return The created item or @c NULL upon failure.
28774     *
28775     * The item is inserted into the naviframe straight away without any
28776     * transition operations. This item will be deleted when it is popped.
28777     *
28778     * @see also elm_naviframe_item_style_set()
28779     * @see also elm_naviframe_item_push()
28780     * @see also elm_naviframe_item_insert_before()
28781     *
28782     * The following styles are available for this item:
28783     * @li @c "default"
28784     *
28785     * @ingroup Naviframe
28786     */
28787    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);
28788    /**
28789     * @brief Pop an item that is on top of the stack
28790     *
28791     * @param obj The naviframe object
28792     * @return @c NULL or the content object(if the
28793     *         elm_naviframe_content_preserve_on_pop_get is true).
28794     *
28795     * This pops an item that is on the top(visible) of the naviframe, makes it
28796     * disappear, then deletes the item. The item that was underneath it on the
28797     * stack will become visible.
28798     *
28799     * @see also elm_naviframe_content_preserve_on_pop_get()
28800     *
28801     * @ingroup Naviframe
28802     */
28803    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28804    /**
28805     * @brief Pop the items between the top and the above one on the given item.
28806     *
28807     * @param it The naviframe item
28808     *
28809     * @ingroup Naviframe
28810     */
28811    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28812    /**
28813    * Promote an item already in the naviframe stack to the top of the stack
28814    *
28815    * @param it The naviframe item
28816    *
28817    * This will take the indicated item and promote it to the top of the stack
28818    * as if it had been pushed there. The item must already be inside the
28819    * naviframe stack to work.
28820    *
28821    */
28822    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28823    /**
28824     * @brief Delete the given item instantly.
28825     *
28826     * @param it The naviframe item
28827     *
28828     * This just deletes the given item from the naviframe item list instantly.
28829     * So this would not emit any signals for view transitions but just change
28830     * the current view if the given item is a top one.
28831     *
28832     * @ingroup Naviframe
28833     */
28834    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28835    /**
28836     * @brief preserve the content objects when items are popped.
28837     *
28838     * @param obj The naviframe object
28839     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28840     *
28841     * @see also elm_naviframe_content_preserve_on_pop_get()
28842     *
28843     * @ingroup Naviframe
28844     */
28845    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28846    /**
28847     * @brief Get a value whether preserve mode is enabled or not.
28848     *
28849     * @param obj The naviframe object
28850     * @return If @c EINA_TRUE, preserve mode is enabled
28851     *
28852     * @see also elm_naviframe_content_preserve_on_pop_set()
28853     *
28854     * @ingroup Naviframe
28855     */
28856    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28857    /**
28858     * @brief Get a top item on the naviframe stack
28859     *
28860     * @param obj The naviframe object
28861     * @return The top item on the naviframe stack or @c NULL, if the stack is
28862     *         empty
28863     *
28864     * @ingroup Naviframe
28865     */
28866    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28867    /**
28868     * @brief Get a bottom item on the naviframe stack
28869     *
28870     * @param obj The naviframe object
28871     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28872     *         empty
28873     *
28874     * @ingroup Naviframe
28875     */
28876    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28877    /**
28878     * @brief Set an item style
28879     *
28880     * @param obj The naviframe item
28881     * @param item_style The current item style name. @c NULL would be default
28882     *
28883     * The following styles are available for this item:
28884     * @li @c "default"
28885     *
28886     * @see also elm_naviframe_item_style_get()
28887     *
28888     * @ingroup Naviframe
28889     */
28890    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28891    /**
28892     * @brief Get an item style
28893     *
28894     * @param obj The naviframe item
28895     * @return The current item style name
28896     *
28897     * @see also elm_naviframe_item_style_set()
28898     *
28899     * @ingroup Naviframe
28900     */
28901    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28902    /**
28903     * @brief Show/Hide the title area
28904     *
28905     * @param it The naviframe item
28906     * @param visible If @c EINA_TRUE, title area will be visible, hidden
28907     *        otherwise
28908     *
28909     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
28910     *
28911     * @see also elm_naviframe_item_title_visible_get()
28912     *
28913     * @ingroup Naviframe
28914     */
28915    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28916    /**
28917     * @brief Get a value whether title area is visible or not.
28918     *
28919     * @param it The naviframe item
28920     * @return If @c EINA_TRUE, title area is visible
28921     *
28922     * @see also elm_naviframe_item_title_visible_set()
28923     *
28924     * @ingroup Naviframe
28925     */
28926    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28927
28928    /**
28929     * @brief Set creating prev button automatically or not
28930     *
28931     * @param obj The naviframe object
28932     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28933     *        be created internally when you pass the @c NULL to the prev_btn
28934     *        parameter in elm_naviframe_item_push
28935     *
28936     * @see also elm_naviframe_item_push()
28937     */
28938    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28939    /**
28940     * @brief Get a value whether prev button(back button) will be auto pushed or
28941     *        not.
28942     *
28943     * @param obj The naviframe object
28944     * @return If @c EINA_TRUE, prev button will be auto pushed.
28945     *
28946     * @see also elm_naviframe_item_push()
28947     *           elm_naviframe_prev_btn_auto_pushed_set()
28948     */
28949    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28950    /**
28951     * @brief Get a list of all the naviframe items.
28952     *
28953     * @param obj The naviframe object
28954     * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28955     * or @c NULL on failure.
28956     */
28957    EAPI Eina_Inlist        *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28958
28959     /**
28960     * @}
28961     */
28962
28963    /**
28964     * @defgroup Multibuttonentry Multibuttonentry
28965     *
28966     * A Multibuttonentry is a widget to allow a user enter text and manage it as a number of buttons
28967     * Each text button is inserted by pressing the "return" key. If there is no space in the current row,
28968     * a new button is added to the next row. When a text button is pressed, it will become focused.
28969     * Backspace removes the focus.
28970     * When the Multibuttonentry loses focus items longer than 1 lines are shrunk to one line.
28971     *
28972     * Smart callbacks one can register:
28973     * - @c "item,selected" - when item is selected. May be called on backspace key.
28974     * - @c "item,added" - when a new multibuttonentry item is added.
28975     * - @c "item,deleted" - when a multibuttonentry item is deleted.
28976     * - @c "item,clicked" - selected item of multibuttonentry is clicked.
28977     * - @c "clicked" - when multibuttonentry is clicked.
28978     * - @c "focused" - when multibuttonentry is focused.
28979     * - @c "unfocused" - when multibuttonentry is unfocused.
28980     * - @c "expanded" - when multibuttonentry is expanded.
28981     * - @c "shrank" - when multibuttonentry is shrank.
28982     * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed.
28983     *
28984     * Here is an example on its usage:
28985     * @li @ref multibuttonentry_example
28986     */
28987     /**
28988     * @addtogroup Multibuttonentry
28989     * @{
28990     */
28991
28992    typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
28993    typedef Eina_Bool (*Elm_Multibuttonentry_Item_Filter_callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
28994
28995    /**
28996     * @brief Add a new multibuttonentry to the parent
28997     *
28998     * @param parent The parent object
28999     * @return The new object or NULL if it cannot be created
29000     *
29001     */
29002    EAPI Evas_Object               *elm_multibuttonentry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29003    /**
29004     * Get the label
29005     *
29006     * @param obj The multibuttonentry object
29007     * @return The label, or NULL if none
29008     *
29009     */
29010    EAPI const char                *elm_multibuttonentry_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29011    /**
29012     * Set the label
29013     *
29014     * @param obj The multibuttonentry object
29015     * @param label The text label string
29016     *
29017     */
29018    EAPI void                       elm_multibuttonentry_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29019    /**
29020     * Get the entry of the multibuttonentry object
29021     *
29022     * @param obj The multibuttonentry object
29023     * @return The entry object, or NULL if none
29024     *
29025     */
29026    EAPI Evas_Object               *elm_multibuttonentry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29027    /**
29028     * Get the guide text
29029     *
29030     * @param obj The multibuttonentry object
29031     * @return The guide text, or NULL if none
29032     *
29033     */
29034    EAPI const char *               elm_multibuttonentry_guide_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29035    /**
29036     * Set the guide text
29037     *
29038     * @param obj The multibuttonentry object
29039     * @param label The guide text string
29040     *
29041     */
29042    EAPI void                       elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext) EINA_ARG_NONNULL(1);
29043    /**
29044     * Get the value of shrink_mode state.
29045     *
29046     * @param obj The multibuttonentry object
29047     * @param the value of shrink mode state.
29048     *
29049     */
29050    EAPI int                        elm_multibuttonentry_shrink_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29051    /**
29052     * Set/Unset the multibuttonentry to shrink mode state of single line
29053     *
29054     * @param obj The multibuttonentry object
29055     * @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.
29056     *
29057     */
29058    EAPI void                       elm_multibuttonentry_shrink_mode_set(Evas_Object *obj, int shrink) EINA_ARG_NONNULL(1);
29059    /**
29060     * Prepend a new item to the multibuttonentry
29061     *
29062     * @param obj The multibuttonentry object
29063     * @param label The label of new item
29064     * @param data The ponter to the data to be attached
29065     * @return A handle to the item added or NULL if not possible
29066     *
29067     */
29068    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prepend(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
29069    /**
29070     * Append a new item to the multibuttonentry
29071     *
29072     * @param obj The multibuttonentry object
29073     * @param label The label of new item
29074     * @param data The ponter to the data to be attached
29075     * @return A handle to the item added or NULL if not possible
29076     *
29077     */
29078    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_append(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
29079    /**
29080     * Add a new item to the multibuttonentry before the indicated object
29081     *
29082     * reference.
29083     * @param obj The multibuttonentry object
29084     * @param before The item before which to add it
29085     * @param label The label of new item
29086     * @param data The ponter to the data to be attached
29087     * @return A handle to the item added or NULL if not possible
29088     *
29089     */
29090    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);
29091    /**
29092     * Add a new item to the multibuttonentry after the indicated object
29093     *
29094     * @param obj The multibuttonentry object
29095     * @param after The item after which to add it
29096     * @param label The label of new item
29097     * @param data The ponter to the data to be attached
29098     * @return A handle to the item added or NULL if not possible
29099     *
29100     */
29101    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);
29102    /**
29103     * Get a list of items in the multibuttonentry
29104     *
29105     * @param obj The multibuttonentry object
29106     * @return The list of items, or NULL if none
29107     *
29108     */
29109    EAPI const Eina_List           *elm_multibuttonentry_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29110    /**
29111     * Get the first item in the multibuttonentry
29112     *
29113     * @param obj The multibuttonentry object
29114     * @return The first item, or NULL if none
29115     *
29116     */
29117    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29118    /**
29119     * Get the last item in the multibuttonentry
29120     *
29121     * @param obj The multibuttonentry object
29122     * @return The last item, or NULL if none
29123     *
29124     */
29125    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29126    /**
29127     * Get the selected item in the multibuttonentry
29128     *
29129     * @param obj The multibuttonentry object
29130     * @return The selected item, or NULL if none
29131     *
29132     */
29133    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29134    /**
29135     * Set the selected state of an item
29136     *
29137     * @param item The item
29138     * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
29139     *
29140     */
29141    EAPI void                       elm_multibuttonentry_item_select(Elm_Multibuttonentry_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
29142    /**
29143    * unselect all items.
29144    *
29145    * @param obj The multibuttonentry object
29146    *
29147    */
29148    EAPI void                       elm_multibuttonentry_item_unselect_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
29149   /**
29150    * Delete a given item
29151    *
29152    * @param item The item
29153    *
29154    */
29155    EAPI void                       elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29156   /**
29157    * Remove all items in the multibuttonentry.
29158    *
29159    * @param obj The multibuttonentry object
29160    *
29161    */
29162    EAPI void                       elm_multibuttonentry_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
29163   /**
29164    * Get the label of a given item
29165    *
29166    * @param item The item
29167    * @return The label of a given item, or NULL if none
29168    *
29169    */
29170    EAPI const char                *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29171   /**
29172    * Set the label of a given item
29173    *
29174    * @param item The item
29175    * @param label The text label string
29176    *
29177    */
29178    EAPI void                       elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str) EINA_ARG_NONNULL(1);
29179   /**
29180    * Get the previous item in the multibuttonentry
29181    *
29182    * @param item The item
29183    * @return The item before the item @p item
29184    *
29185    */
29186    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29187   /**
29188    * Get the next item in the multibuttonentry
29189    *
29190    * @param item The item
29191    * @return The item after the item @p item
29192    *
29193    */
29194    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
29195   /**
29196    * Append a item filter function for text inserted in the Multibuttonentry
29197    *
29198    * Append the given callback to the list. This functions will be called
29199    * whenever any text is inserted into the Multibuttonentry, with the text to be inserted
29200    * as a parameter. The callback function is free to alter the text in any way
29201    * it wants, but it must remember to free the given pointer and update it.
29202    * If the new text is to be discarded, the function can free it and set it text
29203    * parameter to NULL. This will also prevent any following filters from being
29204    * called.
29205    *
29206    * @param obj The multibuttonentryentry object
29207    * @param func The function to use as item filter
29208    * @param data User data to pass to @p func
29209    *
29210    */
29211    EAPI void elm_multibuttonentry_item_filter_append(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
29212   /**
29213    * Prepend a filter function for text inserted in the Multibuttentry
29214    *
29215    * Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
29216    * for more information
29217    *
29218    * @param obj The multibuttonentry object
29219    * @param func The function to use as text filter
29220    * @param data User data to pass to @p func
29221    *
29222    */
29223    EAPI void elm_multibuttonentry_item_filter_prepend(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
29224   /**
29225    * Remove a filter from the list
29226    *
29227    * Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
29228    * for more information.
29229    *
29230    * @param obj The multibuttonentry object
29231    * @param func The filter function to remove
29232    * @param data The user data passed when adding the function
29233    *
29234    */
29235    EAPI void elm_multibuttonentry_item_filter_remove(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
29236
29237    /**
29238     * @}
29239     */
29240
29241 #ifdef __cplusplus
29242 }
29243 #endif
29244
29245 #endif