ummm not sure how I did this
[framework/uifw/elementary.git] / src / lib / Elementary.h.in
1 /*
2  *
3  * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
4  */
5
6 /**
7 @file Elementary.h.in
8 @brief Elementary Widget Library
9 */
10
11 /**
12 @mainpage Elementary
13 @image html  elementary.png
14 @version 0.8.0
15 @date 2008-2011
16
17 @section intro What is Elementary?
18
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
21
22 It is meant to make the programmers work almost brainless but give them lots
23 of flexibility.
24
25 @li @ref Start - Go here to quickly get started with writing Apps
26
27 @section organization Organization
28
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
33
34 @section license License
35
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
38
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
44 */
45
46
47 /**
48  * @defgroup Start Getting Started
49  *
50  * To write an Elementary app, you can get started with the following:
51  *
52 @code
53 #include <Elementary.h>
54 EAPI_MAIN int
55 elm_main(int argc, char **argv)
56 {
57    // create window(s) here and do any application init
58    elm_run(); // run main loop
59    elm_shutdown(); // after mainloop finishes running, shutdown
60    return 0; // exit 0 for exit code
61 }
62 ELM_MAIN()
63 @endcode
64  *
65  * To use autotools (which helps in many ways in the long run, like being able
66  * to immediately create releases of your software directly from your tree
67  * and ensure everything needed to build it is there) you will need a
68  * configure.ac, Makefile.am and autogen.sh file.
69  *
70  * configure.ac:
71  *
72 @verbatim
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
74 AC_PREREQ(2.52)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
77 AC_PROG_CC
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
80 AC_OUTPUT(Makefile)
81 @endverbatim
82  *
83  * Makefile.am:
84  *
85 @verbatim
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
88
89 INCLUDES = -I$(top_srcdir)
90
91 bin_PROGRAMS = myapp
92
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
96 @endverbatim
97  *
98  * autogen.sh:
99  *
100 @verbatim
101 #!/bin/sh
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
106 ./configure "$@"
107 @endverbatim
108  *
109  * To generate all the things needed to bootstrap just run:
110  *
111 @verbatim
112 ./autogen.sh
113 @endverbatim
114  *
115  * This will generate Makefile.in's, the confgure script and everything else.
116  * After this it works like all normal autotools projects:
117 @verbatim
118 ./configure
119 make
120 sudo make install
121 @endverbatim
122  *
123  * Note sudo was assumed to get root permissions, as this would install in
124  * /usr/local which is system-owned. Use any way you like to gain root, or
125  * specify a different prefix with configure:
126  *
127 @verbatim
128 ./confiugre --prefix=$HOME/mysoftware
129 @endverbatim
130  *
131  * Also remember that autotools buys you some useful commands like:
132 @verbatim
133 make uninstall
134 @endverbatim
135  *
136  * This uninstalls the software after it was installed with "make install".
137  * It is very useful to clear up what you built if you wish to clean the
138  * system.
139  *
140 @verbatim
141 make distcheck
142 @endverbatim
143  *
144  * This firstly checks if your build tree is "clean" and ready for
145  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146  * ready to upload and distribute to the world, that contains the generated
147  * Makefile.in's and configure script. The users do not need to run
148  * autogen.sh - just configure and on. They don't need autotools installed.
149  * This tarball also builds cleanly, has all the sources it needs to build
150  * included (that is sources for your application, not libraries it depends
151  * on like Elementary). It builds cleanly in a buildroot and does not
152  * contain any files that are temporarily generated like binaries and other
153  * build-generated files, so the tarball is clean, and no need to worry
154  * about cleaning up your tree before packaging.
155  *
156 @verbatim
157 make clean
158 @endverbatim
159  *
160  * This cleans up all build files (binaries, objects etc.) from the tree.
161  *
162 @verbatim
163 make distclean
164 @endverbatim
165  *
166  * This cleans out all files from the build and from configure's output too.
167  *
168 @verbatim
169 make maintainer-clean
170 @endverbatim
171  *
172  * This deletes all the files autogen.sh will produce so the tree is clean
173  * to be put into a revision-control system (like CVS, SVN or GIT for example).
174  *
175  * There is a more advanced way of making use of the quicklaunch infrastructure
176  * in Elementary (which will not be covered here due to its more advanced
177  * nature).
178  *
179  * Now let's actually create an interactive "Hello World" gui that you can
180  * click the ok button to exit. It's more code because this now does something
181  * much more significant, but it's still very simple:
182  *
183 @code
184 #include <Elementary.h>
185
186 static void
187 on_done(void *data, Evas_Object *obj, void *event_info)
188 {
189    // quit the mainloop (elm_run function will return)
190    elm_exit();
191 }
192
193 EAPI_MAIN int
194 elm_main(int argc, char **argv)
195 {
196    Evas_Object *win, *bg, *box, *lab, *btn;
197
198    // new window - do the usual and give it a name (hello) and title (Hello)
199    win = elm_win_util_standard_add("hello", "Hello");
200    // when the user clicks "close" on a window there is a request to delete
201    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
202
203    // add a box object - default is vertical. a box holds children in a row,
204    // either horizontally or vertically. nothing more.
205    box = elm_box_add(win);
206    // make the box hotizontal
207    elm_box_horizontal_set(box, EINA_TRUE);
208    // add object as a resize object for the window (controls window minimum
209    // size as well as gets resized if window is resized)
210    elm_win_resize_object_add(win, box);
211    evas_object_show(box);
212
213    // add a label widget, set the text and put it in the pad frame
214    lab = elm_label_add(win);
215    // set default text of the label
216    elm_object_text_set(lab, "Hello out there world!");
217    // pack the label at the end of the box
218    elm_box_pack_end(box, lab);
219    evas_object_show(lab);
220
221    // add an ok button
222    btn = elm_button_add(win);
223    // set default text of button to "OK"
224    elm_object_text_set(btn, "OK");
225    // pack the button at the end of the box
226    elm_box_pack_end(box, btn);
227    evas_object_show(btn);
228    // call on_done when button is clicked
229    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
230
231    // now we are done, show the window
232    evas_object_show(win);
233
234    // run the mainloop and process events and callbacks
235    elm_run();
236    elm_shutdown();
237    return 0;
238 }
239 ELM_MAIN()
240 @endcode
241    *
242    */
243
244 /**
245 @page authors Authors
246 @author Carsten Haitzler <raster@@rasterman.com>
247 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
248 @author Cedric Bail <cedric.bail@@free.fr>
249 @author Vincent Torri <vtorri@@univ-evry.fr>
250 @author Daniel Kolesa <quaker66@@gmail.com>
251 @author Jaime Thomas <avi.thomas@@gmail.com>
252 @author Swisscom - http://www.swisscom.ch/
253 @author Christopher Michael <devilhorns@@comcast.net>
254 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
255 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
256 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
257 @author Brian Wang <brian.wang.0721@@gmail.com>
258 @author Mike Blumenkrantz (discomfitor/zmike) <michael.blumenkrantz@@gmail.com>
259 @author Samsung Electronics <tbd>
260 @author Samsung SAIT <tbd>
261 @author Brett Nash <nash@@nash.id.au>
262 @author Bruno Dilly <bdilly@@profusion.mobi>
263 @author Rafael Fonseca <rfonseca@@profusion.mobi>
264 @author Chuneon Park <hermet@@hermet.pe.kr>
265 @author Woohyun Jung <wh0705.jung@@samsung.com>
266 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
267 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
268 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
269 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
270 @author Gustavo Lima Chaves <glima@@profusion.mobi>
271 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
272 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
273 @author Otavio Pontes <otavio@@profusion.mobi>
274 @author Viktor Kojouharov <vkojouharov@@gmail.com>
275 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
276 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
277 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
278 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
279 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
280 @author Jihoon Kim <jihoon48.kim@@samsung.com>
281 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
282 @author Tom Hacohen <tom@@stosb.com>
283 @author Aharon Hillel <a.hillel@@partner.samsung.com>
284 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
285 @author Shinwoo Kim <kimcinoo@@gmail.com>
286 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
287 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
288 @author Sung W. Park <sungwoo@@gmail.com>
289 @author Thierry el Borgi <thierry@@substantiel.fr>
290 @author Shilpa Singh <shilpa.singh@@samsung.com> <shilpasingh.o@@gmail.com>
291 @author Chanwook Jung <joey.jung@@samsung.com>
292 @author Hyoyoung Chang <hyoyoung.chang@@samsung.com>
293 @author Guillaume "Kuri" Friloux <guillaume.friloux@@asp64.com>
294 @author Kim Yunhan <spbear@@gmail.com>
295 @author Bluezery <ohpowel@@gmail.com>
296 @author Nicolas Aguirre <aguirre.nicolas@@gmail.com>
297 @author Sanjeev BA <iamsanjeev@@gmail.com>
298
299 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
300 contact with the developers and maintainers.
301  */
302
303 #ifndef ELEMENTARY_H
304 #define ELEMENTARY_H
305
306 /**
307  * @file Elementary.h
308  * @brief Elementary's API
309  *
310  * Elementary API.
311  */
312
313 @ELM_UNIX_DEF@ ELM_UNIX
314 @ELM_WIN32_DEF@ ELM_WIN32
315 @ELM_WINCE_DEF@ ELM_WINCE
316 @ELM_EDBUS_DEF@ ELM_EDBUS
317 @ELM_EFREET_DEF@ ELM_EFREET
318 @ELM_ETHUMB_DEF@ ELM_ETHUMB
319 @ELM_WEB_DEF@ ELM_WEB
320 @ELM_EMAP_DEF@ ELM_EMAP
321 @ELM_DEBUG_DEF@ ELM_DEBUG
322 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
323 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
324 @ELM_DIRENT_H_DEF@ ELM_DIRENT_H
325
326 /* Standard headers for standard system calls etc. */
327 #include <stdio.h>
328 #include <stdlib.h>
329 #include <unistd.h>
330 #include <string.h>
331 #include <sys/types.h>
332 #include <sys/stat.h>
333 #include <sys/time.h>
334 #include <sys/param.h>
335 #include <math.h>
336 #include <fnmatch.h>
337 #include <limits.h>
338 #include <ctype.h>
339 #include <time.h>
340 #ifdef ELM_DIRENT_H
341 # include <dirent.h>
342 #endif
343 #include <pwd.h>
344 #include <errno.h>
345
346 #ifdef ELM_UNIX
347 # include <locale.h>
348 # ifdef ELM_LIBINTL_H
349 #  include <libintl.h>
350 # endif
351 # include <signal.h>
352 # include <grp.h>
353 # include <glob.h>
354 #endif
355
356 #ifdef ELM_ALLOCA_H
357 # include <alloca.h>
358 #endif
359
360 #if defined (ELM_WIN32) || defined (ELM_WINCE)
361 # include <malloc.h>
362 # ifndef alloca
363 #  define alloca _alloca
364 # endif
365 #endif
366
367
368 /* EFL headers */
369 #include <Eina.h>
370 #include <Eet.h>
371 #include <Evas.h>
372 #include <Evas_GL.h>
373 #include <Ecore.h>
374 #include <Ecore_Evas.h>
375 #include <Ecore_File.h>
376 @ELEMENTARY_ECORE_IMF_INC@
377 @ELEMENTARY_ECORE_CON_INC@
378 #include <Edje.h>
379
380 #ifdef ELM_EDBUS
381 # include <E_DBus.h>
382 #endif
383
384 #ifdef ELM_EFREET
385 # include <Efreet.h>
386 # include <Efreet_Mime.h>
387 # include <Efreet_Trash.h>
388 #endif
389
390 #ifdef ELM_ETHUMB
391 # include <Ethumb_Client.h>
392 #endif
393
394 #ifdef ELM_EMAP
395 # include <EMap.h>
396 #endif
397
398 #ifdef EAPI
399 # undef EAPI
400 #endif
401
402 #ifdef _WIN32
403 # ifdef ELEMENTARY_BUILD
404 #  ifdef DLL_EXPORT
405 #   define EAPI __declspec(dllexport)
406 #  else
407 #   define EAPI
408 #  endif /* ! DLL_EXPORT */
409 # else
410 #  define EAPI __declspec(dllimport)
411 # endif /* ! EFL_EVAS_BUILD */
412 #else
413 # ifdef __GNUC__
414 #  if __GNUC__ >= 4
415 #   define EAPI __attribute__ ((visibility("default")))
416 #  else
417 #   define EAPI
418 #  endif
419 # else
420 #  define EAPI
421 # endif
422 #endif /* ! _WIN32 */
423
424 #ifdef _WIN32
425 # define EAPI_MAIN
426 #else
427 # define EAPI_MAIN EAPI
428 #endif
429
430 /* allow usage from c++ */
431 #ifdef __cplusplus
432 extern "C" {
433 #endif
434
435 #define ELM_VERSION_MAJOR @VMAJ@
436 #define ELM_VERSION_MINOR @VMIN@
437
438    typedef struct _Elm_Version
439      {
440         int major;
441         int minor;
442         int micro;
443         int revision;
444      } Elm_Version;
445
446    EAPI extern Elm_Version *elm_version;
447
448 /* handy macros */
449 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
450 #define ELM_PI 3.14159265358979323846
451
452    /**
453     * @defgroup General General
454     *
455     * @brief General Elementary API. Functions that don't relate to
456     * Elementary objects specifically.
457     *
458     * Here are documented functions which init/shutdown the library,
459     * that apply to generic Elementary objects, that deal with
460     * configuration, et cetera.
461     *
462     * @ref general_functions_example_page "This" example contemplates
463     * some of these functions.
464     */
465
466    /**
467     * @addtogroup General
468     * @{
469     */
470
471   /**
472    * Defines couple of standard Evas_Object layers to be used
473    * with evas_object_layer_set().
474    *
475    * @note whenever extending with new values, try to keep some padding
476    *       to siblings so there is room for further extensions.
477    */
478   typedef enum _Elm_Object_Layer
479     {
480        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
481        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
482        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
483        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
484        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
485        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
486     } Elm_Object_Layer;
487
488 /**************************************************************************/
489    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
490
491    /**
492     * Emitted when the application has reconfigured elementary settings due
493     * to an external configuration tool asking it to.
494     */
495    EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
496
497    /**
498     * Emitted when any Elementary's policy value is changed.
499     */
500    EAPI extern int ELM_EVENT_POLICY_CHANGED;
501
502    /**
503     * @typedef Elm_Event_Policy_Changed
504     *
505     * Data on the event when an Elementary policy has changed
506     */
507     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
508
509    /**
510     * @struct _Elm_Event_Policy_Changed
511     *
512     * Data on the event when an Elementary policy has changed
513     */
514     struct _Elm_Event_Policy_Changed
515      {
516         unsigned int policy; /**< the policy identifier */
517         int          new_value; /**< value the policy had before the change */
518         int          old_value; /**< new value the policy got */
519     };
520
521    /**
522     * Policy identifiers.
523     */
524     typedef enum _Elm_Policy
525     {
526         ELM_POLICY_QUIT, /**< under which circumstances the application
527                           * should quit automatically. @see
528                           * Elm_Policy_Quit.
529                           */
530         ELM_POLICY_LAST
531     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set() */
532
533    typedef enum _Elm_Policy_Quit
534      {
535         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
536                                    * automatically */
537         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
538                                             * application's last
539                                             * window is closed */
540      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
541
542    typedef enum _Elm_Focus_Direction
543      {
544         ELM_FOCUS_PREVIOUS,
545         ELM_FOCUS_NEXT
546      } Elm_Focus_Direction;
547
548    typedef enum _Elm_Text_Format
549      {
550         ELM_TEXT_FORMAT_PLAIN_UTF8,
551         ELM_TEXT_FORMAT_MARKUP_UTF8
552      } Elm_Text_Format;
553
554    /**
555     * Line wrapping types.
556     */
557    typedef enum _Elm_Wrap_Type
558      {
559         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
560         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
561         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
562         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
563         ELM_WRAP_LAST
564      } Elm_Wrap_Type;
565
566    typedef enum
567      {
568         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
569         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
570         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
571         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
572         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
573         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
574         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
575         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
576         ELM_INPUT_PANEL_LAYOUT_INVALID
577      } Elm_Input_Panel_Layout;
578
579    typedef enum
580      {
581         ELM_AUTOCAPITAL_TYPE_NONE,
582         ELM_AUTOCAPITAL_TYPE_WORD,
583         ELM_AUTOCAPITAL_TYPE_SENTENCE,
584         ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
585      } Elm_Autocapital_Type;
586
587    /**
588     * @typedef Elm_Object_Item
589     * An Elementary Object item handle.
590     * @ingroup General
591     */
592    typedef struct _Elm_Object_Item Elm_Object_Item;
593
594
595    /**
596     * Called back when a widget's tooltip is activated and needs content.
597     * @param data user-data given to elm_object_tooltip_content_cb_set()
598     * @param obj owner widget.
599     * @param tooltip The tooltip object (affix content to this!)
600     */
601    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
602
603    /**
604     * Called back when a widget's item tooltip is activated and needs content.
605     * @param data user-data given to elm_object_tooltip_content_cb_set()
606     * @param obj owner widget.
607     * @param tooltip The tooltip object (affix content to this!)
608     * @param item context dependent item. As an example, if tooltip was
609     *        set on Elm_List_Item, then it is of this type.
610     */
611    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
612
613    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. */
614
615 #ifndef ELM_LIB_QUICKLAUNCH
616 #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 */
617 #else
618 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
619 #endif
620
621 /**************************************************************************/
622    /* General calls */
623
624    /**
625     * Initialize Elementary
626     *
627     * @param[in] argc System's argument count value
628     * @param[in] argv System's pointer to array of argument strings
629     * @return The init counter value.
630     *
631     * This function initializes Elementary and increments a counter of
632     * the number of calls to it. It returns the new counter's value.
633     *
634     * @warning This call is exported only for use by the @c ELM_MAIN()
635     * macro. There is no need to use this if you use this macro (which
636     * is highly advisable). An elm_main() should contain the entry
637     * point code for your application, having the same prototype as
638     * elm_init(), and @b not being static (putting the @c EAPI symbol
639     * in front of its type declaration is advisable). The @c
640     * ELM_MAIN() call should be placed just after it.
641     *
642     * Example:
643     * @dontinclude bg_example_01.c
644     * @skip static void
645     * @until ELM_MAIN
646     *
647     * See the full @ref bg_example_01_c "example".
648     *
649     * @see elm_shutdown().
650     * @ingroup General
651     */
652    EAPI int          elm_init(int argc, char **argv);
653
654    /**
655     * Shut down Elementary
656     *
657     * @return The init counter value.
658     *
659     * This should be called at the end of your application, just
660     * before it ceases to do any more processing. This will clean up
661     * any permanent resources your application may have allocated via
662     * Elementary that would otherwise persist.
663     *
664     * @see elm_init() for an example
665     *
666     * @ingroup General
667     */
668    EAPI int          elm_shutdown(void);
669
670    /**
671     * Run Elementary's main loop
672     *
673     * This call should be issued just after all initialization is
674     * completed. This function will not return until elm_exit() is
675     * called. It will keep looping, running the main
676     * (event/processing) loop for Elementary.
677     *
678     * @see elm_init() for an example
679     *
680     * @ingroup General
681     */
682    EAPI void         elm_run(void);
683
684    /**
685     * Exit Elementary's main loop
686     *
687     * If this call is issued, it will flag the main loop to cease
688     * processing and return back to its parent function (usually your
689     * elm_main() function).
690     *
691     * @see elm_init() for an example. There, just after a request to
692     * close the window comes, the main loop will be left.
693     *
694     * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
695     * applications, you'll be able to get this function called automatically for you.
696     *
697     * @ingroup General
698     */
699    EAPI void         elm_exit(void);
700
701    /**
702     * Provide information in order to make Elementary determine the @b
703     * run time location of the software in question, so other data files
704     * such as images, sound files, executable utilities, libraries,
705     * modules and locale files can be found.
706     *
707     * @param mainfunc This is your application's main function name,
708     *        whose binary's location is to be found. Providing @c NULL
709     *        will make Elementary not to use it
710     * @param dom This will be used as the application's "domain", in the
711     *        form of a prefix to any environment variables that may
712     *        override prefix detection and the directory name, inside the
713     *        standard share or data directories, where the software's
714     *        data files will be looked for.
715     * @param checkfile This is an (optional) magic file's path to check
716     *        for existence (and it must be located in the data directory,
717     *        under the share directory provided above). Its presence will
718     *        help determine the prefix found was correct. Pass @c NULL if
719     *        the check is not to be done.
720     *
721     * This function allows one to re-locate the application somewhere
722     * else after compilation, if the developer wishes for easier
723     * distribution of pre-compiled binaries.
724     *
725     * The prefix system is designed to locate where the given software is
726     * installed (under a common path prefix) at run time and then report
727     * specific locations of this prefix and common directories inside
728     * this prefix like the binary, library, data and locale directories,
729     * through the @c elm_app_*_get() family of functions.
730     *
731     * Call elm_app_info_set() early on before you change working
732     * directory or anything about @c argv[0], so it gets accurate
733     * information.
734     *
735     * It will then try and trace back which file @p mainfunc comes from,
736     * if provided, to determine the application's prefix directory.
737     *
738     * The @p dom parameter provides a string prefix to prepend before
739     * environment variables, allowing a fallback to @b specific
740     * environment variables to locate the software. You would most
741     * probably provide a lowercase string there, because it will also
742     * serve as directory domain, explained next. For environment
743     * variables purposes, this string is made uppercase. For example if
744     * @c "myapp" is provided as the prefix, then the program would expect
745     * @c "MYAPP_PREFIX" as a master environment variable to specify the
746     * exact install prefix for the software, or more specific environment
747     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
748     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
749     * the user or scripts before launching. If not provided (@c NULL),
750     * environment variables will not be used to override compiled-in
751     * defaults or auto detections.
752     *
753     * The @p dom string also provides a subdirectory inside the system
754     * shared data directory for data files. For example, if the system
755     * directory is @c /usr/local/share, then this directory name is
756     * appended, creating @c /usr/local/share/myapp, if it @p was @c
757     * "myapp". It is expected that the application installs data files in
758     * this directory.
759     *
760     * The @p checkfile is a file name or path of something inside the
761     * share or data directory to be used to test that the prefix
762     * detection worked. For example, your app will install a wallpaper
763     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
764     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
765     * checkfile string.
766     *
767     * @see elm_app_compile_bin_dir_set()
768     * @see elm_app_compile_lib_dir_set()
769     * @see elm_app_compile_data_dir_set()
770     * @see elm_app_compile_locale_set()
771     * @see elm_app_prefix_dir_get()
772     * @see elm_app_bin_dir_get()
773     * @see elm_app_lib_dir_get()
774     * @see elm_app_data_dir_get()
775     * @see elm_app_locale_dir_get()
776     */
777    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
778
779    /**
780     * Provide information on the @b fallback application's binaries
781     * directory, in scenarios where they get overriden by
782     * elm_app_info_set().
783     *
784     * @param dir The path to the default binaries directory (compile time
785     * one)
786     *
787     * @note Elementary will as well use this path to determine actual
788     * names of binaries' directory paths, maybe changing it to be @c
789     * something/local/bin instead of @c something/bin, only, for
790     * example.
791     *
792     * @warning You should call this function @b before
793     * elm_app_info_set().
794     */
795    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
796
797    /**
798     * Provide information on the @b fallback application's libraries
799     * directory, on scenarios where they get overriden by
800     * elm_app_info_set().
801     *
802     * @param dir The path to the default libraries directory (compile
803     * time one)
804     *
805     * @note Elementary will as well use this path to determine actual
806     * names of libraries' directory paths, maybe changing it to be @c
807     * something/lib32 or @c something/lib64 instead of @c something/lib,
808     * only, for example.
809     *
810     * @warning You should call this function @b before
811     * elm_app_info_set().
812     */
813    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
814
815    /**
816     * Provide information on the @b fallback application's data
817     * directory, on scenarios where they get overriden by
818     * elm_app_info_set().
819     *
820     * @param dir The path to the default data directory (compile time
821     * one)
822     *
823     * @note Elementary will as well use this path to determine actual
824     * names of data directory paths, maybe changing it to be @c
825     * something/local/share instead of @c something/share, only, for
826     * example.
827     *
828     * @warning You should call this function @b before
829     * elm_app_info_set().
830     */
831    EAPI void         elm_app_compile_data_dir_set(const char *dir);
832
833    /**
834     * Provide information on the @b fallback application's locale
835     * directory, on scenarios where they get overriden by
836     * elm_app_info_set().
837     *
838     * @param dir The path to the default locale directory (compile time
839     * one)
840     *
841     * @warning You should call this function @b before
842     * elm_app_info_set().
843     */
844    EAPI void         elm_app_compile_locale_set(const char *dir);
845
846    /**
847     * Retrieve the application's run time prefix directory, as set by
848     * elm_app_info_set() and the way (environment) the application was
849     * run from.
850     *
851     * @return The directory prefix the application is actually using.
852     */
853    EAPI const char  *elm_app_prefix_dir_get(void);
854
855    /**
856     * Retrieve the application's run time binaries prefix directory, as
857     * set by elm_app_info_set() and the way (environment) the application
858     * was run from.
859     *
860     * @return The binaries directory prefix the application is actually
861     * using.
862     */
863    EAPI const char  *elm_app_bin_dir_get(void);
864
865    /**
866     * Retrieve the application's run time libraries prefix directory, as
867     * set by elm_app_info_set() and the way (environment) the application
868     * was run from.
869     *
870     * @return The libraries directory prefix the application is actually
871     * using.
872     */
873    EAPI const char  *elm_app_lib_dir_get(void);
874
875    /**
876     * Retrieve the application's run time data prefix directory, as
877     * set by elm_app_info_set() and the way (environment) the application
878     * was run from.
879     *
880     * @return The data directory prefix the application is actually
881     * using.
882     */
883    EAPI const char  *elm_app_data_dir_get(void);
884
885    /**
886     * Retrieve the application's run time locale prefix directory, as
887     * set by elm_app_info_set() and the way (environment) the application
888     * was run from.
889     *
890     * @return The locale directory prefix the application is actually
891     * using.
892     */
893    EAPI const char  *elm_app_locale_dir_get(void);
894
895    /**
896     * Exposed symbol used only by macros and should not be used by apps
897     */
898    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
899
900    /**
901     * Exposed symbol used only by macros and should not be used by apps
902     */
903    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
904
905    /**
906     * Exposed symbol used only by macros and should not be used by apps
907     */
908    EAPI int          elm_quicklaunch_init(int argc, char **argv);
909
910    /**
911     * Exposed symbol used only by macros and should not be used by apps
912     */
913    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
914
915    /**
916     * Exposed symbol used only by macros and should not be used by apps
917     */
918    EAPI int          elm_quicklaunch_sub_shutdown(void);
919
920    /**
921     * Exposed symbol used only by macros and should not be used by apps
922     */
923    EAPI int          elm_quicklaunch_shutdown(void);
924
925    /**
926     * Exposed symbol used only by macros and should not be used by apps
927     */
928    EAPI void         elm_quicklaunch_seed(void);
929
930    /**
931     * Exposed symbol used only by macros and should not be used by apps
932     */
933    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
934
935    /**
936     * Exposed symbol used only by macros and should not be used by apps
937     */
938    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
939
940    /**
941     * Exposed symbol used only by macros and should not be used by apps
942     */
943    EAPI void         elm_quicklaunch_cleanup(void);
944
945    /**
946     * Exposed symbol used only by macros and should not be used by apps
947     */
948    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
949
950    /**
951     * Exposed symbol used only by macros and should not be used by apps
952     */
953    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
954
955    /**
956     * Request that your elementary application needs efreet
957     * 
958     * This initializes the Efreet library when called and if support exists
959     * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
960     * before any efreet calls.
961     * 
962     * @return EINA_TRUE if support exists and initialization succeeded.
963     * 
964     * @ingroup Efreet
965     */
966    EAPI Eina_Bool    elm_need_efreet(void);
967
968    /**
969     * Request that your elementary application needs e_dbus
970     * 
971     * This initializes the E_dbus library when called and if support exists
972     * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
973     * before any e_dbus calls.
974     * 
975     * @return EINA_TRUE if support exists and initialization succeeded.
976     * 
977     * @ingroup E_dbus
978     */
979    EAPI Eina_Bool    elm_need_e_dbus(void);
980
981    /**
982     * Request that your elementary application needs ethumb
983     * 
984     * This initializes the Ethumb library when called and if support exists
985     * it returns EINA_TRUE, otherwise returns EINA_FALSE.
986     * This must be called before any other function that deals with
987     * elm_thumb objects or ethumb_client instances.
988     *
989     * @ingroup Thumb
990     */
991    EAPI Eina_Bool    elm_need_ethumb(void);
992
993    /**
994     * Request that your elementary application needs web support
995     * 
996     * This initializes the Ewebkit library when called and if support exists
997     * it returns EINA_TRUE, otherwise returns EINA_FALSE.
998     * This must be called before any other function that deals with
999     * elm_web objects or ewk_view instances.
1000     *
1001     * @ingroup Web
1002     */
1003    EAPI Eina_Bool    elm_need_web(void);
1004
1005    /**
1006     * Set a new policy's value (for a given policy group/identifier).
1007     *
1008     * @param policy policy identifier, as in @ref Elm_Policy.
1009     * @param value policy value, which depends on the identifier
1010     *
1011     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
1012     *
1013     * Elementary policies define applications' behavior,
1014     * somehow. These behaviors are divided in policy groups (see
1015     * #Elm_Policy enumeration). This call will emit the Ecore event
1016     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
1017     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
1018     * then.
1019     *
1020     * @note Currently, we have only one policy identifier/group
1021     * (#ELM_POLICY_QUIT), which has two possible values.
1022     *
1023     * @ingroup General
1024     */
1025    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
1026
1027    /**
1028     * Gets the policy value for given policy identifier.
1029     *
1030     * @param policy policy identifier, as in #Elm_Policy.
1031     * @return The currently set policy value, for that
1032     * identifier. Will be @c 0 if @p policy passed is invalid.
1033     *
1034     * @ingroup General
1035     */
1036    EAPI int          elm_policy_get(unsigned int policy);
1037
1038    /**
1039     * Change the language of the current application
1040     *
1041     * The @p lang passed must be the full name of the locale to use, for
1042     * example "en_US.utf8" or "es_ES@euro".
1043     *
1044     * Changing language with this function will make Elementary run through
1045     * all its widgets, translating strings set with
1046     * elm_object_domain_translatable_text_part_set(). This way, an entire
1047     * UI can have its language changed without having to restart the program.
1048     *
1049     * For more complex cases, like having formatted strings that need
1050     * translation, widgets will also emit a "language,changed" signal that
1051     * the user can listen to to manually translate the text.
1052     *
1053     * @param lang Language to set, must be the full name of the locale
1054     *
1055     * @ingroup General
1056     */
1057    EAPI void         elm_language_set(const char *lang);
1058
1059    /**
1060     * Set a label of an object
1061     *
1062     * @param obj The Elementary object
1063     * @param part The text part name to set (NULL for the default label)
1064     * @param label The new text of the label
1065     *
1066     * @note Elementary objects may have many labels (e.g. Action Slider)
1067     * @deprecated Use elm_object_part_text_set() instead.
1068     * @ingroup General
1069     */
1070    EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
1071
1072    /**
1073     * Set a label of an object
1074     *
1075     * @param obj The Elementary object
1076     * @param part The text part name to set (NULL for the default label)
1077     * @param label The new text of the label
1078     *
1079     * @note Elementary objects may have many labels (e.g. Action Slider)
1080     *
1081     * @ingroup General
1082     */
1083    EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
1084
1085 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
1086
1087    /**
1088     * Get a label of an object
1089     *
1090     * @param obj The Elementary object
1091     * @param part The text part name to get (NULL for the default label)
1092     * @return text of the label or NULL for any error
1093     *
1094     * @note Elementary objects may have many labels (e.g. Action Slider)
1095     * @deprecated Use elm_object_part_text_get() instead.
1096     * @ingroup General
1097     */
1098    EINA_DEPRECATED EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1099
1100    /**
1101     * Get a label of an object
1102     *
1103     * @param obj The Elementary object
1104     * @param part The text part name to get (NULL for the default label)
1105     * @return text of the label or NULL for any error
1106     *
1107     * @note Elementary objects may have many labels (e.g. Action Slider)
1108     *
1109     * @ingroup General
1110     */
1111    EAPI const char  *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1112
1113 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1114
1115    /**
1116     * Set the text for an objects' part, marking it as translatable.
1117     *
1118     * The string to set as @p text must be the original one. Do not pass the
1119     * return of @c gettext() here. Elementary will translate the string
1120     * internally and set it on the object using elm_object_part_text_set(),
1121     * also storing the original string so that it can be automatically
1122     * translated when the language is changed with elm_language_set().
1123     *
1124     * The @p domain will be stored along to find the translation in the
1125     * correct catalog. It can be NULL, in which case it will use whatever
1126     * domain was set by the application with @c textdomain(). This is useful
1127     * in case you are building a library on top of Elementary that will have
1128     * its own translatable strings, that should not be mixed with those of
1129     * programs using the library.
1130     *
1131     * @param obj The object containing the text part
1132     * @param part The name of the part to set
1133     * @param domain The translation domain to use
1134     * @param text The original, non-translated text to set
1135     *
1136     * @ingroup General
1137     */
1138    EAPI void         elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1139
1140 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1141
1142 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1143
1144    /**
1145     * Gets the original string set as translatable for an object
1146     *
1147     * When setting translated strings, the function elm_object_part_text_get()
1148     * will return the translation returned by @c gettext(). To get the
1149     * original string use this function.
1150     *
1151     * @param obj The object
1152     * @param part The name of the part that was set
1153     *
1154     * @return The original, untranslated string
1155     *
1156     * @ingroup General
1157     */
1158    EAPI const char  *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1159
1160 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1161
1162    /**
1163     * Set a content of an object
1164     *
1165     * @param obj The Elementary object
1166     * @param part The content part name to set (NULL for the default content)
1167     * @param content The new content of the object
1168     *
1169     * @note Elementary objects may have many contents
1170     * @deprecated Use elm_object_part_content_set instead.
1171     * @ingroup General
1172     */
1173    EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1174
1175    /**
1176     * Set a content of an object
1177     *
1178     * @param obj The Elementary object
1179     * @param part The content part name to set (NULL for the default content)
1180     * @param content The new content of the object
1181     *
1182     * @note Elementary objects may have many contents
1183     *
1184     * @ingroup General
1185     */
1186    EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1187
1188 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1189
1190    /**
1191     * Get a content of an object
1192     *
1193     * @param obj The Elementary object
1194     * @param item The content part name to get (NULL for the default content)
1195     * @return content of the object or NULL for any error
1196     *
1197     * @note Elementary objects may have many contents
1198     * @deprecated Use elm_object_part_content_get instead.
1199     * @ingroup General
1200     */
1201    EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1202
1203    /**
1204     * Get a content of an object
1205     *
1206     * @param obj The Elementary object
1207     * @param item The content part name to get (NULL for the default content)
1208     * @return content of the object or NULL for any error
1209     *
1210     * @note Elementary objects may have many contents
1211     *
1212     * @ingroup General
1213     */
1214    EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1215
1216 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1217
1218    /**
1219     * Unset a content of an object
1220     *
1221     * @param obj The Elementary object
1222     * @param item The content part name to unset (NULL for the default content)
1223     *
1224     * @note Elementary objects may have many contents
1225     * @deprecated Use elm_object_part_content_unset instead.
1226     * @ingroup General
1227     */
1228    EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1229
1230    /**
1231     * Unset a content of an object
1232     *
1233     * @param obj The Elementary object
1234     * @param item The content part name to unset (NULL for the default content)
1235     *
1236     * @note Elementary objects may have many contents
1237     *
1238     * @ingroup General
1239     */
1240    EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1241
1242 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1243
1244    /**
1245     * Set the text to read out when in accessibility mode
1246     *
1247     * @param obj The object which is to be described
1248     * @param txt The text that describes the widget to people with poor or no vision
1249     *
1250     * @ingroup General
1251     */
1252    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1253
1254    /**
1255     * Get a named object from the children
1256     * 
1257     * @param obj The parent object whose children to look at
1258     * @param name The name of the child to find
1259     * @param recurse Set to thge maximum number of levels to recurse (0 == none, 1 is only look at 1 level of children etc.)
1260     * @return The found object of that name, or NULL if none is found
1261     * 
1262     * This function searches the children (or recursively children of
1263     * children and so on) of the given @p obj object looking for a child with
1264     * the name of @p name. If the child is found the object is returned, or
1265     * NULL is returned. You can set the name of an object with 
1266     * evas_object_name_set(). If the name is not unique within the child
1267     * objects (or the tree is @p recurse is greater than 0) then it is
1268     * undefined as to which child of that name is returned, so ensure the name
1269     * is unique amongst children. If recurse is set to -1 it will recurse
1270     * without limit.
1271     * 
1272     * @ingroup General
1273     */
1274    EAPI Evas_Object *elm_object_name_find(const Evas_Object *obj, const char *name, int recurse);
1275        
1276    /**
1277     * Get the widget object's handle which contains a given item
1278     *
1279     * @param item The Elementary object item
1280     * @return The widget object
1281     *
1282     * @note This returns the widget object itself that an item belongs to.
1283     *
1284     * @ingroup General
1285     */
1286    EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1287
1288    /**
1289     * Set a content of an object item
1290     *
1291     * @param it The Elementary object item
1292     * @param part The content part name to set (NULL for the default content)
1293     * @param content The new content of the object item
1294     *
1295     * @note Elementary object items may have many contents
1296     * @deprecated Use elm_object_item_part_content_set instead.
1297     * @ingroup General
1298     */
1299    EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1300
1301    /**
1302     * Set a content of an object item
1303     *
1304     * @param it The Elementary object item
1305     * @param part The content part name to set (NULL for the default content)
1306     * @param content The new content of the object item
1307     *
1308     * @note Elementary object items may have many contents
1309     *
1310     * @ingroup General
1311     */
1312    EAPI void elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1313
1314 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
1315
1316    /**
1317     * Get a content of an object item
1318     *
1319     * @param it The Elementary object item
1320     * @param part The content part name to unset (NULL for the default content)
1321     * @return content of the object item or NULL for any error
1322     *
1323     * @note Elementary object items may have many contents
1324     * @deprecated Use elm_object_item_part_content_get instead.
1325     * @ingroup General
1326     */
1327    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1328
1329    /**
1330     * Get a content of an object item
1331     *
1332     * @param it The Elementary object item
1333     * @param part The content part name to unset (NULL for the default content)
1334     * @return content of the object item or NULL for any error
1335     *
1336     * @note Elementary object items may have many contents
1337     *
1338     * @ingroup General
1339     */
1340    EAPI Evas_Object *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
1341
1342 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
1343
1344    /**
1345     * Unset a content of an object item
1346     *
1347     * @param it The Elementary object item
1348     * @param part The content part name to unset (NULL for the default content)
1349     *
1350     * @note Elementary object items may have many contents
1351     * @deprecated Use elm_object_item_part_content_unset instead.
1352     * @ingroup General
1353     */
1354    EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1355
1356    /**
1357     * Unset a content of an object item
1358     *
1359     * @param it The Elementary object item
1360     * @param part The content part name to unset (NULL for the default content)
1361     *
1362     * @note Elementary object items may have many contents
1363     *
1364     * @ingroup General
1365     */
1366    EAPI Evas_Object *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
1367
1368 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1369
1370    /**
1371     * Set a label of an object item
1372     *
1373     * @param it The Elementary object item
1374     * @param part The text part name to set (NULL for the default label)
1375     * @param label The new text of the label
1376     *
1377     * @note Elementary object items may have many labels
1378     * @deprecated Use elm_object_item_part_text_set instead.
1379     * @ingroup General
1380     */
1381    EINA_DEPRECATED EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1382
1383    /**
1384     * Set a label of an object item
1385     *
1386     * @param it The Elementary object item
1387     * @param part The text part name to set (NULL for the default label)
1388     * @param label The new text of the label
1389     *
1390     * @note Elementary object items may have many labels
1391     *
1392     * @ingroup General
1393     */
1394    EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1395
1396 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1397
1398    /**
1399     * Get a label of an object item
1400     *
1401     * @param it The Elementary object item
1402     * @param part The text part name to get (NULL for the default label)
1403     * @return text of the label or NULL for any error
1404     *
1405     * @note Elementary object items may have many labels
1406     * @deprecated Use elm_object_item_part_text_get instead.
1407     * @ingroup General
1408     */
1409    EINA_DEPRECATED EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1410    /**
1411     * Get a label of an object item
1412     *
1413     * @param it The Elementary object item
1414     * @param part The text part name to get (NULL for the default label)
1415     * @return text of the label or NULL for any error
1416     *
1417     * @note Elementary object items may have many labels
1418     *
1419     * @ingroup General
1420     */
1421    EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1422
1423 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1424
1425    /**
1426     * Set the text to read out when in accessibility mode
1427     *
1428     * @param it The object item which is to be described
1429     * @param txt The text that describes the widget to people with poor or no vision
1430     *
1431     * @ingroup General
1432     */
1433    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1434
1435    /**
1436     * Get the data associated with an object item
1437     * @param it The Elementary object item
1438     * @return The data associated with @p it
1439     *
1440     * @ingroup General
1441     */
1442    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1443
1444    /**
1445     * Set the data associated with an object item
1446     * @param it The Elementary object item
1447     * @param data The data to be associated with @p it
1448     *
1449     * @ingroup General
1450     */
1451    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1452
1453    /**
1454     * Send a signal to the edje object of the widget item.
1455     *
1456     * This function sends a signal to the edje object of the obj item. An
1457     * edje program can respond to a signal by specifying matching
1458     * 'signal' and 'source' fields.
1459     *
1460     * @param it The Elementary object item
1461     * @param emission The signal's name.
1462     * @param source The signal's source.
1463     * @ingroup General
1464     */
1465    EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1466
1467    /**
1468     * Set the disabled state of an widget item.
1469     *
1470     * @param obj The Elementary object item
1471     * @param disabled The state to put in in: @c EINA_TRUE for
1472     *        disabled, @c EINA_FALSE for enabled
1473     *
1474     * Elementary object item can be @b disabled, in which state they won't
1475     * receive input and, in general, will be themed differently from
1476     * their normal state, usually greyed out. Useful for contexts
1477     * where you don't want your users to interact with some of the
1478     * parts of you interface.
1479     *
1480     * This sets the state for the widget item, either disabling it or
1481     * enabling it back.
1482     *
1483     * @ingroup Styles
1484     */
1485    EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1486
1487    /**
1488     * Get the disabled state of an widget item.
1489     *
1490     * @param obj The Elementary object
1491     * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1492     *            if it's enabled (or on errors)
1493     *
1494     * This gets the state of the widget, which might be enabled or disabled.
1495     *
1496     * @ingroup Styles
1497     */
1498    EAPI Eina_Bool    elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1499
1500    /**
1501     * @}
1502     */
1503
1504    /**
1505     * @defgroup Caches Caches
1506     *
1507     * These are functions which let one fine-tune some cache values for
1508     * Elementary applications, thus allowing for performance adjustments.
1509     *
1510     * @{
1511     */
1512
1513    /**
1514     * @brief Flush all caches.
1515     *
1516     * Frees all data that was in cache and is not currently being used to reduce
1517     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1518     * to calling all of the following functions:
1519     * @li edje_file_cache_flush()
1520     * @li edje_collection_cache_flush()
1521     * @li eet_clearcache()
1522     * @li evas_image_cache_flush()
1523     * @li evas_font_cache_flush()
1524     * @li evas_render_dump()
1525     * @note Evas caches are flushed for every canvas associated with a window.
1526     *
1527     * @ingroup Caches
1528     */
1529    EAPI void         elm_all_flush(void);
1530
1531    /**
1532     * Get the configured cache flush interval time
1533     *
1534     * This gets the globally configured cache flush interval time, in
1535     * ticks
1536     *
1537     * @return The cache flush interval time
1538     * @ingroup Caches
1539     *
1540     * @see elm_all_flush()
1541     */
1542    EAPI int          elm_cache_flush_interval_get(void);
1543
1544    /**
1545     * Set the configured cache flush interval time
1546     *
1547     * This sets the globally configured cache flush interval time, in ticks
1548     *
1549     * @param size The cache flush interval time
1550     * @ingroup Caches
1551     *
1552     * @see elm_all_flush()
1553     */
1554    EAPI void         elm_cache_flush_interval_set(int size);
1555
1556    /**
1557     * Set the configured cache flush interval time for all applications on the
1558     * display
1559     *
1560     * This sets the globally configured cache flush interval time -- in ticks
1561     * -- for all applications on the display.
1562     *
1563     * @param size The cache flush interval time
1564     * @ingroup Caches
1565     */
1566    // XXX: deprecate and replace with elm_config_all_flush()
1567    EAPI void         elm_cache_flush_interval_all_set(int size);
1568
1569    /**
1570     * Get the configured cache flush enabled state
1571     *
1572     * This gets the globally configured cache flush state - if it is enabled
1573     * or not. When cache flushing is enabled, elementary will regularly
1574     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1575     * memory and allow usage to re-seed caches and data in memory where it
1576     * can do so. An idle application will thus minimise its memory usage as
1577     * data will be freed from memory and not be re-loaded as it is idle and
1578     * not rendering or doing anything graphically right now.
1579     *
1580     * @return The cache flush state
1581     * @ingroup Caches
1582     *
1583     * @see elm_all_flush()
1584     */
1585    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1586
1587    /**
1588     * Set the configured cache flush enabled state
1589     *
1590     * This sets the globally configured cache flush enabled state.
1591     *
1592     * @param size The cache flush enabled state
1593     * @ingroup Caches
1594     *
1595     * @see elm_all_flush()
1596     */
1597    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1598
1599    /**
1600     * Set the configured cache flush enabled state for all applications on the
1601     * display
1602     *
1603     * This sets the globally configured cache flush enabled state for all
1604     * applications on the display.
1605     *
1606     * @param size The cache flush enabled state
1607     * @ingroup Caches
1608     */
1609    // XXX: deprecate and replace with elm_config_all_flush()
1610    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1611
1612    /**
1613     * Get the configured font cache size
1614     *
1615     * This gets the globally configured font cache size, in bytes.
1616     *
1617     * @return The font cache size
1618     * @ingroup Caches
1619     */
1620    EAPI int          elm_font_cache_get(void);
1621
1622    /**
1623     * Set the configured font cache size
1624     *
1625     * This sets the globally configured font cache size, in bytes
1626     *
1627     * @param size The font cache size
1628     * @ingroup Caches
1629     */
1630    EAPI void         elm_font_cache_set(int size);
1631
1632    /**
1633     * Set the configured font cache size for all applications on the
1634     * display
1635     *
1636     * This sets the globally configured font cache size -- in bytes
1637     * -- for all applications on the display.
1638     *
1639     * @param size The font cache size
1640     * @ingroup Caches
1641     */
1642    // XXX: deprecate and replace with elm_config_all_flush()
1643    EAPI void         elm_font_cache_all_set(int size);
1644
1645    /**
1646     * Get the configured image cache size
1647     *
1648     * This gets the globally configured image cache size, in bytes
1649     *
1650     * @return The image cache size
1651     * @ingroup Caches
1652     */
1653    EAPI int          elm_image_cache_get(void);
1654
1655    /**
1656     * Set the configured image cache size
1657     *
1658     * This sets the globally configured image cache size, in bytes
1659     *
1660     * @param size The image cache size
1661     * @ingroup Caches
1662     */
1663    EAPI void         elm_image_cache_set(int size);
1664
1665    /**
1666     * Set the configured image cache size for all applications on the
1667     * display
1668     *
1669     * This sets the globally configured image cache size -- in bytes
1670     * -- for all applications on the display.
1671     *
1672     * @param size The image cache size
1673     * @ingroup Caches
1674     */
1675    // XXX: deprecate and replace with elm_config_all_flush()
1676    EAPI void         elm_image_cache_all_set(int size);
1677
1678    /**
1679     * Get the configured edje file cache size.
1680     *
1681     * This gets the globally configured edje file cache size, in number
1682     * of files.
1683     *
1684     * @return The edje file cache size
1685     * @ingroup Caches
1686     */
1687    EAPI int          elm_edje_file_cache_get(void);
1688
1689    /**
1690     * Set the configured edje file cache size
1691     *
1692     * This sets the globally configured edje file cache size, in number
1693     * of files.
1694     *
1695     * @param size The edje file cache size
1696     * @ingroup Caches
1697     */
1698    EAPI void         elm_edje_file_cache_set(int size);
1699
1700    /**
1701     * Set the configured edje file cache size for all applications on the
1702     * display
1703     *
1704     * This sets the globally configured edje file cache size -- in number
1705     * of files -- for all applications on the display.
1706     *
1707     * @param size The edje file cache size
1708     * @ingroup Caches
1709     */
1710    // XXX: deprecate and replace with elm_config_all_flush()
1711    EAPI void         elm_edje_file_cache_all_set(int size);
1712
1713    /**
1714     * Get the configured edje collections (groups) cache size.
1715     *
1716     * This gets the globally configured edje collections cache size, in
1717     * number of collections.
1718     *
1719     * @return The edje collections cache size
1720     * @ingroup Caches
1721     */
1722    EAPI int          elm_edje_collection_cache_get(void);
1723
1724    /**
1725     * Set the configured edje collections (groups) cache size
1726     *
1727     * This sets the globally configured edje collections cache size, in
1728     * number of collections.
1729     *
1730     * @param size The edje collections cache size
1731     * @ingroup Caches
1732     */
1733    EAPI void         elm_edje_collection_cache_set(int size);
1734
1735    /**
1736     * Set the configured edje collections (groups) cache size for all
1737     * applications on the display
1738     *
1739     * This sets the globally configured edje collections cache size -- in
1740     * number of collections -- for all applications on the display.
1741     *
1742     * @param size The edje collections cache size
1743     * @ingroup Caches
1744     */
1745    // XXX: deprecate and replace with elm_config_all_flush()
1746    EAPI void         elm_edje_collection_cache_all_set(int size);
1747
1748    /**
1749     * @}
1750     */
1751
1752    /**
1753     * @defgroup Scaling Widget Scaling
1754     *
1755     * Different widgets can be scaled independently. These functions
1756     * allow you to manipulate this scaling on a per-widget basis. The
1757     * object and all its children get their scaling factors multiplied
1758     * by the scale factor set. This is multiplicative, in that if a
1759     * child also has a scale size set it is in turn multiplied by its
1760     * parent's scale size. @c 1.0 means ā€œdon't scaleā€, @c 2.0 is
1761     * double size, @c 0.5 is half, etc.
1762     *
1763     * @ref general_functions_example_page "This" example contemplates
1764     * some of these functions.
1765     */
1766
1767    /**
1768     * Get the global scaling factor
1769     *
1770     * This gets the globally configured scaling factor that is applied to all
1771     * objects.
1772     *
1773     * @return The scaling factor
1774     * @ingroup Scaling
1775     */
1776    EAPI double       elm_scale_get(void);
1777
1778    /**
1779     * Set the global scaling factor
1780     *
1781     * This sets the globally configured scaling factor that is applied to all
1782     * objects.
1783     *
1784     * @param scale The scaling factor to set
1785     * @ingroup Scaling
1786     */
1787    EAPI void         elm_scale_set(double scale);
1788
1789    /**
1790     * Set the global scaling factor for all applications on the display
1791     *
1792     * This sets the globally configured scaling factor that is applied to all
1793     * objects for all applications.
1794     * @param scale The scaling factor to set
1795     * @ingroup Scaling
1796     */
1797    // XXX: deprecate and replace with elm_config_all_flush()
1798    EAPI void         elm_scale_all_set(double scale);
1799
1800    /**
1801     * Set the scaling factor for a given Elementary object
1802     *
1803     * @param obj The Elementary to operate on
1804     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1805     * no scaling)
1806     *
1807     * @ingroup Scaling
1808     */
1809    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1810
1811    /**
1812     * Get the scaling factor for a given Elementary object
1813     *
1814     * @param obj The object
1815     * @return The scaling factor set by elm_object_scale_set()
1816     *
1817     * @ingroup Scaling
1818     */
1819    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1820
1821    /**
1822     * @defgroup Password_last_show Password last input show
1823     *
1824     * Last show feature of password mode enables user to view
1825     * the last input entered for few seconds before masking it.
1826     * These functions allow to set this feature in password mode
1827     * of entry widget and also allow to manipulate the duration
1828     * for which the input has to be visible.
1829     *
1830     * @{
1831     */
1832
1833    /**
1834     * Get show last setting of password mode.
1835     *
1836     * This gets the show last input setting of password mode which might be
1837     * enabled or disabled.
1838     *
1839     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1840     *            if it's disabled.
1841     * @ingroup Password_last_show
1842     */
1843    EAPI Eina_Bool elm_password_show_last_get(void);
1844
1845    /**
1846     * Set show last setting in password mode.
1847     *
1848     * This enables or disables show last setting of password mode.
1849     *
1850     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1851     * @see elm_password_show_last_timeout_set()
1852     * @ingroup Password_last_show
1853     */
1854    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1855
1856    /**
1857     * Get's the timeout value in last show password mode.
1858     *
1859     * This gets the time out value for which the last input entered in password
1860     * mode will be visible.
1861     *
1862     * @return The timeout value of last show password mode.
1863     * @ingroup Password_last_show
1864     */
1865    EAPI double elm_password_show_last_timeout_get(void);
1866
1867    /**
1868     * Set's the timeout value in last show password mode.
1869     *
1870     * This sets the time out value for which the last input entered in password
1871     * mode will be visible.
1872     *
1873     * @param password_show_last_timeout The timeout value.
1874     * @see elm_password_show_last_set()
1875     * @ingroup Password_last_show
1876     */
1877    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1878
1879    /**
1880     * @}
1881     */
1882
1883    /**
1884     * @defgroup UI-Mirroring Selective Widget mirroring
1885     *
1886     * These functions allow you to set ui-mirroring on specific
1887     * widgets or the whole interface. Widgets can be in one of two
1888     * modes, automatic and manual.  Automatic means they'll be changed
1889     * according to the system mirroring mode and manual means only
1890     * explicit changes will matter. You are not supposed to change
1891     * mirroring state of a widget set to automatic, will mostly work,
1892     * but the behavior is not really defined.
1893     *
1894     * @{
1895     */
1896
1897    EAPI Eina_Bool    elm_mirrored_get(void);
1898    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1899
1900    /**
1901     * Get the system mirrored mode. This determines the default mirrored mode
1902     * of widgets.
1903     *
1904     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1905     */
1906    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1907
1908    /**
1909     * Set the system mirrored mode. This determines the default mirrored mode
1910     * of widgets.
1911     *
1912     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1913     */
1914    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1915
1916    /**
1917     * Returns the widget's mirrored mode setting.
1918     *
1919     * @param obj The widget.
1920     * @return mirrored mode setting of the object.
1921     *
1922     **/
1923    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1924
1925    /**
1926     * Sets the widget's mirrored mode setting.
1927     * When widget in automatic mode, it follows the system mirrored mode set by
1928     * elm_mirrored_set().
1929     * @param obj The widget.
1930     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1931     */
1932    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1933
1934    /**
1935     * @}
1936     */
1937
1938    /**
1939     * Set the style to use by a widget
1940     *
1941     * Sets the style name that will define the appearance of a widget. Styles
1942     * vary from widget to widget and may also be defined by other themes
1943     * by means of extensions and overlays.
1944     *
1945     * @param obj The Elementary widget to style
1946     * @param style The style name to use
1947     *
1948     * @see elm_theme_extension_add()
1949     * @see elm_theme_extension_del()
1950     * @see elm_theme_overlay_add()
1951     * @see elm_theme_overlay_del()
1952     *
1953     * @ingroup Styles
1954     */
1955    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1956    /**
1957     * Get the style used by the widget
1958     *
1959     * This gets the style being used for that widget. Note that the string
1960     * pointer is only valid as longas the object is valid and the style doesn't
1961     * change.
1962     *
1963     * @param obj The Elementary widget to query for its style
1964     * @return The style name used
1965     *
1966     * @see elm_object_style_set()
1967     *
1968     * @ingroup Styles
1969     */
1970    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1971
1972    /**
1973     * @defgroup Styles Styles
1974     *
1975     * Widgets can have different styles of look. These generic API's
1976     * set styles of widgets, if they support them (and if the theme(s)
1977     * do).
1978     *
1979     * @ref general_functions_example_page "This" example contemplates
1980     * some of these functions.
1981     */
1982
1983    /**
1984     * Set the disabled state of an Elementary object.
1985     *
1986     * @param obj The Elementary object to operate on
1987     * @param disabled The state to put in in: @c EINA_TRUE for
1988     *        disabled, @c EINA_FALSE for enabled
1989     *
1990     * Elementary objects can be @b disabled, in which state they won't
1991     * receive input and, in general, will be themed differently from
1992     * their normal state, usually greyed out. Useful for contexts
1993     * where you don't want your users to interact with some of the
1994     * parts of you interface.
1995     *
1996     * This sets the state for the widget, either disabling it or
1997     * enabling it back.
1998     *
1999     * @ingroup Styles
2000     */
2001    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
2002
2003    /**
2004     * Get the disabled state of an Elementary object.
2005     *
2006     * @param obj The Elementary object to operate on
2007     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
2008     *            if it's enabled (or on errors)
2009     *
2010     * This gets the state of the widget, which might be enabled or disabled.
2011     *
2012     * @ingroup Styles
2013     */
2014    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2015
2016    /**
2017     * @defgroup WidgetNavigation Widget Tree Navigation.
2018     *
2019     * How to check if an Evas Object is an Elementary widget? How to
2020     * get the first elementary widget that is parent of the given
2021     * object?  These are all covered in widget tree navigation.
2022     *
2023     * @ref general_functions_example_page "This" example contemplates
2024     * some of these functions.
2025     */
2026
2027    /**
2028     * Check if the given Evas Object is an Elementary widget.
2029     *
2030     * @param obj the object to query.
2031     * @return @c EINA_TRUE if it is an elementary widget variant,
2032     *         @c EINA_FALSE otherwise
2033     * @ingroup WidgetNavigation
2034     */
2035    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2036
2037    /**
2038     * Get the first parent of the given object that is an Elementary
2039     * widget.
2040     *
2041     * @param obj the Elementary object to query parent from.
2042     * @return the parent object that is an Elementary widget, or @c
2043     *         NULL, if it was not found.
2044     *
2045     * Use this to query for an object's parent widget.
2046     *
2047     * @note Most of Elementary users wouldn't be mixing non-Elementary
2048     * smart objects in the objects tree of an application, as this is
2049     * an advanced usage of Elementary with Evas. So, except for the
2050     * application's window, which is the root of that tree, all other
2051     * objects would have valid Elementary widget parents.
2052     *
2053     * @ingroup WidgetNavigation
2054     */
2055    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2056
2057    /**
2058     * Get the top level parent of an Elementary widget.
2059     *
2060     * @param obj The object to query.
2061     * @return The top level Elementary widget, or @c NULL if parent cannot be
2062     * found.
2063     * @ingroup WidgetNavigation
2064     */
2065    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2066
2067    /**
2068     * Get the string that represents this Elementary widget.
2069     *
2070     * @note Elementary is weird and exposes itself as a single
2071     *       Evas_Object_Smart_Class of type "elm_widget", so
2072     *       evas_object_type_get() always return that, making debug and
2073     *       language bindings hard. This function tries to mitigate this
2074     *       problem, but the solution is to change Elementary to use
2075     *       proper inheritance.
2076     *
2077     * @param obj the object to query.
2078     * @return Elementary widget name, or @c NULL if not a valid widget.
2079     * @ingroup WidgetNavigation
2080     */
2081    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2082
2083    /**
2084     * @defgroup Config Elementary Config
2085     *
2086     * Elementary configuration is formed by a set options bounded to a
2087     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
2088     * "finger size", etc. These are functions with which one syncronizes
2089     * changes made to those values to the configuration storing files, de
2090     * facto. You most probably don't want to use the functions in this
2091     * group unlees you're writing an elementary configuration manager.
2092     *
2093     * @{
2094     */
2095
2096    /**
2097     * Save back Elementary's configuration, so that it will persist on
2098     * future sessions.
2099     *
2100     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2101     * @ingroup Config
2102     *
2103     * This function will take effect -- thus, do I/O -- immediately. Use
2104     * it when you want to apply all configuration changes at once. The
2105     * current configuration set will get saved onto the current profile
2106     * configuration file.
2107     *
2108     */
2109    EAPI Eina_Bool    elm_config_save(void);
2110
2111    /**
2112     * Reload Elementary's configuration, bounded to current selected
2113     * profile.
2114     *
2115     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2116     * @ingroup Config
2117     *
2118     * Useful when you want to force reloading of configuration values for
2119     * a profile. If one removes user custom configuration directories,
2120     * for example, it will force a reload with system values instead.
2121     *
2122     */
2123    EAPI void         elm_config_reload(void);
2124
2125    /**
2126     * @}
2127     */
2128
2129    /**
2130     * @defgroup Profile Elementary Profile
2131     *
2132     * Profiles are pre-set options that affect the whole look-and-feel of
2133     * Elementary-based applications. There are, for example, profiles
2134     * aimed at desktop computer applications and others aimed at mobile,
2135     * touchscreen-based ones. You most probably don't want to use the
2136     * functions in this group unlees you're writing an elementary
2137     * configuration manager.
2138     *
2139     * @{
2140     */
2141
2142    /**
2143     * Get Elementary's profile in use.
2144     *
2145     * This gets the global profile that is applied to all Elementary
2146     * applications.
2147     *
2148     * @return The profile's name
2149     * @ingroup Profile
2150     */
2151    EAPI const char  *elm_profile_current_get(void);
2152
2153    /**
2154     * Get an Elementary's profile directory path in the filesystem. One
2155     * may want to fetch a system profile's dir or an user one (fetched
2156     * inside $HOME).
2157     *
2158     * @param profile The profile's name
2159     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2160     *                or a system one (@c EINA_FALSE)
2161     * @return The profile's directory path.
2162     * @ingroup Profile
2163     *
2164     * @note You must free it with elm_profile_dir_free().
2165     */
2166    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2167
2168    /**
2169     * Free an Elementary's profile directory path, as returned by
2170     * elm_profile_dir_get().
2171     *
2172     * @param p_dir The profile's path
2173     * @ingroup Profile
2174     *
2175     */
2176    EAPI void         elm_profile_dir_free(const char *p_dir);
2177
2178    /**
2179     * Get Elementary's list of available profiles.
2180     *
2181     * @return The profiles list. List node data are the profile name
2182     *         strings.
2183     * @ingroup Profile
2184     *
2185     * @note One must free this list, after usage, with the function
2186     *       elm_profile_list_free().
2187     */
2188    EAPI Eina_List   *elm_profile_list_get(void);
2189
2190    /**
2191     * Free Elementary's list of available profiles.
2192     *
2193     * @param l The profiles list, as returned by elm_profile_list_get().
2194     * @ingroup Profile
2195     *
2196     */
2197    EAPI void         elm_profile_list_free(Eina_List *l);
2198
2199    /**
2200     * Set Elementary's profile.
2201     *
2202     * This sets the global profile that is applied to Elementary
2203     * applications. Just the process the call comes from will be
2204     * affected.
2205     *
2206     * @param profile The profile's name
2207     * @ingroup Profile
2208     *
2209     */
2210    EAPI void         elm_profile_set(const char *profile);
2211
2212    /**
2213     * Set Elementary's profile.
2214     *
2215     * This sets the global profile that is applied to all Elementary
2216     * applications. All running Elementary windows will be affected.
2217     *
2218     * @param profile The profile's name
2219     * @ingroup Profile
2220     *
2221     */
2222    EAPI void         elm_profile_all_set(const char *profile);
2223
2224    /**
2225     * @}
2226     */
2227
2228    /**
2229     * @defgroup Engine Elementary Engine
2230     *
2231     * These are functions setting and querying which rendering engine
2232     * Elementary will use for drawing its windows' pixels.
2233     *
2234     * The following are the available engines:
2235     * @li "software_x11"
2236     * @li "fb"
2237     * @li "directfb"
2238     * @li "software_16_x11"
2239     * @li "software_8_x11"
2240     * @li "xrender_x11"
2241     * @li "opengl_x11"
2242     * @li "software_gdi"
2243     * @li "software_16_wince_gdi"
2244     * @li "sdl"
2245     * @li "software_16_sdl"
2246     * @li "opengl_sdl"
2247     * @li "buffer"
2248     * @li "ews"
2249     * @li "opengl_cocoa"
2250     * @li "psl1ght"
2251     *
2252     * @{
2253     */
2254
2255    /**
2256     * @brief Get Elementary's rendering engine in use.
2257     *
2258     * @return The rendering engine's name
2259     * @note there's no need to free the returned string, here.
2260     *
2261     * This gets the global rendering engine that is applied to all Elementary
2262     * applications.
2263     *
2264     * @see elm_engine_set()
2265     */
2266    // XXX: rename to elm_engine_get()
2267    EAPI const char  *elm_engine_current_get(void);
2268
2269    /**
2270     * @brief Set Elementary's rendering engine for use.
2271     *
2272     * @param engine The rendering engine's name
2273     *
2274     * This sets global rendering engine that is applied to all Elementary
2275     * applications. Note that it will take effect only to Elementary windows
2276     * created after this is called.
2277     *
2278     * @see elm_win_add()
2279     */
2280    EAPI void         elm_engine_set(const char *engine);
2281
2282    /**
2283     * @}
2284     */
2285
2286    /**
2287     * @defgroup Fonts Elementary Fonts
2288     *
2289     * These are functions dealing with font rendering, selection and the
2290     * like for Elementary applications. One might fetch which system
2291     * fonts are there to use and set custom fonts for individual classes
2292     * of UI items containing text (text classes).
2293     *
2294     * @{
2295     */
2296
2297   typedef struct _Elm_Text_Class
2298     {
2299        const char *name;
2300        const char *desc;
2301     } Elm_Text_Class;
2302
2303   typedef struct _Elm_Font_Overlay
2304     {
2305        const char     *text_class;
2306        const char     *font;
2307        Evas_Font_Size  size;
2308     } Elm_Font_Overlay;
2309
2310   typedef struct _Elm_Font_Properties
2311     {
2312        const char *name;
2313        Eina_List  *styles;
2314     } Elm_Font_Properties;
2315
2316    /**
2317     * Get Elementary's list of supported text classes.
2318     *
2319     * @return The text classes list, with @c Elm_Text_Class blobs as data.
2320     * @ingroup Fonts
2321     *
2322     * Release the list with elm_text_classes_list_free().
2323     */
2324    EAPI const Eina_List     *elm_text_classes_list_get(void);
2325
2326    /**
2327     * Free Elementary's list of supported text classes.
2328     *
2329     * @ingroup Fonts
2330     *
2331     * @see elm_text_classes_list_get().
2332     */
2333    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
2334
2335    /**
2336     * Get Elementary's list of font overlays, set with
2337     * elm_font_overlay_set().
2338     *
2339     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2340     * data.
2341     *
2342     * @ingroup Fonts
2343     *
2344     * For each text class, one can set a <b>font overlay</b> for it,
2345     * overriding the default font properties for that class coming from
2346     * the theme in use. There is no need to free this list.
2347     *
2348     * @see elm_font_overlay_set() and elm_font_overlay_unset().
2349     */
2350    EAPI const Eina_List     *elm_font_overlay_list_get(void);
2351
2352    /**
2353     * Set a font overlay for a given Elementary text class.
2354     *
2355     * @param text_class Text class name
2356     * @param font Font name and style string
2357     * @param size Font size
2358     *
2359     * @ingroup Fonts
2360     *
2361     * @p font has to be in the format returned by
2362     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2363     * and elm_font_overlay_unset().
2364     */
2365    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2366
2367    /**
2368     * Unset a font overlay for a given Elementary text class.
2369     *
2370     * @param text_class Text class name
2371     *
2372     * @ingroup Fonts
2373     *
2374     * This will bring back text elements belonging to text class
2375     * @p text_class back to their default font settings.
2376     */
2377    EAPI void                 elm_font_overlay_unset(const char *text_class);
2378
2379    /**
2380     * Apply the changes made with elm_font_overlay_set() and
2381     * elm_font_overlay_unset() on the current Elementary window.
2382     *
2383     * @ingroup Fonts
2384     *
2385     * This applies all font overlays set to all objects in the UI.
2386     */
2387    EAPI void                 elm_font_overlay_apply(void);
2388
2389    /**
2390     * Apply the changes made with elm_font_overlay_set() and
2391     * elm_font_overlay_unset() on all Elementary application windows.
2392     *
2393     * @ingroup Fonts
2394     *
2395     * This applies all font overlays set to all objects in the UI.
2396     */
2397    // XXX: deprecate and replace with elm_config_all_flush()
2398    EAPI void                 elm_font_overlay_all_apply(void);
2399
2400    /**
2401     * Translate a font (family) name string in fontconfig's font names
2402     * syntax into an @c Elm_Font_Properties struct.
2403     *
2404     * @param font The font name and styles string
2405     * @return the font properties struct
2406     *
2407     * @ingroup Fonts
2408     *
2409     * @note The reverse translation can be achived with
2410     * elm_font_fontconfig_name_get(), for one style only (single font
2411     * instance, not family).
2412     */
2413    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2414
2415    /**
2416     * Free font properties return by elm_font_properties_get().
2417     *
2418     * @param efp the font properties struct
2419     *
2420     * @ingroup Fonts
2421     */
2422    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2423
2424    /**
2425     * Translate a font name, bound to a style, into fontconfig's font names
2426     * syntax.
2427     *
2428     * @param name The font (family) name
2429     * @param style The given style (may be @c NULL)
2430     *
2431     * @return the font name and style string
2432     *
2433     * @ingroup Fonts
2434     *
2435     * @note The reverse translation can be achived with
2436     * elm_font_properties_get(), for one style only (single font
2437     * instance, not family).
2438     */
2439    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2440
2441    /**
2442     * Free the font string return by elm_font_fontconfig_name_get().
2443     *
2444     * @param efp the font properties struct
2445     *
2446     * @ingroup Fonts
2447     */
2448    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2449
2450    /**
2451     * Create a font hash table of available system fonts.
2452     *
2453     * One must call it with @p list being the return value of
2454     * evas_font_available_list(). The hash will be indexed by font
2455     * (family) names, being its values @c Elm_Font_Properties blobs.
2456     *
2457     * @param list The list of available system fonts, as returned by
2458     * evas_font_available_list().
2459     * @return the font hash.
2460     *
2461     * @ingroup Fonts
2462     *
2463     * @note The user is supposed to get it populated at least with 3
2464     * default font families (Sans, Serif, Monospace), which should be
2465     * present on most systems.
2466     */
2467    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2468
2469    /**
2470     * Free the hash return by elm_font_available_hash_add().
2471     *
2472     * @param hash the hash to be freed.
2473     *
2474     * @ingroup Fonts
2475     */
2476    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2477
2478    /**
2479     * @}
2480     */
2481
2482    /**
2483     * @defgroup Fingers Fingers
2484     *
2485     * Elementary is designed to be finger-friendly for touchscreens,
2486     * and so in addition to scaling for display resolution, it can
2487     * also scale based on finger "resolution" (or size). You can then
2488     * customize the granularity of the areas meant to receive clicks
2489     * on touchscreens.
2490     *
2491     * Different profiles may have pre-set values for finger sizes.
2492     *
2493     * @ref general_functions_example_page "This" example contemplates
2494     * some of these functions.
2495     *
2496     * @{
2497     */
2498
2499    /**
2500     * Get the configured "finger size"
2501     *
2502     * @return The finger size
2503     *
2504     * This gets the globally configured finger size, <b>in pixels</b>
2505     *
2506     * @ingroup Fingers
2507     */
2508    EAPI Evas_Coord       elm_finger_size_get(void);
2509
2510    /**
2511     * Set the configured finger size
2512     *
2513     * This sets the globally configured finger size in pixels
2514     *
2515     * @param size The finger size
2516     * @ingroup Fingers
2517     */
2518    EAPI void             elm_finger_size_set(Evas_Coord size);
2519
2520    /**
2521     * Set the configured finger size for all applications on the display
2522     *
2523     * This sets the globally configured finger size in pixels for all
2524     * applications on the display
2525     *
2526     * @param size The finger size
2527     * @ingroup Fingers
2528     */
2529    // XXX: deprecate and replace with elm_config_all_flush()
2530    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2531
2532    /**
2533     * @}
2534     */
2535
2536    /**
2537     * @defgroup Focus Focus
2538     *
2539     * An Elementary application has, at all times, one (and only one)
2540     * @b focused object. This is what determines where the input
2541     * events go to within the application's window. Also, focused
2542     * objects can be decorated differently, in order to signal to the
2543     * user where the input is, at a given moment.
2544     *
2545     * Elementary applications also have the concept of <b>focus
2546     * chain</b>: one can cycle through all the windows' focusable
2547     * objects by input (tab key) or programmatically. The default
2548     * focus chain for an application is the one define by the order in
2549     * which the widgets where added in code. One will cycle through
2550     * top level widgets, and, for each one containg sub-objects, cycle
2551     * through them all, before returning to the level
2552     * above. Elementary also allows one to set @b custom focus chains
2553     * for their applications.
2554     *
2555     * Besides the focused decoration a widget may exhibit, when it
2556     * gets focus, Elementary has a @b global focus highlight object
2557     * that can be enabled for a window. If one chooses to do so, this
2558     * extra highlight effect will surround the current focused object,
2559     * too.
2560     *
2561     * @note Some Elementary widgets are @b unfocusable, after
2562     * creation, by their very nature: they are not meant to be
2563     * interacted with input events, but are there just for visual
2564     * purposes.
2565     *
2566     * @ref general_functions_example_page "This" example contemplates
2567     * some of these functions.
2568     */
2569
2570    /**
2571     * Get the enable status of the focus highlight
2572     *
2573     * This gets whether the highlight on focused objects is enabled or not
2574     * @ingroup Focus
2575     */
2576    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2577
2578    /**
2579     * Set the enable status of the focus highlight
2580     *
2581     * Set whether to show or not the highlight on focused objects
2582     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2583     * @ingroup Focus
2584     */
2585    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2586
2587    /**
2588     * Get the enable status of the highlight animation
2589     *
2590     * Get whether the focus highlight, if enabled, will animate its switch from
2591     * one object to the next
2592     * @ingroup Focus
2593     */
2594    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2595
2596    /**
2597     * Set the enable status of the highlight animation
2598     *
2599     * Set whether the focus highlight, if enabled, will animate its switch from
2600     * one object to the next
2601     * @param animate Enable animation if EINA_TRUE, disable otherwise
2602     * @ingroup Focus
2603     */
2604    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2605
2606    /**
2607     * Get the whether an Elementary object has the focus or not.
2608     *
2609     * @param obj The Elementary object to get the information from
2610     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2611     *            not (and on errors).
2612     *
2613     * @see elm_object_focus_set()
2614     *
2615     * @ingroup Focus
2616     */
2617    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2618
2619    /**
2620     * Set/unset focus to a given Elementary object.
2621     *
2622     * @param obj The Elementary object to operate on.
2623     * @param enable @c EINA_TRUE Set focus to a given object,
2624     *               @c EINA_FALSE Unset focus to a given object.
2625     *
2626     * @note When you set focus to this object, if it can handle focus, will
2627     * take the focus away from the one who had it previously and will, for
2628     * now on, be the one receiving input events. Unsetting focus will remove
2629     * the focus from @p obj, passing it back to the previous element in the
2630     * focus chain list.
2631     *
2632     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2633     *
2634     * @ingroup Focus
2635     */
2636    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2637
2638    /**
2639     * Make a given Elementary object the focused one.
2640     *
2641     * @param obj The Elementary object to make focused.
2642     *
2643     * @note This object, if it can handle focus, will take the focus
2644     * away from the one who had it previously and will, for now on, be
2645     * the one receiving input events.
2646     *
2647     * @see elm_object_focus_get()
2648     * @deprecated use elm_object_focus_set() instead.
2649     *
2650     * @ingroup Focus
2651     */
2652    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2653
2654    /**
2655     * Remove the focus from an Elementary object
2656     *
2657     * @param obj The Elementary to take focus from
2658     *
2659     * This removes the focus from @p obj, passing it back to the
2660     * previous element in the focus chain list.
2661     *
2662     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2663     * @deprecated use elm_object_focus_set() instead.
2664     *
2665     * @ingroup Focus
2666     */
2667    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2668
2669    /**
2670     * Set the ability for an Element object to be focused
2671     *
2672     * @param obj The Elementary object to operate on
2673     * @param enable @c EINA_TRUE if the object can be focused, @c
2674     *        EINA_FALSE if not (and on errors)
2675     *
2676     * This sets whether the object @p obj is able to take focus or
2677     * not. Unfocusable objects do nothing when programmatically
2678     * focused, being the nearest focusable parent object the one
2679     * really getting focus. Also, when they receive mouse input, they
2680     * will get the event, but not take away the focus from where it
2681     * was previously.
2682     *
2683     * @ingroup Focus
2684     */
2685    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2686
2687    /**
2688     * Get whether an Elementary object is focusable or not
2689     *
2690     * @param obj The Elementary object to operate on
2691     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2692     *             EINA_FALSE if not (and on errors)
2693     *
2694     * @note Objects which are meant to be interacted with by input
2695     * events are created able to be focused, by default. All the
2696     * others are not.
2697     *
2698     * @ingroup Focus
2699     */
2700    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2701
2702    /**
2703     * Set custom focus chain.
2704     *
2705     * This function overwrites any previous custom focus chain within
2706     * the list of objects. The previous list will be deleted and this list
2707     * will be managed by elementary. After it is set, don't modify it.
2708     *
2709     * @note On focus cycle, only will be evaluated children of this container.
2710     *
2711     * @param obj The container object
2712     * @param objs Chain of objects to pass focus
2713     * @ingroup Focus
2714     */
2715    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2716
2717    /**
2718     * Unset a custom focus chain on a given Elementary widget
2719     *
2720     * @param obj The container object to remove focus chain from
2721     *
2722     * Any focus chain previously set on @p obj (for its child objects)
2723     * is removed entirely after this call.
2724     *
2725     * @ingroup Focus
2726     */
2727    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2728
2729    /**
2730     * Get custom focus chain
2731     *
2732     * @param obj The container object
2733     * @ingroup Focus
2734     */
2735    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2736
2737    /**
2738     * Append object to custom focus chain.
2739     *
2740     * @note If relative_child equal to NULL or not in custom chain, the object
2741     * will be added in end.
2742     *
2743     * @note On focus cycle, only will be evaluated children of this container.
2744     *
2745     * @param obj The container object
2746     * @param child The child to be added in custom chain
2747     * @param relative_child The relative object to position the child
2748     * @ingroup Focus
2749     */
2750    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2751
2752    /**
2753     * Prepend object to custom focus chain.
2754     *
2755     * @note If relative_child equal to NULL or not in custom chain, the object
2756     * will be added in begin.
2757     *
2758     * @note On focus cycle, only will be evaluated children of this container.
2759     *
2760     * @param obj The container object
2761     * @param child The child to be added in custom chain
2762     * @param relative_child The relative object to position the child
2763     * @ingroup Focus
2764     */
2765    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2766
2767    /**
2768     * Give focus to next object in object tree.
2769     *
2770     * Give focus to next object in focus chain of one object sub-tree.
2771     * If the last object of chain already have focus, the focus will go to the
2772     * first object of chain.
2773     *
2774     * @param obj The object root of sub-tree
2775     * @param dir Direction to cycle the focus
2776     *
2777     * @ingroup Focus
2778     */
2779    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2780
2781    /**
2782     * Give focus to near object in one direction.
2783     *
2784     * Give focus to near object in direction of one object.
2785     * If none focusable object in given direction, the focus will not change.
2786     *
2787     * @param obj The reference object
2788     * @param x Horizontal component of direction to focus
2789     * @param y Vertical component of direction to focus
2790     *
2791     * @ingroup Focus
2792     */
2793    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2794
2795    /**
2796     * Make the elementary object and its children to be unfocusable
2797     * (or focusable).
2798     *
2799     * @param obj The Elementary object to operate on
2800     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2801     *        @c EINA_FALSE for focusable.
2802     *
2803     * This sets whether the object @p obj and its children objects
2804     * are able to take focus or not. If the tree is set as unfocusable,
2805     * newest focused object which is not in this tree will get focus.
2806     * This API can be helpful for an object to be deleted.
2807     * When an object will be deleted soon, it and its children may not
2808     * want to get focus (by focus reverting or by other focus controls).
2809     * Then, just use this API before deleting.
2810     *
2811     * @see elm_object_tree_unfocusable_get()
2812     *
2813     * @ingroup Focus
2814     */
2815    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2816
2817    /**
2818     * Get whether an Elementary object and its children are unfocusable or not.
2819     *
2820     * @param obj The Elementary object to get the information from
2821     * @return @c EINA_TRUE, if the tree is unfocussable,
2822     *         @c EINA_FALSE if not (and on errors).
2823     *
2824     * @see elm_object_tree_unfocusable_set()
2825     *
2826     * @ingroup Focus
2827     */
2828    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2829
2830    /**
2831     * @defgroup Scrolling Scrolling
2832     *
2833     * These are functions setting how scrollable views in Elementary
2834     * widgets should behave on user interaction.
2835     *
2836     * @{
2837     */
2838
2839    /**
2840     * Get whether scrollers should bounce when they reach their
2841     * viewport's edge during a scroll.
2842     *
2843     * @return the thumb scroll bouncing state
2844     *
2845     * This is the default behavior for touch screens, in general.
2846     * @ingroup Scrolling
2847     */
2848    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2849
2850    /**
2851     * Set whether scrollers should bounce when they reach their
2852     * viewport's edge during a scroll.
2853     *
2854     * @param enabled the thumb scroll bouncing state
2855     *
2856     * @see elm_thumbscroll_bounce_enabled_get()
2857     * @ingroup Scrolling
2858     */
2859    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2860
2861    /**
2862     * Set whether scrollers should bounce when they reach their
2863     * viewport's edge during a scroll, for all Elementary application
2864     * windows.
2865     *
2866     * @param enabled the thumb scroll bouncing state
2867     *
2868     * @see elm_thumbscroll_bounce_enabled_get()
2869     * @ingroup Scrolling
2870     */
2871    // XXX: deprecate and replace with elm_config_all_flush()
2872    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2873
2874    /**
2875     * Get the amount of inertia a scroller will impose at bounce
2876     * animations.
2877     *
2878     * @return the thumb scroll bounce friction
2879     *
2880     * @ingroup Scrolling
2881     */
2882    EAPI double           elm_scroll_bounce_friction_get(void);
2883
2884    /**
2885     * Set the amount of inertia a scroller will impose at bounce
2886     * animations.
2887     *
2888     * @param friction the thumb scroll bounce friction
2889     *
2890     * @see elm_thumbscroll_bounce_friction_get()
2891     * @ingroup Scrolling
2892     */
2893    EAPI void             elm_scroll_bounce_friction_set(double friction);
2894
2895    /**
2896     * Set the amount of inertia a scroller will impose at bounce
2897     * animations, for all Elementary application windows.
2898     *
2899     * @param friction the thumb scroll bounce friction
2900     *
2901     * @see elm_thumbscroll_bounce_friction_get()
2902     * @ingroup Scrolling
2903     */
2904    // XXX: deprecate and replace with elm_config_all_flush()
2905    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2906
2907    /**
2908     * Get the amount of inertia a <b>paged</b> scroller will impose at
2909     * page fitting animations.
2910     *
2911     * @return the page scroll friction
2912     *
2913     * @ingroup Scrolling
2914     */
2915    EAPI double           elm_scroll_page_scroll_friction_get(void);
2916
2917    /**
2918     * Set the amount of inertia a <b>paged</b> scroller will impose at
2919     * page fitting animations.
2920     *
2921     * @param friction the page scroll friction
2922     *
2923     * @see elm_thumbscroll_page_scroll_friction_get()
2924     * @ingroup Scrolling
2925     */
2926    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2927
2928    /**
2929     * Set the amount of inertia a <b>paged</b> scroller will impose at
2930     * page fitting animations, for all Elementary application windows.
2931     *
2932     * @param friction the page scroll friction
2933     *
2934     * @see elm_thumbscroll_page_scroll_friction_get()
2935     * @ingroup Scrolling
2936     */
2937    // XXX: deprecate and replace with elm_config_all_flush()
2938    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2939
2940    /**
2941     * Get the amount of inertia a scroller will impose at region bring
2942     * animations.
2943     *
2944     * @return the bring in scroll friction
2945     *
2946     * @ingroup Scrolling
2947     */
2948    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2949
2950    /**
2951     * Set the amount of inertia a scroller will impose at region bring
2952     * animations.
2953     *
2954     * @param friction the bring in scroll friction
2955     *
2956     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2957     * @ingroup Scrolling
2958     */
2959    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2960
2961    /**
2962     * Set the amount of inertia a scroller will impose at region bring
2963     * animations, for all Elementary application windows.
2964     *
2965     * @param friction the bring in scroll friction
2966     *
2967     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2968     * @ingroup Scrolling
2969     */
2970    // XXX: deprecate and replace with elm_config_all_flush()
2971    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2972
2973    /**
2974     * Get the amount of inertia scrollers will impose at animations
2975     * triggered by Elementary widgets' zooming API.
2976     *
2977     * @return the zoom friction
2978     *
2979     * @ingroup Scrolling
2980     */
2981    EAPI double           elm_scroll_zoom_friction_get(void);
2982
2983    /**
2984     * Set the amount of inertia scrollers will impose at animations
2985     * triggered by Elementary widgets' zooming API.
2986     *
2987     * @param friction the zoom friction
2988     *
2989     * @see elm_thumbscroll_zoom_friction_get()
2990     * @ingroup Scrolling
2991     */
2992    EAPI void             elm_scroll_zoom_friction_set(double friction);
2993
2994    /**
2995     * Set the amount of inertia scrollers will impose at animations
2996     * triggered by Elementary widgets' zooming API, for all Elementary
2997     * application windows.
2998     *
2999     * @param friction the zoom friction
3000     *
3001     * @see elm_thumbscroll_zoom_friction_get()
3002     * @ingroup Scrolling
3003     */
3004    // XXX: deprecate and replace with elm_config_all_flush()
3005    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
3006
3007    /**
3008     * Get whether scrollers should be draggable from any point in their
3009     * views.
3010     *
3011     * @return the thumb scroll state
3012     *
3013     * @note This is the default behavior for touch screens, in general.
3014     * @note All other functions namespaced with "thumbscroll" will only
3015     *       have effect if this mode is enabled.
3016     *
3017     * @ingroup Scrolling
3018     */
3019    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
3020
3021    /**
3022     * Set whether scrollers should be draggable from any point in their
3023     * views.
3024     *
3025     * @param enabled the thumb scroll state
3026     *
3027     * @see elm_thumbscroll_enabled_get()
3028     * @ingroup Scrolling
3029     */
3030    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
3031
3032    /**
3033     * Set whether scrollers should be draggable from any point in their
3034     * views, for all Elementary application windows.
3035     *
3036     * @param enabled the thumb scroll state
3037     *
3038     * @see elm_thumbscroll_enabled_get()
3039     * @ingroup Scrolling
3040     */
3041    // XXX: deprecate and replace with elm_config_all_flush()
3042    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
3043
3044    /**
3045     * Get the number of pixels one should travel while dragging a
3046     * scroller's view to actually trigger scrolling.
3047     *
3048     * @return the thumb scroll threshould
3049     *
3050     * One would use higher values for touch screens, in general, because
3051     * of their inherent imprecision.
3052     * @ingroup Scrolling
3053     */
3054    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
3055
3056    /**
3057     * Set the number of pixels one should travel while dragging a
3058     * scroller's view to actually trigger scrolling.
3059     *
3060     * @param threshold the thumb scroll threshould
3061     *
3062     * @see elm_thumbscroll_threshould_get()
3063     * @ingroup Scrolling
3064     */
3065    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
3066
3067    /**
3068     * Set the number of pixels one should travel while dragging a
3069     * scroller's view to actually trigger scrolling, for all Elementary
3070     * application windows.
3071     *
3072     * @param threshold the thumb scroll threshould
3073     *
3074     * @see elm_thumbscroll_threshould_get()
3075     * @ingroup Scrolling
3076     */
3077    // XXX: deprecate and replace with elm_config_all_flush()
3078    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
3079
3080    /**
3081     * Get the minimum speed of mouse cursor movement which will trigger
3082     * list self scrolling animation after a mouse up event
3083     * (pixels/second).
3084     *
3085     * @return the thumb scroll momentum threshould
3086     *
3087     * @ingroup Scrolling
3088     */
3089    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
3090
3091    /**
3092     * Set the minimum speed of mouse cursor movement which will trigger
3093     * list self scrolling animation after a mouse up event
3094     * (pixels/second).
3095     *
3096     * @param threshold the thumb scroll momentum threshould
3097     *
3098     * @see elm_thumbscroll_momentum_threshould_get()
3099     * @ingroup Scrolling
3100     */
3101    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
3102
3103    /**
3104     * Set the minimum speed of mouse cursor movement which will trigger
3105     * list self scrolling animation after a mouse up event
3106     * (pixels/second), for all Elementary application windows.
3107     *
3108     * @param threshold the thumb scroll momentum threshould
3109     *
3110     * @see elm_thumbscroll_momentum_threshould_get()
3111     * @ingroup Scrolling
3112     */
3113    // XXX: deprecate and replace with elm_config_all_flush()
3114    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
3115
3116    /**
3117     * Get the amount of inertia a scroller will impose at self scrolling
3118     * animations.
3119     *
3120     * @return the thumb scroll friction
3121     *
3122     * @ingroup Scrolling
3123     */
3124    EAPI double           elm_scroll_thumbscroll_friction_get(void);
3125
3126    /**
3127     * Set the amount of inertia a scroller will impose at self scrolling
3128     * animations.
3129     *
3130     * @param friction the thumb scroll friction
3131     *
3132     * @see elm_thumbscroll_friction_get()
3133     * @ingroup Scrolling
3134     */
3135    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
3136
3137    /**
3138     * Set the amount of inertia a scroller will impose at self scrolling
3139     * animations, for all Elementary application windows.
3140     *
3141     * @param friction the thumb scroll friction
3142     *
3143     * @see elm_thumbscroll_friction_get()
3144     * @ingroup Scrolling
3145     */
3146    // XXX: deprecate and replace with elm_config_all_flush()
3147    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
3148
3149    /**
3150     * Get the amount of lag between your actual mouse cursor dragging
3151     * movement and a scroller's view movement itself, while pushing it
3152     * into bounce state manually.
3153     *
3154     * @return the thumb scroll border friction
3155     *
3156     * @ingroup Scrolling
3157     */
3158    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
3159
3160    /**
3161     * Set the amount of lag between your actual mouse cursor dragging
3162     * movement and a scroller's view movement itself, while pushing it
3163     * into bounce state manually.
3164     *
3165     * @param friction the thumb scroll border friction. @c 0.0 for
3166     *        perfect synchrony between two movements, @c 1.0 for maximum
3167     *        lag.
3168     *
3169     * @see elm_thumbscroll_border_friction_get()
3170     * @note parameter value will get bound to 0.0 - 1.0 interval, always
3171     *
3172     * @ingroup Scrolling
3173     */
3174    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
3175
3176    /**
3177     * Set the amount of lag between your actual mouse cursor dragging
3178     * movement and a scroller's view movement itself, while pushing it
3179     * into bounce state manually, for all Elementary application windows.
3180     *
3181     * @param friction the thumb scroll border friction. @c 0.0 for
3182     *        perfect synchrony between two movements, @c 1.0 for maximum
3183     *        lag.
3184     *
3185     * @see elm_thumbscroll_border_friction_get()
3186     * @note parameter value will get bound to 0.0 - 1.0 interval, always
3187     *
3188     * @ingroup Scrolling
3189     */
3190    // XXX: deprecate and replace with elm_config_all_flush()
3191    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
3192
3193    /**
3194     * Get the sensitivity amount which is be multiplied by the length of
3195     * mouse dragging.
3196     *
3197     * @return the thumb scroll sensitivity friction
3198     *
3199     * @ingroup Scrolling
3200     */
3201    EAPI double           elm_scroll_thumbscroll_sensitivity_friction_get(void);
3202
3203    /**
3204     * Set the sensitivity amount which is be multiplied by the length of
3205     * mouse dragging.
3206     *
3207     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3208     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3209     *        is proper.
3210     *
3211     * @see elm_thumbscroll_sensitivity_friction_get()
3212     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3213     *
3214     * @ingroup Scrolling
3215     */
3216    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3217
3218    /**
3219     * Set the sensitivity amount which is be multiplied by the length of
3220     * mouse dragging, for all Elementary application windows.
3221     *
3222     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3223     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3224     *        is proper.
3225     *
3226     * @see elm_thumbscroll_sensitivity_friction_get()
3227     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3228     *
3229     * @ingroup Scrolling
3230     */
3231    // XXX: deprecate and replace with elm_config_all_flush()
3232    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3233
3234    /**
3235     * @}
3236     */
3237
3238    /**
3239     * @defgroup Scrollhints Scrollhints
3240     *
3241     * Objects when inside a scroller can scroll, but this may not always be
3242     * desirable in certain situations. This allows an object to hint to itself
3243     * and parents to "not scroll" in one of 2 ways. If any child object of a
3244     * scroller has pushed a scroll freeze or hold then it affects all parent
3245     * scrollers until all children have released them.
3246     *
3247     * 1. To hold on scrolling. This means just flicking and dragging may no
3248     * longer scroll, but pressing/dragging near an edge of the scroller will
3249     * still scroll. This is automatically used by the entry object when
3250     * selecting text.
3251     *
3252     * 2. To totally freeze scrolling. This means it stops. until
3253     * popped/released.
3254     *
3255     * @{
3256     */
3257
3258    /**
3259     * Push the scroll hold by 1
3260     *
3261     * This increments the scroll hold count by one. If it is more than 0 it will
3262     * take effect on the parents of the indicated object.
3263     *
3264     * @param obj The object
3265     * @ingroup Scrollhints
3266     */
3267    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3268
3269    /**
3270     * Pop the scroll hold by 1
3271     *
3272     * This decrements the scroll hold count by one. If it is more than 0 it will
3273     * take effect on the parents of the indicated object.
3274     *
3275     * @param obj The object
3276     * @ingroup Scrollhints
3277     */
3278    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3279
3280    /**
3281     * Push the scroll freeze by 1
3282     *
3283     * This increments the scroll freeze count by one. If it is more
3284     * than 0 it will take effect on the parents of the indicated
3285     * object.
3286     *
3287     * @param obj The object
3288     * @ingroup Scrollhints
3289     */
3290    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3291
3292    /**
3293     * Pop the scroll freeze by 1
3294     *
3295     * This decrements the scroll freeze count by one. If it is more
3296     * than 0 it will take effect on the parents of the indicated
3297     * object.
3298     *
3299     * @param obj The object
3300     * @ingroup Scrollhints
3301     */
3302    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3303
3304    /**
3305     * Lock the scrolling of the given widget (and thus all parents)
3306     *
3307     * This locks the given object from scrolling in the X axis (and implicitly
3308     * also locks all parent scrollers too from doing the same).
3309     *
3310     * @param obj The object
3311     * @param lock The lock state (1 == locked, 0 == unlocked)
3312     * @ingroup Scrollhints
3313     */
3314    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3315
3316    /**
3317     * Lock the scrolling of the given widget (and thus all parents)
3318     *
3319     * This locks the given object from scrolling in the Y axis (and implicitly
3320     * also locks all parent scrollers too from doing the same).
3321     *
3322     * @param obj The object
3323     * @param lock The lock state (1 == locked, 0 == unlocked)
3324     * @ingroup Scrollhints
3325     */
3326    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3327
3328    /**
3329     * Get the scrolling lock of the given widget
3330     *
3331     * This gets the lock for X axis scrolling.
3332     *
3333     * @param obj The object
3334     * @ingroup Scrollhints
3335     */
3336    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3337
3338    /**
3339     * Get the scrolling lock of the given widget
3340     *
3341     * This gets the lock for X axis scrolling.
3342     *
3343     * @param obj The object
3344     * @ingroup Scrollhints
3345     */
3346    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3347
3348    /**
3349     * @}
3350     */
3351
3352    /**
3353     * Send a signal to the widget edje object.
3354     *
3355     * This function sends a signal to the edje object of the obj. An
3356     * edje program can respond to a signal by specifying matching
3357     * 'signal' and 'source' fields.
3358     *
3359     * @param obj The object
3360     * @param emission The signal's name.
3361     * @param source The signal's source.
3362     * @ingroup General
3363     */
3364    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3365
3366    /**
3367     * Add a callback for a signal emitted by widget edje object.
3368     *
3369     * This function connects a callback function to a signal emitted by the
3370     * edje object of the obj.
3371     * Globs can occur in either the emission or source name.
3372     *
3373     * @param obj The object
3374     * @param emission The signal's name.
3375     * @param source The signal's source.
3376     * @param func The callback function to be executed when the signal is
3377     * emitted.
3378     * @param data A pointer to data to pass in to the callback function.
3379     * @ingroup General
3380     */
3381    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);
3382
3383    /**
3384     * Remove a signal-triggered callback from a widget edje object.
3385     *
3386     * This function removes a callback, previoulsy attached to a
3387     * signal emitted by the edje object of the obj.  The parameters
3388     * emission, source and func must match exactly those passed to a
3389     * previous call to elm_object_signal_callback_add(). The data
3390     * pointer that was passed to this call will be returned.
3391     *
3392     * @param obj The object
3393     * @param emission The signal's name.
3394     * @param source The signal's source.
3395     * @param func The callback function to be executed when the signal is
3396     * emitted.
3397     * @return The data pointer
3398     * @ingroup General
3399     */
3400    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);
3401
3402    /**
3403     * Add a callback for input events (key up, key down, mouse wheel)
3404     * on a given Elementary widget
3405     *
3406     * @param obj The widget to add an event callback on
3407     * @param func The callback function to be executed when the event
3408     * happens
3409     * @param data Data to pass in to @p func
3410     *
3411     * Every widget in an Elementary interface set to receive focus,
3412     * with elm_object_focus_allow_set(), will propagate @b all of its
3413     * key up, key down and mouse wheel input events up to its parent
3414     * object, and so on. All of the focusable ones in this chain which
3415     * had an event callback set, with this call, will be able to treat
3416     * those events. There are two ways of making the propagation of
3417     * these event upwards in the tree of widgets to @b cease:
3418     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3419     *   the event was @b not processed, so the propagation will go on.
3420     * - The @c event_info pointer passed to @p func will contain the
3421     *   event's structure and, if you OR its @c event_flags inner
3422     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3423     *   one has already handled it, thus killing the event's
3424     *   propagation, too.
3425     *
3426     * @note Your event callback will be issued on those events taking
3427     * place only if no other child widget of @obj has consumed the
3428     * event already.
3429     *
3430     * @note Not to be confused with @c
3431     * evas_object_event_callback_add(), which will add event callbacks
3432     * per type on general Evas objects (no event propagation
3433     * infrastructure taken in account).
3434     *
3435     * @note Not to be confused with @c
3436     * elm_object_signal_callback_add(), which will add callbacks to @b
3437     * signals coming from a widget's theme, not input events.
3438     *
3439     * @note Not to be confused with @c
3440     * edje_object_signal_callback_add(), which does the same as
3441     * elm_object_signal_callback_add(), but directly on an Edje
3442     * object.
3443     *
3444     * @note Not to be confused with @c
3445     * evas_object_smart_callback_add(), which adds callbacks to smart
3446     * objects' <b>smart events</b>, and not input events.
3447     *
3448     * @see elm_object_event_callback_del()
3449     *
3450     * @ingroup General
3451     */
3452    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3453
3454    /**
3455     * Remove an event callback from a widget.
3456     *
3457     * This function removes a callback, previoulsy attached to event emission
3458     * by the @p obj.
3459     * The parameters func and data must match exactly those passed to
3460     * a previous call to elm_object_event_callback_add(). The data pointer that
3461     * was passed to this call will be returned.
3462     *
3463     * @param obj The object
3464     * @param func The callback function to be executed when the event is
3465     * emitted.
3466     * @param data Data to pass in to the callback function.
3467     * @return The data pointer
3468     * @ingroup General
3469     */
3470    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3471
3472    /**
3473     * Adjust size of an element for finger usage.
3474     *
3475     * @param times_w How many fingers should fit horizontally
3476     * @param w Pointer to the width size to adjust
3477     * @param times_h How many fingers should fit vertically
3478     * @param h Pointer to the height size to adjust
3479     *
3480     * This takes width and height sizes (in pixels) as input and a
3481     * size multiple (which is how many fingers you want to place
3482     * within the area, being "finger" the size set by
3483     * elm_finger_size_set()), and adjusts the size to be large enough
3484     * to accommodate the resulting size -- if it doesn't already
3485     * accommodate it. On return the @p w and @p h sizes pointed to by
3486     * these parameters will be modified, on those conditions.
3487     *
3488     * @note This is kind of a low level Elementary call, most useful
3489     * on size evaluation times for widgets. An external user wouldn't
3490     * be calling, most of the time.
3491     *
3492     * @ingroup Fingers
3493     */
3494    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3495
3496    /**
3497     * Get the duration for occuring long press event.
3498     *
3499     * @return Timeout for long press event
3500     * @ingroup Longpress
3501     */
3502    EAPI double           elm_longpress_timeout_get(void);
3503
3504    /**
3505     * Set the duration for occuring long press event.
3506     *
3507     * @param lonpress_timeout Timeout for long press event
3508     * @ingroup Longpress
3509     */
3510    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3511
3512    /**
3513     * @defgroup Debug Debug
3514     * don't use it unless you are sure
3515     *
3516     * @{
3517     */
3518
3519    /**
3520     * Print Tree object hierarchy in stdout
3521     *
3522     * @param obj The root object
3523     * @ingroup Debug
3524     */
3525    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3526
3527    /**
3528     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3529     *
3530     * @param obj The root object
3531     * @param file The path of output file
3532     * @ingroup Debug
3533     */
3534    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3535
3536    /**
3537     * @}
3538     */
3539
3540    /**
3541     * @defgroup Theme Theme
3542     *
3543     * Elementary uses Edje to theme its widgets, naturally. But for the most
3544     * part this is hidden behind a simpler interface that lets the user set
3545     * extensions and choose the style of widgets in a much easier way.
3546     *
3547     * Instead of thinking in terms of paths to Edje files and their groups
3548     * each time you want to change the appearance of a widget, Elementary
3549     * works so you can add any theme file with extensions or replace the
3550     * main theme at one point in the application, and then just set the style
3551     * of widgets with elm_object_style_set() and related functions. Elementary
3552     * will then look in its list of themes for a matching group and apply it,
3553     * and when the theme changes midway through the application, all widgets
3554     * will be updated accordingly.
3555     *
3556     * There are three concepts you need to know to understand how Elementary
3557     * theming works: default theme, extensions and overlays.
3558     *
3559     * Default theme, obviously enough, is the one that provides the default
3560     * look of all widgets. End users can change the theme used by Elementary
3561     * by setting the @c ELM_THEME environment variable before running an
3562     * application, or globally for all programs using the @c elementary_config
3563     * utility. Applications can change the default theme using elm_theme_set(),
3564     * but this can go against the user wishes, so it's not an adviced practice.
3565     *
3566     * Ideally, applications should find everything they need in the already
3567     * provided theme, but there may be occasions when that's not enough and
3568     * custom styles are required to correctly express the idea. For this
3569     * cases, Elementary has extensions.
3570     *
3571     * Extensions allow the application developer to write styles of its own
3572     * to apply to some widgets. This requires knowledge of how each widget
3573     * is themed, as extensions will always replace the entire group used by
3574     * the widget, so important signals and parts need to be there for the
3575     * object to behave properly (see documentation of Edje for details).
3576     * Once the theme for the extension is done, the application needs to add
3577     * it to the list of themes Elementary will look into, using
3578     * elm_theme_extension_add(), and set the style of the desired widgets as
3579     * he would normally with elm_object_style_set().
3580     *
3581     * Overlays, on the other hand, can replace the look of all widgets by
3582     * overriding the default style. Like extensions, it's up to the application
3583     * developer to write the theme for the widgets it wants, the difference
3584     * being that when looking for the theme, Elementary will check first the
3585     * list of overlays, then the set theme and lastly the list of extensions,
3586     * so with overlays it's possible to replace the default view and every
3587     * widget will be affected. This is very much alike to setting the whole
3588     * theme for the application and will probably clash with the end user
3589     * options, not to mention the risk of ending up with not matching styles
3590     * across the program. Unless there's a very special reason to use them,
3591     * overlays should be avoided for the resons exposed before.
3592     *
3593     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3594     * keeps one default internally and every function that receives one of
3595     * these can be called with NULL to refer to this default (except for
3596     * elm_theme_free()). It's possible to create a new instance of a
3597     * ::Elm_Theme to set other theme for a specific widget (and all of its
3598     * children), but this is as discouraged, if not even more so, than using
3599     * overlays. Don't use this unless you really know what you are doing.
3600     *
3601     * But to be less negative about things, you can look at the following
3602     * examples:
3603     * @li @ref theme_example_01 "Using extensions"
3604     * @li @ref theme_example_02 "Using overlays"
3605     *
3606     * @{
3607     */
3608    /**
3609     * @typedef Elm_Theme
3610     *
3611     * Opaque handler for the list of themes Elementary looks for when
3612     * rendering widgets.
3613     *
3614     * Stay out of this unless you really know what you are doing. For most
3615     * cases, sticking to the default is all a developer needs.
3616     */
3617    typedef struct _Elm_Theme Elm_Theme;
3618
3619    /**
3620     * Create a new specific theme
3621     *
3622     * This creates an empty specific theme that only uses the default theme. A
3623     * specific theme has its own private set of extensions and overlays too
3624     * (which are empty by default). Specific themes do not fall back to themes
3625     * of parent objects. They are not intended for this use. Use styles, overlays
3626     * and extensions when needed, but avoid specific themes unless there is no
3627     * other way (example: you want to have a preview of a new theme you are
3628     * selecting in a "theme selector" window. The preview is inside a scroller
3629     * and should display what the theme you selected will look like, but not
3630     * actually apply it yet. The child of the scroller will have a specific
3631     * theme set to show this preview before the user decides to apply it to all
3632     * applications).
3633     */
3634    EAPI Elm_Theme       *elm_theme_new(void);
3635
3636    /**
3637     * Free a specific theme
3638     *
3639     * @param th The theme to free
3640     *
3641     * This frees a theme created with elm_theme_new().
3642     */
3643    EAPI void             elm_theme_free(Elm_Theme *th);
3644
3645    /**
3646     * Copy the theme fom the source to the destination theme
3647     *
3648     * @param th The source theme to copy from
3649     * @param thdst The destination theme to copy data to
3650     *
3651     * This makes a one-time static copy of all the theme config, extensions
3652     * and overlays from @p th to @p thdst. If @p th references a theme, then
3653     * @p thdst is also set to reference it, with all the theme settings,
3654     * overlays and extensions that @p th had.
3655     */
3656    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3657
3658    /**
3659     * Tell the source theme to reference the ref theme
3660     *
3661     * @param th The theme that will do the referencing
3662     * @param thref The theme that is the reference source
3663     *
3664     * This clears @p th to be empty and then sets it to refer to @p thref
3665     * so @p th acts as an override to @p thref, but where its overrides
3666     * don't apply, it will fall through to @p thref for configuration.
3667     */
3668    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3669
3670    /**
3671     * Return the theme referred to
3672     *
3673     * @param th The theme to get the reference from
3674     * @return The referenced theme handle
3675     *
3676     * This gets the theme set as the reference theme by elm_theme_ref_set().
3677     * If no theme is set as a reference, NULL is returned.
3678     */
3679    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3680
3681    /**
3682     * Return the default theme
3683     *
3684     * @return The default theme handle
3685     *
3686     * This returns the internal default theme setup handle that all widgets
3687     * use implicitly unless a specific theme is set. This is also often use
3688     * as a shorthand of NULL.
3689     */
3690    EAPI Elm_Theme       *elm_theme_default_get(void);
3691
3692    /**
3693     * Prepends a theme overlay to the list of overlays
3694     *
3695     * @param th The theme to add to, or if NULL, the default theme
3696     * @param item The Edje file path to be used
3697     *
3698     * Use this if your application needs to provide some custom overlay theme
3699     * (An Edje file that replaces some default styles of widgets) where adding
3700     * new styles, or changing system theme configuration is not possible. Do
3701     * NOT use this instead of a proper system theme configuration. Use proper
3702     * configuration files, profiles, environment variables etc. to set a theme
3703     * so that the theme can be altered by simple confiugration by a user. Using
3704     * this call to achieve that effect is abusing the API and will create lots
3705     * of trouble.
3706     *
3707     * @see elm_theme_extension_add()
3708     */
3709    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3710
3711    /**
3712     * Delete a theme overlay from the list of overlays
3713     *
3714     * @param th The theme to delete from, or if NULL, the default theme
3715     * @param item The name of the theme overlay
3716     *
3717     * @see elm_theme_overlay_add()
3718     */
3719    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3720
3721    /**
3722     * Appends a theme extension to the list of extensions.
3723     *
3724     * @param th The theme to add to, or if NULL, the default theme
3725     * @param item The Edje file path to be used
3726     *
3727     * This is intended when an application needs more styles of widgets or new
3728     * widget themes that the default does not provide (or may not provide). The
3729     * application has "extended" usage by coming up with new custom style names
3730     * for widgets for specific uses, but as these are not "standard", they are
3731     * not guaranteed to be provided by a default theme. This means the
3732     * application is required to provide these extra elements itself in specific
3733     * Edje files. This call adds one of those Edje files to the theme search
3734     * path to be search after the default theme. The use of this call is
3735     * encouraged when default styles do not meet the needs of the application.
3736     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3737     *
3738     * @see elm_object_style_set()
3739     */
3740    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3741
3742    /**
3743     * Deletes a theme extension from the list of extensions.
3744     *
3745     * @param th The theme to delete from, or if NULL, the default theme
3746     * @param item The name of the theme extension
3747     *
3748     * @see elm_theme_extension_add()
3749     */
3750    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3751
3752    /**
3753     * Set the theme search order for the given theme
3754     *
3755     * @param th The theme to set the search order, or if NULL, the default theme
3756     * @param theme Theme search string
3757     *
3758     * This sets the search string for the theme in path-notation from first
3759     * theme to search, to last, delimited by the : character. Example:
3760     *
3761     * "shiny:/path/to/file.edj:default"
3762     *
3763     * See the ELM_THEME environment variable for more information.
3764     *
3765     * @see elm_theme_get()
3766     * @see elm_theme_list_get()
3767     */
3768    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3769
3770    /**
3771     * Return the theme search order
3772     *
3773     * @param th The theme to get the search order, or if NULL, the default theme
3774     * @return The internal search order path
3775     *
3776     * This function returns a colon separated string of theme elements as
3777     * returned by elm_theme_list_get().
3778     *
3779     * @see elm_theme_set()
3780     * @see elm_theme_list_get()
3781     */
3782    EAPI const char      *elm_theme_get(Elm_Theme *th);
3783
3784    /**
3785     * Return a list of theme elements to be used in a theme.
3786     *
3787     * @param th Theme to get the list of theme elements from.
3788     * @return The internal list of theme elements
3789     *
3790     * This returns the internal list of theme elements (will only be valid as
3791     * long as the theme is not modified by elm_theme_set() or theme is not
3792     * freed by elm_theme_free(). This is a list of strings which must not be
3793     * altered as they are also internal. If @p th is NULL, then the default
3794     * theme element list is returned.
3795     *
3796     * A theme element can consist of a full or relative path to a .edj file,
3797     * or a name, without extension, for a theme to be searched in the known
3798     * theme paths for Elemementary.
3799     *
3800     * @see elm_theme_set()
3801     * @see elm_theme_get()
3802     */
3803    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3804
3805    /**
3806     * Return the full patrh for a theme element
3807     *
3808     * @param f The theme element name
3809     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3810     * @return The full path to the file found.
3811     *
3812     * This returns a string you should free with free() on success, NULL on
3813     * failure. This will search for the given theme element, and if it is a
3814     * full or relative path element or a simple searchable name. The returned
3815     * path is the full path to the file, if searched, and the file exists, or it
3816     * is simply the full path given in the element or a resolved path if
3817     * relative to home. The @p in_search_path boolean pointed to is set to
3818     * EINA_TRUE if the file was a searchable file andis in the search path,
3819     * and EINA_FALSE otherwise.
3820     */
3821    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3822
3823    /**
3824     * Flush the current theme.
3825     *
3826     * @param th Theme to flush
3827     *
3828     * This flushes caches that let elementary know where to find theme elements
3829     * in the given theme. If @p th is NULL, then the default theme is flushed.
3830     * Call this function if source theme data has changed in such a way as to
3831     * make any caches Elementary kept invalid.
3832     */
3833    EAPI void             elm_theme_flush(Elm_Theme *th);
3834
3835    /**
3836     * This flushes all themes (default and specific ones).
3837     *
3838     * This will flush all themes in the current application context, by calling
3839     * elm_theme_flush() on each of them.
3840     */
3841    EAPI void             elm_theme_full_flush(void);
3842
3843    /**
3844     * Set the theme for all elementary using applications on the current display
3845     *
3846     * @param theme The name of the theme to use. Format same as the ELM_THEME
3847     * environment variable.
3848     */
3849    EAPI void             elm_theme_all_set(const char *theme);
3850
3851    /**
3852     * Return a list of theme elements in the theme search path
3853     *
3854     * @return A list of strings that are the theme element names.
3855     *
3856     * This lists all available theme files in the standard Elementary search path
3857     * for theme elements, and returns them in alphabetical order as theme
3858     * element names in a list of strings. Free this with
3859     * elm_theme_name_available_list_free() when you are done with the list.
3860     */
3861    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3862
3863    /**
3864     * Free the list returned by elm_theme_name_available_list_new()
3865     *
3866     * This frees the list of themes returned by
3867     * elm_theme_name_available_list_new(). Once freed the list should no longer
3868     * be used. a new list mys be created.
3869     */
3870    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3871
3872    /**
3873     * Set a specific theme to be used for this object and its children
3874     *
3875     * @param obj The object to set the theme on
3876     * @param th The theme to set
3877     *
3878     * This sets a specific theme that will be used for the given object and any
3879     * child objects it has. If @p th is NULL then the theme to be used is
3880     * cleared and the object will inherit its theme from its parent (which
3881     * ultimately will use the default theme if no specific themes are set).
3882     *
3883     * Use special themes with great care as this will annoy users and make
3884     * configuration difficult. Avoid any custom themes at all if it can be
3885     * helped.
3886     */
3887    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3888
3889    /**
3890     * Get the specific theme to be used
3891     *
3892     * @param obj The object to get the specific theme from
3893     * @return The specifc theme set.
3894     *
3895     * This will return a specific theme set, or NULL if no specific theme is
3896     * set on that object. It will not return inherited themes from parents, only
3897     * the specific theme set for that specific object. See elm_object_theme_set()
3898     * for more information.
3899     */
3900    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3901
3902    /**
3903     * Get a data item from a theme
3904     *
3905     * @param th The theme, or NULL for default theme
3906     * @param key The data key to search with
3907     * @return The data value, or NULL on failure
3908     *
3909     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3910     * It works the same way as edje_file_data_get() except that the return is stringshared.
3911     */
3912    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3913
3914    /**
3915     * @}
3916     */
3917
3918    /* win */
3919    /** @defgroup Win Win
3920     *
3921     * @image html img/widget/win/preview-00.png
3922     * @image latex img/widget/win/preview-00.eps
3923     *
3924     * The window class of Elementary.  Contains functions to manipulate
3925     * windows. The Evas engine used to render the window contents is specified
3926     * in the system or user elementary config files (whichever is found last),
3927     * and can be overridden with the ELM_ENGINE environment variable for
3928     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3929     * compilation setup and modules actually installed at runtime) are (listed
3930     * in order of best supported and most likely to be complete and work to
3931     * lowest quality).
3932     *
3933     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3934     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3935     * rendering in X11)
3936     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3937     * exits)
3938     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3939     * rendering)
3940     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3941     * buffer)
3942     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3943     * rendering using SDL as the buffer)
3944     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3945     * GDI with software)
3946     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3947     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3948     * grayscale using dedicated 8bit software engine in X11)
3949     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3950     * X11 using 16bit software engine)
3951     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3952     * (Windows CE rendering via GDI with 16bit software renderer)
3953     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3954     * buffer with 16bit software renderer)
3955     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3956     * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3957     * @li "psl1ght" (PS3 rendering using PSL1GHT)
3958     *
3959     * All engines use a simple string to select the engine to render, EXCEPT
3960     * the "shot" engine. This actually encodes the output of the virtual
3961     * screenshot and how long to delay in the engine string. The engine string
3962     * is encoded in the following way:
3963     *
3964     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3965     *
3966     * Where options are separated by a ":" char if more than one option is
3967     * given, with delay, if provided being the first option and file the last
3968     * (order is important). The delay specifies how long to wait after the
3969     * window is shown before doing the virtual "in memory" rendering and then
3970     * save the output to the file specified by the file option (and then exit).
3971     * If no delay is given, the default is 0.5 seconds. If no file is given the
3972     * default output file is "out.png". Repeat option is for continous
3973     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3974     * fixed to "out001.png" Some examples of using the shot engine:
3975     *
3976     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3977     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3978     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3979     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3980     *   ELM_ENGINE="shot:" elementary_test
3981     *
3982     * Signals that you can add callbacks for are:
3983     *
3984     * @li "delete,request": the user requested to close the window. See
3985     * elm_win_autodel_set().
3986     * @li "focus,in": window got focus
3987     * @li "focus,out": window lost focus
3988     * @li "moved": window that holds the canvas was moved
3989     *
3990     * Examples:
3991     * @li @ref win_example_01
3992     *
3993     * @{
3994     */
3995    /**
3996     * Defines the types of window that can be created
3997     *
3998     * These are hints set on the window so that a running Window Manager knows
3999     * how the window should be handled and/or what kind of decorations it
4000     * should have.
4001     *
4002     * Currently, only the X11 backed engines use them.
4003     */
4004    typedef enum _Elm_Win_Type
4005      {
4006         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
4007                          window. Almost every window will be created with this
4008                          type. */
4009         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
4010         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
4011                            window holding desktop icons. */
4012         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
4013                         be kept on top of any other window by the Window
4014                         Manager. */
4015         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
4016                            similar. */
4017         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
4018         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
4019                            pallete. */
4020         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
4021         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
4022                                  entry in a menubar is clicked. Typically used
4023                                  with elm_win_override_set(). This hint exists
4024                                  for completion only, as the EFL way of
4025                                  implementing a menu would not normally use a
4026                                  separate window for its contents. */
4027         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
4028                               triggered by right-clicking an object. */
4029         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
4030                            explanatory text that typically appear after the
4031                            mouse cursor hovers over an object for a while.
4032                            Typically used with elm_win_override_set() and also
4033                            not very commonly used in the EFL. */
4034         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
4035                                 battery life or a new E-Mail received. */
4036         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
4037                          usually used in the EFL. */
4038         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
4039                        object being dragged across different windows, or even
4040                        applications. Typically used with
4041                        elm_win_override_set(). */
4042         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
4043                                  buffer. No actual window is created for this
4044                                  type, instead the window and all of its
4045                                  contents will be rendered to an image buffer.
4046                                  This allows to have children window inside a
4047                                  parent one just like any other object would
4048                                  be, and do other things like applying @c
4049                                  Evas_Map effects to it. This is the only type
4050                                  of window that requires the @c parent
4051                                  parameter of elm_win_add() to be a valid @c
4052                                  Evas_Object. */
4053      } Elm_Win_Type;
4054
4055    /**
4056     * The differents layouts that can be requested for the virtual keyboard.
4057     *
4058     * When the application window is being managed by Illume, it may request
4059     * any of the following layouts for the virtual keyboard.
4060     */
4061    typedef enum _Elm_Win_Keyboard_Mode
4062      {
4063         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
4064         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
4065         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
4066         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
4067         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
4068         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
4069         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
4070         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
4071         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
4072         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
4073         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
4074         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
4075         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
4076         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
4077         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
4078         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
4079      } Elm_Win_Keyboard_Mode;
4080
4081    /**
4082     * Available commands that can be sent to the Illume manager.
4083     *
4084     * When running under an Illume session, a window may send commands to the
4085     * Illume manager to perform different actions.
4086     */
4087    typedef enum _Elm_Illume_Command
4088      {
4089         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
4090                                          window */
4091         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
4092                                             in the list */
4093         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
4094                                          screen */
4095         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
4096      } Elm_Illume_Command;
4097
4098    /**
4099     * Adds a window object. If this is the first window created, pass NULL as
4100     * @p parent.
4101     *
4102     * @param parent Parent object to add the window to, or NULL
4103     * @param name The name of the window
4104     * @param type The window type, one of #Elm_Win_Type.
4105     *
4106     * The @p parent paramter can be @c NULL for every window @p type except
4107     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
4108     * which the image object will be created.
4109     *
4110     * @return The created object, or NULL on failure
4111     */
4112    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
4113
4114    /**
4115     * Adds a window object with standard setup
4116     *
4117     * @param name The name of the window
4118     * @param title The title for the window
4119     *
4120     * This creates a window like elm_win_add() but also puts in a standard
4121     * background with elm_bg_add(), as well as setting the window title to
4122     * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
4123     * as the parent widget.
4124     *
4125     * @return The created object, or NULL on failure
4126     *
4127     * @see elm_win_add()
4128     */
4129    EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
4130
4131    /**
4132     * Add @p subobj as a resize object of window @p obj.
4133     *
4134     *
4135     * Setting an object as a resize object of the window means that the
4136     * @p subobj child's size and position will be controlled by the window
4137     * directly. That is, the object will be resized to match the window size
4138     * and should never be moved or resized manually by the developer.
4139     *
4140     * In addition, resize objects of the window control what the minimum size
4141     * of it will be, as well as whether it can or not be resized by the user.
4142     *
4143     * For the end user to be able to resize a window by dragging the handles
4144     * or borders provided by the Window Manager, or using any other similar
4145     * mechanism, all of the resize objects in the window should have their
4146     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4147     *
4148     * Also notice that the window can get resized to the current size of the
4149     * object if the EVAS_HINT_EXPAND is set @b after the call to
4150     * elm_win_resize_object_add(). So if the object should get resized to the
4151     * size of the window, set this hint @b before adding it as a resize object
4152     * (this happens because the size of the window and the object are evaluated
4153     * as soon as the object is added to the window).
4154     *
4155     * @param obj The window object
4156     * @param subobj The resize object to add
4157     */
4158    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4159
4160    /**
4161     * Delete @p subobj as a resize object of window @p obj.
4162     *
4163     * This function removes the object @p subobj from the resize objects of
4164     * the window @p obj. It will not delete the object itself, which will be
4165     * left unmanaged and should be deleted by the developer, manually handled
4166     * or set as child of some other container.
4167     *
4168     * @param obj The window object
4169     * @param subobj The resize object to add
4170     */
4171    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4172
4173    /**
4174     * Set the title of the window
4175     *
4176     * @param obj The window object
4177     * @param title The title to set
4178     */
4179    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4180
4181    /**
4182     * Get the title of the window
4183     *
4184     * The returned string is an internal one and should not be freed or
4185     * modified. It will also be rendered invalid if a new title is set or if
4186     * the window is destroyed.
4187     *
4188     * @param obj The window object
4189     * @return The title
4190     */
4191    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4192
4193    /**
4194     * Set the window's autodel state.
4195     *
4196     * When closing the window in any way outside of the program control, like
4197     * pressing the X button in the titlebar or using a command from the
4198     * Window Manager, a "delete,request" signal is emitted to indicate that
4199     * this event occurred and the developer can take any action, which may
4200     * include, or not, destroying the window object.
4201     *
4202     * When the @p autodel parameter is set, the window will be automatically
4203     * destroyed when this event occurs, after the signal is emitted.
4204     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4205     * and is up to the program to do so when it's required.
4206     *
4207     * @param obj The window object
4208     * @param autodel If true, the window will automatically delete itself when
4209     * closed
4210     */
4211    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4212
4213    /**
4214     * Get the window's autodel state.
4215     *
4216     * @param obj The window object
4217     * @return If the window will automatically delete itself when closed
4218     *
4219     * @see elm_win_autodel_set()
4220     */
4221    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4222
4223    /**
4224     * Activate a window object.
4225     *
4226     * This function sends a request to the Window Manager to activate the
4227     * window pointed by @p obj. If honored by the WM, the window will receive
4228     * the keyboard focus.
4229     *
4230     * @note This is just a request that a Window Manager may ignore, so calling
4231     * this function does not ensure in any way that the window will be the
4232     * active one after it.
4233     *
4234     * @param obj The window object
4235     */
4236    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4237
4238    /**
4239     * Lower a window object.
4240     *
4241     * Places the window pointed by @p obj at the bottom of the stack, so that
4242     * no other window is covered by it.
4243     *
4244     * If elm_win_override_set() is not set, the Window Manager may ignore this
4245     * request.
4246     *
4247     * @param obj The window object
4248     */
4249    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4250
4251    /**
4252     * Raise a window object.
4253     *
4254     * Places the window pointed by @p obj at the top of the stack, so that it's
4255     * not covered by any other window.
4256     *
4257     * If elm_win_override_set() is not set, the Window Manager may ignore this
4258     * request.
4259     *
4260     * @param obj The window object
4261     */
4262    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4263
4264    /**
4265     * Center a window on its screen
4266     *
4267     * This function centers window @p obj horizontally and/or vertically based on the values
4268     * of @p h and @v.
4269     * @param obj The window object
4270     * @param h If true, center horizontally. If false, do not change horizontal location.
4271     * @param v If true, center vertically. If false, do not change vertical location.
4272     */
4273    EAPI void         elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bool v) EINA_ARG_NONNULL(1);
4274
4275    /**
4276     * Set the borderless state of a window.
4277     *
4278     * This function requests the Window Manager to not draw any decoration
4279     * around the window.
4280     *
4281     * @param obj The window object
4282     * @param borderless If true, the window is borderless
4283     */
4284    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4285
4286    /**
4287     * Get the borderless state of a window.
4288     *
4289     * @param obj The window object
4290     * @return If true, the window is borderless
4291     */
4292    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4293
4294    /**
4295     * Set the shaped state of a window.
4296     *
4297     * Shaped windows, when supported, will render the parts of the window that
4298     * has no content, transparent.
4299     *
4300     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4301     * background object or cover the entire window in any other way, or the
4302     * parts of the canvas that have no data will show framebuffer artifacts.
4303     *
4304     * @param obj The window object
4305     * @param shaped If true, the window is shaped
4306     *
4307     * @see elm_win_alpha_set()
4308     */
4309    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4310
4311    /**
4312     * Get the shaped state of a window.
4313     *
4314     * @param obj The window object
4315     * @return If true, the window is shaped
4316     *
4317     * @see elm_win_shaped_set()
4318     */
4319    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4320
4321    /**
4322     * Set the alpha channel state of a window.
4323     *
4324     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4325     * possibly making parts of the window completely or partially transparent.
4326     * This is also subject to the underlying system supporting it, like for
4327     * example, running under a compositing manager. If no compositing is
4328     * available, enabling this option will instead fallback to using shaped
4329     * windows, with elm_win_shaped_set().
4330     *
4331     * @param obj The window object
4332     * @param alpha If true, the window has an alpha channel
4333     *
4334     * @see elm_win_alpha_set()
4335     */
4336    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4337
4338    /**
4339     * Get the transparency state of a window.
4340     *
4341     * @param obj The window object
4342     * @return If true, the window is transparent
4343     *
4344     * @see elm_win_transparent_set()
4345     */
4346    // XXX: deprecate this
4347    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4348
4349    /**
4350     * Set the transparency state of a window.
4351     *
4352     * Use elm_win_alpha_set() instead.
4353     *
4354     * @param obj The window object
4355     * @param transparent If true, the window is transparent
4356     *
4357     * @see elm_win_alpha_set()
4358     */
4359    // XXX: deprecate this
4360    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4361
4362    /**
4363     * Get the alpha channel state of a window.
4364     *
4365     * @param obj The window object
4366     * @return If true, the window has an alpha channel
4367     */
4368    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4369
4370    /**
4371     * Set the override state of a window.
4372     *
4373     * A window with @p override set to EINA_TRUE will not be managed by the
4374     * Window Manager. This means that no decorations of any kind will be shown
4375     * for it, moving and resizing must be handled by the application, as well
4376     * as the window visibility.
4377     *
4378     * This should not be used for normal windows, and even for not so normal
4379     * ones, it should only be used when there's a good reason and with a lot
4380     * of care. Mishandling override windows may result situations that
4381     * disrupt the normal workflow of the end user.
4382     *
4383     * @param obj The window object
4384     * @param override If true, the window is overridden
4385     */
4386    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4387
4388    /**
4389     * Get the override state of a window.
4390     *
4391     * @param obj The window object
4392     * @return If true, the window is overridden
4393     *
4394     * @see elm_win_override_set()
4395     */
4396    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4397
4398    /**
4399     * Set the fullscreen state of a window.
4400     *
4401     * @param obj The window object
4402     * @param fullscreen If true, the window is fullscreen
4403     */
4404    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4405
4406    /**
4407     * Get the fullscreen state of a window.
4408     *
4409     * @param obj The window object
4410     * @return If true, the window is fullscreen
4411     */
4412    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4413
4414    /**
4415     * Set the maximized state of a window.
4416     *
4417     * @param obj The window object
4418     * @param maximized If true, the window is maximized
4419     */
4420    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4421
4422    /**
4423     * Get the maximized state of a window.
4424     *
4425     * @param obj The window object
4426     * @return If true, the window is maximized
4427     */
4428    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4429
4430    /**
4431     * Set the iconified state of a window.
4432     *
4433     * @param obj The window object
4434     * @param iconified If true, the window is iconified
4435     */
4436    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4437
4438    /**
4439     * Get the iconified state of a window.
4440     *
4441     * @param obj The window object
4442     * @return If true, the window is iconified
4443     */
4444    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4445
4446    /**
4447     * Set the layer of the window.
4448     *
4449     * What this means exactly will depend on the underlying engine used.
4450     *
4451     * In the case of X11 backed engines, the value in @p layer has the
4452     * following meanings:
4453     * @li < 3: The window will be placed below all others.
4454     * @li > 5: The window will be placed above all others.
4455     * @li other: The window will be placed in the default layer.
4456     *
4457     * @param obj The window object
4458     * @param layer The layer of the window
4459     */
4460    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4461
4462    /**
4463     * Get the layer of the window.
4464     *
4465     * @param obj The window object
4466     * @return The layer of the window
4467     *
4468     * @see elm_win_layer_set()
4469     */
4470    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4471
4472    /**
4473     * Set the rotation of the window.
4474     *
4475     * Most engines only work with multiples of 90.
4476     *
4477     * This function is used to set the orientation of the window @p obj to
4478     * match that of the screen. The window itself will be resized to adjust
4479     * to the new geometry of its contents. If you want to keep the window size,
4480     * see elm_win_rotation_with_resize_set().
4481     *
4482     * @param obj The window object
4483     * @param rotation The rotation of the window, in degrees (0-360),
4484     * counter-clockwise.
4485     */
4486    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4487
4488    /**
4489     * Rotates the window and resizes it.
4490     *
4491     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4492     * that they fit inside the current window geometry.
4493     *
4494     * @param obj The window object
4495     * @param layer The rotation of the window in degrees (0-360),
4496     * counter-clockwise.
4497     */
4498    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4499
4500    /**
4501     * Get the rotation of the window.
4502     *
4503     * @param obj The window object
4504     * @return The rotation of the window in degrees (0-360)
4505     *
4506     * @see elm_win_rotation_set()
4507     * @see elm_win_rotation_with_resize_set()
4508     */
4509    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4510
4511    /**
4512     * Set the sticky state of the window.
4513     *
4514     * Hints the Window Manager that the window in @p obj should be left fixed
4515     * at its position even when the virtual desktop it's on moves or changes.
4516     *
4517     * @param obj The window object
4518     * @param sticky If true, the window's sticky state is enabled
4519     */
4520    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4521
4522    /**
4523     * Get the sticky state of the window.
4524     *
4525     * @param obj The window object
4526     * @return If true, the window's sticky state is enabled
4527     *
4528     * @see elm_win_sticky_set()
4529     */
4530    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4531
4532    /**
4533     * Set if this window is an illume conformant window
4534     *
4535     * @param obj The window object
4536     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4537     */
4538    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4539
4540    /**
4541     * Get if this window is an illume conformant window
4542     *
4543     * @param obj The window object
4544     * @return A boolean if this window is illume conformant or not
4545     */
4546    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4547
4548    /**
4549     * Set a window to be an illume quickpanel window
4550     *
4551     * By default window objects are not quickpanel windows.
4552     *
4553     * @param obj The window object
4554     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4555     */
4556    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4557
4558    /**
4559     * Get if this window is a quickpanel or not
4560     *
4561     * @param obj The window object
4562     * @return A boolean if this window is a quickpanel or not
4563     */
4564    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4565
4566    /**
4567     * Set the major priority of a quickpanel window
4568     *
4569     * @param obj The window object
4570     * @param priority The major priority for this quickpanel
4571     */
4572    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4573
4574    /**
4575     * Get the major priority of a quickpanel window
4576     *
4577     * @param obj The window object
4578     * @return The major priority of this quickpanel
4579     */
4580    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4581
4582    /**
4583     * Set the minor priority of a quickpanel window
4584     *
4585     * @param obj The window object
4586     * @param priority The minor priority for this quickpanel
4587     */
4588    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4589
4590    /**
4591     * Get the minor priority of a quickpanel window
4592     *
4593     * @param obj The window object
4594     * @return The minor priority of this quickpanel
4595     */
4596    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4597
4598    /**
4599     * Set which zone this quickpanel should appear in
4600     *
4601     * @param obj The window object
4602     * @param zone The requested zone for this quickpanel
4603     */
4604    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4605
4606    /**
4607     * Get which zone this quickpanel should appear in
4608     *
4609     * @param obj The window object
4610     * @return The requested zone for this quickpanel
4611     */
4612    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4613
4614    /**
4615     * Set the window to be skipped by keyboard focus
4616     *
4617     * This sets the window to be skipped by normal keyboard input. This means
4618     * a window manager will be asked to not focus this window as well as omit
4619     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4620     *
4621     * Call this and enable it on a window BEFORE you show it for the first time,
4622     * otherwise it may have no effect.
4623     *
4624     * Use this for windows that have only output information or might only be
4625     * interacted with by the mouse or fingers, and never for typing input.
4626     * Be careful that this may have side-effects like making the window
4627     * non-accessible in some cases unless the window is specially handled. Use
4628     * this with care.
4629     *
4630     * @param obj The window object
4631     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4632     */
4633    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4634
4635    /**
4636     * Send a command to the windowing environment
4637     *
4638     * This is intended to work in touchscreen or small screen device
4639     * environments where there is a more simplistic window management policy in
4640     * place. This uses the window object indicated to select which part of the
4641     * environment to control (the part that this window lives in), and provides
4642     * a command and an optional parameter structure (use NULL for this if not
4643     * needed).
4644     *
4645     * @param obj The window object that lives in the environment to control
4646     * @param command The command to send
4647     * @param params Optional parameters for the command
4648     */
4649    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4650
4651    /**
4652     * Get the inlined image object handle
4653     *
4654     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4655     * then the window is in fact an evas image object inlined in the parent
4656     * canvas. You can get this object (be careful to not manipulate it as it
4657     * is under control of elementary), and use it to do things like get pixel
4658     * data, save the image to a file, etc.
4659     *
4660     * @param obj The window object to get the inlined image from
4661     * @return The inlined image object, or NULL if none exists
4662     */
4663    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4664
4665    /**
4666     * Determine whether a window has focus
4667     * @param obj The window to query
4668     * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4669     */
4670    EAPI Eina_Bool    elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4671
4672    /**
4673     * Constrain the maximum width and height of a window to the width and height of its screen
4674     *
4675     * When @p constrain is true, @p obj will never resize larger than the screen.
4676     * @param obj The window object
4677     * @param constrain EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
4678     */
4679    EAPI void         elm_win_screen_constrain_set(Evas_Object *obj, Eina_Bool constrain) EINA_ARG_NONNULL(1);
4680
4681    /**
4682     * Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen
4683     *
4684     * When this function returns true, @p obj will never resize larger than the screen.
4685     * @param obj The window object
4686     * @return EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
4687     */
4688    EAPI Eina_Bool    elm_win_screen_constrain_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4689
4690    /**
4691     * Get screen geometry details for the screen that a window is on
4692     * @param obj The window to query
4693     * @param x where to return the horizontal offset value. May be NULL.
4694     * @param y  where to return the vertical offset value. May be NULL.
4695     * @param w  where to return the width value. May be NULL.
4696     * @param h  where to return the height value. May be NULL.
4697     */
4698    EAPI void         elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4699
4700    /**
4701     * Set the enabled status for the focus highlight in a window
4702     *
4703     * This function will enable or disable the focus highlight only for the
4704     * given window, regardless of the global setting for it
4705     *
4706     * @param obj The window where to enable the highlight
4707     * @param enabled The enabled value for the highlight
4708     */
4709    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4710
4711    /**
4712     * Get the enabled value of the focus highlight for this window
4713     *
4714     * @param obj The window in which to check if the focus highlight is enabled
4715     *
4716     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4717     */
4718    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4719
4720    /**
4721     * Set the style for the focus highlight on this window
4722     *
4723     * Sets the style to use for theming the highlight of focused objects on
4724     * the given window. If @p style is NULL, the default will be used.
4725     *
4726     * @param obj The window where to set the style
4727     * @param style The style to set
4728     */
4729    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4730
4731    /**
4732     * Get the style set for the focus highlight object
4733     *
4734     * Gets the style set for this windows highilght object, or NULL if none
4735     * is set.
4736     *
4737     * @param obj The window to retrieve the highlights style from
4738     *
4739     * @return The style set or NULL if none was. Default is used in that case.
4740     */
4741    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4742
4743    /*...
4744     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4745     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4746     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4747     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4748     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4749     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4750     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4751     *
4752     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4753     * (blank mouse, private mouse obj, defaultmouse)
4754     *
4755     */
4756
4757    /**
4758     * Sets the keyboard mode of the window.
4759     *
4760     * @param obj The window object
4761     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4762     */
4763    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4764
4765    /**
4766     * Gets the keyboard mode of the window.
4767     *
4768     * @param obj The window object
4769     * @return The mode, one of #Elm_Win_Keyboard_Mode
4770     */
4771    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4772
4773    /**
4774     * Sets whether the window is a keyboard.
4775     *
4776     * @param obj The window object
4777     * @param is_keyboard If true, the window is a virtual keyboard
4778     */
4779    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4780
4781    /**
4782     * Gets whether the window is a keyboard.
4783     *
4784     * @param obj The window object
4785     * @return If the window is a virtual keyboard
4786     */
4787    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4788
4789    /**
4790     * Get the screen position of a window.
4791     *
4792     * @param obj The window object
4793     * @param x The int to store the x coordinate to
4794     * @param y The int to store the y coordinate to
4795     */
4796    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4797
4798    /**
4799     * @}
4800     */
4801
4802    /**
4803     * @defgroup Inwin Inwin
4804     *
4805     * @image html img/widget/inwin/preview-00.png
4806     * @image latex img/widget/inwin/preview-00.eps
4807     * @image html img/widget/inwin/preview-01.png
4808     * @image latex img/widget/inwin/preview-01.eps
4809     * @image html img/widget/inwin/preview-02.png
4810     * @image latex img/widget/inwin/preview-02.eps
4811     *
4812     * An inwin is a window inside a window that is useful for a quick popup.
4813     * It does not hover.
4814     *
4815     * It works by creating an object that will occupy the entire window, so it
4816     * must be created using an @ref Win "elm_win" as parent only. The inwin
4817     * object can be hidden or restacked below every other object if it's
4818     * needed to show what's behind it without destroying it. If this is done,
4819     * the elm_win_inwin_activate() function can be used to bring it back to
4820     * full visibility again.
4821     *
4822     * There are three styles available in the default theme. These are:
4823     * @li default: The inwin is sized to take over most of the window it's
4824     * placed in.
4825     * @li minimal: The size of the inwin will be the minimum necessary to show
4826     * its contents.
4827     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4828     * possible, but it's sized vertically the most it needs to fit its\
4829     * contents.
4830     *
4831     * Some examples of Inwin can be found in the following:
4832     * @li @ref inwin_example_01
4833     *
4834     * @{
4835     */
4836
4837    /**
4838     * Adds an inwin to the current window
4839     *
4840     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4841     * Never call this function with anything other than the top-most window
4842     * as its parameter, unless you are fond of undefined behavior.
4843     *
4844     * After creating the object, the widget will set itself as resize object
4845     * for the window with elm_win_resize_object_add(), so when shown it will
4846     * appear to cover almost the entire window (how much of it depends on its
4847     * content and the style used). It must not be added into other container
4848     * objects and it needs not be moved or resized manually.
4849     *
4850     * @param parent The parent object
4851     * @return The new object or NULL if it cannot be created
4852     */
4853    // XXX: deprecate this
4854    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4855
4856    /**
4857     * Activates an inwin object, ensuring its visibility
4858     *
4859     * This function will make sure that the inwin @p obj is completely visible
4860     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4861     * to the front. It also sets the keyboard focus to it, which will be passed
4862     * onto its content.
4863     *
4864     * The object's theme will also receive the signal "elm,action,show" with
4865     * source "elm".
4866     *
4867     * @param obj The inwin to activate
4868     */
4869    // XXX: deprecate this
4870    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4871
4872    /**
4873     * Set the content of an inwin object.
4874     *
4875     * Once the content object is set, a previously set one will be deleted.
4876     * If you want to keep that old content object, use the
4877     * elm_win_inwin_content_unset() function.
4878     *
4879     * @param obj The inwin object
4880     * @param content The object to set as content
4881     */
4882    // XXX: deprecate this
4883    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4884
4885    /**
4886     * Get the content of an inwin object.
4887     *
4888     * Return the content object which is set for this widget.
4889     *
4890     * The returned object is valid as long as the inwin is still alive and no
4891     * other content is set on it. Deleting the object will notify the inwin
4892     * about it and this one will be left empty.
4893     *
4894     * If you need to remove an inwin's content to be reused somewhere else,
4895     * see elm_win_inwin_content_unset().
4896     *
4897     * @param obj The inwin object
4898     * @return The content that is being used
4899     */
4900    // XXX: deprecate this
4901    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4902
4903    /**
4904     * Unset the content of an inwin object.
4905     *
4906     * Unparent and return the content object which was set for this widget.
4907     *
4908     * @param obj The inwin object
4909     * @return The content that was being used
4910     */
4911    // XXX: deprecate this
4912    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4913
4914    /**
4915     * @}
4916     */
4917    /* X specific calls - won't work on non-x engines (return 0) */
4918
4919    /**
4920     * Get the Ecore_X_Window of an Evas_Object
4921     *
4922     * @param obj The object
4923     *
4924     * @return The Ecore_X_Window of @p obj
4925     *
4926     * @ingroup Win
4927     */
4928    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4929
4930    /* smart callbacks called:
4931     * "delete,request" - the user requested to delete the window
4932     * "focus,in" - window got focus
4933     * "focus,out" - window lost focus
4934     * "moved" - window that holds the canvas was moved
4935     */
4936
4937    /**
4938     * @defgroup Bg Bg
4939     *
4940     * @image html img/widget/bg/preview-00.png
4941     * @image latex img/widget/bg/preview-00.eps
4942     *
4943     * @brief Background object, used for setting a solid color, image or Edje
4944     * group as background to a window or any container object.
4945     *
4946     * The bg object is used for setting a solid background to a window or
4947     * packing into any container object. It works just like an image, but has
4948     * some properties useful to a background, like setting it to tiled,
4949     * centered, scaled or stretched.
4950     *
4951     * Default contents parts of the bg widget that you can use for are:
4952     * @li "overlay" - overlay of the bg
4953     *
4954     * Here is some sample code using it:
4955     * @li @ref bg_01_example_page
4956     * @li @ref bg_02_example_page
4957     * @li @ref bg_03_example_page
4958     */
4959
4960    /* bg */
4961    typedef enum _Elm_Bg_Option
4962      {
4963         ELM_BG_OPTION_CENTER,  /**< center the background */
4964         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4965         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4966         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4967      } Elm_Bg_Option;
4968
4969    /**
4970     * Add a new background to the parent
4971     *
4972     * @param parent The parent object
4973     * @return The new object or NULL if it cannot be created
4974     *
4975     * @ingroup Bg
4976     */
4977    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4978
4979    /**
4980     * Set the file (image or edje) used for the background
4981     *
4982     * @param obj The bg object
4983     * @param file The file path
4984     * @param group Optional key (group in Edje) within the file
4985     *
4986     * This sets the image file used in the background object. The image (or edje)
4987     * will be stretched (retaining aspect if its an image file) to completely fill
4988     * the bg object. This may mean some parts are not visible.
4989     *
4990     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4991     * even if @p file is NULL.
4992     *
4993     * @ingroup Bg
4994     */
4995    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4996
4997    /**
4998     * Get the file (image or edje) used for the background
4999     *
5000     * @param obj The bg object
5001     * @param file The file path
5002     * @param group Optional key (group in Edje) within the file
5003     *
5004     * @ingroup Bg
5005     */
5006    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5007
5008    /**
5009     * Set the option used for the background image
5010     *
5011     * @param obj The bg object
5012     * @param option The desired background option (TILE, SCALE)
5013     *
5014     * This sets the option used for manipulating the display of the background
5015     * image. The image can be tiled or scaled.
5016     *
5017     * @ingroup Bg
5018     */
5019    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
5020
5021    /**
5022     * Get the option used for the background image
5023     *
5024     * @param obj The bg object
5025     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
5026     *
5027     * @ingroup Bg
5028     */
5029    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5030    /**
5031     * Set the option used for the background color
5032     *
5033     * @param obj The bg object
5034     * @param r
5035     * @param g
5036     * @param b
5037     *
5038     * This sets the color used for the background rectangle. Its range goes
5039     * from 0 to 255.
5040     *
5041     * @ingroup Bg
5042     */
5043    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
5044    /**
5045     * Get the option used for the background color
5046     *
5047     * @param obj The bg object
5048     * @param r
5049     * @param g
5050     * @param b
5051     *
5052     * @ingroup Bg
5053     */
5054    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
5055
5056    /**
5057     * Set the overlay object used for the background object.
5058     *
5059     * @param obj The bg object
5060     * @param overlay The overlay object
5061     *
5062     * This provides a way for elm_bg to have an 'overlay' that will be on top
5063     * of the bg. Once the over object is set, a previously set one will be
5064     * deleted, even if you set the new one to NULL. If you want to keep that
5065     * old content object, use the elm_bg_overlay_unset() function.
5066     *
5067     * @deprecated use elm_object_part_content_set() instead
5068     *
5069     * @ingroup Bg
5070     */
5071
5072    EINA_DEPRECATED EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
5073
5074    /**
5075     * Get the overlay object used for the background object.
5076     *
5077     * @param obj The bg object
5078     * @return The content that is being used
5079     *
5080     * Return the content object which is set for this widget
5081     *
5082     * @deprecated use elm_object_part_content_get() instead
5083     *
5084     * @ingroup Bg
5085     */
5086    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5087
5088    /**
5089     * Get the overlay object used for the background object.
5090     *
5091     * @param obj The bg object
5092     * @return The content that was being used
5093     *
5094     * Unparent and return the overlay object which was set for this widget
5095     *
5096     * @deprecated use elm_object_part_content_unset() instead
5097     *
5098     * @ingroup Bg
5099     */
5100    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5101
5102    /**
5103     * Set the size of the pixmap representation of the image.
5104     *
5105     * This option just makes sense if an image is going to be set in the bg.
5106     *
5107     * @param obj The bg object
5108     * @param w The new width of the image pixmap representation.
5109     * @param h The new height of the image pixmap representation.
5110     *
5111     * This function sets a new size for pixmap representation of the given bg
5112     * image. It allows the image to be loaded already in the specified size,
5113     * reducing the memory usage and load time when loading a big image with load
5114     * size set to a smaller size.
5115     *
5116     * NOTE: this is just a hint, the real size of the pixmap may differ
5117     * depending on the type of image being loaded, being bigger than requested.
5118     *
5119     * @ingroup Bg
5120     */
5121    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
5122
5123    /**
5124     * @}
5125     */
5126
5127    /**
5128     * @defgroup Icon Icon
5129     *
5130     * @image html img/widget/icon/preview-00.png
5131     * @image latex img/widget/icon/preview-00.eps
5132     *
5133     * An object that provides standard icon images (delete, edit, arrows, etc.)
5134     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
5135     *
5136     * The icon image requested can be in the elementary theme, or in the
5137     * freedesktop.org paths. It's possible to set the order of preference from
5138     * where the image will be used.
5139     *
5140     * This API is very similar to @ref Image, but with ready to use images.
5141     *
5142     * Default images provided by the theme are described below.
5143     *
5144     * The first list contains icons that were first intended to be used in
5145     * toolbars, but can be used in many other places too:
5146     * @li home
5147     * @li close
5148     * @li apps
5149     * @li arrow_up
5150     * @li arrow_down
5151     * @li arrow_left
5152     * @li arrow_right
5153     * @li chat
5154     * @li clock
5155     * @li delete
5156     * @li edit
5157     * @li refresh
5158     * @li folder
5159     * @li file
5160     *
5161     * Now some icons that were designed to be used in menus (but again, you can
5162     * use them anywhere else):
5163     * @li menu/home
5164     * @li menu/close
5165     * @li menu/apps
5166     * @li menu/arrow_up
5167     * @li menu/arrow_down
5168     * @li menu/arrow_left
5169     * @li menu/arrow_right
5170     * @li menu/chat
5171     * @li menu/clock
5172     * @li menu/delete
5173     * @li menu/edit
5174     * @li menu/refresh
5175     * @li menu/folder
5176     * @li menu/file
5177     *
5178     * And here we have some media player specific icons:
5179     * @li media_player/forward
5180     * @li media_player/info
5181     * @li media_player/next
5182     * @li media_player/pause
5183     * @li media_player/play
5184     * @li media_player/prev
5185     * @li media_player/rewind
5186     * @li media_player/stop
5187     *
5188     * Signals that you can add callbacks for are:
5189     *
5190     * "clicked" - This is called when a user has clicked the icon
5191     *
5192     * An example of usage for this API follows:
5193     * @li @ref tutorial_icon
5194     */
5195
5196    /**
5197     * @addtogroup Icon
5198     * @{
5199     */
5200
5201    typedef enum _Elm_Icon_Type
5202      {
5203         ELM_ICON_NONE,
5204         ELM_ICON_FILE,
5205         ELM_ICON_STANDARD
5206      } Elm_Icon_Type;
5207
5208    /**
5209     * @enum _Elm_Icon_Lookup_Order
5210     * @typedef Elm_Icon_Lookup_Order
5211     *
5212     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
5213     * theme, FDO paths, or both?
5214     *
5215     * @ingroup Icon
5216     */
5217    typedef enum _Elm_Icon_Lookup_Order
5218      {
5219         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
5220         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
5221         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
5222         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
5223      } Elm_Icon_Lookup_Order;
5224
5225    /**
5226     * Add a new icon object to the parent.
5227     *
5228     * @param parent The parent object
5229     * @return The new object or NULL if it cannot be created
5230     *
5231     * @see elm_icon_file_set()
5232     *
5233     * @ingroup Icon
5234     */
5235    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5236
5237    /**
5238     * Set the file that will be used as icon.
5239     *
5240     * @param obj The icon object
5241     * @param file The path to file that will be used as icon image
5242     * @param group The group that the icon belongs to an edje file
5243     *
5244     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5245     *
5246     * @note The icon image set by this function can be changed by
5247     * elm_icon_standard_set().
5248     *
5249     * @see elm_icon_file_get()
5250     *
5251     * @ingroup Icon
5252     */
5253    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5254
5255    /**
5256     * Set a location in memory to be used as an icon
5257     *
5258     * @param obj The icon object
5259     * @param img The binary data that will be used as an image
5260     * @param size The size of binary data @p img
5261     * @param format Optional format of @p img to pass to the image loader
5262     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5263     *
5264     * The @p format string should be something like "png", "jpg", "tga",
5265     * "tiff", "bmp" etc. if it is provided (NULL if not). This improves
5266     * the loader performance as it tries the "correct" loader first before
5267     * trying a range of other possible loaders until one succeeds.
5268     * 
5269     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5270     *
5271     * @note The icon image set by this function can be changed by
5272     * elm_icon_standard_set().
5273     *
5274     * @ingroup Icon
5275     */
5276    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);
5277
5278    /**
5279     * Get the file that will be used as icon.
5280     *
5281     * @param obj The icon object
5282     * @param file The path to file that will be used as the icon image
5283     * @param group The group that the icon belongs to, in edje file
5284     *
5285     * @see elm_icon_file_set()
5286     *
5287     * @ingroup Icon
5288     */
5289    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5290
5291    /**
5292     * Set the file that will be used, but use a generated thumbnail.
5293     *
5294     * @param obj The icon object
5295     * @param file The path to file that will be used as icon image
5296     * @param group The group that the icon belongs to an edje file
5297     *
5298     * This functions like elm_icon_file_set() but requires the Ethumb library
5299     * support to be enabled successfully with elm_need_ethumb(). When set
5300     * the file indicated has a thumbnail generated and cached on disk for
5301     * future use or will directly use an existing cached thumbnail if it
5302     * is valid.
5303     * 
5304     * @see elm_icon_file_set()
5305     *
5306     * @ingroup Icon
5307     */
5308    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5309
5310    /**
5311     * Set the icon by icon standards names.
5312     *
5313     * @param obj The icon object
5314     * @param name The icon name
5315     *
5316     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5317     *
5318     * For example, freedesktop.org defines standard icon names such as "home",
5319     * "network", etc. There can be different icon sets to match those icon
5320     * keys. The @p name given as parameter is one of these "keys", and will be
5321     * used to look in the freedesktop.org paths and elementary theme. One can
5322     * change the lookup order with elm_icon_order_lookup_set().
5323     *
5324     * If name is not found in any of the expected locations and it is the
5325     * absolute path of an image file, this image will be used.
5326     *
5327     * @note The icon image set by this function can be changed by
5328     * elm_icon_file_set().
5329     *
5330     * @see elm_icon_standard_get()
5331     * @see elm_icon_file_set()
5332     *
5333     * @ingroup Icon
5334     */
5335    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5336
5337    /**
5338     * Get the icon name set by icon standard names.
5339     *
5340     * @param obj The icon object
5341     * @return The icon name
5342     *
5343     * If the icon image was set using elm_icon_file_set() instead of
5344     * elm_icon_standard_set(), then this function will return @c NULL.
5345     *
5346     * @see elm_icon_standard_set()
5347     *
5348     * @ingroup Icon
5349     */
5350    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5351
5352    /**
5353     * Set the smooth scaling for an icon object.
5354     *
5355     * @param obj The icon object
5356     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5357     * otherwise. Default is @c EINA_TRUE.
5358     *
5359     * Set the scaling algorithm to be used when scaling the icon image. Smooth
5360     * scaling provides a better resulting image, but is slower.
5361     *
5362     * The smooth scaling should be disabled when making animations that change
5363     * the icon size, since they will be faster. Animations that don't require
5364     * resizing of the icon can keep the smooth scaling enabled (even if the icon
5365     * is already scaled, since the scaled icon image will be cached).
5366     *
5367     * @see elm_icon_smooth_get()
5368     *
5369     * @ingroup Icon
5370     */
5371    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5372
5373    /**
5374     * Get whether smooth scaling is enabled for an icon object.
5375     *
5376     * @param obj The icon object
5377     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5378     *
5379     * @see elm_icon_smooth_set()
5380     *
5381     * @ingroup Icon
5382     */
5383    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5384
5385    /**
5386     * Disable scaling of this object.
5387     *
5388     * @param obj The icon object.
5389     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5390     * otherwise. Default is @c EINA_FALSE.
5391     *
5392     * This function disables scaling of the icon object through the function
5393     * elm_object_scale_set(). However, this does not affect the object
5394     * size/resize in any way. For that effect, take a look at
5395     * elm_icon_scale_set().
5396     *
5397     * @see elm_icon_no_scale_get()
5398     * @see elm_icon_scale_set()
5399     * @see elm_object_scale_set()
5400     *
5401     * @ingroup Icon
5402     */
5403    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5404
5405    /**
5406     * Get whether scaling is disabled on the object.
5407     *
5408     * @param obj The icon object
5409     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5410     *
5411     * @see elm_icon_no_scale_set()
5412     *
5413     * @ingroup Icon
5414     */
5415    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5416
5417    /**
5418     * Set if the object is (up/down) resizable.
5419     *
5420     * @param obj The icon object
5421     * @param scale_up A bool to set if the object is resizable up. Default is
5422     * @c EINA_TRUE.
5423     * @param scale_down A bool to set if the object is resizable down. Default
5424     * is @c EINA_TRUE.
5425     *
5426     * This function limits the icon object resize ability. If @p scale_up is set to
5427     * @c EINA_FALSE, the object can't have its height or width resized to a value
5428     * higher than the original icon size. Same is valid for @p scale_down.
5429     *
5430     * @see elm_icon_scale_get()
5431     *
5432     * @ingroup Icon
5433     */
5434    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5435
5436    /**
5437     * Get if the object is (up/down) resizable.
5438     *
5439     * @param obj The icon object
5440     * @param scale_up A bool to set if the object is resizable up
5441     * @param scale_down A bool to set if the object is resizable down
5442     *
5443     * @see elm_icon_scale_set()
5444     *
5445     * @ingroup Icon
5446     */
5447    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5448
5449    /**
5450     * Get the object's image size
5451     *
5452     * @param obj The icon object
5453     * @param w A pointer to store the width in
5454     * @param h A pointer to store the height in
5455     *
5456     * @ingroup Icon
5457     */
5458    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5459
5460    /**
5461     * Set if the icon fill the entire object area.
5462     *
5463     * @param obj The icon object
5464     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5465     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5466     *
5467     * When the icon object is resized to a different aspect ratio from the
5468     * original icon image, the icon image will still keep its aspect. This flag
5469     * tells how the image should fill the object's area. They are: keep the
5470     * entire icon inside the limits of height and width of the object (@p
5471     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5472     * of the object, and the icon will fill the entire object (@p fill_outside
5473     * is @c EINA_TRUE).
5474     *
5475     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5476     * retain property to false. Thus, the icon image will always keep its
5477     * original aspect ratio.
5478     *
5479     * @see elm_icon_fill_outside_get()
5480     * @see elm_image_fill_outside_set()
5481     *
5482     * @ingroup Icon
5483     */
5484    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5485
5486    /**
5487     * Get if the object is filled outside.
5488     *
5489     * @param obj The icon object
5490     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5491     *
5492     * @see elm_icon_fill_outside_set()
5493     *
5494     * @ingroup Icon
5495     */
5496    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5497
5498    /**
5499     * Set the prescale size for the icon.
5500     *
5501     * @param obj The icon object
5502     * @param size The prescale size. This value is used for both width and
5503     * height.
5504     *
5505     * This function sets a new size for pixmap representation of the given
5506     * icon. It allows the icon to be loaded already in the specified size,
5507     * reducing the memory usage and load time when loading a big icon with load
5508     * size set to a smaller size.
5509     *
5510     * It's equivalent to the elm_bg_load_size_set() function for bg.
5511     *
5512     * @note this is just a hint, the real size of the pixmap may differ
5513     * depending on the type of icon being loaded, being bigger than requested.
5514     *
5515     * @see elm_icon_prescale_get()
5516     * @see elm_bg_load_size_set()
5517     *
5518     * @ingroup Icon
5519     */
5520    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5521
5522    /**
5523     * Get the prescale size for the icon.
5524     *
5525     * @param obj The icon object
5526     * @return The prescale size
5527     *
5528     * @see elm_icon_prescale_set()
5529     *
5530     * @ingroup Icon
5531     */
5532    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5533
5534    /**
5535     * Gets the image object of the icon. DO NOT MODIFY THIS.
5536     *
5537     * @param obj The icon object
5538     * @return The internal icon object
5539     *
5540     * @ingroup Icon
5541     */
5542    EAPI Evas_Object          *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5543
5544    /**
5545     * Sets the icon lookup order used by elm_icon_standard_set().
5546     *
5547     * @param obj The icon object
5548     * @param order The icon lookup order (can be one of
5549     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5550     * or ELM_ICON_LOOKUP_THEME)
5551     *
5552     * @see elm_icon_order_lookup_get()
5553     * @see Elm_Icon_Lookup_Order
5554     *
5555     * @ingroup Icon
5556     */
5557    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5558
5559    /**
5560     * Gets the icon lookup order.
5561     *
5562     * @param obj The icon object
5563     * @return The icon lookup order
5564     *
5565     * @see elm_icon_order_lookup_set()
5566     * @see Elm_Icon_Lookup_Order
5567     *
5568     * @ingroup Icon
5569     */
5570    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5571
5572    /**
5573     * Enable or disable preloading of the icon
5574     *
5575     * @param obj The icon object
5576     * @param disable If EINA_TRUE, preloading will be disabled
5577     * @ingroup Icon
5578     */
5579    EAPI void                  elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5580
5581    /**
5582     * Get if the icon supports animation or not.
5583     *
5584     * @param obj The icon object
5585     * @return @c EINA_TRUE if the icon supports animation,
5586     *         @c EINA_FALSE otherwise.
5587     *
5588     * Return if this elm icon's image can be animated. Currently Evas only
5589     * supports gif animation. If the return value is EINA_FALSE, other
5590     * elm_icon_animated_XXX APIs won't work.
5591     * @ingroup Icon
5592     */
5593    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5594
5595    /**
5596     * Set animation mode of the icon.
5597     *
5598     * @param obj The icon object
5599     * @param anim @c EINA_TRUE if the object do animation job,
5600     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5601     *
5602     * Since the default animation mode is set to EINA_FALSE,
5603     * the icon is shown without animation. Files like animated GIF files
5604     * can animate, and this is supported if you enable animated support
5605     * on the icon.
5606     * Set it to EINA_TRUE when the icon needs to be animated.
5607     * @ingroup Icon
5608     */
5609    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5610
5611    /**
5612     * Get animation mode of the icon.
5613     *
5614     * @param obj The icon object
5615     * @return The animation mode of the icon object
5616     * @see elm_icon_animated_set
5617     * @ingroup Icon
5618     */
5619    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5620
5621    /**
5622     * Set animation play mode of the icon.
5623     *
5624     * @param obj The icon object
5625     * @param play @c EINA_TRUE the object play animation images,
5626     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5627     *
5628     * To play elm icon's animation, set play to EINA_TURE.
5629     * For example, you make gif player using this set/get API and click event.
5630     * This literally lets you control current play or paused state. To have
5631     * this work with animated GIF files for example, you first, before
5632     * setting the file have to use elm_icon_animated_set() to enable animation
5633     * at all on the icon.
5634     *
5635     * 1. Click event occurs
5636     * 2. Check play flag using elm_icon_animaged_play_get
5637     * 3. If elm icon was playing, set play to EINA_FALSE.
5638     *    Then animation will be stopped and vice versa
5639     * @ingroup Icon
5640     */
5641    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5642
5643    /**
5644     * Get animation play mode of the icon.
5645     *
5646     * @param obj The icon object
5647     * @return The play mode of the icon object
5648     *
5649     * @see elm_icon_animated_play_get
5650     * @ingroup Icon
5651     */
5652    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5653
5654    /**
5655     * @}
5656     */
5657
5658    /**
5659     * @defgroup Image Image
5660     *
5661     * @image html img/widget/image/preview-00.png
5662     * @image latex img/widget/image/preview-00.eps
5663
5664     *
5665     * An object that allows one to load an image file to it. It can be used
5666     * anywhere like any other elementary widget.
5667     *
5668     * This widget provides most of the functionality provided from @ref Bg or @ref
5669     * Icon, but with a slightly different API (use the one that fits better your
5670     * needs).
5671     *
5672     * The features not provided by those two other image widgets are:
5673     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5674     * @li change the object orientation with elm_image_orient_set();
5675     * @li and turning the image editable with elm_image_editable_set().
5676     *
5677     * Signals that you can add callbacks for are:
5678     *
5679     * @li @c "clicked" - This is called when a user has clicked the image
5680     *
5681     * An example of usage for this API follows:
5682     * @li @ref tutorial_image
5683     */
5684
5685    /**
5686     * @addtogroup Image
5687     * @{
5688     */
5689
5690    /**
5691     * @enum _Elm_Image_Orient
5692     * @typedef Elm_Image_Orient
5693     *
5694     * Possible orientation options for elm_image_orient_set().
5695     *
5696     * @image html elm_image_orient_set.png
5697     * @image latex elm_image_orient_set.eps width=\textwidth
5698     *
5699     * @ingroup Image
5700     */
5701    typedef enum _Elm_Image_Orient
5702      {
5703         ELM_IMAGE_ORIENT_NONE = 0, /**< no orientation change */
5704         ELM_IMAGE_ORIENT_0 = 0, /**< no orientation change */
5705         ELM_IMAGE_ROTATE_90 = 1, /**< rotate 90 degrees clockwise */
5706         ELM_IMAGE_ROTATE_180 = 2, /**< rotate 180 degrees clockwise */
5707         ELM_IMAGE_ROTATE_270 = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5708    // XXX: remove 
5709         /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CW = 1, /**< rotate 90 degrees clockwise */
5710    // XXX: remove 
5711         /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_180_CW = 2, /**< rotate 180 degrees clockwise */
5712    // XXX: remove 
5713         /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CCW = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5714         ELM_IMAGE_FLIP_HORIZONTAL = 4, /**< flip image horizontally */
5715         ELM_IMAGE_FLIP_VERTICAL = 5, /**< flip image vertically */
5716         ELM_IMAGE_FLIP_TRANSPOSE = 6, /**< flip the image along the y = (width - x) line (bottom-left to top-right) */
5717         ELM_IMAGE_FLIP_TRANSVERSE = 7 /**< flip the image along the y = x line (top-left to bottom-right) */
5718      } Elm_Image_Orient;
5719
5720    /**
5721     * Add a new image to the parent.
5722     *
5723     * @param parent The parent object
5724     * @return The new object or NULL if it cannot be created
5725     *
5726     * @see elm_image_file_set()
5727     *
5728     * @ingroup Image
5729     */
5730    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5731
5732    /**
5733     * Set the file that will be used as image.
5734     *
5735     * @param obj The image object
5736     * @param file The path to file that will be used as image
5737     * @param group The group that the image belongs in edje file (if it's an
5738     * edje image)
5739     *
5740     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5741     *
5742     * @see elm_image_file_get()
5743     *
5744     * @ingroup Image
5745     */
5746    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5747
5748    /**
5749     * Get the file that will be used as image.
5750     *
5751     * @param obj The image object
5752     * @param file The path to file
5753     * @param group The group that the image belongs in edje file
5754     *
5755     * @see elm_image_file_set()
5756     *
5757     * @ingroup Image
5758     */
5759    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5760
5761    /**
5762     * Set the smooth effect for an image.
5763     *
5764     * @param obj The image object
5765     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5766     * otherwise. Default is @c EINA_TRUE.
5767     *
5768     * Set the scaling algorithm to be used when scaling the image. Smooth
5769     * scaling provides a better resulting image, but is slower.
5770     *
5771     * The smooth scaling should be disabled when making animations that change
5772     * the image size, since it will be faster. Animations that don't require
5773     * resizing of the image can keep the smooth scaling enabled (even if the
5774     * image is already scaled, since the scaled image will be cached).
5775     *
5776     * @see elm_image_smooth_get()
5777     *
5778     * @ingroup Image
5779     */
5780    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5781
5782    /**
5783     * Get the smooth effect for an image.
5784     *
5785     * @param obj The image object
5786     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5787     *
5788     * @see elm_image_smooth_get()
5789     *
5790     * @ingroup Image
5791     */
5792    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5793
5794    /**
5795     * Gets the current size of the image.
5796     *
5797     * @param obj The image object.
5798     * @param w Pointer to store width, or NULL.
5799     * @param h Pointer to store height, or NULL.
5800     *
5801     * This is the real size of the image, not the size of the object.
5802     *
5803     * On error, neither w and h will be fileld with 0.
5804     *
5805     * @ingroup Image
5806     */
5807    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5808
5809    /**
5810     * Disable scaling of this object.
5811     *
5812     * @param obj The image object.
5813     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5814     * otherwise. Default is @c EINA_FALSE.
5815     *
5816     * This function disables scaling of the elm_image widget through the
5817     * function elm_object_scale_set(). However, this does not affect the widget
5818     * size/resize in any way. For that effect, take a look at
5819     * elm_image_scale_set().
5820     *
5821     * @see elm_image_no_scale_get()
5822     * @see elm_image_scale_set()
5823     * @see elm_object_scale_set()
5824     *
5825     * @ingroup Image
5826     */
5827    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5828
5829    /**
5830     * Get whether scaling is disabled on the object.
5831     *
5832     * @param obj The image object
5833     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5834     *
5835     * @see elm_image_no_scale_set()
5836     *
5837     * @ingroup Image
5838     */
5839    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5840
5841    /**
5842     * Set if the object is (up/down) resizable.
5843     *
5844     * @param obj The image object
5845     * @param scale_up A bool to set if the object is resizable up. Default is
5846     * @c EINA_TRUE.
5847     * @param scale_down A bool to set if the object is resizable down. Default
5848     * is @c EINA_TRUE.
5849     *
5850     * This function limits the image resize ability. If @p scale_up is set to
5851     * @c EINA_FALSE, the object can't have its height or width resized to a value
5852     * higher than the original image size. Same is valid for @p scale_down.
5853     *
5854     * @see elm_image_scale_get()
5855     *
5856     * @ingroup Image
5857     */
5858    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5859
5860    /**
5861     * Get if the object is (up/down) resizable.
5862     *
5863     * @param obj The image object
5864     * @param scale_up A bool to set if the object is resizable up
5865     * @param scale_down A bool to set if the object is resizable down
5866     *
5867     * @see elm_image_scale_set()
5868     *
5869     * @ingroup Image
5870     */
5871    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5872
5873    /**
5874     * Set if the image fills the entire object area, when keeping the aspect ratio.
5875     *
5876     * @param obj The image object
5877     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5878     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5879     *
5880     * When the image should keep its aspect ratio even if resized to another
5881     * aspect ratio, there are two possibilities to resize it: keep the entire
5882     * image inside the limits of height and width of the object (@p fill_outside
5883     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5884     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5885     *
5886     * @note This option will have no effect if
5887     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5888     *
5889     * @see elm_image_fill_outside_get()
5890     * @see elm_image_aspect_ratio_retained_set()
5891     *
5892     * @ingroup Image
5893     */
5894    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5895
5896    /**
5897     * Get if the object is filled outside
5898     *
5899     * @param obj The image object
5900     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5901     *
5902     * @see elm_image_fill_outside_set()
5903     *
5904     * @ingroup Image
5905     */
5906    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5907
5908    /**
5909     * Set the prescale size for the image
5910     *
5911     * @param obj The image object
5912     * @param size The prescale size. This value is used for both width and
5913     * height.
5914     *
5915     * This function sets a new size for pixmap representation of the given
5916     * image. It allows the image to be loaded already in the specified size,
5917     * reducing the memory usage and load time when loading a big image with load
5918     * size set to a smaller size.
5919     *
5920     * It's equivalent to the elm_bg_load_size_set() function for bg.
5921     *
5922     * @note this is just a hint, the real size of the pixmap may differ
5923     * depending on the type of image being loaded, being bigger than requested.
5924     *
5925     * @see elm_image_prescale_get()
5926     * @see elm_bg_load_size_set()
5927     *
5928     * @ingroup Image
5929     */
5930    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5931
5932    /**
5933     * Get the prescale size for the image
5934     *
5935     * @param obj The image object
5936     * @return The prescale size
5937     *
5938     * @see elm_image_prescale_set()
5939     *
5940     * @ingroup Image
5941     */
5942    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5943
5944    /**
5945     * Set the image orientation.
5946     *
5947     * @param obj The image object
5948     * @param orient The image orientation @ref Elm_Image_Orient
5949     *  Default is #ELM_IMAGE_ORIENT_NONE.
5950     *
5951     * This function allows to rotate or flip the given image.
5952     *
5953     * @see elm_image_orient_get()
5954     * @see @ref Elm_Image_Orient
5955     *
5956     * @ingroup Image
5957     */
5958    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5959
5960    /**
5961     * Get the image orientation.
5962     *
5963     * @param obj The image object
5964     * @return The image orientation @ref Elm_Image_Orient
5965     *
5966     * @see elm_image_orient_set()
5967     * @see @ref Elm_Image_Orient
5968     *
5969     * @ingroup Image
5970     */
5971    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5972
5973    /**
5974     * Make the image 'editable'.
5975     *
5976     * @param obj Image object.
5977     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5978     *
5979     * This means the image is a valid drag target for drag and drop, and can be
5980     * cut or pasted too.
5981     *
5982     * @ingroup Image
5983     */
5984    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5985
5986    /**
5987     * Check if the image 'editable'.
5988     *
5989     * @param obj Image object.
5990     * @return Editability.
5991     *
5992     * A return value of EINA_TRUE means the image is a valid drag target
5993     * for drag and drop, and can be cut or pasted too.
5994     *
5995     * @ingroup Image
5996     */
5997    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5998
5999    /**
6000     * Get the basic Evas_Image object from this object (widget).
6001     *
6002     * @param obj The image object to get the inlined image from
6003     * @return The inlined image object, or NULL if none exists
6004     *
6005     * This function allows one to get the underlying @c Evas_Object of type
6006     * Image from this elementary widget. It can be useful to do things like get
6007     * the pixel data, save the image to a file, etc.
6008     *
6009     * @note Be careful to not manipulate it, as it is under control of
6010     * elementary.
6011     *
6012     * @ingroup Image
6013     */
6014    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6015
6016    /**
6017     * Set whether the original aspect ratio of the image should be kept on resize.
6018     *
6019     * @param obj The image object.
6020     * @param retained @c EINA_TRUE if the image should retain the aspect,
6021     * @c EINA_FALSE otherwise.
6022     *
6023     * The original aspect ratio (width / height) of the image is usually
6024     * distorted to match the object's size. Enabling this option will retain
6025     * this original aspect, and the way that the image is fit into the object's
6026     * area depends on the option set by elm_image_fill_outside_set().
6027     *
6028     * @see elm_image_aspect_ratio_retained_get()
6029     * @see elm_image_fill_outside_set()
6030     *
6031     * @ingroup Image
6032     */
6033    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
6034
6035    /**
6036     * Get if the object retains the original aspect ratio.
6037     *
6038     * @param obj The image object.
6039     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
6040     * otherwise.
6041     *
6042     * @ingroup Image
6043     */
6044    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6045
6046    /**
6047     * @}
6048     */
6049
6050    /* glview */
6051    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
6052
6053    typedef enum _Elm_GLView_Mode
6054      {
6055         ELM_GLVIEW_ALPHA   = 1,
6056         ELM_GLVIEW_DEPTH   = 2,
6057         ELM_GLVIEW_STENCIL = 4
6058      } Elm_GLView_Mode;
6059
6060    /**
6061     * Defines a policy for the glview resizing.
6062     *
6063     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
6064     */
6065    typedef enum _Elm_GLView_Resize_Policy
6066      {
6067         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
6068         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
6069      } Elm_GLView_Resize_Policy;
6070
6071    typedef enum _Elm_GLView_Render_Policy
6072      {
6073         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
6074         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
6075      } Elm_GLView_Render_Policy;
6076
6077    /**
6078     * @defgroup GLView
6079     *
6080     * A simple GLView widget that allows GL rendering.
6081     *
6082     * Signals that you can add callbacks for are:
6083     *
6084     * @{
6085     */
6086
6087    /**
6088     * Add a new glview to the parent
6089     *
6090     * @param parent The parent object
6091     * @return The new object or NULL if it cannot be created
6092     *
6093     * @ingroup GLView
6094     */
6095    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6096
6097    /**
6098     * Sets the size of the glview
6099     *
6100     * @param obj The glview object
6101     * @param width width of the glview object
6102     * @param height height of the glview object
6103     *
6104     * @ingroup GLView
6105     */
6106    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6107
6108    /**
6109     * Gets the size of the glview.
6110     *
6111     * @param obj The glview object
6112     * @param width width of the glview object
6113     * @param height height of the glview object
6114     *
6115     * Note that this function returns the actual image size of the
6116     * glview.  This means that when the scale policy is set to
6117     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
6118     * size.
6119     *
6120     * @ingroup GLView
6121     */
6122    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6123
6124    /**
6125     * Gets the gl api struct for gl rendering
6126     *
6127     * @param obj The glview object
6128     * @return The api object or NULL if it cannot be created
6129     *
6130     * @ingroup GLView
6131     */
6132    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6133
6134    /**
6135     * Set the mode of the GLView. Supports Three simple modes.
6136     *
6137     * @param obj The glview object
6138     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
6139     * @return True if set properly.
6140     *
6141     * @ingroup GLView
6142     */
6143    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
6144
6145    /**
6146     * Set the resize policy for the glview object.
6147     *
6148     * @param obj The glview object.
6149     * @param policy The scaling policy.
6150     *
6151     * By default, the resize policy is set to
6152     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
6153     * destroys the previous surface and recreates the newly specified
6154     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
6155     * however, glview only scales the image object and not the underlying
6156     * GL Surface.
6157     *
6158     * @ingroup GLView
6159     */
6160    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
6161
6162    /**
6163     * Set the render policy for the glview object.
6164     *
6165     * @param obj The glview object.
6166     * @param policy The render policy.
6167     *
6168     * By default, the render policy is set to
6169     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
6170     * that during the render loop, glview is only redrawn if it needs
6171     * to be redrawn. (i.e. When it is visible) If the policy is set to
6172     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
6173     * whether it is visible/need redrawing or not.
6174     *
6175     * @ingroup GLView
6176     */
6177    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
6178
6179    /**
6180     * Set the init function that runs once in the main loop.
6181     *
6182     * @param obj The glview object.
6183     * @param func The init function to be registered.
6184     *
6185     * The registered init function gets called once during the render loop.
6186     *
6187     * @ingroup GLView
6188     */
6189    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6190
6191    /**
6192     * Set the render function that runs in the main loop.
6193     *
6194     * @param obj The glview object.
6195     * @param func The delete function to be registered.
6196     *
6197     * The registered del function gets called when GLView object is deleted.
6198     *
6199     * @ingroup GLView
6200     */
6201    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6202
6203    /**
6204     * Set the resize function that gets called when resize happens.
6205     *
6206     * @param obj The glview object.
6207     * @param func The resize function to be registered.
6208     *
6209     * @ingroup GLView
6210     */
6211    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6212
6213    /**
6214     * Set the render function that runs in the main loop.
6215     *
6216     * @param obj The glview object.
6217     * @param func The render function to be registered.
6218     *
6219     * @ingroup GLView
6220     */
6221    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6222
6223    /**
6224     * Notifies that there has been changes in the GLView.
6225     *
6226     * @param obj The glview object.
6227     *
6228     * @ingroup GLView
6229     */
6230    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6231
6232    /**
6233     * @}
6234     */
6235
6236    /* box */
6237    /**
6238     * @defgroup Box Box
6239     *
6240     * @image html img/widget/box/preview-00.png
6241     * @image latex img/widget/box/preview-00.eps width=\textwidth
6242     *
6243     * @image html img/box.png
6244     * @image latex img/box.eps width=\textwidth
6245     *
6246     * A box arranges objects in a linear fashion, governed by a layout function
6247     * that defines the details of this arrangement.
6248     *
6249     * By default, the box will use an internal function to set the layout to
6250     * a single row, either vertical or horizontal. This layout is affected
6251     * by a number of parameters, such as the homogeneous flag set by
6252     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
6253     * elm_box_align_set() and the hints set to each object in the box.
6254     *
6255     * For this default layout, it's possible to change the orientation with
6256     * elm_box_horizontal_set(). The box will start in the vertical orientation,
6257     * placing its elements ordered from top to bottom. When horizontal is set,
6258     * the order will go from left to right. If the box is set to be
6259     * homogeneous, every object in it will be assigned the same space, that
6260     * of the largest object. Padding can be used to set some spacing between
6261     * the cell given to each object. The alignment of the box, set with
6262     * elm_box_align_set(), determines how the bounding box of all the elements
6263     * will be placed within the space given to the box widget itself.
6264     *
6265     * The size hints of each object also affect how they are placed and sized
6266     * within the box. evas_object_size_hint_min_set() will give the minimum
6267     * size the object can have, and the box will use it as the basis for all
6268     * latter calculations. Elementary widgets set their own minimum size as
6269     * needed, so there's rarely any need to use it manually.
6270     *
6271     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
6272     * used to tell whether the object will be allocated the minimum size it
6273     * needs or if the space given to it should be expanded. It's important
6274     * to realize that expanding the size given to the object is not the same
6275     * thing as resizing the object. It could very well end being a small
6276     * widget floating in a much larger empty space. If not set, the weight
6277     * for objects will normally be 0.0 for both axis, meaning the widget will
6278     * not be expanded. To take as much space possible, set the weight to
6279     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
6280     *
6281     * Besides how much space each object is allocated, it's possible to control
6282     * how the widget will be placed within that space using
6283     * evas_object_size_hint_align_set(). By default, this value will be 0.5
6284     * for both axis, meaning the object will be centered, but any value from
6285     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
6286     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
6287     * is -1.0, means the object will be resized to fill the entire space it
6288     * was allocated.
6289     *
6290     * In addition, customized functions to define the layout can be set, which
6291     * allow the application developer to organize the objects within the box
6292     * in any number of ways.
6293     *
6294     * The special elm_box_layout_transition() function can be used
6295     * to switch from one layout to another, animating the motion of the
6296     * children of the box.
6297     *
6298     * @note Objects should not be added to box objects using _add() calls.
6299     *
6300     * Some examples on how to use boxes follow:
6301     * @li @ref box_example_01
6302     * @li @ref box_example_02
6303     *
6304     * @{
6305     */
6306    /**
6307     * @typedef Elm_Box_Transition
6308     *
6309     * Opaque handler containing the parameters to perform an animated
6310     * transition of the layout the box uses.
6311     *
6312     * @see elm_box_transition_new()
6313     * @see elm_box_layout_set()
6314     * @see elm_box_layout_transition()
6315     */
6316    typedef struct _Elm_Box_Transition Elm_Box_Transition;
6317
6318    /**
6319     * Add a new box to the parent
6320     *
6321     * By default, the box will be in vertical mode and non-homogeneous.
6322     *
6323     * @param parent The parent object
6324     * @return The new object or NULL if it cannot be created
6325     */
6326    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6327
6328    /**
6329     * Set the horizontal orientation
6330     *
6331     * By default, box object arranges their contents vertically from top to
6332     * bottom.
6333     * By calling this function with @p horizontal as EINA_TRUE, the box will
6334     * become horizontal, arranging contents from left to right.
6335     *
6336     * @note This flag is ignored if a custom layout function is set.
6337     *
6338     * @param obj The box object
6339     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
6340     * EINA_FALSE = vertical)
6341     */
6342    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6343
6344    /**
6345     * Get the horizontal orientation
6346     *
6347     * @param obj The box object
6348     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
6349     */
6350    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6351
6352    /**
6353     * Set the box to arrange its children homogeneously
6354     *
6355     * If enabled, homogeneous layout makes all items the same size, according
6356     * to the size of the largest of its children.
6357     *
6358     * @note This flag is ignored if a custom layout function is set.
6359     *
6360     * @param obj The box object
6361     * @param homogeneous The homogeneous flag
6362     */
6363    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6364
6365    /**
6366     * Get whether the box is using homogeneous mode or not
6367     *
6368     * @param obj The box object
6369     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
6370     */
6371    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6372
6373    /**
6374     * Add an object to the beginning of the pack list
6375     *
6376     * Pack @p subobj into the box @p obj, placing it first in the list of
6377     * children objects. The actual position the object will get on screen
6378     * depends on the layout used. If no custom layout is set, it will be at
6379     * the top or left, depending if the box is vertical or horizontal,
6380     * respectively.
6381     *
6382     * @param obj The box object
6383     * @param subobj The object to add to the box
6384     *
6385     * @see elm_box_pack_end()
6386     * @see elm_box_pack_before()
6387     * @see elm_box_pack_after()
6388     * @see elm_box_unpack()
6389     * @see elm_box_unpack_all()
6390     * @see elm_box_clear()
6391     */
6392    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6393
6394    /**
6395     * Add an object at the end of the pack list
6396     *
6397     * Pack @p subobj into the box @p obj, placing it last in the list of
6398     * children objects. The actual position the object will get on screen
6399     * depends on the layout used. If no custom layout is set, it will be at
6400     * the bottom or right, depending if the box is vertical or horizontal,
6401     * respectively.
6402     *
6403     * @param obj The box object
6404     * @param subobj The object to add to the box
6405     *
6406     * @see elm_box_pack_start()
6407     * @see elm_box_pack_before()
6408     * @see elm_box_pack_after()
6409     * @see elm_box_unpack()
6410     * @see elm_box_unpack_all()
6411     * @see elm_box_clear()
6412     */
6413    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6414
6415    /**
6416     * Adds an object to the box before the indicated object
6417     *
6418     * This will add the @p subobj to the box indicated before the object
6419     * indicated with @p before. If @p before is not already in the box, results
6420     * are undefined. Before means either to the left of the indicated object or
6421     * above it depending on orientation.
6422     *
6423     * @param obj The box object
6424     * @param subobj The object to add to the box
6425     * @param before The object before which to add it
6426     *
6427     * @see elm_box_pack_start()
6428     * @see elm_box_pack_end()
6429     * @see elm_box_pack_after()
6430     * @see elm_box_unpack()
6431     * @see elm_box_unpack_all()
6432     * @see elm_box_clear()
6433     */
6434    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6435
6436    /**
6437     * Adds an object to the box after the indicated object
6438     *
6439     * This will add the @p subobj to the box indicated after the object
6440     * indicated with @p after. If @p after is not already in the box, results
6441     * are undefined. After means either to the right of the indicated object or
6442     * below it depending on orientation.
6443     *
6444     * @param obj The box object
6445     * @param subobj The object to add to the box
6446     * @param after The object after which to add it
6447     *
6448     * @see elm_box_pack_start()
6449     * @see elm_box_pack_end()
6450     * @see elm_box_pack_before()
6451     * @see elm_box_unpack()
6452     * @see elm_box_unpack_all()
6453     * @see elm_box_clear()
6454     */
6455    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6456
6457    /**
6458     * Clear the box of all children
6459     *
6460     * Remove all the elements contained by the box, deleting the respective
6461     * objects.
6462     *
6463     * @param obj The box object
6464     *
6465     * @see elm_box_unpack()
6466     * @see elm_box_unpack_all()
6467     */
6468    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6469
6470    /**
6471     * Unpack a box item
6472     *
6473     * Remove the object given by @p subobj from the box @p obj without
6474     * deleting it.
6475     *
6476     * @param obj The box object
6477     *
6478     * @see elm_box_unpack_all()
6479     * @see elm_box_clear()
6480     */
6481    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6482
6483    /**
6484     * Remove all items from the box, without deleting them
6485     *
6486     * Clear the box from all children, but don't delete the respective objects.
6487     * If no other references of the box children exist, the objects will never
6488     * be deleted, and thus the application will leak the memory. Make sure
6489     * when using this function that you hold a reference to all the objects
6490     * in the box @p obj.
6491     *
6492     * @param obj The box object
6493     *
6494     * @see elm_box_clear()
6495     * @see elm_box_unpack()
6496     */
6497    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6498
6499    /**
6500     * Retrieve a list of the objects packed into the box
6501     *
6502     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6503     * The order of the list corresponds to the packing order the box uses.
6504     *
6505     * You must free this list with eina_list_free() once you are done with it.
6506     *
6507     * @param obj The box object
6508     */
6509    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6510
6511    /**
6512     * Set the space (padding) between the box's elements.
6513     *
6514     * Extra space in pixels that will be added between a box child and its
6515     * neighbors after its containing cell has been calculated. This padding
6516     * is set for all elements in the box, besides any possible padding that
6517     * individual elements may have through their size hints.
6518     *
6519     * @param obj The box object
6520     * @param horizontal The horizontal space between elements
6521     * @param vertical The vertical space between elements
6522     */
6523    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6524
6525    /**
6526     * Get the space (padding) between the box's elements.
6527     *
6528     * @param obj The box object
6529     * @param horizontal The horizontal space between elements
6530     * @param vertical The vertical space between elements
6531     *
6532     * @see elm_box_padding_set()
6533     */
6534    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6535
6536    /**
6537     * Set the alignment of the whole bouding box of contents.
6538     *
6539     * Sets how the bounding box containing all the elements of the box, after
6540     * their sizes and position has been calculated, will be aligned within
6541     * the space given for the whole box widget.
6542     *
6543     * @param obj The box object
6544     * @param horizontal The horizontal alignment of elements
6545     * @param vertical The vertical alignment of elements
6546     */
6547    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6548
6549    /**
6550     * Get the alignment of the whole bouding box of contents.
6551     *
6552     * @param obj The box object
6553     * @param horizontal The horizontal alignment of elements
6554     * @param vertical The vertical alignment of elements
6555     *
6556     * @see elm_box_align_set()
6557     */
6558    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6559
6560    /**
6561     * Force the box to recalculate its children packing.
6562     *
6563     * If any children was added or removed, box will not calculate the
6564     * values immediately rather leaving it to the next main loop
6565     * iteration. While this is great as it would save lots of
6566     * recalculation, whenever you need to get the position of a just
6567     * added item you must force recalculate before doing so.
6568     *
6569     * @param obj The box object.
6570     */
6571    EAPI void                 elm_box_recalculate(Evas_Object *obj);
6572
6573    /**
6574     * Set the layout defining function to be used by the box
6575     *
6576     * Whenever anything changes that requires the box in @p obj to recalculate
6577     * the size and position of its elements, the function @p cb will be called
6578     * to determine what the layout of the children will be.
6579     *
6580     * Once a custom function is set, everything about the children layout
6581     * is defined by it. The flags set by elm_box_horizontal_set() and
6582     * elm_box_homogeneous_set() no longer have any meaning, and the values
6583     * given by elm_box_padding_set() and elm_box_align_set() are up to this
6584     * layout function to decide if they are used and how. These last two
6585     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6586     * passed to @p cb. The @c Evas_Object the function receives is not the
6587     * Elementary widget, but the internal Evas Box it uses, so none of the
6588     * functions described here can be used on it.
6589     *
6590     * Any of the layout functions in @c Evas can be used here, as well as the
6591     * special elm_box_layout_transition().
6592     *
6593     * The final @p data argument received by @p cb is the same @p data passed
6594     * here, and the @p free_data function will be called to free it
6595     * whenever the box is destroyed or another layout function is set.
6596     *
6597     * Setting @p cb to NULL will revert back to the default layout function.
6598     *
6599     * @param obj The box object
6600     * @param cb The callback function used for layout
6601     * @param data Data that will be passed to layout function
6602     * @param free_data Function called to free @p data
6603     *
6604     * @see elm_box_layout_transition()
6605     */
6606    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);
6607
6608    /**
6609     * Special layout function that animates the transition from one layout to another
6610     *
6611     * Normally, when switching the layout function for a box, this will be
6612     * reflected immediately on screen on the next render, but it's also
6613     * possible to do this through an animated transition.
6614     *
6615     * This is done by creating an ::Elm_Box_Transition and setting the box
6616     * layout to this function.
6617     *
6618     * For example:
6619     * @code
6620     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6621     *                            evas_object_box_layout_vertical, // start
6622     *                            NULL, // data for initial layout
6623     *                            NULL, // free function for initial data
6624     *                            evas_object_box_layout_horizontal, // end
6625     *                            NULL, // data for final layout
6626     *                            NULL, // free function for final data
6627     *                            anim_end, // will be called when animation ends
6628     *                            NULL); // data for anim_end function\
6629     * elm_box_layout_set(box, elm_box_layout_transition, t,
6630     *                    elm_box_transition_free);
6631     * @endcode
6632     *
6633     * @note This function can only be used with elm_box_layout_set(). Calling
6634     * it directly will not have the expected results.
6635     *
6636     * @see elm_box_transition_new
6637     * @see elm_box_transition_free
6638     * @see elm_box_layout_set
6639     */
6640    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6641
6642    /**
6643     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6644     *
6645     * If you want to animate the change from one layout to another, you need
6646     * to set the layout function of the box to elm_box_layout_transition(),
6647     * passing as user data to it an instance of ::Elm_Box_Transition with the
6648     * necessary information to perform this animation. The free function to
6649     * set for the layout is elm_box_transition_free().
6650     *
6651     * The parameters to create an ::Elm_Box_Transition sum up to how long
6652     * will it be, in seconds, a layout function to describe the initial point,
6653     * another for the final position of the children and one function to be
6654     * called when the whole animation ends. This last function is useful to
6655     * set the definitive layout for the box, usually the same as the end
6656     * layout for the animation, but could be used to start another transition.
6657     *
6658     * @param start_layout The layout function that will be used to start the animation
6659     * @param start_layout_data The data to be passed the @p start_layout function
6660     * @param start_layout_free_data Function to free @p start_layout_data
6661     * @param end_layout The layout function that will be used to end the animation
6662     * @param end_layout_free_data The data to be passed the @p end_layout function
6663     * @param end_layout_free_data Function to free @p end_layout_data
6664     * @param transition_end_cb Callback function called when animation ends
6665     * @param transition_end_data Data to be passed to @p transition_end_cb
6666     * @return An instance of ::Elm_Box_Transition
6667     *
6668     * @see elm_box_transition_new
6669     * @see elm_box_layout_transition
6670     */
6671    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);
6672
6673    /**
6674     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6675     *
6676     * This function is mostly useful as the @c free_data parameter in
6677     * elm_box_layout_set() when elm_box_layout_transition().
6678     *
6679     * @param data The Elm_Box_Transition instance to be freed.
6680     *
6681     * @see elm_box_transition_new
6682     * @see elm_box_layout_transition
6683     */
6684    EAPI void                elm_box_transition_free(void *data);
6685
6686    /**
6687     * @}
6688     */
6689
6690    /* button */
6691    /**
6692     * @defgroup Button Button
6693     *
6694     * @image html img/widget/button/preview-00.png
6695     * @image latex img/widget/button/preview-00.eps
6696     * @image html img/widget/button/preview-01.png
6697     * @image latex img/widget/button/preview-01.eps
6698     * @image html img/widget/button/preview-02.png
6699     * @image latex img/widget/button/preview-02.eps
6700     *
6701     * This is a push-button. Press it and run some function. It can contain
6702     * a simple label and icon object and it also has an autorepeat feature.
6703     *
6704     * This widgets emits the following signals:
6705     * @li "clicked": the user clicked the button (press/release).
6706     * @li "repeated": the user pressed the button without releasing it.
6707     * @li "pressed": button was pressed.
6708     * @li "unpressed": button was released after being pressed.
6709     * In all three cases, the @c event parameter of the callback will be
6710     * @c NULL.
6711     *
6712     * Also, defined in the default theme, the button has the following styles
6713     * available:
6714     * @li default: a normal button.
6715     * @li anchor: Like default, but the button fades away when the mouse is not
6716     * over it, leaving only the text or icon.
6717     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6718     * continuous look across its options.
6719     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6720     *
6721     * Default contents parts of the button widget that you can use for are:
6722     * @li "icon" - An icon of the button
6723     *
6724     * Default text parts of the button widget that you can use for are:
6725     * @li "default" - Label of the button
6726     *
6727     * Follow through a complete example @ref button_example_01 "here".
6728     * @{
6729     */
6730
6731    /**
6732     * Add a new button to the parent's canvas
6733     *
6734     * @param parent The parent object
6735     * @return The new object or NULL if it cannot be created
6736     */
6737    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6738
6739    /**
6740     * Set the label used in the button
6741     *
6742     * The passed @p label can be NULL to clean any existing text in it and
6743     * leave the button as an icon only object.
6744     *
6745     * @param obj The button object
6746     * @param label The text will be written on the button
6747     * @deprecated use elm_object_text_set() instead.
6748     */
6749    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6750
6751    /**
6752     * Get the label set for the button
6753     *
6754     * The string returned is an internal pointer and should not be freed or
6755     * altered. It will also become invalid when the button is destroyed.
6756     * The string returned, if not NULL, is a stringshare, so if you need to
6757     * keep it around even after the button is destroyed, you can use
6758     * eina_stringshare_ref().
6759     *
6760     * @param obj The button object
6761     * @return The text set to the label, or NULL if nothing is set
6762     * @deprecated use elm_object_text_set() instead.
6763     */
6764    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6765
6766    /**
6767     * Set the icon used for the button
6768     *
6769     * Setting a new icon will delete any other that was previously set, making
6770     * any reference to them invalid. If you need to maintain the previous
6771     * object alive, unset it first with elm_button_icon_unset().
6772     *
6773     * @param obj The button object
6774     * @param icon The icon object for the button
6775     * @deprecated use elm_object_part_content_set() instead.
6776     */
6777    EINA_DEPRECATED EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6778
6779    /**
6780     * Get the icon used for the button
6781     *
6782     * Return the icon object which is set for this widget. If the button is
6783     * destroyed or another icon is set, the returned object will be deleted
6784     * and any reference to it will be invalid.
6785     *
6786     * @param obj The button object
6787     * @return The icon object that is being used
6788     *
6789     * @deprecated use elm_object_part_content_get() instead
6790     */
6791    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6792
6793    /**
6794     * Remove the icon set without deleting it and return the object
6795     *
6796     * This function drops the reference the button holds of the icon object
6797     * and returns this last object. It is used in case you want to remove any
6798     * icon, or set another one, without deleting the actual object. The button
6799     * will be left without an icon set.
6800     *
6801     * @param obj The button object
6802     * @return The icon object that was being used
6803     * @deprecated use elm_object_part_content_unset() instead.
6804     */
6805    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6806
6807    /**
6808     * Turn on/off the autorepeat event generated when the button is kept pressed
6809     *
6810     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6811     * signal when they are clicked.
6812     *
6813     * When on, keeping a button pressed will continuously emit a @c repeated
6814     * signal until the button is released. The time it takes until it starts
6815     * emitting the signal is given by
6816     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6817     * new emission by elm_button_autorepeat_gap_timeout_set().
6818     *
6819     * @param obj The button object
6820     * @param on  A bool to turn on/off the event
6821     */
6822    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6823
6824    /**
6825     * Get whether the autorepeat feature is enabled
6826     *
6827     * @param obj The button object
6828     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6829     *
6830     * @see elm_button_autorepeat_set()
6831     */
6832    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6833
6834    /**
6835     * Set the initial timeout before the autorepeat event is generated
6836     *
6837     * Sets the timeout, in seconds, since the button is pressed until the
6838     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6839     * won't be any delay and the even will be fired the moment the button is
6840     * pressed.
6841     *
6842     * @param obj The button object
6843     * @param t   Timeout in seconds
6844     *
6845     * @see elm_button_autorepeat_set()
6846     * @see elm_button_autorepeat_gap_timeout_set()
6847     */
6848    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6849
6850    /**
6851     * Get the initial timeout before the autorepeat event is generated
6852     *
6853     * @param obj The button object
6854     * @return Timeout in seconds
6855     *
6856     * @see elm_button_autorepeat_initial_timeout_set()
6857     */
6858    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6859
6860    /**
6861     * Set the interval between each generated autorepeat event
6862     *
6863     * After the first @c repeated event is fired, all subsequent ones will
6864     * follow after a delay of @p t seconds for each.
6865     *
6866     * @param obj The button object
6867     * @param t   Interval in seconds
6868     *
6869     * @see elm_button_autorepeat_initial_timeout_set()
6870     */
6871    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6872
6873    /**
6874     * Get the interval between each generated autorepeat event
6875     *
6876     * @param obj The button object
6877     * @return Interval in seconds
6878     */
6879    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6880
6881    /**
6882     * @}
6883     */
6884
6885    /**
6886     * @defgroup File_Selector_Button File Selector Button
6887     *
6888     * @image html img/widget/fileselector_button/preview-00.png
6889     * @image latex img/widget/fileselector_button/preview-00.eps
6890     * @image html img/widget/fileselector_button/preview-01.png
6891     * @image latex img/widget/fileselector_button/preview-01.eps
6892     * @image html img/widget/fileselector_button/preview-02.png
6893     * @image latex img/widget/fileselector_button/preview-02.eps
6894     *
6895     * This is a button that, when clicked, creates an Elementary
6896     * window (or inner window) <b> with a @ref Fileselector "file
6897     * selector widget" within</b>. When a file is chosen, the (inner)
6898     * window is closed and the button emits a signal having the
6899     * selected file as it's @c event_info.
6900     *
6901     * This widget encapsulates operations on its internal file
6902     * selector on its own API. There is less control over its file
6903     * selector than that one would have instatiating one directly.
6904     *
6905     * The following styles are available for this button:
6906     * @li @c "default"
6907     * @li @c "anchor"
6908     * @li @c "hoversel_vertical"
6909     * @li @c "hoversel_vertical_entry"
6910     *
6911     * Smart callbacks one can register to:
6912     * - @c "file,chosen" - the user has selected a path, whose string
6913     *   pointer comes as the @c event_info data (a stringshared
6914     *   string)
6915     *
6916     * Here is an example on its usage:
6917     * @li @ref fileselector_button_example
6918     *
6919     * @see @ref File_Selector_Entry for a similar widget.
6920     * @{
6921     */
6922
6923    /**
6924     * Add a new file selector button widget to the given parent
6925     * Elementary (container) object
6926     *
6927     * @param parent The parent object
6928     * @return a new file selector button widget handle or @c NULL, on
6929     * errors
6930     */
6931    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6932
6933    /**
6934     * Set the label for a given file selector button widget
6935     *
6936     * @param obj The file selector button widget
6937     * @param label The text label to be displayed on @p obj
6938     *
6939     * @deprecated use elm_object_text_set() instead.
6940     */
6941    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6942
6943    /**
6944     * Get the label set for a given file selector button widget
6945     *
6946     * @param obj The file selector button widget
6947     * @return The button label
6948     *
6949     * @deprecated use elm_object_text_set() instead.
6950     */
6951    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6952
6953    /**
6954     * Set the icon on a given file selector button widget
6955     *
6956     * @param obj The file selector button widget
6957     * @param icon The icon object for the button
6958     *
6959     * Once the icon object is set, a previously set one will be
6960     * deleted. If you want to keep the latter, use the
6961     * elm_fileselector_button_icon_unset() function.
6962     *
6963     * @see elm_fileselector_button_icon_get()
6964     */
6965    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6966
6967    /**
6968     * Get the icon set for a given file selector button widget
6969     *
6970     * @param obj The file selector button widget
6971     * @return The icon object currently set on @p obj or @c NULL, if
6972     * none is
6973     *
6974     * @see elm_fileselector_button_icon_set()
6975     */
6976    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6977
6978    /**
6979     * Unset the icon used in a given file selector button widget
6980     *
6981     * @param obj The file selector button widget
6982     * @return The icon object that was being used on @p obj or @c
6983     * NULL, on errors
6984     *
6985     * Unparent and return the icon object which was set for this
6986     * widget.
6987     *
6988     * @see elm_fileselector_button_icon_set()
6989     */
6990    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6991
6992    /**
6993     * Set the title for a given file selector button widget's window
6994     *
6995     * @param obj The file selector button widget
6996     * @param title The title string
6997     *
6998     * This will change the window's title, when the file selector pops
6999     * out after a click on the button. Those windows have the default
7000     * (unlocalized) value of @c "Select a file" as titles.
7001     *
7002     * @note It will only take any effect if the file selector
7003     * button widget is @b not under "inwin mode".
7004     *
7005     * @see elm_fileselector_button_window_title_get()
7006     */
7007    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
7008
7009    /**
7010     * Get the title set for a given file selector button widget's
7011     * window
7012     *
7013     * @param obj The file selector button widget
7014     * @return Title of the file selector button's window
7015     *
7016     * @see elm_fileselector_button_window_title_get() for more details
7017     */
7018    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7019
7020    /**
7021     * Set the size of a given file selector button widget's window,
7022     * holding the file selector itself.
7023     *
7024     * @param obj The file selector button widget
7025     * @param width The window's width
7026     * @param height The window's height
7027     *
7028     * @note it will only take any effect if the file selector button
7029     * widget is @b not under "inwin mode". The default size for the
7030     * window (when applicable) is 400x400 pixels.
7031     *
7032     * @see elm_fileselector_button_window_size_get()
7033     */
7034    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7035
7036    /**
7037     * Get the size of a given file selector button widget's window,
7038     * holding the file selector itself.
7039     *
7040     * @param obj The file selector button widget
7041     * @param width Pointer into which to store the width value
7042     * @param height Pointer into which to store the height value
7043     *
7044     * @note Use @c NULL pointers on the size values you're not
7045     * interested in: they'll be ignored by the function.
7046     *
7047     * @see elm_fileselector_button_window_size_set(), for more details
7048     */
7049    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7050
7051    /**
7052     * Set the initial file system path for a given file selector
7053     * button widget
7054     *
7055     * @param obj The file selector button widget
7056     * @param path The path string
7057     *
7058     * It must be a <b>directory</b> path, which will have the contents
7059     * displayed initially in the file selector's view, when invoked
7060     * from @p obj. The default initial path is the @c "HOME"
7061     * environment variable's value.
7062     *
7063     * @see elm_fileselector_button_path_get()
7064     */
7065    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7066
7067    /**
7068     * Get the initial file system path set for a given file selector
7069     * button widget
7070     *
7071     * @param obj The file selector button widget
7072     * @return path The path string
7073     *
7074     * @see elm_fileselector_button_path_set() for more details
7075     */
7076    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7077
7078    /**
7079     * Enable/disable a tree view in the given file selector button
7080     * widget's internal file selector
7081     *
7082     * @param obj The file selector button widget
7083     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7084     * disable
7085     *
7086     * This has the same effect as elm_fileselector_expandable_set(),
7087     * but now applied to a file selector button's internal file
7088     * selector.
7089     *
7090     * @note There's no way to put a file selector button's internal
7091     * file selector in "grid mode", as one may do with "pure" file
7092     * selectors.
7093     *
7094     * @see elm_fileselector_expandable_get()
7095     */
7096    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7097
7098    /**
7099     * Get whether tree view is enabled for the given file selector
7100     * button widget's internal file selector
7101     *
7102     * @param obj The file selector button widget
7103     * @return @c EINA_TRUE if @p obj widget's internal file selector
7104     * is in tree view, @c EINA_FALSE otherwise (and or errors)
7105     *
7106     * @see elm_fileselector_expandable_set() for more details
7107     */
7108    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7109
7110    /**
7111     * Set whether a given file selector button widget's internal file
7112     * selector is to display folders only or the directory contents,
7113     * as well.
7114     *
7115     * @param obj The file selector button widget
7116     * @param only @c EINA_TRUE to make @p obj widget's internal file
7117     * selector only display directories, @c EINA_FALSE to make files
7118     * to be displayed in it too
7119     *
7120     * This has the same effect as elm_fileselector_folder_only_set(),
7121     * but now applied to a file selector button's internal file
7122     * selector.
7123     *
7124     * @see elm_fileselector_folder_only_get()
7125     */
7126    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7127
7128    /**
7129     * Get whether a given file selector button widget's internal file
7130     * selector is displaying folders only or the directory contents,
7131     * as well.
7132     *
7133     * @param obj The file selector button widget
7134     * @return @c EINA_TRUE if @p obj widget's internal file
7135     * selector is only displaying directories, @c EINA_FALSE if files
7136     * are being displayed in it too (and on errors)
7137     *
7138     * @see elm_fileselector_button_folder_only_set() for more details
7139     */
7140    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7141
7142    /**
7143     * Enable/disable the file name entry box where the user can type
7144     * in a name for a file, in a given file selector button widget's
7145     * internal file selector.
7146     *
7147     * @param obj The file selector button widget
7148     * @param is_save @c EINA_TRUE to make @p obj widget's internal
7149     * file selector a "saving dialog", @c EINA_FALSE otherwise
7150     *
7151     * This has the same effect as elm_fileselector_is_save_set(),
7152     * but now applied to a file selector button's internal file
7153     * selector.
7154     *
7155     * @see elm_fileselector_is_save_get()
7156     */
7157    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7158
7159    /**
7160     * Get whether the given file selector button widget's internal
7161     * file selector is in "saving dialog" mode
7162     *
7163     * @param obj The file selector button widget
7164     * @return @c EINA_TRUE, if @p obj widget's internal file selector
7165     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7166     * errors)
7167     *
7168     * @see elm_fileselector_button_is_save_set() for more details
7169     */
7170    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7171
7172    /**
7173     * Set whether a given file selector button widget's internal file
7174     * selector will raise an Elementary "inner window", instead of a
7175     * dedicated Elementary window. By default, it won't.
7176     *
7177     * @param obj The file selector button widget
7178     * @param value @c EINA_TRUE to make it use an inner window, @c
7179     * EINA_TRUE to make it use a dedicated window
7180     *
7181     * @see elm_win_inwin_add() for more information on inner windows
7182     * @see elm_fileselector_button_inwin_mode_get()
7183     */
7184    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7185
7186    /**
7187     * Get whether a given file selector button widget's internal file
7188     * selector will raise an Elementary "inner window", instead of a
7189     * dedicated Elementary window.
7190     *
7191     * @param obj The file selector button widget
7192     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7193     * if it will use a dedicated window
7194     *
7195     * @see elm_fileselector_button_inwin_mode_set() for more details
7196     */
7197    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7198
7199    /**
7200     * @}
7201     */
7202
7203     /**
7204     * @defgroup File_Selector_Entry File Selector Entry
7205     *
7206     * @image html img/widget/fileselector_entry/preview-00.png
7207     * @image latex img/widget/fileselector_entry/preview-00.eps
7208     *
7209     * This is an entry made to be filled with or display a <b>file
7210     * system path string</b>. Besides the entry itself, the widget has
7211     * a @ref File_Selector_Button "file selector button" on its side,
7212     * which will raise an internal @ref Fileselector "file selector widget",
7213     * when clicked, for path selection aided by file system
7214     * navigation.
7215     *
7216     * This file selector may appear in an Elementary window or in an
7217     * inner window. When a file is chosen from it, the (inner) window
7218     * is closed and the selected file's path string is exposed both as
7219     * an smart event and as the new text on the entry.
7220     *
7221     * This widget encapsulates operations on its internal file
7222     * selector on its own API. There is less control over its file
7223     * selector than that one would have instatiating one directly.
7224     *
7225     * Smart callbacks one can register to:
7226     * - @c "changed" - The text within the entry was changed
7227     * - @c "activated" - The entry has had editing finished and
7228     *   changes are to be "committed"
7229     * - @c "press" - The entry has been clicked
7230     * - @c "longpressed" - The entry has been clicked (and held) for a
7231     *   couple seconds
7232     * - @c "clicked" - The entry has been clicked
7233     * - @c "clicked,double" - The entry has been double clicked
7234     * - @c "focused" - The entry has received focus
7235     * - @c "unfocused" - The entry has lost focus
7236     * - @c "selection,paste" - A paste action has occurred on the
7237     *   entry
7238     * - @c "selection,copy" - A copy action has occurred on the entry
7239     * - @c "selection,cut" - A cut action has occurred on the entry
7240     * - @c "unpressed" - The file selector entry's button was released
7241     *   after being pressed.
7242     * - @c "file,chosen" - The user has selected a path via the file
7243     *   selector entry's internal file selector, whose string pointer
7244     *   comes as the @c event_info data (a stringshared string)
7245     *
7246     * Here is an example on its usage:
7247     * @li @ref fileselector_entry_example
7248     *
7249     * @see @ref File_Selector_Button for a similar widget.
7250     * @{
7251     */
7252
7253    /**
7254     * Add a new file selector entry widget to the given parent
7255     * Elementary (container) object
7256     *
7257     * @param parent The parent object
7258     * @return a new file selector entry widget handle or @c NULL, on
7259     * errors
7260     */
7261    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7262
7263    /**
7264     * Set the label for a given file selector entry widget's button
7265     *
7266     * @param obj The file selector entry widget
7267     * @param label The text label to be displayed on @p obj widget's
7268     * button
7269     *
7270     * @deprecated use elm_object_text_set() instead.
7271     */
7272    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7273
7274    /**
7275     * Get the label set for a given file selector entry widget's button
7276     *
7277     * @param obj The file selector entry widget
7278     * @return The widget button's label
7279     *
7280     * @deprecated use elm_object_text_set() instead.
7281     */
7282    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7283
7284    /**
7285     * Set the icon on a given file selector entry widget's button
7286     *
7287     * @param obj The file selector entry widget
7288     * @param icon The icon object for the entry's button
7289     *
7290     * Once the icon object is set, a previously set one will be
7291     * deleted. If you want to keep the latter, use the
7292     * elm_fileselector_entry_button_icon_unset() function.
7293     *
7294     * @see elm_fileselector_entry_button_icon_get()
7295     */
7296    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7297
7298    /**
7299     * Get the icon set for a given file selector entry widget's button
7300     *
7301     * @param obj The file selector entry widget
7302     * @return The icon object currently set on @p obj widget's button
7303     * or @c NULL, if none is
7304     *
7305     * @see elm_fileselector_entry_button_icon_set()
7306     */
7307    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7308
7309    /**
7310     * Unset the icon used in a given file selector entry widget's
7311     * button
7312     *
7313     * @param obj The file selector entry widget
7314     * @return The icon object that was being used on @p obj widget's
7315     * button or @c NULL, on errors
7316     *
7317     * Unparent and return the icon object which was set for this
7318     * widget's button.
7319     *
7320     * @see elm_fileselector_entry_button_icon_set()
7321     */
7322    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7323
7324    /**
7325     * Set the title for a given file selector entry widget's window
7326     *
7327     * @param obj The file selector entry widget
7328     * @param title The title string
7329     *
7330     * This will change the window's title, when the file selector pops
7331     * out after a click on the entry's button. Those windows have the
7332     * default (unlocalized) value of @c "Select a file" as titles.
7333     *
7334     * @note It will only take any effect if the file selector
7335     * entry widget is @b not under "inwin mode".
7336     *
7337     * @see elm_fileselector_entry_window_title_get()
7338     */
7339    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
7340
7341    /**
7342     * Get the title set for a given file selector entry widget's
7343     * window
7344     *
7345     * @param obj The file selector entry widget
7346     * @return Title of the file selector entry's window
7347     *
7348     * @see elm_fileselector_entry_window_title_get() for more details
7349     */
7350    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7351
7352    /**
7353     * Set the size of a given file selector entry widget's window,
7354     * holding the file selector itself.
7355     *
7356     * @param obj The file selector entry widget
7357     * @param width The window's width
7358     * @param height The window's height
7359     *
7360     * @note it will only take any effect if the file selector entry
7361     * widget is @b not under "inwin mode". The default size for the
7362     * window (when applicable) is 400x400 pixels.
7363     *
7364     * @see elm_fileselector_entry_window_size_get()
7365     */
7366    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7367
7368    /**
7369     * Get the size of a given file selector entry widget's window,
7370     * holding the file selector itself.
7371     *
7372     * @param obj The file selector entry widget
7373     * @param width Pointer into which to store the width value
7374     * @param height Pointer into which to store the height value
7375     *
7376     * @note Use @c NULL pointers on the size values you're not
7377     * interested in: they'll be ignored by the function.
7378     *
7379     * @see elm_fileselector_entry_window_size_set(), for more details
7380     */
7381    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7382
7383    /**
7384     * Set the initial file system path and the entry's path string for
7385     * a given file selector entry widget
7386     *
7387     * @param obj The file selector entry widget
7388     * @param path The path string
7389     *
7390     * It must be a <b>directory</b> path, which will have the contents
7391     * displayed initially in the file selector's view, when invoked
7392     * from @p obj. The default initial path is the @c "HOME"
7393     * environment variable's value.
7394     *
7395     * @see elm_fileselector_entry_path_get()
7396     */
7397    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7398
7399    /**
7400     * Get the entry's path string for a given file selector entry
7401     * widget
7402     *
7403     * @param obj The file selector entry widget
7404     * @return path The path string
7405     *
7406     * @see elm_fileselector_entry_path_set() for more details
7407     */
7408    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7409
7410    /**
7411     * Enable/disable a tree view in the given file selector entry
7412     * widget's internal file selector
7413     *
7414     * @param obj The file selector entry widget
7415     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7416     * disable
7417     *
7418     * This has the same effect as elm_fileselector_expandable_set(),
7419     * but now applied to a file selector entry's internal file
7420     * selector.
7421     *
7422     * @note There's no way to put a file selector entry's internal
7423     * file selector in "grid mode", as one may do with "pure" file
7424     * selectors.
7425     *
7426     * @see elm_fileselector_expandable_get()
7427     */
7428    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7429
7430    /**
7431     * Get whether tree view is enabled for the given file selector
7432     * entry widget's internal file selector
7433     *
7434     * @param obj The file selector entry widget
7435     * @return @c EINA_TRUE if @p obj widget's internal file selector
7436     * is in tree view, @c EINA_FALSE otherwise (and or errors)
7437     *
7438     * @see elm_fileselector_expandable_set() for more details
7439     */
7440    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7441
7442    /**
7443     * Set whether a given file selector entry widget's internal file
7444     * selector is to display folders only or the directory contents,
7445     * as well.
7446     *
7447     * @param obj The file selector entry widget
7448     * @param only @c EINA_TRUE to make @p obj widget's internal file
7449     * selector only display directories, @c EINA_FALSE to make files
7450     * to be displayed in it too
7451     *
7452     * This has the same effect as elm_fileselector_folder_only_set(),
7453     * but now applied to a file selector entry's internal file
7454     * selector.
7455     *
7456     * @see elm_fileselector_folder_only_get()
7457     */
7458    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7459
7460    /**
7461     * Get whether a given file selector entry widget's internal file
7462     * selector is displaying folders only or the directory contents,
7463     * as well.
7464     *
7465     * @param obj The file selector entry widget
7466     * @return @c EINA_TRUE if @p obj widget's internal file
7467     * selector is only displaying directories, @c EINA_FALSE if files
7468     * are being displayed in it too (and on errors)
7469     *
7470     * @see elm_fileselector_entry_folder_only_set() for more details
7471     */
7472    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7473
7474    /**
7475     * Enable/disable the file name entry box where the user can type
7476     * in a name for a file, in a given file selector entry widget's
7477     * internal file selector.
7478     *
7479     * @param obj The file selector entry widget
7480     * @param is_save @c EINA_TRUE to make @p obj widget's internal
7481     * file selector a "saving dialog", @c EINA_FALSE otherwise
7482     *
7483     * This has the same effect as elm_fileselector_is_save_set(),
7484     * but now applied to a file selector entry's internal file
7485     * selector.
7486     *
7487     * @see elm_fileselector_is_save_get()
7488     */
7489    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7490
7491    /**
7492     * Get whether the given file selector entry widget's internal
7493     * file selector is in "saving dialog" mode
7494     *
7495     * @param obj The file selector entry widget
7496     * @return @c EINA_TRUE, if @p obj widget's internal file selector
7497     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7498     * errors)
7499     *
7500     * @see elm_fileselector_entry_is_save_set() for more details
7501     */
7502    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7503
7504    /**
7505     * Set whether a given file selector entry widget's internal file
7506     * selector will raise an Elementary "inner window", instead of a
7507     * dedicated Elementary window. By default, it won't.
7508     *
7509     * @param obj The file selector entry widget
7510     * @param value @c EINA_TRUE to make it use an inner window, @c
7511     * EINA_TRUE to make it use a dedicated window
7512     *
7513     * @see elm_win_inwin_add() for more information on inner windows
7514     * @see elm_fileselector_entry_inwin_mode_get()
7515     */
7516    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7517
7518    /**
7519     * Get whether a given file selector entry widget's internal file
7520     * selector will raise an Elementary "inner window", instead of a
7521     * dedicated Elementary window.
7522     *
7523     * @param obj The file selector entry widget
7524     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7525     * if it will use a dedicated window
7526     *
7527     * @see elm_fileselector_entry_inwin_mode_set() for more details
7528     */
7529    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7530
7531    /**
7532     * Set the initial file system path for a given file selector entry
7533     * widget
7534     *
7535     * @param obj The file selector entry widget
7536     * @param path The path string
7537     *
7538     * It must be a <b>directory</b> path, which will have the contents
7539     * displayed initially in the file selector's view, when invoked
7540     * from @p obj. The default initial path is the @c "HOME"
7541     * environment variable's value.
7542     *
7543     * @see elm_fileselector_entry_path_get()
7544     */
7545    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7546
7547    /**
7548     * Get the parent directory's path to the latest file selection on
7549     * a given filer selector entry widget
7550     *
7551     * @param obj The file selector object
7552     * @return The (full) path of the directory of the last selection
7553     * on @p obj widget, a @b stringshared string
7554     *
7555     * @see elm_fileselector_entry_path_set()
7556     */
7557    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7558
7559    /**
7560     * @}
7561     */
7562
7563    /**
7564     * @defgroup Scroller Scroller
7565     *
7566     * A scroller holds a single object and "scrolls it around". This means that
7567     * it allows the user to use a scrollbar (or a finger) to drag the viewable
7568     * region around, allowing to move through a much larger object that is
7569     * contained in the scroller. The scroller will always have a small minimum
7570     * size by default as it won't be limited by the contents of the scroller.
7571     *
7572     * Signals that you can add callbacks for are:
7573     * @li "edge,left" - the left edge of the content has been reached
7574     * @li "edge,right" - the right edge of the content has been reached
7575     * @li "edge,top" - the top edge of the content has been reached
7576     * @li "edge,bottom" - the bottom edge of the content has been reached
7577     * @li "scroll" - the content has been scrolled (moved)
7578     * @li "scroll,anim,start" - scrolling animation has started
7579     * @li "scroll,anim,stop" - scrolling animation has stopped
7580     * @li "scroll,drag,start" - dragging the contents around has started
7581     * @li "scroll,drag,stop" - dragging the contents around has stopped
7582     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7583     * user intervetion.
7584     *
7585     * @note When Elemementary is in embedded mode the scrollbars will not be
7586     * dragable, they appear merely as indicators of how much has been scrolled.
7587     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7588     * fingerscroll) won't work.
7589     *
7590     * Default contents parts of the scroller widget that you can use for are:
7591     * @li "default" - A content of the scroller
7592     *
7593     * In @ref tutorial_scroller you'll find an example of how to use most of
7594     * this API.
7595     * @{
7596     */
7597
7598    /**
7599     * @brief Type that controls when scrollbars should appear.
7600     *
7601     * @see elm_scroller_policy_set()
7602     */
7603    typedef enum _Elm_Scroller_Policy
7604      {
7605         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7606         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7607         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7608         ELM_SCROLLER_POLICY_LAST
7609      } Elm_Scroller_Policy;
7610
7611    /**
7612     * @brief Add a new scroller to the parent
7613     *
7614     * @param parent The parent object
7615     * @return The new object or NULL if it cannot be created
7616     */
7617    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7618
7619    /**
7620     * @brief Set the content of the scroller widget (the object to be scrolled around).
7621     *
7622     * @param obj The scroller object
7623     * @param content The new content object
7624     *
7625     * Once the content object is set, a previously set one will be deleted.
7626     * If you want to keep that old content object, use the
7627     * elm_scroller_content_unset() function.
7628     * @deprecated use elm_object_content_set() instead
7629     */
7630    EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7631
7632    /**
7633     * @brief Get the content of the scroller widget
7634     *
7635     * @param obj The slider object
7636     * @return The content that is being used
7637     *
7638     * Return the content object which is set for this widget
7639     *
7640     * @see elm_scroller_content_set()
7641     * @deprecated use elm_object_content_get() instead.
7642     */
7643    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7644
7645    /**
7646     * @brief Unset the content of the scroller widget
7647     *
7648     * @param obj The slider object
7649     * @return The content that was being used
7650     *
7651     * Unparent and return the content object which was set for this widget
7652     *
7653     * @see elm_scroller_content_set()
7654     * @deprecated use elm_object_content_unset() instead.
7655     */
7656    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7657
7658    /**
7659     * @brief Set custom theme elements for the scroller
7660     *
7661     * @param obj The scroller object
7662     * @param widget The widget name to use (default is "scroller")
7663     * @param base The base name to use (default is "base")
7664     */
7665    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7666
7667    /**
7668     * @brief Make the scroller minimum size limited to the minimum size of the content
7669     *
7670     * @param obj The scroller object
7671     * @param w Enable limiting minimum size horizontally
7672     * @param h Enable limiting minimum size vertically
7673     *
7674     * By default the scroller will be as small as its design allows,
7675     * irrespective of its content. This will make the scroller minimum size the
7676     * right size horizontally and/or vertically to perfectly fit its content in
7677     * that direction.
7678     */
7679    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7680
7681    /**
7682     * @brief Show a specific virtual region within the scroller content object
7683     *
7684     * @param obj The scroller object
7685     * @param x X coordinate of the region
7686     * @param y Y coordinate of the region
7687     * @param w Width of the region
7688     * @param h Height of the region
7689     *
7690     * This will ensure all (or part if it does not fit) of the designated
7691     * region in the virtual content object (0, 0 starting at the top-left of the
7692     * virtual content object) is shown within the scroller.
7693     */
7694    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);
7695
7696    /**
7697     * @brief Set the scrollbar visibility policy
7698     *
7699     * @param obj The scroller object
7700     * @param policy_h Horizontal scrollbar policy
7701     * @param policy_v Vertical scrollbar policy
7702     *
7703     * This sets the scrollbar visibility policy for the given scroller.
7704     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7705     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7706     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7707     * respectively for the horizontal and vertical scrollbars.
7708     */
7709    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7710
7711    /**
7712     * @brief Gets scrollbar visibility policy
7713     *
7714     * @param obj The scroller object
7715     * @param policy_h Horizontal scrollbar policy
7716     * @param policy_v Vertical scrollbar policy
7717     *
7718     * @see elm_scroller_policy_set()
7719     */
7720    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7721
7722    /**
7723     * @brief Get the currently visible content region
7724     *
7725     * @param obj The scroller object
7726     * @param x X coordinate of the region
7727     * @param y Y coordinate of the region
7728     * @param w Width of the region
7729     * @param h Height of the region
7730     *
7731     * This gets the current region in the content object that is visible through
7732     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7733     * w, @p h values pointed to.
7734     *
7735     * @note All coordinates are relative to the content.
7736     *
7737     * @see elm_scroller_region_show()
7738     */
7739    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);
7740
7741    /**
7742     * @brief Get the size of the content object
7743     *
7744     * @param obj The scroller object
7745     * @param w Width of the content object.
7746     * @param h Height of the content object.
7747     *
7748     * This gets the size of the content object of the scroller.
7749     */
7750    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7751
7752    /**
7753     * @brief Set bouncing behavior
7754     *
7755     * @param obj The scroller object
7756     * @param h_bounce Allow bounce horizontally
7757     * @param v_bounce Allow bounce vertically
7758     *
7759     * When scrolling, the scroller may "bounce" when reaching an edge of the
7760     * content object. This is a visual way to indicate the end has been reached.
7761     * This is enabled by default for both axis. This API will set if it is enabled
7762     * for the given axis with the boolean parameters for each axis.
7763     */
7764    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7765
7766    /**
7767     * @brief Get the bounce behaviour
7768     *
7769     * @param obj The Scroller object
7770     * @param h_bounce Will the scroller bounce horizontally or not
7771     * @param v_bounce Will the scroller bounce vertically or not
7772     *
7773     * @see elm_scroller_bounce_set()
7774     */
7775    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7776
7777    /**
7778     * @brief Set scroll page size relative to viewport size.
7779     *
7780     * @param obj The scroller object
7781     * @param h_pagerel The horizontal page relative size
7782     * @param v_pagerel The vertical page relative size
7783     *
7784     * The scroller is capable of limiting scrolling by the user to "pages". That
7785     * is to jump by and only show a "whole page" at a time as if the continuous
7786     * area of the scroller content is split into page sized pieces. This sets
7787     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7788     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7789     * axis. This is mutually exclusive with page size
7790     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7791     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7792     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7793     * the other axis.
7794     */
7795    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7796
7797    /**
7798     * @brief Set scroll page size.
7799     *
7800     * @param obj The scroller object
7801     * @param h_pagesize The horizontal page size
7802     * @param v_pagesize The vertical page size
7803     *
7804     * This sets the page size to an absolute fixed value, with 0 turning it off
7805     * for that axis.
7806     *
7807     * @see elm_scroller_page_relative_set()
7808     */
7809    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7810
7811    /**
7812     * @brief Get scroll current page number.
7813     *
7814     * @param obj The scroller object
7815     * @param h_pagenumber The horizontal page number
7816     * @param v_pagenumber The vertical page number
7817     *
7818     * The page number starts from 0. 0 is the first page.
7819     * Current page means the page which meets the top-left of the viewport.
7820     * If there are two or more pages in the viewport, it returns the number of the page
7821     * which meets the top-left of the viewport.
7822     *
7823     * @see elm_scroller_last_page_get()
7824     * @see elm_scroller_page_show()
7825     * @see elm_scroller_page_brint_in()
7826     */
7827    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7828
7829    /**
7830     * @brief Get scroll last page number.
7831     *
7832     * @param obj The scroller object
7833     * @param h_pagenumber The horizontal page number
7834     * @param v_pagenumber The vertical page number
7835     *
7836     * The page number starts from 0. 0 is the first page.
7837     * This returns the last page number among the pages.
7838     *
7839     * @see elm_scroller_current_page_get()
7840     * @see elm_scroller_page_show()
7841     * @see elm_scroller_page_brint_in()
7842     */
7843    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7844
7845    /**
7846     * Show a specific virtual region within the scroller content object by page number.
7847     *
7848     * @param obj The scroller object
7849     * @param h_pagenumber The horizontal page number
7850     * @param v_pagenumber The vertical page number
7851     *
7852     * 0, 0 of the indicated page is located at the top-left of the viewport.
7853     * This will jump to the page directly without animation.
7854     *
7855     * Example of usage:
7856     *
7857     * @code
7858     * sc = elm_scroller_add(win);
7859     * elm_scroller_content_set(sc, content);
7860     * elm_scroller_page_relative_set(sc, 1, 0);
7861     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7862     * elm_scroller_page_show(sc, h_page + 1, v_page);
7863     * @endcode
7864     *
7865     * @see elm_scroller_page_bring_in()
7866     */
7867    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7868
7869    /**
7870     * Show a specific virtual region within the scroller content object by page number.
7871     *
7872     * @param obj The scroller object
7873     * @param h_pagenumber The horizontal page number
7874     * @param v_pagenumber The vertical page number
7875     *
7876     * 0, 0 of the indicated page is located at the top-left of the viewport.
7877     * This will slide to the page with animation.
7878     *
7879     * Example of usage:
7880     *
7881     * @code
7882     * sc = elm_scroller_add(win);
7883     * elm_scroller_content_set(sc, content);
7884     * elm_scroller_page_relative_set(sc, 1, 0);
7885     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7886     * elm_scroller_page_bring_in(sc, h_page, v_page);
7887     * @endcode
7888     *
7889     * @see elm_scroller_page_show()
7890     */
7891    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7892
7893    /**
7894     * @brief Show a specific virtual region within the scroller content object.
7895     *
7896     * @param obj The scroller object
7897     * @param x X coordinate of the region
7898     * @param y Y coordinate of the region
7899     * @param w Width of the region
7900     * @param h Height of the region
7901     *
7902     * This will ensure all (or part if it does not fit) of the designated
7903     * region in the virtual content object (0, 0 starting at the top-left of the
7904     * virtual content object) is shown within the scroller. Unlike
7905     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7906     * to this location (if configuration in general calls for transitions). It
7907     * may not jump immediately to the new location and make take a while and
7908     * show other content along the way.
7909     *
7910     * @see elm_scroller_region_show()
7911     */
7912    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);
7913
7914    /**
7915     * @brief Set event propagation on a scroller
7916     *
7917     * @param obj The scroller object
7918     * @param propagation If propagation is enabled or not
7919     *
7920     * This enables or disabled event propagation from the scroller content to
7921     * the scroller and its parent. By default event propagation is disabled.
7922     */
7923    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7924
7925    /**
7926     * @brief Get event propagation for a scroller
7927     *
7928     * @param obj The scroller object
7929     * @return The propagation state
7930     *
7931     * This gets the event propagation for a scroller.
7932     *
7933     * @see elm_scroller_propagate_events_set()
7934     */
7935    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7936
7937    /**
7938     * @brief Set scrolling gravity on a scroller
7939     *
7940     * @param obj The scroller object
7941     * @param x The scrolling horizontal gravity
7942     * @param y The scrolling vertical gravity
7943     *
7944     * The gravity, defines how the scroller will adjust its view
7945     * when the size of the scroller contents increase.
7946     *
7947     * The scroller will adjust the view to glue itself as follows.
7948     *
7949     *  x=0.0, for showing the left most region of the content.
7950     *  x=1.0, for showing the right most region of the content.
7951     *  y=0.0, for showing the bottom most region of the content.
7952     *  y=1.0, for showing the top most region of the content.
7953     *
7954     * Default values for x and y are 0.0
7955     */
7956    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7957
7958    /**
7959     * @brief Get scrolling gravity values for a scroller
7960     *
7961     * @param obj The scroller object
7962     * @param x The scrolling horizontal gravity
7963     * @param y The scrolling vertical gravity
7964     *
7965     * This gets gravity values for a scroller.
7966     *
7967     * @see elm_scroller_gravity_set()
7968     *
7969     */
7970    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7971
7972    /**
7973     * @}
7974     */
7975
7976    /**
7977     * @defgroup Label Label
7978     *
7979     * @image html img/widget/label/preview-00.png
7980     * @image latex img/widget/label/preview-00.eps
7981     *
7982     * @brief Widget to display text, with simple html-like markup.
7983     *
7984     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7985     * text doesn't fit the geometry of the label it will be ellipsized or be
7986     * cut. Elementary provides several styles for this widget:
7987     * @li default - No animation
7988     * @li marker - Centers the text in the label and make it bold by default
7989     * @li slide_long - The entire text appears from the right of the screen and
7990     * slides until it disappears in the left of the screen(reappering on the
7991     * right again).
7992     * @li slide_short - The text appears in the left of the label and slides to
7993     * the right to show the overflow. When all of the text has been shown the
7994     * position is reset.
7995     * @li slide_bounce - The text appears in the left of the label and slides to
7996     * the right to show the overflow. When all of the text has been shown the
7997     * animation reverses, moving the text to the left.
7998     *
7999     * Custom themes can of course invent new markup tags and style them any way
8000     * they like.
8001     *
8002     * The following signals may be emitted by the label widget:
8003     * @li "language,changed": The program's language changed.
8004     *
8005     * See @ref tutorial_label for a demonstration of how to use a label widget.
8006     * @{
8007     */
8008
8009    /**
8010     * @brief Add a new label to the parent
8011     *
8012     * @param parent The parent object
8013     * @return The new object or NULL if it cannot be created
8014     */
8015    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8016
8017    /**
8018     * @brief Set the label on the label object
8019     *
8020     * @param obj The label object
8021     * @param label The label will be used on the label object
8022     * @deprecated See elm_object_text_set()
8023     */
8024    EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8025
8026    /**
8027     * @brief Get the label used on the label object
8028     *
8029     * @param obj The label object
8030     * @return The string inside the label
8031     * @deprecated See elm_object_text_get()
8032     */
8033    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8034
8035    /**
8036     * @brief Set the wrapping behavior of the label
8037     *
8038     * @param obj The label object
8039     * @param wrap To wrap text or not
8040     *
8041     * By default no wrapping is done. Possible values for @p wrap are:
8042     * @li ELM_WRAP_NONE - No wrapping
8043     * @li ELM_WRAP_CHAR - wrap between characters
8044     * @li ELM_WRAP_WORD - wrap between words
8045     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
8046     */
8047    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8048
8049    /**
8050     * @brief Get the wrapping behavior of the label
8051     *
8052     * @param obj The label object
8053     * @return Wrap type
8054     *
8055     * @see elm_label_line_wrap_set()
8056     */
8057    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8058
8059    /**
8060     * @brief Set wrap width of the label
8061     *
8062     * @param obj The label object
8063     * @param w The wrap width in pixels at a minimum where words need to wrap
8064     *
8065     * This function sets the maximum width size hint of the label.
8066     *
8067     * @warning This is only relevant if the label is inside a container.
8068     */
8069    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
8070
8071    /**
8072     * @brief Get wrap width of the label
8073     *
8074     * @param obj The label object
8075     * @return The wrap width in pixels at a minimum where words need to wrap
8076     *
8077     * @see elm_label_wrap_width_set()
8078     */
8079    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8080
8081    /**
8082     * @brief Set wrap height of the label
8083     *
8084     * @param obj The label object
8085     * @param h The wrap height in pixels at a minimum where words need to wrap
8086     *
8087     * This function sets the maximum height size hint of the label.
8088     *
8089     * @warning This is only relevant if the label is inside a container.
8090     */
8091    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
8092
8093    /**
8094     * @brief get wrap width of the label
8095     *
8096     * @param obj The label object
8097     * @return The wrap height in pixels at a minimum where words need to wrap
8098     */
8099    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8100
8101    /**
8102     * @brief Set the font size on the label object.
8103     *
8104     * @param obj The label object
8105     * @param size font size
8106     *
8107     * @warning NEVER use this. It is for hyper-special cases only. use styles
8108     * instead. e.g. "default", "marker", "slide_long" etc.
8109     */
8110    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
8111
8112    /**
8113     * @brief Set the text color on the label object
8114     *
8115     * @param obj The label object
8116     * @param r Red property background color of The label object
8117     * @param g Green property background color of The label object
8118     * @param b Blue property background color of The label object
8119     * @param a Alpha property background color of The label object
8120     *
8121     * @warning NEVER use this. It is for hyper-special cases only. use styles
8122     * instead. e.g. "default", "marker", "slide_long" etc.
8123     */
8124    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);
8125
8126    /**
8127     * @brief Set the text align on the label object
8128     *
8129     * @param obj The label object
8130     * @param align align mode ("left", "center", "right")
8131     *
8132     * @warning NEVER use this. It is for hyper-special cases only. use styles
8133     * instead. e.g. "default", "marker", "slide_long" etc.
8134     */
8135    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
8136
8137    /**
8138     * @brief Set background color of the label
8139     *
8140     * @param obj The label object
8141     * @param r Red property background color of The label object
8142     * @param g Green property background color of The label object
8143     * @param b Blue property background color of The label object
8144     * @param a Alpha property background alpha of The label object
8145     *
8146     * @warning NEVER use this. It is for hyper-special cases only. use styles
8147     * instead. e.g. "default", "marker", "slide_long" etc.
8148     */
8149    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);
8150
8151    /**
8152     * @brief Set the ellipsis behavior of the label
8153     *
8154     * @param obj The label object
8155     * @param ellipsis To ellipsis text or not
8156     *
8157     * If set to true and the text doesn't fit in the label an ellipsis("...")
8158     * will be shown at the end of the widget.
8159     *
8160     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
8161     * choosen wrap method was ELM_WRAP_WORD.
8162     */
8163    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
8164
8165    /**
8166     * @brief Set the text slide of the label
8167     *
8168     * @param obj The label object
8169     * @param slide To start slide or stop
8170     *
8171     * If set to true, the text of the label will slide/scroll through the length of
8172     * label.
8173     *
8174     * @warning This only works with the themes "slide_short", "slide_long" and
8175     * "slide_bounce".
8176     */
8177    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
8178
8179    /**
8180     * @brief Get the text slide mode of the label
8181     *
8182     * @param obj The label object
8183     * @return slide slide mode value
8184     *
8185     * @see elm_label_slide_set()
8186     */
8187    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8188
8189    /**
8190     * @brief Set the slide duration(speed) of the label
8191     *
8192     * @param obj The label object
8193     * @return The duration in seconds in moving text from slide begin position
8194     * to slide end position
8195     */
8196    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
8197
8198    /**
8199     * @brief Get the slide duration(speed) of the label
8200     *
8201     * @param obj The label object
8202     * @return The duration time in moving text from slide begin position to slide end position
8203     *
8204     * @see elm_label_slide_duration_set()
8205     */
8206    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8207
8208    /**
8209     * @}
8210     */
8211
8212    /**
8213     * @defgroup Toggle Toggle
8214     *
8215     * @image html img/widget/toggle/preview-00.png
8216     * @image latex img/widget/toggle/preview-00.eps
8217     *
8218     * @brief A toggle is a slider which can be used to toggle between
8219     * two values.  It has two states: on and off.
8220     *
8221     * This widget is deprecated. Please use elm_check_add() instead using the
8222     * toggle style like:
8223     *
8224     * @code
8225     * obj = elm_check_add(parent);
8226     * elm_object_style_set(obj, "toggle");
8227     * elm_object_part_text_set(obj, "on", "ON");
8228     * elm_object_part_text_set(obj, "off", "OFF");
8229     * @endcode
8230     *
8231     * Signals that you can add callbacks for are:
8232     * @li "changed" - Whenever the toggle value has been changed.  Is not called
8233     *                 until the toggle is released by the cursor (assuming it
8234     *                 has been triggered by the cursor in the first place).
8235     *
8236     * Default contents parts of the toggle widget that you can use for are:
8237     * @li "icon" - An icon of the toggle
8238     *
8239     * Default text parts of the toggle widget that you can use for are:
8240     * @li "elm.text" - Label of the toggle
8241     *
8242     * @ref tutorial_toggle show how to use a toggle.
8243     * @{
8244     */
8245
8246    /**
8247     * @brief Add a toggle to @p parent.
8248     *
8249     * @param parent The parent object
8250     *
8251     * @return The toggle object
8252     */
8253    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8254
8255    /**
8256     * @brief Sets the label to be displayed with the toggle.
8257     *
8258     * @param obj The toggle object
8259     * @param label The label to be displayed
8260     *
8261     * @deprecated use elm_object_text_set() instead.
8262     */
8263    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8264
8265    /**
8266     * @brief Gets the label of the toggle
8267     *
8268     * @param obj  toggle object
8269     * @return The label of the toggle
8270     *
8271     * @deprecated use elm_object_text_get() instead.
8272     */
8273    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8274
8275    /**
8276     * @brief Set the icon used for the toggle
8277     *
8278     * @param obj The toggle object
8279     * @param icon The icon object for the button
8280     *
8281     * Once the icon object is set, a previously set one will be deleted
8282     * If you want to keep that old content object, use the
8283     * elm_toggle_icon_unset() function.
8284     *
8285     * @deprecated use elm_object_part_content_set() instead.
8286     */
8287    EINA_DEPRECATED EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8288
8289    /**
8290     * @brief Get the icon used for the toggle
8291     *
8292     * @param obj The toggle object
8293     * @return The icon object that is being used
8294     *
8295     * Return the icon object which is set for this widget.
8296     *
8297     * @see elm_toggle_icon_set()
8298     *
8299     * @deprecated use elm_object_part_content_get() instead.
8300     */
8301    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8302
8303    /**
8304     * @brief Unset the icon used for the toggle
8305     *
8306     * @param obj The toggle object
8307     * @return The icon object that was being used
8308     *
8309     * Unparent and return the icon object which was set for this widget.
8310     *
8311     * @see elm_toggle_icon_set()
8312     *
8313     * @deprecated use elm_object_part_content_unset() instead.
8314     */
8315    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8316
8317    /**
8318     * @brief Sets the labels to be associated with the on and off states of the toggle.
8319     *
8320     * @param obj The toggle object
8321     * @param onlabel The label displayed when the toggle is in the "on" state
8322     * @param offlabel The label displayed when the toggle is in the "off" state
8323     *
8324     * @deprecated use elm_object_part_text_set() for "on" and "off" parts
8325     * instead.
8326     */
8327    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
8328
8329    /**
8330     * @brief Gets the labels associated with the on and off states of the
8331     * toggle.
8332     *
8333     * @param obj The toggle object
8334     * @param onlabel A char** to place the onlabel of @p obj into
8335     * @param offlabel A char** to place the offlabel of @p obj into
8336     *
8337     * @deprecated use elm_object_part_text_get() for "on" and "off" parts
8338     * instead.
8339     */
8340    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
8341
8342    /**
8343     * @brief Sets the state of the toggle to @p state.
8344     *
8345     * @param obj The toggle object
8346     * @param state The state of @p obj
8347     *
8348     * @deprecated use elm_check_state_set() instead.
8349     */
8350    EINA_DEPRECATED EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
8351
8352    /**
8353     * @brief Gets the state of the toggle to @p state.
8354     *
8355     * @param obj The toggle object
8356     * @return The state of @p obj
8357     *
8358     * @deprecated use elm_check_state_get() instead.
8359     */
8360    EINA_DEPRECATED EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8361
8362    /**
8363     * @brief Sets the state pointer of the toggle to @p statep.
8364     *
8365     * @param obj The toggle object
8366     * @param statep The state pointer of @p obj
8367     *
8368     * @deprecated use elm_check_state_pointer_set() instead.
8369     */
8370    EINA_DEPRECATED EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
8371
8372    /**
8373     * @}
8374     */
8375
8376    /**
8377     * @defgroup Frame Frame
8378     *
8379     * @image html img/widget/frame/preview-00.png
8380     * @image latex img/widget/frame/preview-00.eps
8381     *
8382     * @brief Frame is a widget that holds some content and has a title.
8383     *
8384     * The default look is a frame with a title, but Frame supports multple
8385     * styles:
8386     * @li default
8387     * @li pad_small
8388     * @li pad_medium
8389     * @li pad_large
8390     * @li pad_huge
8391     * @li outdent_top
8392     * @li outdent_bottom
8393     *
8394     * Of all this styles only default shows the title. Frame emits no signals.
8395     *
8396     * Default contents parts of the frame widget that you can use for are:
8397     * @li "default" - A content of the frame
8398     *
8399     * Default text parts of the frame widget that you can use for are:
8400     * @li "elm.text" - Label of the frame
8401     *
8402     * For a detailed example see the @ref tutorial_frame.
8403     *
8404     * @{
8405     */
8406
8407    /**
8408     * @brief Add a new frame to the parent
8409     *
8410     * @param parent The parent object
8411     * @return The new object or NULL if it cannot be created
8412     */
8413    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8414
8415    /**
8416     * @brief Set the frame label
8417     *
8418     * @param obj The frame object
8419     * @param label The label of this frame object
8420     *
8421     * @deprecated use elm_object_text_set() instead.
8422     */
8423    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8424
8425    /**
8426     * @brief Get the frame label
8427     *
8428     * @param obj The frame object
8429     *
8430     * @return The label of this frame objet or NULL if unable to get frame
8431     *
8432     * @deprecated use elm_object_text_get() instead.
8433     */
8434    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8435
8436    /**
8437     * @brief Set the content of the frame widget
8438     *
8439     * Once the content object is set, a previously set one will be deleted.
8440     * If you want to keep that old content object, use the
8441     * elm_frame_content_unset() function.
8442     *
8443     * @param obj The frame object
8444     * @param content The content will be filled in this frame object
8445     *
8446     * @deprecated use elm_object_content_set() instead.
8447     */
8448    EINA_DEPRECATED EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8449
8450    /**
8451     * @brief Get the content of the frame widget
8452     *
8453     * Return the content object which is set for this widget
8454     *
8455     * @param obj The frame object
8456     * @return The content that is being used
8457     *
8458     * @deprecated use elm_object_content_get() instead.
8459     */
8460    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8461
8462    /**
8463     * @brief Unset the content of the frame widget
8464     *
8465     * Unparent and return the content object which was set for this widget
8466     *
8467     * @param obj The frame object
8468     * @return The content that was being used
8469     *
8470     * @deprecated use elm_object_content_unset() instead.
8471     */
8472    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8473
8474    /**
8475     * @}
8476     */
8477
8478    /**
8479     * @defgroup Table Table
8480     *
8481     * A container widget to arrange other widgets in a table where items can
8482     * also span multiple columns or rows - even overlap (and then be raised or
8483     * lowered accordingly to adjust stacking if they do overlap).
8484     *
8485     * For a Table widget the row/column count is not fixed.
8486     * The table widget adjusts itself when subobjects are added to it dynamically.
8487     *
8488     * The followin are examples of how to use a table:
8489     * @li @ref tutorial_table_01
8490     * @li @ref tutorial_table_02
8491     *
8492     * @{
8493     */
8494
8495    /**
8496     * @brief Add a new table to the parent
8497     *
8498     * @param parent The parent object
8499     * @return The new object or NULL if it cannot be created
8500     */
8501    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8502
8503    /**
8504     * @brief Set the homogeneous layout in the table
8505     *
8506     * @param obj The layout object
8507     * @param homogeneous A boolean to set if the layout is homogeneous in the
8508     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
8509     */
8510    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
8511
8512    /**
8513     * @brief Get the current table homogeneous mode.
8514     *
8515     * @param obj The table object
8516     * @return A boolean to indicating if the layout is homogeneous in the table
8517     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
8518     */
8519    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8520
8521    /**
8522     * @brief Set padding between cells.
8523     *
8524     * @param obj The layout object.
8525     * @param horizontal set the horizontal padding.
8526     * @param vertical set the vertical padding.
8527     *
8528     * Default value is 0.
8529     */
8530    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
8531
8532    /**
8533     * @brief Get padding between cells.
8534     *
8535     * @param obj The layout object.
8536     * @param horizontal set the horizontal padding.
8537     * @param vertical set the vertical padding.
8538     */
8539    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
8540
8541    /**
8542     * @brief Add a subobject on the table with the coordinates passed
8543     *
8544     * @param obj The table object
8545     * @param subobj The subobject to be added to the table
8546     * @param x Row number
8547     * @param y Column number
8548     * @param w rowspan
8549     * @param h colspan
8550     *
8551     * @note All positioning inside the table is relative to rows and columns, so
8552     * a value of 0 for x and y, means the top left cell of the table, and a
8553     * value of 1 for w and h means @p subobj only takes that 1 cell.
8554     */
8555    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8556
8557    /**
8558     * @brief Remove child from table.
8559     *
8560     * @param obj The table object
8561     * @param subobj The subobject
8562     */
8563    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8564
8565    /**
8566     * @brief Faster way to remove all child objects from a table object.
8567     *
8568     * @param obj The table object
8569     * @param clear If true, will delete children, else just remove from table.
8570     */
8571    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8572
8573    /**
8574     * @brief Set the packing location of an existing child of the table
8575     *
8576     * @param subobj The subobject to be modified in the table
8577     * @param x Row number
8578     * @param y Column number
8579     * @param w rowspan
8580     * @param h colspan
8581     *
8582     * Modifies the position of an object already in the table.
8583     *
8584     * @note All positioning inside the table is relative to rows and columns, so
8585     * a value of 0 for x and y, means the top left cell of the table, and a
8586     * value of 1 for w and h means @p subobj only takes that 1 cell.
8587     */
8588    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8589
8590    /**
8591     * @brief Get the packing location of an existing child of the table
8592     *
8593     * @param subobj The subobject to be modified in the table
8594     * @param x Row number
8595     * @param y Column number
8596     * @param w rowspan
8597     * @param h colspan
8598     *
8599     * @see elm_table_pack_set()
8600     */
8601    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8602
8603    /**
8604     * @}
8605     */
8606
8607    /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
8608    typedef struct Elm_Gen_Item Elm_Gen_Item;
8609    typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
8610    typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
8611    typedef char        *(*Elm_Gen_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
8612    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. */
8613    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. */
8614    typedef void         (*Elm_Gen_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
8615    struct _Elm_Gen_Item_Class
8616      {
8617         const char             *item_style;
8618         struct _Elm_Gen_Item_Class_Func
8619           {
8620              Elm_Gen_Item_Text_Get_Cb  text_get;
8621              Elm_Gen_Item_Content_Get_Cb  content_get;
8622              Elm_Gen_Item_State_Get_Cb state_get;
8623              Elm_Gen_Item_Del_Cb       del;
8624           } func;
8625      };
8626    EINA_DEPRECATED EAPI void elm_gen_clear(Evas_Object *obj);
8627    EINA_DEPRECATED EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8628    EINA_DEPRECATED EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8629    EINA_DEPRECATED EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8630    EINA_DEPRECATED EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8631    EINA_DEPRECATED EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8632    EINA_DEPRECATED EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8633    EINA_DEPRECATED EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8634    EINA_DEPRECATED EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8635    EINA_DEPRECATED EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8636    EINA_DEPRECATED EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8637
8638    EINA_DEPRECATED EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8639    EINA_DEPRECATED EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8640    EINA_DEPRECATED EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8641    EINA_DEPRECATED EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8642    EINA_DEPRECATED EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8643    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8644    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8645    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8646    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8647    EINA_DEPRECATED EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8648
8649    /**
8650     * @defgroup Gengrid Gengrid (Generic grid)
8651     *
8652     * This widget aims to position objects in a grid layout while
8653     * actually creating and rendering only the visible ones, using the
8654     * same idea as the @ref Genlist "genlist": the user defines a @b
8655     * class for each item, specifying functions that will be called at
8656     * object creation, deletion, etc. When those items are selected by
8657     * the user, a callback function is issued. Users may interact with
8658     * a gengrid via the mouse (by clicking on items to select them and
8659     * clicking on the grid's viewport and swiping to pan the whole
8660     * view) or via the keyboard, navigating through item with the
8661     * arrow keys.
8662     *
8663     * @section Gengrid_Layouts Gengrid layouts
8664     *
8665     * Gengrid may layout its items in one of two possible layouts:
8666     * - horizontal or
8667     * - vertical.
8668     *
8669     * When in "horizontal mode", items will be placed in @b columns,
8670     * from top to bottom and, when the space for a column is filled,
8671     * another one is started on the right, thus expanding the grid
8672     * horizontally, making for horizontal scrolling. When in "vertical
8673     * mode" , though, items will be placed in @b rows, from left to
8674     * right and, when the space for a row is filled, another one is
8675     * started below, thus expanding the grid vertically (and making
8676     * for vertical scrolling).
8677     *
8678     * @section Gengrid_Items Gengrid items
8679     *
8680     * An item in a gengrid can have 0 or more texts (they can be
8681     * regular text or textblock Evas objects - that's up to the style
8682     * to determine), 0 or more contents (which are simply objects
8683     * swallowed into the gengrid item's theming Edje object) and 0 or
8684     * more <b>boolean states</b>, which have the behavior left to the
8685     * user to define. The Edje part names for each of these properties
8686     * will be looked up, in the theme file for the gengrid, under the
8687     * Edje (string) data items named @c "texts", @c "contents" and @c
8688     * "states", respectively. For each of those properties, if more
8689     * than one part is provided, they must have names listed separated
8690     * by spaces in the data fields. For the default gengrid item
8691     * theme, we have @b one text part (@c "elm.text"), @b two content 
8692     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8693     * no state parts.
8694     *
8695     * A gengrid item may be at one of several styles. Elementary
8696     * provides one by default - "default", but this can be extended by
8697     * system or application custom themes/overlays/extensions (see
8698     * @ref Theme "themes" for more details).
8699     *
8700     * @section Gengrid_Item_Class Gengrid item classes
8701     *
8702     * In order to have the ability to add and delete items on the fly,
8703     * gengrid implements a class (callback) system where the
8704     * application provides a structure with information about that
8705     * type of item (gengrid may contain multiple different items with
8706     * different classes, states and styles). Gengrid will call the
8707     * functions in this struct (methods) when an item is "realized"
8708     * (i.e., created dynamically, while the user is scrolling the
8709     * grid). All objects will simply be deleted when no longer needed
8710     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8711     * contains the following members:
8712     * - @c item_style - This is a constant string and simply defines
8713     * the name of the item style. It @b must be specified and the
8714     * default should be @c "default".
8715     * - @c func.text_get - This function is called when an item
8716     * object is actually created. The @c data parameter will point to
8717     * the same data passed to elm_gengrid_item_append() and related
8718     * item creation functions. The @c obj parameter is the gengrid
8719     * object itself, while the @c part one is the name string of one
8720     * of the existing text parts in the Edje group implementing the
8721     * item's theme. This function @b must return a strdup'()ed string,
8722     * as the caller will free() it when done. See
8723     * #Elm_Gengrid_Item_Text_Get_Cb.
8724     * - @c func.content_get - This function is called when an item object
8725     * is actually created. The @c data parameter will point to the
8726     * same data passed to elm_gengrid_item_append() and related item
8727     * creation functions. The @c obj parameter is the gengrid object
8728     * itself, while the @c part one is the name string of one of the
8729     * existing (content) swallow parts in the Edje group implementing the
8730     * item's theme. It must return @c NULL, when no content is desired,
8731     * or a valid object handle, otherwise. The object will be deleted
8732     * by the gengrid on its deletion or when the item is "unrealized".
8733     * See #Elm_Gengrid_Item_Content_Get_Cb.
8734     * - @c func.state_get - This function is called when an item
8735     * object is actually created. The @c data parameter will point to
8736     * the same data passed to elm_gengrid_item_append() and related
8737     * item creation functions. The @c obj parameter is the gengrid
8738     * object itself, while the @c part one is the name string of one
8739     * of the state parts in the Edje group implementing the item's
8740     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8741     * true/on. Gengrids will emit a signal to its theming Edje object
8742     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8743     * "source" arguments, respectively, when the state is true (the
8744     * default is false), where @c XXX is the name of the (state) part.
8745     * See #Elm_Gengrid_Item_State_Get_Cb.
8746     * - @c func.del - This is called when elm_gengrid_item_del() is
8747     * called on an item or elm_gengrid_clear() is called on the
8748     * gengrid. This is intended for use when gengrid items are
8749     * deleted, so any data attached to the item (e.g. its data
8750     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8751     *
8752     * @section Gengrid_Usage_Hints Usage hints
8753     *
8754     * If the user wants to have multiple items selected at the same
8755     * time, elm_gengrid_multi_select_set() will permit it. If the
8756     * gengrid is single-selection only (the default), then
8757     * elm_gengrid_select_item_get() will return the selected item or
8758     * @c NULL, if none is selected. If the gengrid is under
8759     * multi-selection, then elm_gengrid_selected_items_get() will
8760     * return a list (that is only valid as long as no items are
8761     * modified (added, deleted, selected or unselected) of child items
8762     * on a gengrid.
8763     *
8764     * If an item changes (internal (boolean) state, text or content
8765     * changes), then use elm_gengrid_item_update() to have gengrid
8766     * update the item with the new state. A gengrid will re-"realize"
8767     * the item, thus calling the functions in the
8768     * #Elm_Gengrid_Item_Class set for that item.
8769     *
8770     * To programmatically (un)select an item, use
8771     * elm_gengrid_item_selected_set(). To get its selected state use
8772     * elm_gengrid_item_selected_get(). To make an item disabled
8773     * (unable to be selected and appear differently) use
8774     * elm_gengrid_item_disabled_set() to set this and
8775     * elm_gengrid_item_disabled_get() to get the disabled state.
8776     *
8777     * Grid cells will only have their selection smart callbacks called
8778     * when firstly getting selected. Any further clicks will do
8779     * nothing, unless you enable the "always select mode", with
8780     * elm_gengrid_always_select_mode_set(), thus making every click to
8781     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8782     * turn off the ability to select items entirely in the widget and
8783     * they will neither appear selected nor call the selection smart
8784     * callbacks.
8785     *
8786     * Remember that you can create new styles and add your own theme
8787     * augmentation per application with elm_theme_extension_add(). If
8788     * you absolutely must have a specific style that overrides any
8789     * theme the user or system sets up you can use
8790     * elm_theme_overlay_add() to add such a file.
8791     *
8792     * @section Gengrid_Smart_Events Gengrid smart events
8793     *
8794     * Smart events that you can add callbacks for are:
8795     * - @c "activated" - The user has double-clicked or pressed
8796     *   (enter|return|spacebar) on an item. The @c event_info parameter
8797     *   is the gengrid item that was activated.
8798     * - @c "clicked,double" - The user has double-clicked an item.
8799     *   The @c event_info parameter is the gengrid item that was double-clicked.
8800     * - @c "longpressed" - This is called when the item is pressed for a certain
8801     *   amount of time. By default it's 1 second.
8802     * - @c "selected" - The user has made an item selected. The
8803     *   @c event_info parameter is the gengrid item that was selected.
8804     * - @c "unselected" - The user has made an item unselected. The
8805     *   @c event_info parameter is the gengrid item that was unselected.
8806     * - @c "realized" - This is called when the item in the gengrid
8807     *   has its implementing Evas object instantiated, de facto. @c
8808     *   event_info is the gengrid item that was created. The object
8809     *   may be deleted at any time, so it is highly advised to the
8810     *   caller @b not to use the object pointer returned from
8811     *   elm_gengrid_item_object_get(), because it may point to freed
8812     *   objects.
8813     * - @c "unrealized" - This is called when the implementing Evas
8814     *   object for this item is deleted. @c event_info is the gengrid
8815     *   item that was deleted.
8816     * - @c "changed" - Called when an item is added, removed, resized
8817     *   or moved and when the gengrid is resized or gets "horizontal"
8818     *   property changes.
8819     * - @c "scroll,anim,start" - This is called when scrolling animation has
8820     *   started.
8821     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8822     *   stopped.
8823     * - @c "drag,start,up" - Called when the item in the gengrid has
8824     *   been dragged (not scrolled) up.
8825     * - @c "drag,start,down" - Called when the item in the gengrid has
8826     *   been dragged (not scrolled) down.
8827     * - @c "drag,start,left" - Called when the item in the gengrid has
8828     *   been dragged (not scrolled) left.
8829     * - @c "drag,start,right" - Called when the item in the gengrid has
8830     *   been dragged (not scrolled) right.
8831     * - @c "drag,stop" - Called when the item in the gengrid has
8832     *   stopped being dragged.
8833     * - @c "drag" - Called when the item in the gengrid is being
8834     *   dragged.
8835     * - @c "scroll" - called when the content has been scrolled
8836     *   (moved).
8837     * - @c "scroll,drag,start" - called when dragging the content has
8838     *   started.
8839     * - @c "scroll,drag,stop" - called when dragging the content has
8840     *   stopped.
8841     * - @c "edge,top" - This is called when the gengrid is scrolled until
8842     *   the top edge.
8843     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8844     *   until the bottom edge.
8845     * - @c "edge,left" - This is called when the gengrid is scrolled
8846     *   until the left edge.
8847     * - @c "edge,right" - This is called when the gengrid is scrolled
8848     *   until the right edge.
8849     *
8850     * List of gengrid examples:
8851     * @li @ref gengrid_example
8852     */
8853
8854    /**
8855     * @addtogroup Gengrid
8856     * @{
8857     */
8858
8859    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8860    #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8861    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8862    #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8863    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8864
8865    /**
8866     * Text fetching class function for Elm_Gen_Item_Class.
8867     * @param data The data passed in the item creation function
8868     * @param obj The base widget object
8869     * @param part The part name of the swallow
8870     * @return The allocated (NOT stringshared) string to set as the text 
8871     */
8872    typedef char        *(*Elm_Gengrid_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8873
8874    /**
8875     * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8876     * @param data The data passed in the item creation function
8877     * @param obj The base widget object
8878     * @param part The part name of the swallow
8879     * @return The content object to swallow
8880     */
8881    typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part);
8882
8883    /**
8884     * State fetching class function for Elm_Gen_Item_Class.
8885     * @param data The data passed in the item creation function
8886     * @param obj The base widget object
8887     * @param part The part name of the swallow
8888     * @return The hell if I know
8889     */
8890    typedef Eina_Bool    (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8891
8892    /**
8893     * Deletion class function for Elm_Gen_Item_Class.
8894     * @param data The data passed in the item creation function
8895     * @param obj The base widget object
8896     */
8897    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj);
8898
8899    /**
8900     * @struct _Elm_Gengrid_Item_Class
8901     *
8902     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8903     * field details.
8904     */
8905    struct _Elm_Gengrid_Item_Class
8906      {
8907         const char             *item_style;
8908         struct _Elm_Gengrid_Item_Class_Func
8909           {
8910              Elm_Gengrid_Item_Text_Get_Cb    text_get; /**< Text fetching class function for gengrid item classes.*/
8911              Elm_Gengrid_Item_Content_Get_Cb content_get; /**< Content fetching class function for gengrid item classes. */
8912              Elm_Gengrid_Item_State_Get_Cb   state_get; /**< State fetching class function for gengrid item classes. */
8913              Elm_Gengrid_Item_Del_Cb         del; /**< Deletion class function for gengrid item classes. */
8914           } func;
8915      }; /**< #Elm_Gengrid_Item_Class member definitions */
8916    #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8917
8918    /**
8919     * Add a new gengrid widget to the given parent Elementary
8920     * (container) object
8921     *
8922     * @param parent The parent object
8923     * @return a new gengrid widget handle or @c NULL, on errors
8924     *
8925     * This function inserts a new gengrid widget on the canvas.
8926     *
8927     * @see elm_gengrid_item_size_set()
8928     * @see elm_gengrid_group_item_size_set()
8929     * @see elm_gengrid_horizontal_set()
8930     * @see elm_gengrid_item_append()
8931     * @see elm_gengrid_item_del()
8932     * @see elm_gengrid_clear()
8933     *
8934     * @ingroup Gengrid
8935     */
8936    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8937
8938    /**
8939     * Set the size for the items of a given gengrid widget
8940     *
8941     * @param obj The gengrid object.
8942     * @param w The items' width.
8943     * @param h The items' height;
8944     *
8945     * A gengrid, after creation, has still no information on the size
8946     * to give to each of its cells. So, you most probably will end up
8947     * with squares one @ref Fingers "finger" wide, the default
8948     * size. Use this function to force a custom size for you items,
8949     * making them as big as you wish.
8950     *
8951     * @see elm_gengrid_item_size_get()
8952     *
8953     * @ingroup Gengrid
8954     */
8955    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8956
8957    /**
8958     * Get the size set for the items of a given gengrid widget
8959     *
8960     * @param obj The gengrid object.
8961     * @param w Pointer to a variable where to store the items' width.
8962     * @param h Pointer to a variable where to store the items' height.
8963     *
8964     * @note Use @c NULL pointers on the size values you're not
8965     * interested in: they'll be ignored by the function.
8966     *
8967     * @see elm_gengrid_item_size_get() for more details
8968     *
8969     * @ingroup Gengrid
8970     */
8971    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8972
8973    /**
8974     * Set the size for the group items of a given gengrid widget
8975     *
8976     * @param obj The gengrid object.
8977     * @param w The group items' width.
8978     * @param h The group items' height;
8979     *
8980     * A gengrid, after creation, has still no information on the size
8981     * to give to each of its cells. So, you most probably will end up
8982     * with squares one @ref Fingers "finger" wide, the default
8983     * size. Use this function to force a custom size for you group items,
8984     * making them as big as you wish.
8985     *
8986     * @see elm_gengrid_group_item_size_get()
8987     *
8988     * @ingroup Gengrid
8989     */
8990    EAPI void               elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8991
8992    /**
8993     * Get the size set for the group items of a given gengrid widget
8994     *
8995     * @param obj The gengrid object.
8996     * @param w Pointer to a variable where to store the group items' width.
8997     * @param h Pointer to a variable where to store the group items' height.
8998     *
8999     * @note Use @c NULL pointers on the size values you're not
9000     * interested in: they'll be ignored by the function.
9001     *
9002     * @see elm_gengrid_group_item_size_get() for more details
9003     *
9004     * @ingroup Gengrid
9005     */
9006    EAPI void               elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
9007
9008    /**
9009     * Set the items grid's alignment within a given gengrid widget
9010     *
9011     * @param obj The gengrid object.
9012     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
9013     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
9014     *
9015     * This sets the alignment of the whole grid of items of a gengrid
9016     * within its given viewport. By default, those values are both
9017     * 0.5, meaning that the gengrid will have its items grid placed
9018     * exactly in the middle of its viewport.
9019     *
9020     * @note If given alignment values are out of the cited ranges,
9021     * they'll be changed to the nearest boundary values on the valid
9022     * ranges.
9023     *
9024     * @see elm_gengrid_align_get()
9025     *
9026     * @ingroup Gengrid
9027     */
9028    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
9029
9030    /**
9031     * Get the items grid's alignment values within a given gengrid
9032     * widget
9033     *
9034     * @param obj The gengrid object.
9035     * @param align_x Pointer to a variable where to store the
9036     * horizontal alignment.
9037     * @param align_y Pointer to a variable where to store the vertical
9038     * alignment.
9039     *
9040     * @note Use @c NULL pointers on the alignment values you're not
9041     * interested in: they'll be ignored by the function.
9042     *
9043     * @see elm_gengrid_align_set() for more details
9044     *
9045     * @ingroup Gengrid
9046     */
9047    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
9048
9049    /**
9050     * Set whether a given gengrid widget is or not able have items
9051     * @b reordered
9052     *
9053     * @param obj The gengrid object
9054     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
9055     * @c EINA_FALSE to turn it off
9056     *
9057     * If a gengrid is set to allow reordering, a click held for more
9058     * than 0.5 over a given item will highlight it specially,
9059     * signalling the gengrid has entered the reordering state. From
9060     * that time on, the user will be able to, while still holding the
9061     * mouse button down, move the item freely in the gengrid's
9062     * viewport, replacing to said item to the locations it goes to.
9063     * The replacements will be animated and, whenever the user
9064     * releases the mouse button, the item being replaced gets a new
9065     * definitive place in the grid.
9066     *
9067     * @see elm_gengrid_reorder_mode_get()
9068     *
9069     * @ingroup Gengrid
9070     */
9071    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
9072
9073    /**
9074     * Get whether a given gengrid widget is or not able have items
9075     * @b reordered
9076     *
9077     * @param obj The gengrid object
9078     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
9079     * off
9080     *
9081     * @see elm_gengrid_reorder_mode_set() for more details
9082     *
9083     * @ingroup Gengrid
9084     */
9085    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9086
9087    /**
9088     * Append a new item in a given gengrid widget.
9089     *
9090     * @param obj The gengrid object.
9091     * @param gic The item class for the item.
9092     * @param data The item data.
9093     * @param func Convenience function called when the item is
9094     * selected.
9095     * @param func_data Data to be passed to @p func.
9096     * @return A handle to the item added or @c NULL, on errors.
9097     *
9098     * This adds an item to the beginning of the gengrid.
9099     *
9100     * @see elm_gengrid_item_prepend()
9101     * @see elm_gengrid_item_insert_before()
9102     * @see elm_gengrid_item_insert_after()
9103     * @see elm_gengrid_item_del()
9104     *
9105     * @ingroup Gengrid
9106     */
9107    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);
9108
9109    /**
9110     * Prepend a new item in a given gengrid widget.
9111     *
9112     * @param obj The gengrid object.
9113     * @param gic The item class for the item.
9114     * @param data The item data.
9115     * @param func Convenience function called when the item is
9116     * selected.
9117     * @param func_data Data to be passed to @p func.
9118     * @return A handle to the item added or @c NULL, on errors.
9119     *
9120     * This adds an item to the end of the gengrid.
9121     *
9122     * @see elm_gengrid_item_append()
9123     * @see elm_gengrid_item_insert_before()
9124     * @see elm_gengrid_item_insert_after()
9125     * @see elm_gengrid_item_del()
9126     *
9127     * @ingroup Gengrid
9128     */
9129    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);
9130
9131    /**
9132     * Insert an item before another in a gengrid widget
9133     *
9134     * @param obj The gengrid object.
9135     * @param gic The item class for the item.
9136     * @param data The item data.
9137     * @param relative The item to place this new one before.
9138     * @param func Convenience function called when the item is
9139     * selected.
9140     * @param func_data Data to be passed to @p func.
9141     * @return A handle to the item added or @c NULL, on errors.
9142     *
9143     * This inserts an item before another in the gengrid.
9144     *
9145     * @see elm_gengrid_item_append()
9146     * @see elm_gengrid_item_prepend()
9147     * @see elm_gengrid_item_insert_after()
9148     * @see elm_gengrid_item_del()
9149     *
9150     * @ingroup Gengrid
9151     */
9152    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);
9153
9154    /**
9155     * Insert an item after another in a gengrid widget
9156     *
9157     * @param obj The gengrid object.
9158     * @param gic The item class for the item.
9159     * @param data The item data.
9160     * @param relative The item to place this new one after.
9161     * @param func Convenience function called when the item is
9162     * selected.
9163     * @param func_data Data to be passed to @p func.
9164     * @return A handle to the item added or @c NULL, on errors.
9165     *
9166     * This inserts an item after another in the gengrid.
9167     *
9168     * @see elm_gengrid_item_append()
9169     * @see elm_gengrid_item_prepend()
9170     * @see elm_gengrid_item_insert_after()
9171     * @see elm_gengrid_item_del()
9172     *
9173     * @ingroup Gengrid
9174     */
9175    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);
9176
9177    /**
9178     * Insert an item in a gengrid widget using a user-defined sort function.
9179     *
9180     * @param obj The gengrid object.
9181     * @param gic The item class for the item.
9182     * @param data The item data.
9183     * @param comp User defined comparison function that defines the sort order based on
9184     * Elm_Gen_Item and its data param.
9185     * @param func Convenience function called when the item is selected.
9186     * @param func_data Data to be passed to @p func.
9187     * @return A handle to the item added or @c NULL, on errors.
9188     *
9189     * This inserts an item in the gengrid based on user defined comparison function.
9190     *
9191     * @see elm_gengrid_item_append()
9192     * @see elm_gengrid_item_prepend()
9193     * @see elm_gengrid_item_insert_after()
9194     * @see elm_gengrid_item_del()
9195     * @see elm_gengrid_item_direct_sorted_insert()
9196     *
9197     * @ingroup Gengrid
9198     */
9199    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);
9200
9201    /**
9202     * Insert an item in a gengrid widget using a user-defined sort function.
9203     *
9204     * @param obj The gengrid object.
9205     * @param gic The item class for the item.
9206     * @param data The item data.
9207     * @param comp User defined comparison function that defines the sort order based on
9208     * Elm_Gen_Item.
9209     * @param func Convenience function called when the item is selected.
9210     * @param func_data Data to be passed to @p func.
9211     * @return A handle to the item added or @c NULL, on errors.
9212     *
9213     * This inserts an item in the gengrid based on user defined comparison function.
9214     *
9215     * @see elm_gengrid_item_append()
9216     * @see elm_gengrid_item_prepend()
9217     * @see elm_gengrid_item_insert_after()
9218     * @see elm_gengrid_item_del()
9219     * @see elm_gengrid_item_sorted_insert()
9220     *
9221     * @ingroup Gengrid
9222     */
9223    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);
9224
9225    /**
9226     * Set whether items on a given gengrid widget are to get their
9227     * selection callbacks issued for @b every subsequent selection
9228     * click on them or just for the first click.
9229     *
9230     * @param obj The gengrid object
9231     * @param always_select @c EINA_TRUE to make items "always
9232     * selected", @c EINA_FALSE, otherwise
9233     *
9234     * By default, grid items will only call their selection callback
9235     * function when firstly getting selected, any subsequent further
9236     * clicks will do nothing. With this call, you make those
9237     * subsequent clicks also to issue the selection callbacks.
9238     *
9239     * @note <b>Double clicks</b> will @b always be reported on items.
9240     *
9241     * @see elm_gengrid_always_select_mode_get()
9242     *
9243     * @ingroup Gengrid
9244     */
9245    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
9246
9247    /**
9248     * Get whether items on a given gengrid widget have their selection
9249     * callbacks issued for @b every subsequent selection click on them
9250     * or just for the first click.
9251     *
9252     * @param obj The gengrid object.
9253     * @return @c EINA_TRUE if the gengrid items are "always selected",
9254     * @c EINA_FALSE, otherwise
9255     *
9256     * @see elm_gengrid_always_select_mode_set() for more details
9257     *
9258     * @ingroup Gengrid
9259     */
9260    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9261
9262    /**
9263     * Set whether items on a given gengrid widget can be selected or not.
9264     *
9265     * @param obj The gengrid object
9266     * @param no_select @c EINA_TRUE to make items selectable,
9267     * @c EINA_FALSE otherwise
9268     *
9269     * This will make items in @p obj selectable or not. In the latter
9270     * case, any user interaction on the gengrid items will neither make
9271     * them appear selected nor them call their selection callback
9272     * functions.
9273     *
9274     * @see elm_gengrid_no_select_mode_get()
9275     *
9276     * @ingroup Gengrid
9277     */
9278    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
9279
9280    /**
9281     * Get whether items on a given gengrid widget can be selected or
9282     * not.
9283     *
9284     * @param obj The gengrid object
9285     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
9286     * otherwise
9287     *
9288     * @see elm_gengrid_no_select_mode_set() for more details
9289     *
9290     * @ingroup Gengrid
9291     */
9292    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9293
9294    /**
9295     * Enable or disable multi-selection in a given gengrid widget
9296     *
9297     * @param obj The gengrid object.
9298     * @param multi @c EINA_TRUE, to enable multi-selection,
9299     * @c EINA_FALSE to disable it.
9300     *
9301     * Multi-selection is the ability to have @b more than one
9302     * item selected, on a given gengrid, simultaneously. When it is
9303     * enabled, a sequence of clicks on different items will make them
9304     * all selected, progressively. A click on an already selected item
9305     * will unselect it. If interacting via the keyboard,
9306     * multi-selection is enabled while holding the "Shift" key.
9307     *
9308     * @note By default, multi-selection is @b disabled on gengrids
9309     *
9310     * @see elm_gengrid_multi_select_get()
9311     *
9312     * @ingroup Gengrid
9313     */
9314    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
9315
9316    /**
9317     * Get whether multi-selection is enabled or disabled for a given
9318     * gengrid widget
9319     *
9320     * @param obj The gengrid object.
9321     * @return @c EINA_TRUE, if multi-selection is enabled, @c
9322     * EINA_FALSE otherwise
9323     *
9324     * @see elm_gengrid_multi_select_set() for more details
9325     *
9326     * @ingroup Gengrid
9327     */
9328    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9329
9330    /**
9331     * Enable or disable bouncing effect for a given gengrid widget
9332     *
9333     * @param obj The gengrid object
9334     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
9335     * @c EINA_FALSE to disable it
9336     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
9337     * @c EINA_FALSE to disable it
9338     *
9339     * The bouncing effect occurs whenever one reaches the gengrid's
9340     * edge's while panning it -- it will scroll past its limits a
9341     * little bit and return to the edge again, in a animated for,
9342     * automatically.
9343     *
9344     * @note By default, gengrids have bouncing enabled on both axis
9345     *
9346     * @see elm_gengrid_bounce_get()
9347     *
9348     * @ingroup Gengrid
9349     */
9350    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9351
9352    /**
9353     * Get whether bouncing effects are enabled or disabled, for a
9354     * given gengrid widget, on each axis
9355     *
9356     * @param obj The gengrid object
9357     * @param h_bounce Pointer to a variable where to store the
9358     * horizontal bouncing flag.
9359     * @param v_bounce Pointer to a variable where to store the
9360     * vertical bouncing flag.
9361     *
9362     * @see elm_gengrid_bounce_set() for more details
9363     *
9364     * @ingroup Gengrid
9365     */
9366    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9367
9368    /**
9369     * Set a given gengrid widget's scrolling page size, relative to
9370     * its viewport size.
9371     *
9372     * @param obj The gengrid object
9373     * @param h_pagerel The horizontal page (relative) size
9374     * @param v_pagerel The vertical page (relative) size
9375     *
9376     * The gengrid's scroller is capable of binding scrolling by the
9377     * user to "pages". It means that, while scrolling and, specially
9378     * after releasing the mouse button, the grid will @b snap to the
9379     * nearest displaying page's area. When page sizes are set, the
9380     * grid's continuous content area is split into (equal) page sized
9381     * pieces.
9382     *
9383     * This function sets the size of a page <b>relatively to the
9384     * viewport dimensions</b> of the gengrid, for each axis. A value
9385     * @c 1.0 means "the exact viewport's size", in that axis, while @c
9386     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
9387     * a viewport". Sane usable values are, than, between @c 0.0 and @c
9388     * 1.0. Values beyond those will make it behave behave
9389     * inconsistently. If you only want one axis to snap to pages, use
9390     * the value @c 0.0 for the other one.
9391     *
9392     * There is a function setting page size values in @b absolute
9393     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
9394     * is mutually exclusive to this one.
9395     *
9396     * @see elm_gengrid_page_relative_get()
9397     *
9398     * @ingroup Gengrid
9399     */
9400    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
9401
9402    /**
9403     * Get a given gengrid widget's scrolling page size, relative to
9404     * its viewport size.
9405     *
9406     * @param obj The gengrid object
9407     * @param h_pagerel Pointer to a variable where to store the
9408     * horizontal page (relative) size
9409     * @param v_pagerel Pointer to a variable where to store the
9410     * vertical page (relative) size
9411     *
9412     * @see elm_gengrid_page_relative_set() for more details
9413     *
9414     * @ingroup Gengrid
9415     */
9416    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
9417
9418    /**
9419     * Set a given gengrid widget's scrolling page size
9420     *
9421     * @param obj The gengrid object
9422     * @param h_pagerel The horizontal page size, in pixels
9423     * @param v_pagerel The vertical page size, in pixels
9424     *
9425     * The gengrid's scroller is capable of binding scrolling by the
9426     * user to "pages". It means that, while scrolling and, specially
9427     * after releasing the mouse button, the grid will @b snap to the
9428     * nearest displaying page's area. When page sizes are set, the
9429     * grid's continuous content area is split into (equal) page sized
9430     * pieces.
9431     *
9432     * This function sets the size of a page of the gengrid, in pixels,
9433     * for each axis. Sane usable values are, between @c 0 and the
9434     * dimensions of @p obj, for each axis. Values beyond those will
9435     * make it behave behave inconsistently. If you only want one axis
9436     * to snap to pages, use the value @c 0 for the other one.
9437     *
9438     * There is a function setting page size values in @b relative
9439     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
9440     * use is mutually exclusive to this one.
9441     *
9442     * @ingroup Gengrid
9443     */
9444    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
9445
9446    /**
9447     * @brief Get gengrid current page number.
9448     *
9449     * @param obj The gengrid object
9450     * @param h_pagenumber The horizontal page number
9451     * @param v_pagenumber The vertical page number
9452     *
9453     * The page number starts from 0. 0 is the first page.
9454     * Current page means the page which meet the top-left of the viewport.
9455     * If there are two or more pages in the viewport, it returns the number of page
9456     * which meet the top-left of the viewport.
9457     *
9458     * @see elm_gengrid_last_page_get()
9459     * @see elm_gengrid_page_show()
9460     * @see elm_gengrid_page_brint_in()
9461     */
9462    EAPI void         elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
9463
9464    /**
9465     * @brief Get scroll last page number.
9466     *
9467     * @param obj The gengrid object
9468     * @param h_pagenumber The horizontal page number
9469     * @param v_pagenumber The vertical page number
9470     *
9471     * The page number starts from 0. 0 is the first page.
9472     * This returns the last page number among the pages.
9473     *
9474     * @see elm_gengrid_current_page_get()
9475     * @see elm_gengrid_page_show()
9476     * @see elm_gengrid_page_brint_in()
9477     */
9478    EAPI void         elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
9479
9480    /**
9481     * Show a specific virtual region within the gengrid content object by page number.
9482     *
9483     * @param obj The gengrid object
9484     * @param h_pagenumber The horizontal page number
9485     * @param v_pagenumber The vertical page number
9486     *
9487     * 0, 0 of the indicated page is located at the top-left of the viewport.
9488     * This will jump to the page directly without animation.
9489     *
9490     * Example of usage:
9491     *
9492     * @code
9493     * sc = elm_gengrid_add(win);
9494     * elm_gengrid_content_set(sc, content);
9495     * elm_gengrid_page_relative_set(sc, 1, 0);
9496     * elm_gengrid_current_page_get(sc, &h_page, &v_page);
9497     * elm_gengrid_page_show(sc, h_page + 1, v_page);
9498     * @endcode
9499     *
9500     * @see elm_gengrid_page_bring_in()
9501     */
9502    EAPI void         elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9503
9504    /**
9505     * Show a specific virtual region within the gengrid content object by page number.
9506     *
9507     * @param obj The gengrid object
9508     * @param h_pagenumber The horizontal page number
9509     * @param v_pagenumber The vertical page number
9510     *
9511     * 0, 0 of the indicated page is located at the top-left of the viewport.
9512     * This will slide to the page with animation.
9513     *
9514     * Example of usage:
9515     *
9516     * @code
9517     * sc = elm_gengrid_add(win);
9518     * elm_gengrid_content_set(sc, content);
9519     * elm_gengrid_page_relative_set(sc, 1, 0);
9520     * elm_gengrid_last_page_get(sc, &h_page, &v_page);
9521     * elm_gengrid_page_bring_in(sc, h_page, v_page);
9522     * @endcode
9523     *
9524     * @see elm_gengrid_page_show()
9525     */
9526     EAPI void         elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9527
9528    /**
9529     * Set the direction in which a given gengrid widget will expand while
9530     * placing its items.
9531     *
9532     * @param obj The gengrid object.
9533     * @param setting @c EINA_TRUE to make the gengrid expand
9534     * horizontally, @c EINA_FALSE to expand vertically.
9535     *
9536     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
9537     * in @b columns, from top to bottom and, when the space for a
9538     * column is filled, another one is started on the right, thus
9539     * expanding the grid horizontally. When in "vertical mode"
9540     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
9541     * to right and, when the space for a row is filled, another one is
9542     * started below, thus expanding the grid vertically.
9543     *
9544     * @see elm_gengrid_horizontal_get()
9545     *
9546     * @ingroup Gengrid
9547     */
9548    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
9549
9550    /**
9551     * Get for what direction a given gengrid widget will expand while
9552     * placing its items.
9553     *
9554     * @param obj The gengrid object.
9555     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
9556     * @c EINA_FALSE if it's set to expand vertically.
9557     *
9558     * @see elm_gengrid_horizontal_set() for more detais
9559     *
9560     * @ingroup Gengrid
9561     */
9562    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9563
9564    /**
9565     * Get the first item in a given gengrid widget
9566     *
9567     * @param obj The gengrid object
9568     * @return The first item's handle or @c NULL, if there are no
9569     * items in @p obj (and on errors)
9570     *
9571     * This returns the first item in the @p obj's internal list of
9572     * items.
9573     *
9574     * @see elm_gengrid_last_item_get()
9575     *
9576     * @ingroup Gengrid
9577     */
9578    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9579
9580    /**
9581     * Get the last item in a given gengrid widget
9582     *
9583     * @param obj The gengrid object
9584     * @return The last item's handle or @c NULL, if there are no
9585     * items in @p obj (and on errors)
9586     *
9587     * This returns the last item in the @p obj's internal list of
9588     * items.
9589     *
9590     * @see elm_gengrid_first_item_get()
9591     *
9592     * @ingroup Gengrid
9593     */
9594    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9595
9596    /**
9597     * Get the @b next item in a gengrid widget's internal list of items,
9598     * given a handle to one of those items.
9599     *
9600     * @param item The gengrid item to fetch next from
9601     * @return The item after @p item, or @c NULL if there's none (and
9602     * on errors)
9603     *
9604     * This returns the item placed after the @p item, on the container
9605     * gengrid.
9606     *
9607     * @see elm_gengrid_item_prev_get()
9608     *
9609     * @ingroup Gengrid
9610     */
9611    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9612
9613    /**
9614     * Get the @b previous item in a gengrid widget's internal list of items,
9615     * given a handle to one of those items.
9616     *
9617     * @param item The gengrid item to fetch previous from
9618     * @return The item before @p item, or @c NULL if there's none (and
9619     * on errors)
9620     *
9621     * This returns the item placed before the @p item, on the container
9622     * gengrid.
9623     *
9624     * @see elm_gengrid_item_next_get()
9625     *
9626     * @ingroup Gengrid
9627     */
9628    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9629
9630    /**
9631     * Get the gengrid object's handle which contains a given gengrid
9632     * item
9633     *
9634     * @param item The item to fetch the container from
9635     * @return The gengrid (parent) object
9636     *
9637     * This returns the gengrid object itself that an item belongs to.
9638     *
9639     * @ingroup Gengrid
9640     */
9641    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9642
9643    /**
9644     * Remove a gengrid item from its parent, deleting it.
9645     *
9646     * @param item The item to be removed.
9647     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
9648     *
9649     * @see elm_gengrid_clear(), to remove all items in a gengrid at
9650     * once.
9651     *
9652     * @ingroup Gengrid
9653     */
9654    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9655
9656    /**
9657     * Update the contents of a given gengrid item
9658     *
9659     * @param item The gengrid item
9660     *
9661     * This updates an item by calling all the item class functions
9662     * again to get the contents, texts and states. Use this when the
9663     * original item data has changed and you want the changes to be
9664     * reflected.
9665     *
9666     * @ingroup Gengrid
9667     */
9668    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9669
9670    /**
9671     * Get the Gengrid Item class for the given Gengrid Item.
9672     *
9673     * @param item The gengrid item
9674     *
9675     * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9676     * the function pointers and item_style.
9677     *
9678     * @ingroup Gengrid
9679     */
9680    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9681
9682    /**
9683     * Get the Gengrid Item class for the given Gengrid Item.
9684     *
9685     * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9686     * the function pointers and item_style.
9687     *
9688     * @param item The gengrid item
9689     * @param gic The gengrid item class describing the function pointers and the item style.
9690     *
9691     * @ingroup Gengrid
9692     */
9693    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9694
9695    /**
9696     * Return the data associated to a given gengrid item
9697     *
9698     * @param item The gengrid item.
9699     * @return the data associated with this item.
9700     *
9701     * This returns the @c data value passed on the
9702     * elm_gengrid_item_append() and related item addition calls.
9703     *
9704     * @see elm_gengrid_item_append()
9705     * @see elm_gengrid_item_data_set()
9706     *
9707     * @ingroup Gengrid
9708     */
9709    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9710
9711    /**
9712     * Set the data associated with a given gengrid item
9713     *
9714     * @param item The gengrid item
9715     * @param data The data pointer to set on it
9716     *
9717     * This @b overrides the @c data value passed on the
9718     * elm_gengrid_item_append() and related item addition calls. This
9719     * function @b won't call elm_gengrid_item_update() automatically,
9720     * so you'd issue it afterwards if you want to have the item
9721     * updated to reflect the new data.
9722     *
9723     * @see elm_gengrid_item_data_get()
9724     * @see elm_gengrid_item_update()
9725     *
9726     * @ingroup Gengrid
9727     */
9728    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9729
9730    /**
9731     * Get a given gengrid item's position, relative to the whole
9732     * gengrid's grid area.
9733     *
9734     * @param item The Gengrid item.
9735     * @param x Pointer to variable to store the item's <b>row number</b>.
9736     * @param y Pointer to variable to store the item's <b>column number</b>.
9737     *
9738     * This returns the "logical" position of the item within the
9739     * gengrid. For example, @c (0, 1) would stand for first row,
9740     * second column.
9741     *
9742     * @ingroup Gengrid
9743     */
9744    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9745
9746    /**
9747     * Set whether a given gengrid item is selected or not
9748     *
9749     * @param item The gengrid item
9750     * @param selected Use @c EINA_TRUE, to make it selected, @c
9751     * EINA_FALSE to make it unselected
9752     *
9753     * This sets the selected state of an item. If multi-selection is
9754     * not enabled on the containing gengrid and @p selected is @c
9755     * EINA_TRUE, any other previously selected items will get
9756     * unselected in favor of this new one.
9757     *
9758     * @see elm_gengrid_item_selected_get()
9759     *
9760     * @ingroup Gengrid
9761     */
9762    EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9763
9764    /**
9765     * Get whether a given gengrid item is selected or not
9766     *
9767     * @param item The gengrid item
9768     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9769     *
9770     * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9771     *
9772     * @see elm_gengrid_item_selected_set() for more details
9773     *
9774     * @ingroup Gengrid
9775     */
9776    EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9777
9778    /**
9779     * Get the real Evas object created to implement the view of a
9780     * given gengrid item
9781     *
9782     * @param item The gengrid item.
9783     * @return the Evas object implementing this item's view.
9784     *
9785     * This returns the actual Evas object used to implement the
9786     * specified gengrid item's view. This may be @c NULL, as it may
9787     * not have been created or may have been deleted, at any time, by
9788     * the gengrid. <b>Do not modify this object</b> (move, resize,
9789     * show, hide, etc.), as the gengrid is controlling it. This
9790     * function is for querying, emitting custom signals or hooking
9791     * lower level callbacks for events on that object. Do not delete
9792     * this object under any circumstances.
9793     *
9794     * @see elm_gengrid_item_data_get()
9795     *
9796     * @ingroup Gengrid
9797     */
9798    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9799
9800    /**
9801     * Show the portion of a gengrid's internal grid containing a given
9802     * item, @b immediately.
9803     *
9804     * @param item The item to display
9805     *
9806     * This causes gengrid to @b redraw its viewport's contents to the
9807     * region contining the given @p item item, if it is not fully
9808     * visible.
9809     *
9810     * @see elm_gengrid_item_bring_in()
9811     *
9812     * @ingroup Gengrid
9813     */
9814    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9815
9816    /**
9817     * Animatedly bring in, to the visible area of a gengrid, a given
9818     * item on it.
9819     *
9820     * @param item The gengrid item to display
9821     *
9822     * This causes gengrid to jump to the given @p item and show
9823     * it (by scrolling), if it is not fully visible. This will use
9824     * animation to do so and take a period of time to complete.
9825     *
9826     * @see elm_gengrid_item_show()
9827     *
9828     * @ingroup Gengrid
9829     */
9830    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9831
9832    /**
9833     * Set whether a given gengrid item is disabled or not.
9834     *
9835     * @param item The gengrid item
9836     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9837     * to enable it back.
9838     *
9839     * A disabled item cannot be selected or unselected. It will also
9840     * change its appearance, to signal the user it's disabled.
9841     *
9842     * @see elm_gengrid_item_disabled_get()
9843     *
9844     * @ingroup Gengrid
9845     */
9846    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9847
9848    /**
9849     * Get whether a given gengrid item is disabled or not.
9850     *
9851     * @param item The gengrid item
9852     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9853     * (and on errors).
9854     *
9855     * @see elm_gengrid_item_disabled_set() for more details
9856     *
9857     * @ingroup Gengrid
9858     */
9859    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9860
9861    /**
9862     * Set the text to be shown in a given gengrid item's tooltips.
9863     *
9864     * @param item The gengrid item
9865     * @param text The text to set in the content
9866     *
9867     * This call will setup the text to be used as tooltip to that item
9868     * (analogous to elm_object_tooltip_text_set(), but being item
9869     * tooltips with higher precedence than object tooltips). It can
9870     * have only one tooltip at a time, so any previous tooltip data
9871     * will get removed.
9872     *
9873     * @ingroup Gengrid
9874     */
9875    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9876
9877    /**
9878     * Set the content to be shown in a given gengrid item's tooltip
9879     *
9880     * @param item The gengrid item.
9881     * @param func The function returning the tooltip contents.
9882     * @param data What to provide to @a func as callback data/context.
9883     * @param del_cb Called when data is not needed anymore, either when
9884     *        another callback replaces @p func, the tooltip is unset with
9885     *        elm_gengrid_item_tooltip_unset() or the owner @p item
9886     *        dies. This callback receives as its first parameter the
9887     *        given @p data, being @c event_info the item handle.
9888     *
9889     * This call will setup the tooltip's contents to @p item
9890     * (analogous to elm_object_tooltip_content_cb_set(), but being
9891     * item tooltips with higher precedence than object tooltips). It
9892     * can have only one tooltip at a time, so any previous tooltip
9893     * content will get removed. @p func (with @p data) will be called
9894     * every time Elementary needs to show the tooltip and it should
9895     * return a valid Evas object, which will be fully managed by the
9896     * tooltip system, getting deleted when the tooltip is gone.
9897     *
9898     * @ingroup Gengrid
9899     */
9900    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);
9901
9902    /**
9903     * Unset a tooltip from a given gengrid item
9904     *
9905     * @param item gengrid item to remove a previously set tooltip from.
9906     *
9907     * This call removes any tooltip set on @p item. The callback
9908     * provided as @c del_cb to
9909     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9910     * notify it is not used anymore (and have resources cleaned, if
9911     * need be).
9912     *
9913     * @see elm_gengrid_item_tooltip_content_cb_set()
9914     *
9915     * @ingroup Gengrid
9916     */
9917    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9918
9919    /**
9920     * Set a different @b style for a given gengrid item's tooltip.
9921     *
9922     * @param item gengrid item with tooltip set
9923     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9924     * "default", @c "transparent", etc)
9925     *
9926     * Tooltips can have <b>alternate styles</b> to be displayed on,
9927     * which are defined by the theme set on Elementary. This function
9928     * works analogously as elm_object_tooltip_style_set(), but here
9929     * applied only to gengrid item objects. The default style for
9930     * tooltips is @c "default".
9931     *
9932     * @note before you set a style you should define a tooltip with
9933     *       elm_gengrid_item_tooltip_content_cb_set() or
9934     *       elm_gengrid_item_tooltip_text_set()
9935     *
9936     * @see elm_gengrid_item_tooltip_style_get()
9937     *
9938     * @ingroup Gengrid
9939     */
9940    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9941
9942    /**
9943     * Get the style set a given gengrid item's tooltip.
9944     *
9945     * @param item gengrid item with tooltip already set on.
9946     * @return style the theme style in use, which defaults to
9947     *         "default". If the object does not have a tooltip set,
9948     *         then @c NULL is returned.
9949     *
9950     * @see elm_gengrid_item_tooltip_style_set() for more details
9951     *
9952     * @ingroup Gengrid
9953     */
9954    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9955
9956    /**
9957     * @brief Disable size restrictions on an object's tooltip
9958     * @param item The tooltip's anchor object
9959     * @param disable If EINA_TRUE, size restrictions are disabled
9960     * @return EINA_FALSE on failure, EINA_TRUE on success
9961     *
9962     * This function allows a tooltip to expand beyond its parant window's canvas.
9963     * It will instead be limited only by the size of the display.
9964     */
9965    EAPI Eina_Bool          elm_gengrid_item_tooltip_window_mode_set(Elm_Gengrid_Item *item, Eina_Bool disable);
9966
9967    /**
9968     * @brief Retrieve size restriction state of an object's tooltip
9969     * @param item The tooltip's anchor object
9970     * @return If EINA_TRUE, size restrictions are disabled
9971     *
9972     * This function returns whether a tooltip is allowed to expand beyond
9973     * its parant window's canvas.
9974     * It will instead be limited only by the size of the display.
9975     */
9976    EAPI Eina_Bool          elm_gengrid_item_tooltip_window_mode_get(const Elm_Gengrid_Item *item);
9977
9978    /**
9979     * Set the type of mouse pointer/cursor decoration to be shown,
9980     * when the mouse pointer is over the given gengrid widget item
9981     *
9982     * @param item gengrid item to customize cursor on
9983     * @param cursor the cursor type's name
9984     *
9985     * This function works analogously as elm_object_cursor_set(), but
9986     * here the cursor's changing area is restricted to the item's
9987     * area, and not the whole widget's. Note that that item cursors
9988     * have precedence over widget cursors, so that a mouse over @p
9989     * item will always show cursor @p type.
9990     *
9991     * If this function is called twice for an object, a previously set
9992     * cursor will be unset on the second call.
9993     *
9994     * @see elm_object_cursor_set()
9995     * @see elm_gengrid_item_cursor_get()
9996     * @see elm_gengrid_item_cursor_unset()
9997     *
9998     * @ingroup Gengrid
9999     */
10000    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
10001
10002    /**
10003     * Get the type of mouse pointer/cursor decoration set to be shown,
10004     * when the mouse pointer is over the given gengrid widget item
10005     *
10006     * @param item gengrid item with custom cursor set
10007     * @return the cursor type's name or @c NULL, if no custom cursors
10008     * were set to @p item (and on errors)
10009     *
10010     * @see elm_object_cursor_get()
10011     * @see elm_gengrid_item_cursor_set() for more details
10012     * @see elm_gengrid_item_cursor_unset()
10013     *
10014     * @ingroup Gengrid
10015     */
10016    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
10017
10018    /**
10019     * Unset any custom mouse pointer/cursor decoration set to be
10020     * shown, when the mouse pointer is over the given gengrid widget
10021     * item, thus making it show the @b default cursor again.
10022     *
10023     * @param item a gengrid item
10024     *
10025     * Use this call to undo any custom settings on this item's cursor
10026     * decoration, bringing it back to defaults (no custom style set).
10027     *
10028     * @see elm_object_cursor_unset()
10029     * @see elm_gengrid_item_cursor_set() for more details
10030     *
10031     * @ingroup Gengrid
10032     */
10033    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
10034
10035    /**
10036     * Set a different @b style for a given custom cursor set for a
10037     * gengrid item.
10038     *
10039     * @param item gengrid item with custom cursor set
10040     * @param style the <b>theme style</b> to use (e.g. @c "default",
10041     * @c "transparent", etc)
10042     *
10043     * This function only makes sense when one is using custom mouse
10044     * cursor decorations <b>defined in a theme file</b> , which can
10045     * have, given a cursor name/type, <b>alternate styles</b> on
10046     * it. It works analogously as elm_object_cursor_style_set(), but
10047     * here applied only to gengrid item objects.
10048     *
10049     * @warning Before you set a cursor style you should have defined a
10050     *       custom cursor previously on the item, with
10051     *       elm_gengrid_item_cursor_set()
10052     *
10053     * @see elm_gengrid_item_cursor_engine_only_set()
10054     * @see elm_gengrid_item_cursor_style_get()
10055     *
10056     * @ingroup Gengrid
10057     */
10058    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
10059
10060    /**
10061     * Get the current @b style set for a given gengrid item's custom
10062     * cursor
10063     *
10064     * @param item gengrid item with custom cursor set.
10065     * @return style the cursor style in use. If the object does not
10066     *         have a cursor set, then @c NULL is returned.
10067     *
10068     * @see elm_gengrid_item_cursor_style_set() for more details
10069     *
10070     * @ingroup Gengrid
10071     */
10072    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
10073
10074    /**
10075     * Set if the (custom) cursor for a given gengrid item should be
10076     * searched in its theme, also, or should only rely on the
10077     * rendering engine.
10078     *
10079     * @param item item with custom (custom) cursor already set on
10080     * @param engine_only Use @c EINA_TRUE to have cursors looked for
10081     * only on those provided by the rendering engine, @c EINA_FALSE to
10082     * have them searched on the widget's theme, as well.
10083     *
10084     * @note This call is of use only if you've set a custom cursor
10085     * for gengrid items, with elm_gengrid_item_cursor_set().
10086     *
10087     * @note By default, cursors will only be looked for between those
10088     * provided by the rendering engine.
10089     *
10090     * @ingroup Gengrid
10091     */
10092    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
10093
10094    /**
10095     * Get if the (custom) cursor for a given gengrid item is being
10096     * searched in its theme, also, or is only relying on the rendering
10097     * engine.
10098     *
10099     * @param item a gengrid item
10100     * @return @c EINA_TRUE, if cursors are being looked for only on
10101     * those provided by the rendering engine, @c EINA_FALSE if they
10102     * are being searched on the widget's theme, as well.
10103     *
10104     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
10105     *
10106     * @ingroup Gengrid
10107     */
10108    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
10109
10110    /**
10111     * Remove all items from a given gengrid widget
10112     *
10113     * @param obj The gengrid object.
10114     *
10115     * This removes (and deletes) all items in @p obj, leaving it
10116     * empty.
10117     *
10118     * @see elm_gengrid_item_del(), to remove just one item.
10119     *
10120     * @ingroup Gengrid
10121     */
10122    EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10123
10124    /**
10125     * Get the selected item in a given gengrid widget
10126     *
10127     * @param obj The gengrid object.
10128     * @return The selected item's handleor @c NULL, if none is
10129     * selected at the moment (and on errors)
10130     *
10131     * This returns the selected item in @p obj. If multi selection is
10132     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
10133     * the first item in the list is selected, which might not be very
10134     * useful. For that case, see elm_gengrid_selected_items_get().
10135     *
10136     * @ingroup Gengrid
10137     */
10138    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10139
10140    /**
10141     * Get <b>a list</b> of selected items in a given gengrid
10142     *
10143     * @param obj The gengrid object.
10144     * @return The list of selected items or @c NULL, if none is
10145     * selected at the moment (and on errors)
10146     *
10147     * This returns a list of the selected items, in the order that
10148     * they appear in the grid. This list is only valid as long as no
10149     * more items are selected or unselected (or unselected implictly
10150     * by deletion). The list contains #Elm_Gengrid_Item pointers as
10151     * data, naturally.
10152     *
10153     * @see elm_gengrid_selected_item_get()
10154     *
10155     * @ingroup Gengrid
10156     */
10157    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10158
10159    /**
10160     * @}
10161     */
10162
10163    /**
10164     * @defgroup Clock Clock
10165     *
10166     * @image html img/widget/clock/preview-00.png
10167     * @image latex img/widget/clock/preview-00.eps
10168     *
10169     * This is a @b digital clock widget. In its default theme, it has a
10170     * vintage "flipping numbers clock" appearance, which will animate
10171     * sheets of individual algarisms individually as time goes by.
10172     *
10173     * A newly created clock will fetch system's time (already
10174     * considering local time adjustments) to start with, and will tick
10175     * accondingly. It may or may not show seconds.
10176     *
10177     * Clocks have an @b edition mode. When in it, the sheets will
10178     * display extra arrow indications on the top and bottom and the
10179     * user may click on them to raise or lower the time values. After
10180     * it's told to exit edition mode, it will keep ticking with that
10181     * new time set (it keeps the difference from local time).
10182     *
10183     * Also, when under edition mode, user clicks on the cited arrows
10184     * which are @b held for some time will make the clock to flip the
10185     * sheet, thus editing the time, continuosly and automatically for
10186     * the user. The interval between sheet flips will keep growing in
10187     * time, so that it helps the user to reach a time which is distant
10188     * from the one set.
10189     *
10190     * The time display is, by default, in military mode (24h), but an
10191     * am/pm indicator may be optionally shown, too, when it will
10192     * switch to 12h.
10193     *
10194     * Smart callbacks one can register to:
10195     * - "changed" - the clock's user changed the time
10196     *
10197     * Here is an example on its usage:
10198     * @li @ref clock_example
10199     */
10200
10201    /**
10202     * @addtogroup Clock
10203     * @{
10204     */
10205
10206    /**
10207     * Identifiers for which clock digits should be editable, when a
10208     * clock widget is in edition mode. Values may be ORed together to
10209     * make a mask, naturally.
10210     *
10211     * @see elm_clock_edit_set()
10212     * @see elm_clock_digit_edit_set()
10213     */
10214    typedef enum _Elm_Clock_Digedit
10215      {
10216         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
10217         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
10218         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
10219         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
10220         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
10221         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
10222         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
10223         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
10224      } Elm_Clock_Digedit;
10225
10226    /**
10227     * Add a new clock widget to the given parent Elementary
10228     * (container) object
10229     *
10230     * @param parent The parent object
10231     * @return a new clock widget handle or @c NULL, on errors
10232     *
10233     * This function inserts a new clock widget on the canvas.
10234     *
10235     * @ingroup Clock
10236     */
10237    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10238
10239    /**
10240     * Set a clock widget's time, programmatically
10241     *
10242     * @param obj The clock widget object
10243     * @param hrs The hours to set
10244     * @param min The minutes to set
10245     * @param sec The secondes to set
10246     *
10247     * This function updates the time that is showed by the clock
10248     * widget.
10249     *
10250     *  Values @b must be set within the following ranges:
10251     * - 0 - 23, for hours
10252     * - 0 - 59, for minutes
10253     * - 0 - 59, for seconds,
10254     *
10255     * even if the clock is not in "military" mode.
10256     *
10257     * @warning The behavior for values set out of those ranges is @b
10258     * undefined.
10259     *
10260     * @ingroup Clock
10261     */
10262    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
10263
10264    /**
10265     * Get a clock widget's time values
10266     *
10267     * @param obj The clock object
10268     * @param[out] hrs Pointer to the variable to get the hours value
10269     * @param[out] min Pointer to the variable to get the minutes value
10270     * @param[out] sec Pointer to the variable to get the seconds value
10271     *
10272     * This function gets the time set for @p obj, returning
10273     * it on the variables passed as the arguments to function
10274     *
10275     * @note Use @c NULL pointers on the time values you're not
10276     * interested in: they'll be ignored by the function.
10277     *
10278     * @ingroup Clock
10279     */
10280    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
10281
10282    /**
10283     * Set whether a given clock widget is under <b>edition mode</b> or
10284     * under (default) displaying-only mode.
10285     *
10286     * @param obj The clock object
10287     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
10288     * put it back to "displaying only" mode
10289     *
10290     * This function makes a clock's time to be editable or not <b>by
10291     * user interaction</b>. When in edition mode, clocks @b stop
10292     * ticking, until one brings them back to canonical mode. The
10293     * elm_clock_digit_edit_set() function will influence which digits
10294     * of the clock will be editable. By default, all of them will be
10295     * (#ELM_CLOCK_NONE).
10296     *
10297     * @note am/pm sheets, if being shown, will @b always be editable
10298     * under edition mode.
10299     *
10300     * @see elm_clock_edit_get()
10301     *
10302     * @ingroup Clock
10303     */
10304    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10305
10306    /**
10307     * Retrieve whether a given clock widget is under <b>edition
10308     * mode</b> or under (default) displaying-only mode.
10309     *
10310     * @param obj The clock object
10311     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
10312     * otherwise
10313     *
10314     * This function retrieves whether the clock's time can be edited
10315     * or not by user interaction.
10316     *
10317     * @see elm_clock_edit_set() for more details
10318     *
10319     * @ingroup Clock
10320     */
10321    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10322
10323    /**
10324     * Set what digits of the given clock widget should be editable
10325     * when in edition mode.
10326     *
10327     * @param obj The clock object
10328     * @param digedit Bit mask indicating the digits to be editable
10329     * (values in #Elm_Clock_Digedit).
10330     *
10331     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
10332     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
10333     * EINA_FALSE).
10334     *
10335     * @see elm_clock_digit_edit_get()
10336     *
10337     * @ingroup Clock
10338     */
10339    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
10340
10341    /**
10342     * Retrieve what digits of the given clock widget should be
10343     * editable when in edition mode.
10344     *
10345     * @param obj The clock object
10346     * @return Bit mask indicating the digits to be editable
10347     * (values in #Elm_Clock_Digedit).
10348     *
10349     * @see elm_clock_digit_edit_set() for more details
10350     *
10351     * @ingroup Clock
10352     */
10353    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10354
10355    /**
10356     * Set if the given clock widget must show hours in military or
10357     * am/pm mode
10358     *
10359     * @param obj The clock object
10360     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
10361     * to military mode
10362     *
10363     * This function sets if the clock must show hours in military or
10364     * am/pm mode. In some countries like Brazil the military mode
10365     * (00-24h-format) is used, in opposition to the USA, where the
10366     * am/pm mode is more commonly used.
10367     *
10368     * @see elm_clock_show_am_pm_get()
10369     *
10370     * @ingroup Clock
10371     */
10372    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
10373
10374    /**
10375     * Get if the given clock widget shows hours in military or am/pm
10376     * mode
10377     *
10378     * @param obj The clock object
10379     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
10380     * military
10381     *
10382     * This function gets if the clock shows hours in military or am/pm
10383     * mode.
10384     *
10385     * @see elm_clock_show_am_pm_set() for more details
10386     *
10387     * @ingroup Clock
10388     */
10389    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10390
10391    /**
10392     * Set if the given clock widget must show time with seconds or not
10393     *
10394     * @param obj The clock object
10395     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
10396     *
10397     * This function sets if the given clock must show or not elapsed
10398     * seconds. By default, they are @b not shown.
10399     *
10400     * @see elm_clock_show_seconds_get()
10401     *
10402     * @ingroup Clock
10403     */
10404    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
10405
10406    /**
10407     * Get whether the given clock widget is showing time with seconds
10408     * or not
10409     *
10410     * @param obj The clock object
10411     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
10412     *
10413     * This function gets whether @p obj is showing or not the elapsed
10414     * seconds.
10415     *
10416     * @see elm_clock_show_seconds_set()
10417     *
10418     * @ingroup Clock
10419     */
10420    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10421
10422    /**
10423     * Set the interval on time updates for an user mouse button hold
10424     * on clock widgets' time edition.
10425     *
10426     * @param obj The clock object
10427     * @param interval The (first) interval value in seconds
10428     *
10429     * This interval value is @b decreased while the user holds the
10430     * mouse pointer either incrementing or decrementing a given the
10431     * clock digit's value.
10432     *
10433     * This helps the user to get to a given time distant from the
10434     * current one easier/faster, as it will start to flip quicker and
10435     * quicker on mouse button holds.
10436     *
10437     * The calculation for the next flip interval value, starting from
10438     * the one set with this call, is the previous interval divided by
10439     * 1.05, so it decreases a little bit.
10440     *
10441     * The default starting interval value for automatic flips is
10442     * @b 0.85 seconds.
10443     *
10444     * @see elm_clock_interval_get()
10445     *
10446     * @ingroup Clock
10447     */
10448    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
10449
10450    /**
10451     * Get the interval on time updates for an user mouse button hold
10452     * on clock widgets' time edition.
10453     *
10454     * @param obj The clock object
10455     * @return The (first) interval value, in seconds, set on it
10456     *
10457     * @see elm_clock_interval_set() for more details
10458     *
10459     * @ingroup Clock
10460     */
10461    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10462
10463    /**
10464     * @}
10465     */
10466
10467    /**
10468     * @defgroup Layout Layout
10469     *
10470     * @image html img/widget/layout/preview-00.png
10471     * @image latex img/widget/layout/preview-00.eps width=\textwidth
10472     *
10473     * @image html img/layout-predefined.png
10474     * @image latex img/layout-predefined.eps width=\textwidth
10475     *
10476     * This is a container widget that takes a standard Edje design file and
10477     * wraps it very thinly in a widget.
10478     *
10479     * An Edje design (theme) file has a very wide range of possibilities to
10480     * describe the behavior of elements added to the Layout. Check out the Edje
10481     * documentation and the EDC reference to get more information about what can
10482     * be done with Edje.
10483     *
10484     * Just like @ref List, @ref Box, and other container widgets, any
10485     * object added to the Layout will become its child, meaning that it will be
10486     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
10487     *
10488     * The Layout widget can contain as many Contents, Boxes or Tables as
10489     * described in its theme file. For instance, objects can be added to
10490     * different Tables by specifying the respective Table part names. The same
10491     * is valid for Content and Box.
10492     *
10493     * The objects added as child of the Layout will behave as described in the
10494     * part description where they were added. There are 3 possible types of
10495     * parts where a child can be added:
10496     *
10497     * @section secContent Content (SWALLOW part)
10498     *
10499     * Only one object can be added to the @c SWALLOW part (but you still can
10500     * have many @c SWALLOW parts and one object on each of them). Use the @c
10501     * elm_object_content_set/get/unset functions to set, retrieve and unset
10502     * objects as content of the @c SWALLOW. After being set to this part, the
10503     * object size, position, visibility, clipping and other description
10504     * properties will be totally controlled by the description of the given part
10505     * (inside the Edje theme file).
10506     *
10507     * One can use @c evas_object_size_hint_* functions on the child to have some
10508     * kind of control over its behavior, but the resulting behavior will still
10509     * depend heavily on the @c SWALLOW part description.
10510     *
10511     * The Edje theme also can change the part description, based on signals or
10512     * scripts running inside the theme. This change can also be animated. All of
10513     * this will affect the child object set as content accordingly. The object
10514     * size will be changed if the part size is changed, it will animate move if
10515     * the part is moving, and so on.
10516     *
10517     * The following picture demonstrates a Layout widget with a child object
10518     * added to its @c SWALLOW:
10519     *
10520     * @image html layout_swallow.png
10521     * @image latex layout_swallow.eps width=\textwidth
10522     *
10523     * @section secBox Box (BOX part)
10524     *
10525     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
10526     * allows one to add objects to the box and have them distributed along its
10527     * area, accordingly to the specified @a layout property (now by @a layout we
10528     * mean the chosen layouting design of the Box, not the Layout widget
10529     * itself).
10530     *
10531     * A similar effect for having a box with its position, size and other things
10532     * controlled by the Layout theme would be to create an Elementary @ref Box
10533     * widget and add it as a Content in the @c SWALLOW part.
10534     *
10535     * The main difference of using the Layout Box is that its behavior, the box
10536     * properties like layouting format, padding, align, etc. will be all
10537     * controlled by the theme. This means, for example, that a signal could be
10538     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
10539     * handled the signal by changing the box padding, or align, or both. Using
10540     * the Elementary @ref Box widget is not necessarily harder or easier, it
10541     * just depends on the circunstances and requirements.
10542     *
10543     * The Layout Box can be used through the @c elm_layout_box_* set of
10544     * functions.
10545     *
10546     * The following picture demonstrates a Layout widget with many child objects
10547     * added to its @c BOX part:
10548     *
10549     * @image html layout_box.png
10550     * @image latex layout_box.eps width=\textwidth
10551     *
10552     * @section secTable Table (TABLE part)
10553     *
10554     * Just like the @ref secBox, the Layout Table is very similar to the
10555     * Elementary @ref Table widget. It allows one to add objects to the Table
10556     * specifying the row and column where the object should be added, and any
10557     * column or row span if necessary.
10558     *
10559     * Again, we could have this design by adding a @ref Table widget to the @c
10560     * SWALLOW part using elm_object_part_content_set(). The same difference happens
10561     * here when choosing to use the Layout Table (a @c TABLE part) instead of
10562     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
10563     *
10564     * The Layout Table can be used through the @c elm_layout_table_* set of
10565     * functions.
10566     *
10567     * The following picture demonstrates a Layout widget with many child objects
10568     * added to its @c TABLE part:
10569     *
10570     * @image html layout_table.png
10571     * @image latex layout_table.eps width=\textwidth
10572     *
10573     * @section secPredef Predefined Layouts
10574     *
10575     * Another interesting thing about the Layout widget is that it offers some
10576     * predefined themes that come with the default Elementary theme. These
10577     * themes can be set by the call elm_layout_theme_set(), and provide some
10578     * basic functionality depending on the theme used.
10579     *
10580     * Most of them already send some signals, some already provide a toolbar or
10581     * back and next buttons.
10582     *
10583     * These are available predefined theme layouts. All of them have class = @c
10584     * layout, group = @c application, and style = one of the following options:
10585     *
10586     * @li @c toolbar-content - application with toolbar and main content area
10587     * @li @c toolbar-content-back - application with toolbar and main content
10588     * area with a back button and title area
10589     * @li @c toolbar-content-back-next - application with toolbar and main
10590     * content area with a back and next buttons and title area
10591     * @li @c content-back - application with a main content area with a back
10592     * button and title area
10593     * @li @c content-back-next - application with a main content area with a
10594     * back and next buttons and title area
10595     * @li @c toolbar-vbox - application with toolbar and main content area as a
10596     * vertical box
10597     * @li @c toolbar-table - application with toolbar and main content area as a
10598     * table
10599     *
10600     * @section secExamples Examples
10601     *
10602     * Some examples of the Layout widget can be found here:
10603     * @li @ref layout_example_01
10604     * @li @ref layout_example_02
10605     * @li @ref layout_example_03
10606     * @li @ref layout_example_edc
10607     *
10608     */
10609
10610    /**
10611     * Add a new layout to the parent
10612     *
10613     * @param parent The parent object
10614     * @return The new object or NULL if it cannot be created
10615     *
10616     * @see elm_layout_file_set()
10617     * @see elm_layout_theme_set()
10618     *
10619     * @ingroup Layout
10620     */
10621    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10622
10623    /**
10624     * Set the file that will be used as layout
10625     *
10626     * @param obj The layout object
10627     * @param file The path to file (edj) that will be used as layout
10628     * @param group The group that the layout belongs in edje file
10629     *
10630     * @return (1 = success, 0 = error)
10631     *
10632     * @ingroup Layout
10633     */
10634    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
10635
10636    /**
10637     * Set the edje group from the elementary theme that will be used as layout
10638     *
10639     * @param obj The layout object
10640     * @param clas the clas of the group
10641     * @param group the group
10642     * @param style the style to used
10643     *
10644     * @return (1 = success, 0 = error)
10645     *
10646     * @ingroup Layout
10647     */
10648    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
10649
10650    /**
10651     * Set the layout content.
10652     *
10653     * @param obj The layout object
10654     * @param swallow The swallow part name in the edje file
10655     * @param content The child that will be added in this layout object
10656     *
10657     * Once the content object is set, a previously set one will be deleted.
10658     * If you want to keep that old content object, use the
10659     * elm_object_part_content_unset() function.
10660     *
10661     * @note In an Edje theme, the part used as a content container is called @c
10662     * SWALLOW. This is why the parameter name is called @p swallow, but it is
10663     * expected to be a part name just like the second parameter of
10664     * elm_layout_box_append().
10665     *
10666     * @see elm_layout_box_append()
10667     * @see elm_object_part_content_get()
10668     * @see elm_object_part_content_unset()
10669     * @see @ref secBox
10670     * @deprecated use elm_object_part_content_set() instead
10671     *
10672     * @ingroup Layout
10673     */
10674    EINA_DEPRECATED EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10675
10676    /**
10677     * Get the child object in the given content part.
10678     *
10679     * @param obj The layout object
10680     * @param swallow The SWALLOW part to get its content
10681     *
10682     * @return The swallowed object or NULL if none or an error occurred
10683     *
10684     * @deprecated use elm_object_part_content_get() instead
10685     *
10686     * @ingroup Layout
10687     */
10688    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10689
10690    /**
10691     * Unset the layout content.
10692     *
10693     * @param obj The layout object
10694     * @param swallow The swallow part name in the edje file
10695     * @return The content that was being used
10696     *
10697     * Unparent and return the content object which was set for this part.
10698     *
10699     * @deprecated use elm_object_part_content_unset() instead
10700     *
10701     * @ingroup Layout
10702     */
10703    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10704
10705    /**
10706     * Set the text of the given part
10707     *
10708     * @param obj The layout object
10709     * @param part The TEXT part where to set the text
10710     * @param text The text to set
10711     *
10712     * @ingroup Layout
10713     * @deprecated use elm_object_part_text_set() instead.
10714     */
10715    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10716
10717    /**
10718     * Get the text set in the given part
10719     *
10720     * @param obj The layout object
10721     * @param part The TEXT part to retrieve the text off
10722     *
10723     * @return The text set in @p part
10724     *
10725     * @ingroup Layout
10726     * @deprecated use elm_object_part_text_get() instead.
10727     */
10728    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10729
10730    /**
10731     * Append child to layout box part.
10732     *
10733     * @param obj the layout object
10734     * @param part the box part to which the object will be appended.
10735     * @param child the child object to append to box.
10736     *
10737     * Once the object is appended, it will become child of the layout. Its
10738     * lifetime will be bound to the layout, whenever the layout dies the child
10739     * will be deleted automatically. One should use elm_layout_box_remove() to
10740     * make this layout forget about the object.
10741     *
10742     * @see elm_layout_box_prepend()
10743     * @see elm_layout_box_insert_before()
10744     * @see elm_layout_box_insert_at()
10745     * @see elm_layout_box_remove()
10746     *
10747     * @ingroup Layout
10748     */
10749    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10750
10751    /**
10752     * Prepend child to layout box part.
10753     *
10754     * @param obj the layout object
10755     * @param part the box part to prepend.
10756     * @param child the child object to prepend to box.
10757     *
10758     * Once the object is prepended, it will become child of the layout. Its
10759     * lifetime will be bound to the layout, whenever the layout dies the child
10760     * will be deleted automatically. One should use elm_layout_box_remove() to
10761     * make this layout forget about the object.
10762     *
10763     * @see elm_layout_box_append()
10764     * @see elm_layout_box_insert_before()
10765     * @see elm_layout_box_insert_at()
10766     * @see elm_layout_box_remove()
10767     *
10768     * @ingroup Layout
10769     */
10770    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10771
10772    /**
10773     * Insert child to layout box part before a reference object.
10774     *
10775     * @param obj the layout object
10776     * @param part the box part to insert.
10777     * @param child the child object to insert into box.
10778     * @param reference another reference object to insert before in box.
10779     *
10780     * Once the object is inserted, it will become child of the layout. Its
10781     * lifetime will be bound to the layout, whenever the layout dies the child
10782     * will be deleted automatically. One should use elm_layout_box_remove() to
10783     * make this layout forget about the object.
10784     *
10785     * @see elm_layout_box_append()
10786     * @see elm_layout_box_prepend()
10787     * @see elm_layout_box_insert_before()
10788     * @see elm_layout_box_remove()
10789     *
10790     * @ingroup Layout
10791     */
10792    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10793
10794    /**
10795     * Insert child to layout box part at a given position.
10796     *
10797     * @param obj the layout object
10798     * @param part the box part to insert.
10799     * @param child the child object to insert into box.
10800     * @param pos the numeric position >=0 to insert the child.
10801     *
10802     * Once the object is inserted, it will become child of the layout. Its
10803     * lifetime will be bound to the layout, whenever the layout dies the child
10804     * will be deleted automatically. One should use elm_layout_box_remove() to
10805     * make this layout forget about the object.
10806     *
10807     * @see elm_layout_box_append()
10808     * @see elm_layout_box_prepend()
10809     * @see elm_layout_box_insert_before()
10810     * @see elm_layout_box_remove()
10811     *
10812     * @ingroup Layout
10813     */
10814    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10815
10816    /**
10817     * Remove a child of the given part box.
10818     *
10819     * @param obj The layout object
10820     * @param part The box part name to remove child.
10821     * @param child The object to remove from box.
10822     * @return The object that was being used, or NULL if not found.
10823     *
10824     * The object will be removed from the box part and its lifetime will
10825     * not be handled by the layout anymore. This is equivalent to
10826     * elm_object_part_content_unset() for box.
10827     *
10828     * @see elm_layout_box_append()
10829     * @see elm_layout_box_remove_all()
10830     *
10831     * @ingroup Layout
10832     */
10833    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10834
10835    /**
10836     * Remove all children of the given part box.
10837     *
10838     * @param obj The layout object
10839     * @param part The box part name to remove child.
10840     * @param clear If EINA_TRUE, then all objects will be deleted as
10841     *        well, otherwise they will just be removed and will be
10842     *        dangling on the canvas.
10843     *
10844     * The objects will be removed from the box part and their lifetime will
10845     * not be handled by the layout anymore. This is equivalent to
10846     * elm_layout_box_remove() for all box children.
10847     *
10848     * @see elm_layout_box_append()
10849     * @see elm_layout_box_remove()
10850     *
10851     * @ingroup Layout
10852     */
10853    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10854
10855    /**
10856     * Insert child to layout table part.
10857     *
10858     * @param obj the layout object
10859     * @param part the box part to pack child.
10860     * @param child_obj the child object to pack into table.
10861     * @param col the column to which the child should be added. (>= 0)
10862     * @param row the row to which the child should be added. (>= 0)
10863     * @param colspan how many columns should be used to store this object. (>=
10864     *        1)
10865     * @param rowspan how many rows should be used to store this object. (>= 1)
10866     *
10867     * Once the object is inserted, it will become child of the table. Its
10868     * lifetime will be bound to the layout, and whenever the layout dies the
10869     * child will be deleted automatically. One should use
10870     * elm_layout_table_remove() to make this layout forget about the object.
10871     *
10872     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10873     * more space than a single cell. For instance, the following code:
10874     * @code
10875     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10876     * @endcode
10877     *
10878     * Would result in an object being added like the following picture:
10879     *
10880     * @image html layout_colspan.png
10881     * @image latex layout_colspan.eps width=\textwidth
10882     *
10883     * @see elm_layout_table_unpack()
10884     * @see elm_layout_table_clear()
10885     *
10886     * @ingroup Layout
10887     */
10888    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);
10889
10890    /**
10891     * Unpack (remove) a child of the given part table.
10892     *
10893     * @param obj The layout object
10894     * @param part The table part name to remove child.
10895     * @param child_obj The object to remove from table.
10896     * @return The object that was being used, or NULL if not found.
10897     *
10898     * The object will be unpacked from the table part and its lifetime
10899     * will not be handled by the layout anymore. This is equivalent to
10900     * elm_object_part_content_unset() for table.
10901     *
10902     * @see elm_layout_table_pack()
10903     * @see elm_layout_table_clear()
10904     *
10905     * @ingroup Layout
10906     */
10907    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10908
10909    /**
10910     * Remove all the child objects of the given part table.
10911     *
10912     * @param obj The layout object
10913     * @param part The table part name to remove child.
10914     * @param clear If EINA_TRUE, then all objects will be deleted as
10915     *        well, otherwise they will just be removed and will be
10916     *        dangling on the canvas.
10917     *
10918     * The objects will be removed from the table part and their lifetime will
10919     * not be handled by the layout anymore. This is equivalent to
10920     * elm_layout_table_unpack() for all table children.
10921     *
10922     * @see elm_layout_table_pack()
10923     * @see elm_layout_table_unpack()
10924     *
10925     * @ingroup Layout
10926     */
10927    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10928
10929    /**
10930     * Get the edje layout
10931     *
10932     * @param obj The layout object
10933     *
10934     * @return A Evas_Object with the edje layout settings loaded
10935     * with function elm_layout_file_set
10936     *
10937     * This returns the edje object. It is not expected to be used to then
10938     * swallow objects via edje_object_part_swallow() for example. Use
10939     * elm_object_part_content_set() instead so child object handling and sizing is
10940     * done properly.
10941     *
10942     * @note This function should only be used if you really need to call some
10943     * low level Edje function on this edje object. All the common stuff (setting
10944     * text, emitting signals, hooking callbacks to signals, etc.) can be done
10945     * with proper elementary functions.
10946     *
10947     * @see elm_object_signal_callback_add()
10948     * @see elm_object_signal_emit()
10949     * @see elm_object_part_text_set()
10950     * @see elm_object_part_content_set()
10951     * @see elm_layout_box_append()
10952     * @see elm_layout_table_pack()
10953     * @see elm_layout_data_get()
10954     *
10955     * @ingroup Layout
10956     */
10957    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10958
10959    /**
10960     * Get the edje data from the given layout
10961     *
10962     * @param obj The layout object
10963     * @param key The data key
10964     *
10965     * @return The edje data string
10966     *
10967     * This function fetches data specified inside the edje theme of this layout.
10968     * This function return NULL if data is not found.
10969     *
10970     * In EDC this comes from a data block within the group block that @p
10971     * obj was loaded from. E.g.
10972     *
10973     * @code
10974     * collections {
10975     *   group {
10976     *     name: "a_group";
10977     *     data {
10978     *       item: "key1" "value1";
10979     *       item: "key2" "value2";
10980     *     }
10981     *   }
10982     * }
10983     * @endcode
10984     *
10985     * @ingroup Layout
10986     */
10987    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10988
10989    /**
10990     * Eval sizing
10991     *
10992     * @param obj The layout object
10993     *
10994     * Manually forces a sizing re-evaluation. This is useful when the minimum
10995     * size required by the edje theme of this layout has changed. The change on
10996     * the minimum size required by the edje theme is not immediately reported to
10997     * the elementary layout, so one needs to call this function in order to tell
10998     * the widget (layout) that it needs to reevaluate its own size.
10999     *
11000     * The minimum size of the theme is calculated based on minimum size of
11001     * parts, the size of elements inside containers like box and table, etc. All
11002     * of this can change due to state changes, and that's when this function
11003     * should be called.
11004     *
11005     * Also note that a standard signal of "size,eval" "elm" emitted from the
11006     * edje object will cause this to happen too.
11007     *
11008     * @ingroup Layout
11009     */
11010    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
11011
11012    /**
11013     * Sets a specific cursor for an edje part.
11014     *
11015     * @param obj The layout object.
11016     * @param part_name a part from loaded edje group.
11017     * @param cursor cursor name to use, see Elementary_Cursor.h
11018     *
11019     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
11020     *         part not exists or it has "mouse_events: 0".
11021     *
11022     * @ingroup Layout
11023     */
11024    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
11025
11026    /**
11027     * Get the cursor to be shown when mouse is over an edje part
11028     *
11029     * @param obj The layout object.
11030     * @param part_name a part from loaded edje group.
11031     * @return the cursor name.
11032     *
11033     * @ingroup Layout
11034     */
11035    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11036
11037    /**
11038     * Unsets a cursor previously set with elm_layout_part_cursor_set().
11039     *
11040     * @param obj The layout object.
11041     * @param part_name a part from loaded edje group, that had a cursor set
11042     *        with elm_layout_part_cursor_set().
11043     *
11044     * @ingroup Layout
11045     */
11046    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11047
11048    /**
11049     * Sets a specific cursor style for an edje part.
11050     *
11051     * @param obj The layout object.
11052     * @param part_name a part from loaded edje group.
11053     * @param style the theme style to use (default, transparent, ...)
11054     *
11055     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
11056     *         part not exists or it did not had a cursor set.
11057     *
11058     * @ingroup Layout
11059     */
11060    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
11061
11062    /**
11063     * Gets a specific cursor style for an edje part.
11064     *
11065     * @param obj The layout object.
11066     * @param part_name a part from loaded edje group.
11067     *
11068     * @return the theme style in use, defaults to "default". If the
11069     *         object does not have a cursor set, then NULL is returned.
11070     *
11071     * @ingroup Layout
11072     */
11073    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11074
11075    /**
11076     * Sets if the cursor set should be searched on the theme or should use
11077     * the provided by the engine, only.
11078     *
11079     * @note before you set if should look on theme you should define a
11080     * cursor with elm_layout_part_cursor_set(). By default it will only
11081     * look for cursors provided by the engine.
11082     *
11083     * @param obj The layout object.
11084     * @param part_name a part from loaded edje group.
11085     * @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
11086     *        or should also search on widget's theme as well (EINA_FALSE)
11087     *
11088     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
11089     *         part not exists or it did not had a cursor set.
11090     *
11091     * @ingroup Layout
11092     */
11093    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);
11094
11095    /**
11096     * Gets a specific cursor engine_only for an edje part.
11097     *
11098     * @param obj The layout object.
11099     * @param part_name a part from loaded edje group.
11100     *
11101     * @return whenever the cursor is just provided by engine or also from theme.
11102     *
11103     * @ingroup Layout
11104     */
11105    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11106
11107 /**
11108  * @def elm_layout_icon_set
11109  * Convenience macro to set the icon object in a layout that follows the
11110  * Elementary naming convention for its parts.
11111  *
11112  * @ingroup Layout
11113  */
11114 #define elm_layout_icon_set(_ly, _obj) \
11115   do { \
11116     const char *sig; \
11117     elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
11118     if ((_obj)) sig = "elm,state,icon,visible"; \
11119     else sig = "elm,state,icon,hidden"; \
11120     elm_object_signal_emit((_ly), sig, "elm"); \
11121   } while (0)
11122
11123 /**
11124  * @def elm_layout_icon_get
11125  * Convienience macro to get the icon object from a layout that follows the
11126  * Elementary naming convention for its parts.
11127  *
11128  * @ingroup Layout
11129  */
11130 #define elm_layout_icon_get(_ly) \
11131   elm_object_part_content_get((_ly), "elm.swallow.icon")
11132
11133 /**
11134  * @def elm_layout_end_set
11135  * Convienience macro to set the end object in a layout that follows the
11136  * Elementary naming convention for its parts.
11137  *
11138  * @ingroup Layout
11139  */
11140 #define elm_layout_end_set(_ly, _obj) \
11141   do { \
11142     const char *sig; \
11143     elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
11144     if ((_obj)) sig = "elm,state,end,visible"; \
11145     else sig = "elm,state,end,hidden"; \
11146     elm_object_signal_emit((_ly), sig, "elm"); \
11147   } while (0)
11148
11149 /**
11150  * @def elm_layout_end_get
11151  * Convienience macro to get the end object in a layout that follows the
11152  * Elementary naming convention for its parts.
11153  *
11154  * @ingroup Layout
11155  */
11156 #define elm_layout_end_get(_ly) \
11157   elm_object_part_content_get((_ly), "elm.swallow.end")
11158
11159 /**
11160  * @def elm_layout_label_set
11161  * Convienience macro to set the label in a layout that follows the
11162  * Elementary naming convention for its parts.
11163  *
11164  * @ingroup Layout
11165  * @deprecated use elm_object_text_set() instead.
11166  */
11167 #define elm_layout_label_set(_ly, _txt) \
11168   elm_layout_text_set((_ly), "elm.text", (_txt))
11169
11170 /**
11171  * @def elm_layout_label_get
11172  * Convenience macro to get the label in a layout that follows the
11173  * Elementary naming convention for its parts.
11174  *
11175  * @ingroup Layout
11176  * @deprecated use elm_object_text_set() instead.
11177  */
11178 #define elm_layout_label_get(_ly) \
11179   elm_layout_text_get((_ly), "elm.text")
11180
11181    /* smart callbacks called:
11182     * "theme,changed" - when elm theme is changed.
11183     */
11184
11185    /**
11186     * @defgroup Notify Notify
11187     *
11188     * @image html img/widget/notify/preview-00.png
11189     * @image latex img/widget/notify/preview-00.eps
11190     *
11191     * Display a container in a particular region of the parent(top, bottom,
11192     * etc).  A timeout can be set to automatically hide the notify. This is so
11193     * that, after an evas_object_show() on a notify object, if a timeout was set
11194     * on it, it will @b automatically get hidden after that time.
11195     *
11196     * Signals that you can add callbacks for are:
11197     * @li "timeout" - when timeout happens on notify and it's hidden
11198     * @li "block,clicked" - when a click outside of the notify happens
11199     *
11200     * Default contents parts of the notify widget that you can use for are:
11201     * @li "default" - A content of the notify
11202     *
11203     * @ref tutorial_notify show usage of the API.
11204     *
11205     * @{
11206     */
11207
11208    /**
11209     * @brief Possible orient values for notify.
11210     *
11211     * This values should be used in conjunction to elm_notify_orient_set() to
11212     * set the position in which the notify should appear(relative to its parent)
11213     * and in conjunction with elm_notify_orient_get() to know where the notify
11214     * is appearing.
11215     */
11216    typedef enum _Elm_Notify_Orient
11217      {
11218         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
11219         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
11220         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
11221         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
11222         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
11223         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
11224         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
11225         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
11226         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
11227         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
11228      } Elm_Notify_Orient;
11229
11230    /**
11231     * @brief Add a new notify to the parent
11232     *
11233     * @param parent The parent object
11234     * @return The new object or NULL if it cannot be created
11235     */
11236    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11237
11238    /**
11239     * @brief Set the content of the notify widget
11240     *
11241     * @param obj The notify object
11242     * @param content The content will be filled in this notify object
11243     *
11244     * Once the content object is set, a previously set one will be deleted. If
11245     * you want to keep that old content object, use the
11246     * elm_notify_content_unset() function.
11247     *
11248     * @deprecated use elm_object_content_set() instead
11249     *
11250     */
11251    EINA_DEPRECATED EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11252
11253    /**
11254     * @brief Unset the content of the notify widget
11255     *
11256     * @param obj The notify object
11257     * @return The content that was being used
11258     *
11259     * Unparent and return the content object which was set for this widget
11260     *
11261     * @see elm_notify_content_set()
11262     * @deprecated use elm_object_content_unset() instead
11263     *
11264     */
11265    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11266
11267    /**
11268     * @brief Return the content of the notify widget
11269     *
11270     * @param obj The notify object
11271     * @return The content that is being used
11272     *
11273     * @see elm_notify_content_set()
11274     * @deprecated use elm_object_content_get() instead
11275     *
11276     */
11277    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11278
11279    /**
11280     * @brief Set the notify parent
11281     *
11282     * @param obj The notify object
11283     * @param content The new parent
11284     *
11285     * Once the parent object is set, a previously set one will be disconnected
11286     * and replaced.
11287     */
11288    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11289
11290    /**
11291     * @brief Get the notify parent
11292     *
11293     * @param obj The notify object
11294     * @return The parent
11295     *
11296     * @see elm_notify_parent_set()
11297     */
11298    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11299
11300    /**
11301     * @brief Set the orientation
11302     *
11303     * @param obj The notify object
11304     * @param orient The new orientation
11305     *
11306     * Sets the position in which the notify will appear in its parent.
11307     *
11308     * @see @ref Elm_Notify_Orient for possible values.
11309     */
11310    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
11311
11312    /**
11313     * @brief Return the orientation
11314     * @param obj The notify object
11315     * @return The orientation of the notification
11316     *
11317     * @see elm_notify_orient_set()
11318     * @see Elm_Notify_Orient
11319     */
11320    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11321
11322    /**
11323     * @brief Set the time interval after which the notify window is going to be
11324     * hidden.
11325     *
11326     * @param obj The notify object
11327     * @param time The timeout in seconds
11328     *
11329     * This function sets a timeout and starts the timer controlling when the
11330     * notify is hidden. Since calling evas_object_show() on a notify restarts
11331     * the timer controlling when the notify is hidden, setting this before the
11332     * notify is shown will in effect mean starting the timer when the notify is
11333     * shown.
11334     *
11335     * @note Set a value <= 0.0 to disable a running timer.
11336     *
11337     * @note If the value > 0.0 and the notify is previously visible, the
11338     * timer will be started with this value, canceling any running timer.
11339     */
11340    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
11341
11342    /**
11343     * @brief Return the timeout value (in seconds)
11344     * @param obj the notify object
11345     *
11346     * @see elm_notify_timeout_set()
11347     */
11348    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11349
11350    /**
11351     * @brief Sets whether events should be passed to by a click outside
11352     * its area.
11353     *
11354     * @param obj The notify object
11355     * @param repeats EINA_TRUE Events are repeats, else no
11356     *
11357     * When true if the user clicks outside the window the events will be caught
11358     * by the others widgets, else the events are blocked.
11359     *
11360     * @note The default value is EINA_TRUE.
11361     */
11362    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
11363
11364    /**
11365     * @brief Return true if events are repeat below the notify object
11366     * @param obj the notify object
11367     *
11368     * @see elm_notify_repeat_events_set()
11369     */
11370    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11371
11372    /**
11373     * @}
11374     */
11375
11376    /**
11377     * @defgroup Hover Hover
11378     *
11379     * @image html img/widget/hover/preview-00.png
11380     * @image latex img/widget/hover/preview-00.eps
11381     *
11382     * A Hover object will hover over its @p parent object at the @p target
11383     * location. Anything in the background will be given a darker coloring to
11384     * indicate that the hover object is on top (at the default theme). When the
11385     * hover is clicked it is dismissed(hidden), if the contents of the hover are
11386     * clicked that @b doesn't cause the hover to be dismissed.
11387     *
11388     * A Hover object has two parents. One parent that owns it during creation
11389     * and the other parent being the one over which the hover object spans.
11390     *
11391     *
11392     * @note The hover object will take up the entire space of @p target
11393     * object.
11394     *
11395     * Elementary has the following styles for the hover widget:
11396     * @li default
11397     * @li popout
11398     * @li menu
11399     * @li hoversel_vertical
11400     *
11401     * The following are the available position for content:
11402     * @li left
11403     * @li top-left
11404     * @li top
11405     * @li top-right
11406     * @li right
11407     * @li bottom-right
11408     * @li bottom
11409     * @li bottom-left
11410     * @li middle
11411     * @li smart
11412     *
11413     * Signals that you can add callbacks for are:
11414     * @li "clicked" - the user clicked the empty space in the hover to dismiss
11415     * @li "smart,changed" - a content object placed under the "smart"
11416     *                   policy was replaced to a new slot direction.
11417     *
11418     * See @ref tutorial_hover for more information.
11419     *
11420     * @{
11421     */
11422    typedef enum _Elm_Hover_Axis
11423      {
11424         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
11425         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
11426         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
11427         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
11428      } Elm_Hover_Axis;
11429
11430    /**
11431     * @brief Adds a hover object to @p parent
11432     *
11433     * @param parent The parent object
11434     * @return The hover object or NULL if one could not be created
11435     */
11436    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11437
11438    /**
11439     * @brief Sets the target object for the hover.
11440     *
11441     * @param obj The hover object
11442     * @param target The object to center the hover onto.
11443     *
11444     * This function will cause the hover to be centered on the target object.
11445     */
11446    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
11447
11448    /**
11449     * @brief Gets the target object for the hover.
11450     *
11451     * @param obj The hover object
11452     * @return The target object for the hover.
11453     *
11454     * @see elm_hover_target_set()
11455     */
11456    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11457
11458    /**
11459     * @brief Sets the parent object for the hover.
11460     *
11461     * @param obj The hover object
11462     * @param parent The object to locate the hover over.
11463     *
11464     * This function will cause the hover to take up the entire space that the
11465     * parent object fills.
11466     */
11467    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11468
11469    /**
11470     * @brief Gets the parent object for the hover.
11471     *
11472     * @param obj The hover object
11473     * @return The parent object to locate the hover over.
11474     *
11475     * @see elm_hover_parent_set()
11476     */
11477    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11478
11479    /**
11480     * @brief Sets the content of the hover object and the direction in which it
11481     * will pop out.
11482     *
11483     * @param obj The hover object
11484     * @param swallow The direction that the object will be displayed
11485     * at. Accepted values are "left", "top-left", "top", "top-right",
11486     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
11487     * "smart".
11488     * @param content The content to place at @p swallow
11489     *
11490     * Once the content object is set for a given direction, a previously
11491     * set one (on the same direction) will be deleted. If you want to
11492     * keep that old content object, use the elm_hover_content_unset()
11493     * function.
11494     *
11495     * All directions may have contents at the same time, except for
11496     * "smart". This is a special placement hint and its use case
11497     * independs of the calculations coming from
11498     * elm_hover_best_content_location_get(). Its use is for cases when
11499     * one desires only one hover content, but with a dynamic special
11500     * placement within the hover area. The content's geometry, whenever
11501     * it changes, will be used to decide on a best location, not
11502     * extrapolating the hover's parent object view to show it in (still
11503     * being the hover's target determinant of its medium part -- move and
11504     * resize it to simulate finger sizes, for example). If one of the
11505     * directions other than "smart" are used, a previously content set
11506     * using it will be deleted, and vice-versa.
11507     */
11508    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
11509
11510    /**
11511     * @brief Get the content of the hover object, in a given direction.
11512     *
11513     * Return the content object which was set for this widget in the
11514     * @p swallow direction.
11515     *
11516     * @param obj The hover object
11517     * @param swallow The direction that the object was display at.
11518     * @return The content that was being used
11519     *
11520     * @see elm_hover_content_set()
11521     */
11522    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
11523
11524    /**
11525     * @brief Unset the content of the hover object, in a given direction.
11526     *
11527     * Unparent and return the content object set at @p swallow direction.
11528     *
11529     * @param obj The hover object
11530     * @param swallow The direction that the object was display at.
11531     * @return The content that was being used.
11532     *
11533     * @see elm_hover_content_set()
11534     */
11535    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
11536
11537    /**
11538     * @brief Returns the best swallow location for content in the hover.
11539     *
11540     * @param obj The hover object
11541     * @param pref_axis The preferred orientation axis for the hover object to use
11542     * @return The edje location to place content into the hover or @c
11543     *         NULL, on errors.
11544     *
11545     * Best is defined here as the location at which there is the most available
11546     * space.
11547     *
11548     * @p pref_axis may be one of
11549     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
11550     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
11551     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
11552     * - @c ELM_HOVER_AXIS_BOTH -- both
11553     *
11554     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
11555     * nescessarily be along the horizontal axis("left" or "right"). If
11556     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
11557     * be along the vertical axis("top" or "bottom"). Chossing
11558     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
11559     * returned position may be in either axis.
11560     *
11561     * @see elm_hover_content_set()
11562     */
11563    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
11564
11565    /**
11566     * @}
11567     */
11568
11569    /* entry */
11570    /**
11571     * @defgroup Entry Entry
11572     *
11573     * @image html img/widget/entry/preview-00.png
11574     * @image latex img/widget/entry/preview-00.eps width=\textwidth
11575     * @image html img/widget/entry/preview-01.png
11576     * @image latex img/widget/entry/preview-01.eps width=\textwidth
11577     * @image html img/widget/entry/preview-02.png
11578     * @image latex img/widget/entry/preview-02.eps width=\textwidth
11579     * @image html img/widget/entry/preview-03.png
11580     * @image latex img/widget/entry/preview-03.eps width=\textwidth
11581     *
11582     * An entry is a convenience widget which shows a box that the user can
11583     * enter text into. Entries by default don't scroll, so they grow to
11584     * accomodate the entire text, resizing the parent window as needed. This
11585     * can be changed with the elm_entry_scrollable_set() function.
11586     *
11587     * They can also be single line or multi line (the default) and when set
11588     * to multi line mode they support text wrapping in any of the modes
11589     * indicated by #Elm_Wrap_Type.
11590     *
11591     * Other features include password mode, filtering of inserted text with
11592     * elm_entry_text_filter_append() and related functions, inline "items" and
11593     * formatted markup text.
11594     *
11595     * @section entry-markup Formatted text
11596     *
11597     * The markup tags supported by the Entry are defined by the theme, but
11598     * even when writing new themes or extensions it's a good idea to stick to
11599     * a sane default, to maintain coherency and avoid application breakages.
11600     * Currently defined by the default theme are the following tags:
11601     * @li \<br\>: Inserts a line break.
11602     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
11603     * breaks.
11604     * @li \<tab\>: Inserts a tab.
11605     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
11606     * enclosed text.
11607     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
11608     * @li \<link\>...\</link\>: Underlines the enclosed text.
11609     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
11610     *
11611     * @section entry-special Special markups
11612     *
11613     * Besides those used to format text, entries support two special markup
11614     * tags used to insert clickable portions of text or items inlined within
11615     * the text.
11616     *
11617     * @subsection entry-anchors Anchors
11618     *
11619     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
11620     * \</a\> tags and an event will be generated when this text is clicked,
11621     * like this:
11622     *
11623     * @code
11624     * This text is outside <a href=anc-01>but this one is an anchor</a>
11625     * @endcode
11626     *
11627     * The @c href attribute in the opening tag gives the name that will be
11628     * used to identify the anchor and it can be any valid utf8 string.
11629     *
11630     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
11631     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
11632     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
11633     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
11634     * an anchor.
11635     *
11636     * @subsection entry-items Items
11637     *
11638     * Inlined in the text, any other @c Evas_Object can be inserted by using
11639     * \<item\> tags this way:
11640     *
11641     * @code
11642     * <item size=16x16 vsize=full href=emoticon/haha></item>
11643     * @endcode
11644     *
11645     * Just like with anchors, the @c href identifies each item, but these need,
11646     * in addition, to indicate their size, which is done using any one of
11647     * @c size, @c absize or @c relsize attributes. These attributes take their
11648     * value in the WxH format, where W is the width and H the height of the
11649     * item.
11650     *
11651     * @li absize: Absolute pixel size for the item. Whatever value is set will
11652     * be the item's size regardless of any scale value the object may have
11653     * been set to. The final line height will be adjusted to fit larger items.
11654     * @li size: Similar to @c absize, but it's adjusted to the scale value set
11655     * for the object.
11656     * @li relsize: Size is adjusted for the item to fit within the current
11657     * line height.
11658     *
11659     * Besides their size, items are specificed a @c vsize value that affects
11660     * how their final size and position are calculated. The possible values
11661     * are:
11662     * @li ascent: Item will be placed within the line's baseline and its
11663     * ascent. That is, the height between the line where all characters are
11664     * positioned and the highest point in the line. For @c size and @c absize
11665     * items, the descent value will be added to the total line height to make
11666     * them fit. @c relsize items will be adjusted to fit within this space.
11667     * @li full: Items will be placed between the descent and ascent, or the
11668     * lowest point in the line and its highest.
11669     *
11670     * The next image shows different configurations of items and how
11671     * the previously mentioned options affect their sizes. In all cases,
11672     * the green line indicates the ascent, blue for the baseline and red for
11673     * the descent.
11674     *
11675     * @image html entry_item.png
11676     * @image latex entry_item.eps width=\textwidth
11677     *
11678     * And another one to show how size differs from absize. In the first one,
11679     * the scale value is set to 1.0, while the second one is using one of 2.0.
11680     *
11681     * @image html entry_item_scale.png
11682     * @image latex entry_item_scale.eps width=\textwidth
11683     *
11684     * After the size for an item is calculated, the entry will request an
11685     * object to place in its space. For this, the functions set with
11686     * elm_entry_item_provider_append() and related functions will be called
11687     * in order until one of them returns a @c non-NULL value. If no providers
11688     * are available, or all of them return @c NULL, then the entry falls back
11689     * to one of the internal defaults, provided the name matches with one of
11690     * them.
11691     *
11692     * All of the following are currently supported:
11693     *
11694     * - emoticon/angry
11695     * - emoticon/angry-shout
11696     * - emoticon/crazy-laugh
11697     * - emoticon/evil-laugh
11698     * - emoticon/evil
11699     * - emoticon/goggle-smile
11700     * - emoticon/grumpy
11701     * - emoticon/grumpy-smile
11702     * - emoticon/guilty
11703     * - emoticon/guilty-smile
11704     * - emoticon/haha
11705     * - emoticon/half-smile
11706     * - emoticon/happy-panting
11707     * - emoticon/happy
11708     * - emoticon/indifferent
11709     * - emoticon/kiss
11710     * - emoticon/knowing-grin
11711     * - emoticon/laugh
11712     * - emoticon/little-bit-sorry
11713     * - emoticon/love-lots
11714     * - emoticon/love
11715     * - emoticon/minimal-smile
11716     * - emoticon/not-happy
11717     * - emoticon/not-impressed
11718     * - emoticon/omg
11719     * - emoticon/opensmile
11720     * - emoticon/smile
11721     * - emoticon/sorry
11722     * - emoticon/squint-laugh
11723     * - emoticon/surprised
11724     * - emoticon/suspicious
11725     * - emoticon/tongue-dangling
11726     * - emoticon/tongue-poke
11727     * - emoticon/uh
11728     * - emoticon/unhappy
11729     * - emoticon/very-sorry
11730     * - emoticon/what
11731     * - emoticon/wink
11732     * - emoticon/worried
11733     * - emoticon/wtf
11734     *
11735     * Alternatively, an item may reference an image by its path, using
11736     * the URI form @c file:///path/to/an/image.png and the entry will then
11737     * use that image for the item.
11738     *
11739     * @section entry-files Loading and saving files
11740     *
11741     * Entries have convinience functions to load text from a file and save
11742     * changes back to it after a short delay. The automatic saving is enabled
11743     * by default, but can be disabled with elm_entry_autosave_set() and files
11744     * can be loaded directly as plain text or have any markup in them
11745     * recognized. See elm_entry_file_set() for more details.
11746     *
11747     * @section entry-signals Emitted signals
11748     *
11749     * This widget emits the following signals:
11750     *
11751     * @li "changed": The text within the entry was changed.
11752     * @li "changed,user": The text within the entry was changed because of user interaction.
11753     * @li "activated": The enter key was pressed on a single line entry.
11754     * @li "press": A mouse button has been pressed on the entry.
11755     * @li "longpressed": A mouse button has been pressed and held for a couple
11756     * seconds.
11757     * @li "clicked": The entry has been clicked (mouse press and release).
11758     * @li "clicked,double": The entry has been double clicked.
11759     * @li "clicked,triple": The entry has been triple clicked.
11760     * @li "focused": The entry has received focus.
11761     * @li "unfocused": The entry has lost focus.
11762     * @li "selection,paste": A paste of the clipboard contents was requested.
11763     * @li "selection,copy": A copy of the selected text into the clipboard was
11764     * requested.
11765     * @li "selection,cut": A cut of the selected text into the clipboard was
11766     * requested.
11767     * @li "selection,start": A selection has begun and no previous selection
11768     * existed.
11769     * @li "selection,changed": The current selection has changed.
11770     * @li "selection,cleared": The current selection has been cleared.
11771     * @li "cursor,changed": The cursor has changed position.
11772     * @li "anchor,clicked": An anchor has been clicked. The event_info
11773     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11774     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11775     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11776     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11777     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11778     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11779     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11780     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11781     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11782     * @li "preedit,changed": The preedit string has changed.
11783     * @li "language,changed": Program language changed.
11784     *
11785     * @section entry-examples
11786     *
11787     * An overview of the Entry API can be seen in @ref entry_example_01
11788     *
11789     * @{
11790     */
11791
11792    /**
11793     * @typedef Elm_Entry_Anchor_Info
11794     *
11795     * The info sent in the callback for the "anchor,clicked" signals emitted
11796     * by entries.
11797     */
11798    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11799
11800    /**
11801     * @struct _Elm_Entry_Anchor_Info
11802     *
11803     * The info sent in the callback for the "anchor,clicked" signals emitted
11804     * by entries.
11805     */
11806    struct _Elm_Entry_Anchor_Info
11807      {
11808         const char *name; /**< The name of the anchor, as stated in its href */
11809         int         button; /**< The mouse button used to click on it */
11810         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
11811                     y, /**< Anchor geometry, relative to canvas */
11812                     w, /**< Anchor geometry, relative to canvas */
11813                     h; /**< Anchor geometry, relative to canvas */
11814      };
11815
11816    /**
11817     * @typedef Elm_Entry_Filter_Cb
11818     * This callback type is used by entry filters to modify text.
11819     * @param data The data specified as the last param when adding the filter
11820     * @param entry The entry object
11821     * @param text A pointer to the location of the text being filtered. This data can be modified,
11822     * but any additional allocations must be managed by the user.
11823     * @see elm_entry_text_filter_append
11824     * @see elm_entry_text_filter_prepend
11825     */
11826    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11827
11828    /**
11829     * @typedef Elm_Entry_Change_Info
11830     * This corresponds to Edje_Entry_Change_Info. Includes information about
11831     * a change in the entry.
11832     */
11833    typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
11834
11835
11836    /**
11837     * This adds an entry to @p parent object.
11838     *
11839     * By default, entries are:
11840     * @li not scrolled
11841     * @li multi-line
11842     * @li word wrapped
11843     * @li autosave is enabled
11844     *
11845     * @param parent The parent object
11846     * @return The new object or NULL if it cannot be created
11847     */
11848    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11849
11850    /**
11851     * Sets the entry to single line mode.
11852     *
11853     * In single line mode, entries don't ever wrap when the text reaches the
11854     * edge, and instead they keep growing horizontally. Pressing the @c Enter
11855     * key will generate an @c "activate" event instead of adding a new line.
11856     *
11857     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11858     * and pressing enter will break the text into a different line
11859     * without generating any events.
11860     *
11861     * @param obj The entry object
11862     * @param single_line If true, the text in the entry
11863     * will be on a single line.
11864     */
11865    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11866
11867    /**
11868     * Gets whether the entry is set to be single line.
11869     *
11870     * @param obj The entry object
11871     * @return single_line If true, the text in the entry is set to display
11872     * on a single line.
11873     *
11874     * @see elm_entry_single_line_set()
11875     */
11876    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11877
11878    /**
11879     * Sets the entry to password mode.
11880     *
11881     * In password mode, entries are implicitly single line and the display of
11882     * any text in them is replaced with asterisks (*).
11883     *
11884     * @param obj The entry object
11885     * @param password If true, password mode is enabled.
11886     */
11887    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11888
11889    /**
11890     * Gets whether the entry is set to password mode.
11891     *
11892     * @param obj The entry object
11893     * @return If true, the entry is set to display all characters
11894     * as asterisks (*).
11895     *
11896     * @see elm_entry_password_set()
11897     */
11898    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11899
11900    /**
11901     * This sets the text displayed within the entry to @p entry.
11902     *
11903     * @param obj The entry object
11904     * @param entry The text to be displayed
11905     *
11906     * @deprecated Use elm_object_text_set() instead.
11907     * @note Using this function bypasses text filters
11908     */
11909    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11910
11911    /**
11912     * This returns the text currently shown in object @p entry.
11913     * See also elm_entry_entry_set().
11914     *
11915     * @param obj The entry object
11916     * @return The currently displayed text or NULL on failure
11917     *
11918     * @deprecated Use elm_object_text_get() instead.
11919     */
11920    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11921
11922    /**
11923     * Appends @p entry to the text of the entry.
11924     *
11925     * Adds the text in @p entry to the end of any text already present in the
11926     * widget.
11927     *
11928     * The appended text is subject to any filters set for the widget.
11929     *
11930     * @param obj The entry object
11931     * @param entry The text to be displayed
11932     *
11933     * @see elm_entry_text_filter_append()
11934     */
11935    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11936
11937    /**
11938     * Gets whether the entry is empty.
11939     *
11940     * Empty means no text at all. If there are any markup tags, like an item
11941     * tag for which no provider finds anything, and no text is displayed, this
11942     * function still returns EINA_FALSE.
11943     *
11944     * @param obj The entry object
11945     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11946     */
11947    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11948
11949    /**
11950     * Gets any selected text within the entry.
11951     *
11952     * If there's any selected text in the entry, this function returns it as
11953     * a string in markup format. NULL is returned if no selection exists or
11954     * if an error occurred.
11955     *
11956     * The returned value points to an internal string and should not be freed
11957     * or modified in any way. If the @p entry object is deleted or its
11958     * contents are changed, the returned pointer should be considered invalid.
11959     *
11960     * @param obj The entry object
11961     * @return The selected text within the entry or NULL on failure
11962     */
11963    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11964
11965    /**
11966     * Returns the actual textblock object of the entry.
11967     *
11968     * This function exposes the internal textblock object that actually
11969     * contains and draws the text. This should be used for low-level
11970     * manipulations that are otherwise not possible.
11971     *
11972     * Changing the textblock directly from here will not notify edje/elm to
11973     * recalculate the textblock size automatically, so any modifications
11974     * done to the textblock returned by this function should be followed by
11975     * a call to elm_entry_calc_force().
11976     *
11977     * The return value is marked as const as an additional warning.
11978     * One should not use the returned object with any of the generic evas
11979     * functions (geometry_get/resize/move and etc), but only with the textblock
11980     * functions; The former will either not work at all, or break the correct
11981     * functionality.
11982     *
11983     * IMPORTANT: Many functions may change (i.e delete and create a new one)
11984     * the internal textblock object. Do NOT cache the returned object, and try
11985     * not to mix calls on this object with regular elm_entry calls (which may
11986     * change the internal textblock object). This applies to all cursors
11987     * returned from textblock calls, and all the other derivative values.
11988     *
11989     * @param obj The entry object
11990     * @return The textblock object.
11991     */
11992    EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11993
11994    /**
11995     * Forces calculation of the entry size and text layouting.
11996     *
11997     * This should be used after modifying the textblock object directly. See
11998     * elm_entry_textblock_get() for more information.
11999     *
12000     * @param obj The entry object
12001     *
12002     * @see elm_entry_textblock_get()
12003     */
12004    EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12005
12006    /**
12007     * Inserts the given text into the entry at the current cursor position.
12008     *
12009     * This inserts text at the cursor position as if it was typed
12010     * by the user (note that this also allows markup which a user
12011     * can't just "type" as it would be converted to escaped text, so this
12012     * call can be used to insert things like emoticon items or bold push/pop
12013     * tags, other font and color change tags etc.)
12014     *
12015     * If any selection exists, it will be replaced by the inserted text.
12016     *
12017     * The inserted text is subject to any filters set for the widget.
12018     *
12019     * @param obj The entry object
12020     * @param entry The text to insert
12021     *
12022     * @see elm_entry_text_filter_append()
12023     */
12024    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
12025
12026    /**
12027     * Set the line wrap type to use on multi-line entries.
12028     *
12029     * Sets the wrap type used by the entry to any of the specified in
12030     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
12031     * line (without inserting a line break or paragraph separator) when it
12032     * reaches the far edge of the widget.
12033     *
12034     * Note that this only makes sense for multi-line entries. A widget set
12035     * to be single line will never wrap.
12036     *
12037     * @param obj The entry object
12038     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
12039     */
12040    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
12041
12042    /**
12043     * Gets the wrap mode the entry was set to use.
12044     *
12045     * @param obj The entry object
12046     * @return Wrap type
12047     *
12048     * @see also elm_entry_line_wrap_set()
12049     */
12050    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12051
12052    /**
12053     * Sets if the entry is to be editable or not.
12054     *
12055     * By default, entries are editable and when focused, any text input by the
12056     * user will be inserted at the current cursor position. But calling this
12057     * function with @p editable as EINA_FALSE will prevent the user from
12058     * inputting text into the entry.
12059     *
12060     * The only way to change the text of a non-editable entry is to use
12061     * elm_object_text_set(), elm_entry_entry_insert() and other related
12062     * functions.
12063     *
12064     * @param obj The entry object
12065     * @param editable If EINA_TRUE, user input will be inserted in the entry,
12066     * if not, the entry is read-only and no user input is allowed.
12067     */
12068    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
12069
12070    /**
12071     * Gets whether the entry is editable or not.
12072     *
12073     * @param obj The entry object
12074     * @return If true, the entry is editable by the user.
12075     * If false, it is not editable by the user
12076     *
12077     * @see elm_entry_editable_set()
12078     */
12079    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12080
12081    /**
12082     * This drops any existing text selection within the entry.
12083     *
12084     * @param obj The entry object
12085     */
12086    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
12087
12088    /**
12089     * This selects all text within the entry.
12090     *
12091     * @param obj The entry object
12092     */
12093    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
12094
12095    /**
12096     * This moves the cursor one place to the right within the entry.
12097     *
12098     * @param obj The entry object
12099     * @return EINA_TRUE upon success, EINA_FALSE upon failure
12100     */
12101    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
12102
12103    /**
12104     * This moves the cursor one place to the left within the entry.
12105     *
12106     * @param obj The entry object
12107     * @return EINA_TRUE upon success, EINA_FALSE upon failure
12108     */
12109    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
12110
12111    /**
12112     * This moves the cursor one line up within the entry.
12113     *
12114     * @param obj The entry object
12115     * @return EINA_TRUE upon success, EINA_FALSE upon failure
12116     */
12117    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
12118
12119    /**
12120     * This moves the cursor one line down within the entry.
12121     *
12122     * @param obj The entry object
12123     * @return EINA_TRUE upon success, EINA_FALSE upon failure
12124     */
12125    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
12126
12127    /**
12128     * This moves the cursor to the beginning of the entry.
12129     *
12130     * @param obj The entry object
12131     */
12132    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12133
12134    /**
12135     * This moves the cursor to the end of the entry.
12136     *
12137     * @param obj The entry object
12138     */
12139    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12140
12141    /**
12142     * This moves the cursor to the beginning of the current line.
12143     *
12144     * @param obj The entry object
12145     */
12146    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12147
12148    /**
12149     * This moves the cursor to the end of the current line.
12150     *
12151     * @param obj The entry object
12152     */
12153    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12154
12155    /**
12156     * This begins a selection within the entry as though
12157     * the user were holding down the mouse button to make a selection.
12158     *
12159     * @param obj The entry object
12160     */
12161    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12162
12163    /**
12164     * This ends a selection within the entry as though
12165     * the user had just released the mouse button while making a selection.
12166     *
12167     * @param obj The entry object
12168     */
12169    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12170
12171    /**
12172     * Gets whether a format node exists at the current cursor position.
12173     *
12174     * A format node is anything that defines how the text is rendered. It can
12175     * be a visible format node, such as a line break or a paragraph separator,
12176     * or an invisible one, such as bold begin or end tag.
12177     * This function returns whether any format node exists at the current
12178     * cursor position.
12179     *
12180     * @param obj The entry object
12181     * @return EINA_TRUE if the current cursor position contains a format node,
12182     * EINA_FALSE otherwise.
12183     *
12184     * @see elm_entry_cursor_is_visible_format_get()
12185     */
12186    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12187
12188    /**
12189     * Gets if the current cursor position holds a visible format node.
12190     *
12191     * @param obj The entry object
12192     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
12193     * if it's an invisible one or no format exists.
12194     *
12195     * @see elm_entry_cursor_is_format_get()
12196     */
12197    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12198
12199    /**
12200     * Gets the character pointed by the cursor at its current position.
12201     *
12202     * This function returns a string with the utf8 character stored at the
12203     * current cursor position.
12204     * Only the text is returned, any format that may exist will not be part
12205     * of the return value.
12206     *
12207     * @param obj The entry object
12208     * @return The text pointed by the cursors.
12209     */
12210    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12211
12212    /**
12213     * This function returns the geometry of the cursor.
12214     *
12215     * It's useful if you want to draw something on the cursor (or where it is),
12216     * or for example in the case of scrolled entry where you want to show the
12217     * cursor.
12218     *
12219     * @param obj The entry object
12220     * @param x returned geometry
12221     * @param y returned geometry
12222     * @param w returned geometry
12223     * @param h returned geometry
12224     * @return EINA_TRUE upon success, EINA_FALSE upon failure
12225     */
12226    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);
12227
12228    /**
12229     * Sets the cursor position in the entry to the given value
12230     *
12231     * The value in @p pos is the index of the character position within the
12232     * contents of the string as returned by elm_entry_cursor_pos_get().
12233     *
12234     * @param obj The entry object
12235     * @param pos The position of the cursor
12236     */
12237    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
12238
12239    /**
12240     * Retrieves the current position of the cursor in the entry
12241     *
12242     * @param obj The entry object
12243     * @return The cursor position
12244     */
12245    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12246
12247    /**
12248     * This executes a "cut" action on the selected text in the entry.
12249     *
12250     * @param obj The entry object
12251     */
12252    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
12253
12254    /**
12255     * This executes a "copy" action on the selected text in the entry.
12256     *
12257     * @param obj The entry object
12258     */
12259    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
12260
12261    /**
12262     * This executes a "paste" action in the entry.
12263     *
12264     * @param obj The entry object
12265     */
12266    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
12267
12268    /**
12269     * This clears and frees the items in a entry's contextual (longpress)
12270     * menu.
12271     *
12272     * @param obj The entry object
12273     *
12274     * @see elm_entry_context_menu_item_add()
12275     */
12276    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12277
12278    /**
12279     * This adds an item to the entry's contextual menu.
12280     *
12281     * A longpress on an entry will make the contextual menu show up, if this
12282     * hasn't been disabled with elm_entry_context_menu_disabled_set().
12283     * By default, this menu provides a few options like enabling selection mode,
12284     * which is useful on embedded devices that need to be explicit about it,
12285     * and when a selection exists it also shows the copy and cut actions.
12286     *
12287     * With this function, developers can add other options to this menu to
12288     * perform any action they deem necessary.
12289     *
12290     * @param obj The entry object
12291     * @param label The item's text label
12292     * @param icon_file The item's icon file
12293     * @param icon_type The item's icon type
12294     * @param func The callback to execute when the item is clicked
12295     * @param data The data to associate with the item for related functions
12296     */
12297    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);
12298
12299    /**
12300     * This disables the entry's contextual (longpress) menu.
12301     *
12302     * @param obj The entry object
12303     * @param disabled If true, the menu is disabled
12304     */
12305    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12306
12307    /**
12308     * This returns whether the entry's contextual (longpress) menu is
12309     * disabled.
12310     *
12311     * @param obj The entry object
12312     * @return If true, the menu is disabled
12313     */
12314    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12315
12316    /**
12317     * This appends a custom item provider to the list for that entry
12318     *
12319     * This appends the given callback. The list is walked from beginning to end
12320     * with each function called given the item href string in the text. If the
12321     * function returns an object handle other than NULL (it should create an
12322     * object to do this), then this object is used to replace that item. If
12323     * not the next provider is called until one provides an item object, or the
12324     * default provider in entry does.
12325     *
12326     * @param obj The entry object
12327     * @param func The function called to provide the item object
12328     * @param data The data passed to @p func
12329     *
12330     * @see @ref entry-items
12331     */
12332    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);
12333
12334    /**
12335     * This prepends a custom item provider to the list for that entry
12336     *
12337     * This prepends the given callback. See elm_entry_item_provider_append() for
12338     * more information
12339     *
12340     * @param obj The entry object
12341     * @param func The function called to provide the item object
12342     * @param data The data passed to @p func
12343     */
12344    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);
12345
12346    /**
12347     * This removes a custom item provider to the list for that entry
12348     *
12349     * This removes the given callback. See elm_entry_item_provider_append() for
12350     * more information
12351     *
12352     * @param obj The entry object
12353     * @param func The function called to provide the item object
12354     * @param data The data passed to @p func
12355     */
12356    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);
12357
12358    /**
12359     * Append a filter function for text inserted in the entry
12360     *
12361     * Append the given callback to the list. This functions will be called
12362     * whenever any text is inserted into the entry, with the text to be inserted
12363     * as a parameter. The callback function is free to alter the text in any way
12364     * it wants, but it must remember to free the given pointer and update it.
12365     * If the new text is to be discarded, the function can free it and set its
12366     * text parameter to NULL. This will also prevent any following filters from
12367     * being called.
12368     *
12369     * @param obj The entry object
12370     * @param func The function to use as text filter
12371     * @param data User data to pass to @p func
12372     */
12373    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
12374
12375    /**
12376     * Prepend a filter function for text insdrted in the entry
12377     *
12378     * Prepend the given callback to the list. See elm_entry_text_filter_append()
12379     * for more information
12380     *
12381     * @param obj The entry object
12382     * @param func The function to use as text filter
12383     * @param data User data to pass to @p func
12384     */
12385    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
12386
12387    /**
12388     * Remove a filter from the list
12389     *
12390     * Removes the given callback from the filter list. See
12391     * elm_entry_text_filter_append() for more information.
12392     *
12393     * @param obj The entry object
12394     * @param func The filter function to remove
12395     * @param data The user data passed when adding the function
12396     */
12397    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
12398
12399    /**
12400     * This converts a markup (HTML-like) string into UTF-8.
12401     *
12402     * The returned string is a malloc'ed buffer and it should be freed when
12403     * not needed anymore.
12404     *
12405     * @param s The string (in markup) to be converted
12406     * @return The converted string (in UTF-8). It should be freed.
12407     */
12408    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
12409
12410    /**
12411     * This converts a UTF-8 string into markup (HTML-like).
12412     *
12413     * The returned string is a malloc'ed buffer and it should be freed when
12414     * not needed anymore.
12415     *
12416     * @param s The string (in UTF-8) to be converted
12417     * @return The converted string (in markup). It should be freed.
12418     */
12419    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
12420
12421    /**
12422     * This sets the file (and implicitly loads it) for the text to display and
12423     * then edit. All changes are written back to the file after a short delay if
12424     * the entry object is set to autosave (which is the default).
12425     *
12426     * If the entry had any other file set previously, any changes made to it
12427     * will be saved if the autosave feature is enabled, otherwise, the file
12428     * will be silently discarded and any non-saved changes will be lost.
12429     *
12430     * @param obj The entry object
12431     * @param file The path to the file to load and save
12432     * @param format The file format
12433     */
12434    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
12435
12436    /**
12437     * Gets the file being edited by the entry.
12438     *
12439     * This function can be used to retrieve any file set on the entry for
12440     * edition, along with the format used to load and save it.
12441     *
12442     * @param obj The entry object
12443     * @param file The path to the file to load and save
12444     * @param format The file format
12445     */
12446    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
12447
12448    /**
12449     * This function writes any changes made to the file set with
12450     * elm_entry_file_set()
12451     *
12452     * @param obj The entry object
12453     */
12454    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
12455
12456    /**
12457     * This sets the entry object to 'autosave' the loaded text file or not.
12458     *
12459     * @param obj The entry object
12460     * @param autosave Autosave the loaded file or not
12461     *
12462     * @see elm_entry_file_set()
12463     */
12464    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
12465
12466    /**
12467     * This gets the entry object's 'autosave' status.
12468     *
12469     * @param obj The entry object
12470     * @return Autosave the loaded file or not
12471     *
12472     * @see elm_entry_file_set()
12473     */
12474    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12475
12476    /**
12477     * Control pasting of text and images for the widget.
12478     *
12479     * Normally the entry allows both text and images to be pasted.  By setting
12480     * textonly to be true, this prevents images from being pasted.
12481     *
12482     * Note this only changes the behaviour of text.
12483     *
12484     * @param obj The entry object
12485     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
12486     * text+image+other.
12487     */
12488    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
12489
12490    /**
12491     * Getting elm_entry text paste/drop mode.
12492     *
12493     * In textonly mode, only text may be pasted or dropped into the widget.
12494     *
12495     * @param obj The entry object
12496     * @return If the widget only accepts text from pastes.
12497     */
12498    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12499
12500    /**
12501     * Enable or disable scrolling in entry
12502     *
12503     * Normally the entry is not scrollable unless you enable it with this call.
12504     *
12505     * @param obj The entry object
12506     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
12507     */
12508    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
12509
12510    /**
12511     * Get the scrollable state of the entry
12512     *
12513     * Normally the entry is not scrollable. This gets the scrollable state
12514     * of the entry. See elm_entry_scrollable_set() for more information.
12515     *
12516     * @param obj The entry object
12517     * @return The scrollable state
12518     */
12519    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
12520
12521    /**
12522     * This sets a widget to be displayed to the left of a scrolled entry.
12523     *
12524     * @param obj The scrolled entry object
12525     * @param icon The widget to display on the left side of the scrolled
12526     * entry.
12527     *
12528     * @note A previously set widget will be destroyed.
12529     * @note If the object being set does not have minimum size hints set,
12530     * it won't get properly displayed.
12531     *
12532     * @see elm_entry_end_set()
12533     */
12534    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
12535
12536    /**
12537     * Gets the leftmost widget of the scrolled entry. This object is
12538     * owned by the scrolled entry and should not be modified.
12539     *
12540     * @param obj The scrolled entry object
12541     * @return the left widget inside the scroller
12542     */
12543    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
12544
12545    /**
12546     * Unset the leftmost widget of the scrolled entry, unparenting and
12547     * returning it.
12548     *
12549     * @param obj The scrolled entry object
12550     * @return the previously set icon sub-object of this entry, on
12551     * success.
12552     *
12553     * @see elm_entry_icon_set()
12554     */
12555    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
12556
12557    /**
12558     * Sets the visibility of the left-side widget of the scrolled entry,
12559     * set by elm_entry_icon_set().
12560     *
12561     * @param obj The scrolled entry object
12562     * @param setting EINA_TRUE if the object should be displayed,
12563     * EINA_FALSE if not.
12564     */
12565    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
12566
12567    /**
12568     * This sets a widget to be displayed to the end of a scrolled entry.
12569     *
12570     * @param obj The scrolled entry object
12571     * @param end The widget to display on the right side of the scrolled
12572     * entry.
12573     *
12574     * @note A previously set widget will be destroyed.
12575     * @note If the object being set does not have minimum size hints set,
12576     * it won't get properly displayed.
12577     *
12578     * @see elm_entry_icon_set
12579     */
12580    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
12581
12582    /**
12583     * Gets the endmost widget of the scrolled entry. This object is owned
12584     * by the scrolled entry and should not be modified.
12585     *
12586     * @param obj The scrolled entry object
12587     * @return the right widget inside the scroller
12588     */
12589    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
12590
12591    /**
12592     * Unset the endmost widget of the scrolled entry, unparenting and
12593     * returning it.
12594     *
12595     * @param obj The scrolled entry object
12596     * @return the previously set icon sub-object of this entry, on
12597     * success.
12598     *
12599     * @see elm_entry_icon_set()
12600     */
12601    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
12602
12603    /**
12604     * Sets the visibility of the end widget of the scrolled entry, set by
12605     * elm_entry_end_set().
12606     *
12607     * @param obj The scrolled entry object
12608     * @param setting EINA_TRUE if the object should be displayed,
12609     * EINA_FALSE if not.
12610     */
12611    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
12612
12613    /**
12614     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
12615     * them).
12616     *
12617     * Setting an entry to single-line mode with elm_entry_single_line_set()
12618     * will automatically disable the display of scrollbars when the entry
12619     * moves inside its scroller.
12620     *
12621     * @param obj The scrolled entry object
12622     * @param h The horizontal scrollbar policy to apply
12623     * @param v The vertical scrollbar policy to apply
12624     */
12625    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
12626
12627    /**
12628     * This enables/disables bouncing within the entry.
12629     *
12630     * This function sets whether the entry will bounce when scrolling reaches
12631     * the end of the contained entry.
12632     *
12633     * @param obj The scrolled entry object
12634     * @param h The horizontal bounce state
12635     * @param v The vertical bounce state
12636     */
12637    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
12638
12639    /**
12640     * Get the bounce mode
12641     *
12642     * @param obj The Entry object
12643     * @param h_bounce Allow bounce horizontally
12644     * @param v_bounce Allow bounce vertically
12645     */
12646    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
12647
12648    /* pre-made filters for entries */
12649    /**
12650     * @typedef Elm_Entry_Filter_Limit_Size
12651     *
12652     * Data for the elm_entry_filter_limit_size() entry filter.
12653     */
12654    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
12655
12656    /**
12657     * @struct _Elm_Entry_Filter_Limit_Size
12658     *
12659     * Data for the elm_entry_filter_limit_size() entry filter.
12660     */
12661    struct _Elm_Entry_Filter_Limit_Size
12662      {
12663         int max_char_count; /**< The maximum number of characters allowed. */
12664         int max_byte_count; /**< The maximum number of bytes allowed*/
12665      };
12666
12667    /**
12668     * Filter inserted text based on user defined character and byte limits
12669     *
12670     * Add this filter to an entry to limit the characters that it will accept
12671     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
12672     * The funtion works on the UTF-8 representation of the string, converting
12673     * it from the set markup, thus not accounting for any format in it.
12674     *
12675     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
12676     * it as data when setting the filter. In it, it's possible to set limits
12677     * by character count or bytes (any of them is disabled if 0), and both can
12678     * be set at the same time. In that case, it first checks for characters,
12679     * then bytes.
12680     *
12681     * The function will cut the inserted text in order to allow only the first
12682     * number of characters that are still allowed. The cut is made in
12683     * characters, even when limiting by bytes, in order to always contain
12684     * valid ones and avoid half unicode characters making it in.
12685     *
12686     * This filter, like any others, does not apply when setting the entry text
12687     * directly with elm_object_text_set() (or the deprecated
12688     * elm_entry_entry_set()).
12689     */
12690    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
12691
12692    /**
12693     * @typedef Elm_Entry_Filter_Accept_Set
12694     *
12695     * Data for the elm_entry_filter_accept_set() entry filter.
12696     */
12697    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
12698
12699    /**
12700     * @struct _Elm_Entry_Filter_Accept_Set
12701     *
12702     * Data for the elm_entry_filter_accept_set() entry filter.
12703     */
12704    struct _Elm_Entry_Filter_Accept_Set
12705      {
12706         const char *accepted; /**< Set of characters accepted in the entry. */
12707         const char *rejected; /**< Set of characters rejected from the entry. */
12708      };
12709
12710    /**
12711     * Filter inserted text based on accepted or rejected sets of characters
12712     *
12713     * Add this filter to an entry to restrict the set of accepted characters
12714     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
12715     * This structure contains both accepted and rejected sets, but they are
12716     * mutually exclusive.
12717     *
12718     * The @c accepted set takes preference, so if it is set, the filter will
12719     * only work based on the accepted characters, ignoring anything in the
12720     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
12721     *
12722     * In both cases, the function filters by matching utf8 characters to the
12723     * raw markup text, so it can be used to remove formatting tags.
12724     *
12725     * This filter, like any others, does not apply when setting the entry text
12726     * directly with elm_object_text_set() (or the deprecated
12727     * elm_entry_entry_set()).
12728     */
12729    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
12730    /**
12731     * Set the input panel layout of the entry
12732     *
12733     * @param obj The entry object
12734     * @param layout layout type
12735     */
12736    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
12737
12738    /**
12739     * Get the input panel layout of the entry
12740     *
12741     * @param obj The entry object
12742     * @return layout type
12743     *
12744     * @see elm_entry_input_panel_layout_set
12745     */
12746    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12747
12748    /**
12749     * Set the autocapitalization type on the immodule.
12750     *
12751     * @param obj The entry object
12752     * @param autocapital_type The type of autocapitalization
12753     */
12754    EAPI void         elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
12755
12756    /**
12757     * Retrieve the autocapitalization type on the immodule.
12758     *
12759     * @param obj The entry object
12760     * @return autocapitalization type
12761     */
12762    EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12763
12764    /**
12765     * Sets the attribute to show the input panel automatically.
12766     *
12767     * @param obj The entry object
12768     * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12769     */
12770    EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12771
12772    /**
12773     * Retrieve the attribute to show the input panel automatically.
12774     *
12775     * @param obj The entry object
12776     * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12777     */
12778    EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12779
12780    /**
12781     * @}
12782     */
12783
12784    /* composite widgets - these basically put together basic widgets above
12785     * in convenient packages that do more than basic stuff */
12786
12787    /* anchorview */
12788    /**
12789     * @defgroup Anchorview Anchorview
12790     *
12791     * @image html img/widget/anchorview/preview-00.png
12792     * @image latex img/widget/anchorview/preview-00.eps
12793     *
12794     * Anchorview is for displaying text that contains markup with anchors
12795     * like <c>\<a href=1234\>something\</\></c> in it.
12796     *
12797     * Besides being styled differently, the anchorview widget provides the
12798     * necessary functionality so that clicking on these anchors brings up a
12799     * popup with user defined content such as "call", "add to contacts" or
12800     * "open web page". This popup is provided using the @ref Hover widget.
12801     *
12802     * This widget is very similar to @ref Anchorblock, so refer to that
12803     * widget for an example. The only difference Anchorview has is that the
12804     * widget is already provided with scrolling functionality, so if the
12805     * text set to it is too large to fit in the given space, it will scroll,
12806     * whereas the @ref Anchorblock widget will keep growing to ensure all the
12807     * text can be displayed.
12808     *
12809     * This widget emits the following signals:
12810     * @li "anchor,clicked": will be called when an anchor is clicked. The
12811     * @p event_info parameter on the callback will be a pointer of type
12812     * ::Elm_Entry_Anchorview_Info.
12813     *
12814     * See @ref Anchorblock for an example on how to use both of them.
12815     *
12816     * @see Anchorblock
12817     * @see Entry
12818     * @see Hover
12819     *
12820     * @{
12821     */
12822
12823    /**
12824     * @typedef Elm_Entry_Anchorview_Info
12825     *
12826     * The info sent in the callback for "anchor,clicked" signals emitted by
12827     * the Anchorview widget.
12828     */
12829    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12830
12831    /**
12832     * @struct _Elm_Entry_Anchorview_Info
12833     *
12834     * The info sent in the callback for "anchor,clicked" signals emitted by
12835     * the Anchorview widget.
12836     */
12837    struct _Elm_Entry_Anchorview_Info
12838      {
12839         const char     *name; /**< Name of the anchor, as indicated in its href
12840                                    attribute */
12841         int             button; /**< The mouse button used to click on it */
12842         Evas_Object    *hover; /**< The hover object to use for the popup */
12843         struct {
12844              Evas_Coord    x, y, w, h;
12845         } anchor, /**< Geometry selection of text used as anchor */
12846           hover_parent; /**< Geometry of the object used as parent by the
12847                              hover */
12848         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12849                                              for content on the left side of
12850                                              the hover. Before calling the
12851                                              callback, the widget will make the
12852                                              necessary calculations to check
12853                                              which sides are fit to be set with
12854                                              content, based on the position the
12855                                              hover is activated and its distance
12856                                              to the edges of its parent object
12857                                              */
12858         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12859                                               the right side of the hover.
12860                                               See @ref hover_left */
12861         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12862                                             of the hover. See @ref hover_left */
12863         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12864                                                below the hover. See @ref
12865                                                hover_left */
12866      };
12867
12868    /**
12869     * Add a new Anchorview object
12870     *
12871     * @param parent The parent object
12872     * @return The new object or NULL if it cannot be created
12873     */
12874    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12875
12876    /**
12877     * Set the text to show in the anchorview
12878     *
12879     * Sets the text of the anchorview to @p text. This text can include markup
12880     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12881     * text that will be specially styled and react to click events, ended with
12882     * either of \</a\> or \</\>. When clicked, the anchor will emit an
12883     * "anchor,clicked" signal that you can attach a callback to with
12884     * evas_object_smart_callback_add(). The name of the anchor given in the
12885     * event info struct will be the one set in the href attribute, in this
12886     * case, anchorname.
12887     *
12888     * Other markup can be used to style the text in different ways, but it's
12889     * up to the style defined in the theme which tags do what.
12890     * @deprecated use elm_object_text_set() instead.
12891     */
12892    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12893
12894    /**
12895     * Get the markup text set for the anchorview
12896     *
12897     * Retrieves the text set on the anchorview, with markup tags included.
12898     *
12899     * @param obj The anchorview object
12900     * @return The markup text set or @c NULL if nothing was set or an error
12901     * occurred
12902     * @deprecated use elm_object_text_set() instead.
12903     */
12904    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12905
12906    /**
12907     * Set the parent of the hover popup
12908     *
12909     * Sets the parent object to use by the hover created by the anchorview
12910     * when an anchor is clicked. See @ref Hover for more details on this.
12911     * If no parent is set, the same anchorview object will be used.
12912     *
12913     * @param obj The anchorview object
12914     * @param parent The object to use as parent for the hover
12915     */
12916    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12917
12918    /**
12919     * Get the parent of the hover popup
12920     *
12921     * Get the object used as parent for the hover created by the anchorview
12922     * widget. See @ref Hover for more details on this.
12923     *
12924     * @param obj The anchorview object
12925     * @return The object used as parent for the hover, NULL if none is set.
12926     */
12927    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12928
12929    /**
12930     * Set the style that the hover should use
12931     *
12932     * When creating the popup hover, anchorview will request that it's
12933     * themed according to @p style.
12934     *
12935     * @param obj The anchorview object
12936     * @param style The style to use for the underlying hover
12937     *
12938     * @see elm_object_style_set()
12939     */
12940    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12941
12942    /**
12943     * Get the style that the hover should use
12944     *
12945     * Get the style the hover created by anchorview will use.
12946     *
12947     * @param obj The anchorview object
12948     * @return The style to use by the hover. NULL means the default is used.
12949     *
12950     * @see elm_object_style_set()
12951     */
12952    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12953
12954    /**
12955     * Ends the hover popup in the anchorview
12956     *
12957     * When an anchor is clicked, the anchorview widget will create a hover
12958     * object to use as a popup with user provided content. This function
12959     * terminates this popup, returning the anchorview to its normal state.
12960     *
12961     * @param obj The anchorview object
12962     */
12963    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12964
12965    /**
12966     * Set bouncing behaviour when the scrolled content reaches an edge
12967     *
12968     * Tell the internal scroller object whether it should bounce or not
12969     * when it reaches the respective edges for each axis.
12970     *
12971     * @param obj The anchorview object
12972     * @param h_bounce Whether to bounce or not in the horizontal axis
12973     * @param v_bounce Whether to bounce or not in the vertical axis
12974     *
12975     * @see elm_scroller_bounce_set()
12976     */
12977    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12978
12979    /**
12980     * Get the set bouncing behaviour of the internal scroller
12981     *
12982     * Get whether the internal scroller should bounce when the edge of each
12983     * axis is reached scrolling.
12984     *
12985     * @param obj The anchorview object
12986     * @param h_bounce Pointer where to store the bounce state of the horizontal
12987     *                 axis
12988     * @param v_bounce Pointer where to store the bounce state of the vertical
12989     *                 axis
12990     *
12991     * @see elm_scroller_bounce_get()
12992     */
12993    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12994
12995    /**
12996     * Appends a custom item provider to the given anchorview
12997     *
12998     * Appends the given function to the list of items providers. This list is
12999     * called, one function at a time, with the given @p data pointer, the
13000     * anchorview object and, in the @p item parameter, the item name as
13001     * referenced in its href string. Following functions in the list will be
13002     * called in order until one of them returns something different to NULL,
13003     * which should be an Evas_Object which will be used in place of the item
13004     * element.
13005     *
13006     * Items in the markup text take the form \<item relsize=16x16 vsize=full
13007     * href=item/name\>\</item\>
13008     *
13009     * @param obj The anchorview object
13010     * @param func The function to add to the list of providers
13011     * @param data User data that will be passed to the callback function
13012     *
13013     * @see elm_entry_item_provider_append()
13014     */
13015    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);
13016
13017    /**
13018     * Prepend a custom item provider to the given anchorview
13019     *
13020     * Like elm_anchorview_item_provider_append(), but it adds the function
13021     * @p func to the beginning of the list, instead of the end.
13022     *
13023     * @param obj The anchorview object
13024     * @param func The function to add to the list of providers
13025     * @param data User data that will be passed to the callback function
13026     */
13027    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);
13028
13029    /**
13030     * Remove a custom item provider from the list of the given anchorview
13031     *
13032     * Removes the function and data pairing that matches @p func and @p data.
13033     * That is, unless the same function and same user data are given, the
13034     * function will not be removed from the list. This allows us to add the
13035     * same callback several times, with different @p data pointers and be
13036     * able to remove them later without conflicts.
13037     *
13038     * @param obj The anchorview object
13039     * @param func The function to remove from the list
13040     * @param data The data matching the function to remove from the list
13041     */
13042    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);
13043
13044    /**
13045     * @}
13046     */
13047
13048    /* anchorblock */
13049    /**
13050     * @defgroup Anchorblock Anchorblock
13051     *
13052     * @image html img/widget/anchorblock/preview-00.png
13053     * @image latex img/widget/anchorblock/preview-00.eps
13054     *
13055     * Anchorblock is for displaying text that contains markup with anchors
13056     * like <c>\<a href=1234\>something\</\></c> in it.
13057     *
13058     * Besides being styled differently, the anchorblock widget provides the
13059     * necessary functionality so that clicking on these anchors brings up a
13060     * popup with user defined content such as "call", "add to contacts" or
13061     * "open web page". This popup is provided using the @ref Hover widget.
13062     *
13063     * This widget emits the following signals:
13064     * @li "anchor,clicked": will be called when an anchor is clicked. The
13065     * @p event_info parameter on the callback will be a pointer of type
13066     * ::Elm_Entry_Anchorblock_Info.
13067     *
13068     * @see Anchorview
13069     * @see Entry
13070     * @see Hover
13071     *
13072     * Since examples are usually better than plain words, we might as well
13073     * try @ref tutorial_anchorblock_example "one".
13074     */
13075
13076    /**
13077     * @addtogroup Anchorblock
13078     * @{
13079     */
13080
13081    /**
13082     * @typedef Elm_Entry_Anchorblock_Info
13083     *
13084     * The info sent in the callback for "anchor,clicked" signals emitted by
13085     * the Anchorblock widget.
13086     */
13087    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
13088
13089    /**
13090     * @struct _Elm_Entry_Anchorblock_Info
13091     *
13092     * The info sent in the callback for "anchor,clicked" signals emitted by
13093     * the Anchorblock widget.
13094     */
13095    struct _Elm_Entry_Anchorblock_Info
13096      {
13097         const char     *name; /**< Name of the anchor, as indicated in its href
13098                                    attribute */
13099         int             button; /**< The mouse button used to click on it */
13100         Evas_Object    *hover; /**< The hover object to use for the popup */
13101         struct {
13102              Evas_Coord    x, y, w, h;
13103         } anchor, /**< Geometry selection of text used as anchor */
13104           hover_parent; /**< Geometry of the object used as parent by the
13105                              hover */
13106         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
13107                                              for content on the left side of
13108                                              the hover. Before calling the
13109                                              callback, the widget will make the
13110                                              necessary calculations to check
13111                                              which sides are fit to be set with
13112                                              content, based on the position the
13113                                              hover is activated and its distance
13114                                              to the edges of its parent object
13115                                              */
13116         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
13117                                               the right side of the hover.
13118                                               See @ref hover_left */
13119         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
13120                                             of the hover. See @ref hover_left */
13121         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
13122                                                below the hover. See @ref
13123                                                hover_left */
13124      };
13125
13126 /**
13127     * Add a new Anchorblock object
13128     *
13129     * @param parent The parent object
13130     * @return The new object or NULL if it cannot be created
13131     */
13132    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13133
13134    /**
13135     * Set the text to show in the anchorblock
13136     *
13137     * Sets the text of the anchorblock to @p text. This text can include markup
13138     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
13139     * of text that will be specially styled and react to click events, ended
13140     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
13141     * "anchor,clicked" signal that you can attach a callback to with
13142     * evas_object_smart_callback_add(). The name of the anchor given in the
13143     * event info struct will be the one set in the href attribute, in this
13144     * case, anchorname.
13145     *
13146     * Other markup can be used to style the text in different ways, but it's
13147     * up to the style defined in the theme which tags do what.
13148     * @deprecated use elm_object_text_set() instead.
13149     */
13150    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
13151
13152    /**
13153     * Get the markup text set for the anchorblock
13154     *
13155     * Retrieves the text set on the anchorblock, with markup tags included.
13156     *
13157     * @param obj The anchorblock object
13158     * @return The markup text set or @c NULL if nothing was set or an error
13159     * occurred
13160     * @deprecated use elm_object_text_set() instead.
13161     */
13162    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13163
13164    /**
13165     * Set the parent of the hover popup
13166     *
13167     * Sets the parent object to use by the hover created by the anchorblock
13168     * when an anchor is clicked. See @ref Hover for more details on this.
13169     *
13170     * @param obj The anchorblock object
13171     * @param parent The object to use as parent for the hover
13172     */
13173    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13174
13175    /**
13176     * Get the parent of the hover popup
13177     *
13178     * Get the object used as parent for the hover created by the anchorblock
13179     * widget. See @ref Hover for more details on this.
13180     * If no parent is set, the same anchorblock object will be used.
13181     *
13182     * @param obj The anchorblock object
13183     * @return The object used as parent for the hover, NULL if none is set.
13184     */
13185    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13186
13187    /**
13188     * Set the style that the hover should use
13189     *
13190     * When creating the popup hover, anchorblock will request that it's
13191     * themed according to @p style.
13192     *
13193     * @param obj The anchorblock object
13194     * @param style The style to use for the underlying hover
13195     *
13196     * @see elm_object_style_set()
13197     */
13198    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
13199
13200    /**
13201     * Get the style that the hover should use
13202     *
13203     * Get the style, the hover created by anchorblock will use.
13204     *
13205     * @param obj The anchorblock object
13206     * @return The style to use by the hover. NULL means the default is used.
13207     *
13208     * @see elm_object_style_set()
13209     */
13210    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13211
13212    /**
13213     * Ends the hover popup in the anchorblock
13214     *
13215     * When an anchor is clicked, the anchorblock widget will create a hover
13216     * object to use as a popup with user provided content. This function
13217     * terminates this popup, returning the anchorblock to its normal state.
13218     *
13219     * @param obj The anchorblock object
13220     */
13221    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
13222
13223    /**
13224     * Appends a custom item provider to the given anchorblock
13225     *
13226     * Appends the given function to the list of items providers. This list is
13227     * called, one function at a time, with the given @p data pointer, the
13228     * anchorblock object and, in the @p item parameter, the item name as
13229     * referenced in its href string. Following functions in the list will be
13230     * called in order until one of them returns something different to NULL,
13231     * which should be an Evas_Object which will be used in place of the item
13232     * element.
13233     *
13234     * Items in the markup text take the form \<item relsize=16x16 vsize=full
13235     * href=item/name\>\</item\>
13236     *
13237     * @param obj The anchorblock object
13238     * @param func The function to add to the list of providers
13239     * @param data User data that will be passed to the callback function
13240     *
13241     * @see elm_entry_item_provider_append()
13242     */
13243    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);
13244
13245    /**
13246     * Prepend a custom item provider to the given anchorblock
13247     *
13248     * Like elm_anchorblock_item_provider_append(), but it adds the function
13249     * @p func to the beginning of the list, instead of the end.
13250     *
13251     * @param obj The anchorblock object
13252     * @param func The function to add to the list of providers
13253     * @param data User data that will be passed to the callback function
13254     */
13255    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);
13256
13257    /**
13258     * Remove a custom item provider from the list of the given anchorblock
13259     *
13260     * Removes the function and data pairing that matches @p func and @p data.
13261     * That is, unless the same function and same user data are given, the
13262     * function will not be removed from the list. This allows us to add the
13263     * same callback several times, with different @p data pointers and be
13264     * able to remove them later without conflicts.
13265     *
13266     * @param obj The anchorblock object
13267     * @param func The function to remove from the list
13268     * @param data The data matching the function to remove from the list
13269     */
13270    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);
13271
13272    /**
13273     * @}
13274     */
13275
13276    /**
13277     * @defgroup Bubble Bubble
13278     *
13279     * @image html img/widget/bubble/preview-00.png
13280     * @image latex img/widget/bubble/preview-00.eps
13281     * @image html img/widget/bubble/preview-01.png
13282     * @image latex img/widget/bubble/preview-01.eps
13283     * @image html img/widget/bubble/preview-02.png
13284     * @image latex img/widget/bubble/preview-02.eps
13285     *
13286     * @brief The Bubble is a widget to show text similar to how speech is
13287     * represented in comics.
13288     *
13289     * The bubble widget contains 5 important visual elements:
13290     * @li The frame is a rectangle with rounded edjes and an "arrow".
13291     * @li The @p icon is an image to which the frame's arrow points to.
13292     * @li The @p label is a text which appears to the right of the icon if the
13293     * corner is "top_left" or "bottom_left" and is right aligned to the frame
13294     * otherwise.
13295     * @li The @p info is a text which appears to the right of the label. Info's
13296     * font is of a ligther color than label.
13297     * @li The @p content is an evas object that is shown inside the frame.
13298     *
13299     * The position of the arrow, icon, label and info depends on which corner is
13300     * selected. The four available corners are:
13301     * @li "top_left" - Default
13302     * @li "top_right"
13303     * @li "bottom_left"
13304     * @li "bottom_right"
13305     *
13306     * Signals that you can add callbacks for are:
13307     * @li "clicked" - This is called when a user has clicked the bubble.
13308     *
13309     * Default contents parts of the bubble that you can use for are:
13310     * @li "default" - A content of the bubble
13311     * @li "icon" - An icon of the bubble
13312     *
13313     * Default text parts of the button widget that you can use for are:
13314     * @li NULL - Label of the bubble
13315     *
13316          * For an example of using a buble see @ref bubble_01_example_page "this".
13317     *
13318     * @{
13319     */
13320
13321    /**
13322     * Add a new bubble to the parent
13323     *
13324     * @param parent The parent object
13325     * @return The new object or NULL if it cannot be created
13326     *
13327     * This function adds a text bubble to the given parent evas object.
13328     */
13329    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13330
13331    /**
13332     * Set the label of the bubble
13333     *
13334     * @param obj The bubble object
13335     * @param label The string to set in the label
13336     *
13337     * This function sets the title of the bubble. Where this appears depends on
13338     * the selected corner.
13339     * @deprecated use elm_object_text_set() instead.
13340     */
13341    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13342
13343    /**
13344     * Get the label of the bubble
13345     *
13346     * @param obj The bubble object
13347     * @return The string of set in the label
13348     *
13349     * This function gets the title of the bubble.
13350     * @deprecated use elm_object_text_get() instead.
13351     */
13352    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13353
13354    /**
13355     * Set the info of the bubble
13356     *
13357     * @param obj The bubble object
13358     * @param info The given info about the bubble
13359     *
13360     * This function sets the info of the bubble. Where this appears depends on
13361     * the selected corner.
13362     * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
13363     */
13364    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
13365
13366    /**
13367     * Get the info of the bubble
13368     *
13369     * @param obj The bubble object
13370     *
13371     * @return The "info" string of the bubble
13372     *
13373     * This function gets the info text.
13374     * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
13375     */
13376    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13377
13378    /**
13379     * Set the content to be shown in the bubble
13380     *
13381     * Once the content object is set, a previously set one will be deleted.
13382     * If you want to keep the old content object, use the
13383     * elm_bubble_content_unset() function.
13384     *
13385     * @param obj The bubble object
13386     * @param content The given content of the bubble
13387     *
13388     * This function sets the content shown on the middle of the bubble.
13389     *
13390     * @deprecated use elm_object_content_set() instead
13391     *
13392     */
13393    EINA_DEPRECATED EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
13394
13395    /**
13396     * Get the content shown in the bubble
13397     *
13398     * Return the content object which is set for this widget.
13399     *
13400     * @param obj The bubble object
13401     * @return The content that is being used
13402     *
13403     * @deprecated use elm_object_content_get() instead
13404     *
13405     */
13406    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13407
13408    /**
13409     * Unset the content shown in the bubble
13410     *
13411     * Unparent and return the content object which was set for this widget.
13412     *
13413     * @param obj The bubble object
13414     * @return The content that was being used
13415     *
13416     * @deprecated use elm_object_content_unset() instead
13417     *
13418     */
13419    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13420
13421    /**
13422     * Set the icon of the bubble
13423     *
13424     * Once the icon object is set, a previously set one will be deleted.
13425     * If you want to keep the old content object, use the
13426     * elm_icon_content_unset() function.
13427     *
13428     * @param obj The bubble object
13429     * @param icon The given icon for the bubble
13430     *
13431     * @deprecated use elm_object_part_content_set() instead
13432     *
13433     */
13434    EINA_DEPRECATED EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13435
13436    /**
13437     * Get the icon of the bubble
13438     *
13439     * @param obj The bubble object
13440     * @return The icon for the bubble
13441     *
13442     * This function gets the icon shown on the top left of bubble.
13443     *
13444     * @deprecated use elm_object_part_content_get() instead
13445     *
13446     */
13447    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13448
13449    /**
13450     * Unset the icon of the bubble
13451     *
13452     * Unparent and return the icon object which was set for this widget.
13453     *
13454     * @param obj The bubble object
13455     * @return The icon that was being used
13456     *
13457     * @deprecated use elm_object_part_content_unset() instead
13458     *
13459     */
13460    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13461
13462    /**
13463     * Set the corner of the bubble
13464     *
13465     * @param obj The bubble object.
13466     * @param corner The given corner for the bubble.
13467     *
13468     * This function sets the corner of the bubble. The corner will be used to
13469     * determine where the arrow in the frame points to and where label, icon and
13470     * info are shown.
13471     *
13472     * Possible values for corner are:
13473     * @li "top_left" - Default
13474     * @li "top_right"
13475     * @li "bottom_left"
13476     * @li "bottom_right"
13477     */
13478    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
13479
13480    /**
13481     * Get the corner of the bubble
13482     *
13483     * @param obj The bubble object.
13484     * @return The given corner for the bubble.
13485     *
13486     * This function gets the selected corner of the bubble.
13487     */
13488    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13489
13490    /**
13491     * @}
13492     */
13493
13494    /**
13495     * @defgroup Photo Photo
13496     *
13497     * For displaying the photo of a person (contact). Simple, yet
13498     * with a very specific purpose.
13499     *
13500     * Signals that you can add callbacks for are:
13501     *
13502     * "clicked" - This is called when a user has clicked the photo
13503     * "drag,start" - Someone started dragging the image out of the object
13504     * "drag,end" - Dragged item was dropped (somewhere)
13505     *
13506     * @{
13507     */
13508
13509    /**
13510     * Add a new photo to the parent
13511     *
13512     * @param parent The parent object
13513     * @return The new object or NULL if it cannot be created
13514     *
13515     * @ingroup Photo
13516     */
13517    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13518
13519    /**
13520     * Set the file that will be used as photo
13521     *
13522     * @param obj The photo object
13523     * @param file The path to file that will be used as photo
13524     *
13525     * @return (1 = success, 0 = error)
13526     *
13527     * @ingroup Photo
13528     */
13529    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
13530
13531     /**
13532     * Set the file that will be used as thumbnail in the photo.
13533     *
13534     * @param obj The photo object.
13535     * @param file The path to file that will be used as thumb.
13536     * @param group The key used in case of an EET file.
13537     *
13538     * @ingroup Photo
13539     */
13540    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
13541
13542    /**
13543     * Set the size that will be used on the photo
13544     *
13545     * @param obj The photo object
13546     * @param size The size that the photo will be
13547     *
13548     * @ingroup Photo
13549     */
13550    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
13551
13552    /**
13553     * Set if the photo should be completely visible or not.
13554     *
13555     * @param obj The photo object
13556     * @param fill if true the photo will be completely visible
13557     *
13558     * @ingroup Photo
13559     */
13560    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
13561
13562    /**
13563     * Set editability of the photo.
13564     *
13565     * An editable photo can be dragged to or from, and can be cut or
13566     * pasted too.  Note that pasting an image or dropping an item on
13567     * the image will delete the existing content.
13568     *
13569     * @param obj The photo object.
13570     * @param set To set of clear editablity.
13571     */
13572    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
13573
13574    /**
13575     * @}
13576     */
13577
13578    /* gesture layer */
13579    /**
13580     * @defgroup Elm_Gesture_Layer Gesture Layer
13581     * Gesture Layer Usage:
13582     *
13583     * Use Gesture Layer to detect gestures.
13584     * The advantage is that you don't have to implement
13585     * gesture detection, just set callbacks of gesture state.
13586     * By using gesture layer we make standard interface.
13587     *
13588     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
13589     * with a parent object parameter.
13590     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
13591     * call. Usually with same object as target (2nd parameter).
13592     *
13593     * Now you need to tell gesture layer what gestures you follow.
13594     * This is done with @ref elm_gesture_layer_cb_set call.
13595     * By setting the callback you actually saying to gesture layer:
13596     * I would like to know when the gesture @ref Elm_Gesture_Types
13597     * switches to state @ref Elm_Gesture_State.
13598     *
13599     * Next, you need to implement the actual action that follows the input
13600     * in your callback.
13601     *
13602     * Note that if you like to stop being reported about a gesture, just set
13603     * all callbacks referring this gesture to NULL.
13604     * (again with @ref elm_gesture_layer_cb_set)
13605     *
13606     * The information reported by gesture layer to your callback is depending
13607     * on @ref Elm_Gesture_Types:
13608     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
13609     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
13610     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
13611     *
13612     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
13613     * @ref ELM_GESTURE_MOMENTUM.
13614     *
13615     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
13616     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
13617     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
13618     * Note that we consider a flick as a line-gesture that should be completed
13619     * in flick-time-limit as defined in @ref Config.
13620     *
13621     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
13622     *
13623     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
13624     *
13625     *
13626     * Gesture Layer Tweaks:
13627     *
13628     * Note that line, flick, gestures can start without the need to remove fingers from surface.
13629     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
13630     *
13631     * Setting glayer_continues_enable to false in @ref Config will change this behavior
13632     * so gesture starts when user touches (a *DOWN event) touch-surface
13633     * and ends when no fingers touches surface (a *UP event).
13634     */
13635
13636    /**
13637     * @enum _Elm_Gesture_Types
13638     * Enum of supported gesture types.
13639     * @ingroup Elm_Gesture_Layer
13640     */
13641    enum _Elm_Gesture_Types
13642      {
13643         ELM_GESTURE_FIRST = 0,
13644
13645         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
13646         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
13647         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
13648         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
13649
13650         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
13651
13652         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
13653         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
13654
13655         ELM_GESTURE_ZOOM, /**< Zoom */
13656         ELM_GESTURE_ROTATE, /**< Rotate */
13657
13658         ELM_GESTURE_LAST
13659      };
13660
13661    /**
13662     * @typedef Elm_Gesture_Types
13663     * gesture types enum
13664     * @ingroup Elm_Gesture_Layer
13665     */
13666    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
13667
13668    /**
13669     * @enum _Elm_Gesture_State
13670     * Enum of gesture states.
13671     * @ingroup Elm_Gesture_Layer
13672     */
13673    enum _Elm_Gesture_State
13674      {
13675         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
13676         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
13677         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
13678         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
13679         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
13680      };
13681
13682    /**
13683     * @typedef Elm_Gesture_State
13684     * gesture states enum
13685     * @ingroup Elm_Gesture_Layer
13686     */
13687    typedef enum _Elm_Gesture_State Elm_Gesture_State;
13688
13689    /**
13690     * @struct _Elm_Gesture_Taps_Info
13691     * Struct holds taps info for user
13692     * @ingroup Elm_Gesture_Layer
13693     */
13694    struct _Elm_Gesture_Taps_Info
13695      {
13696         Evas_Coord x, y;         /**< Holds center point between fingers */
13697         unsigned int n;          /**< Number of fingers tapped           */
13698         unsigned int timestamp;  /**< event timestamp       */
13699      };
13700
13701    /**
13702     * @typedef Elm_Gesture_Taps_Info
13703     * holds taps info for user
13704     * @ingroup Elm_Gesture_Layer
13705     */
13706    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
13707
13708    /**
13709     * @struct _Elm_Gesture_Momentum_Info
13710     * Struct holds momentum info for user
13711     * x1 and y1 are not necessarily in sync
13712     * x1 holds x value of x direction starting point
13713     * and same holds for y1.
13714     * This is noticeable when doing V-shape movement
13715     * @ingroup Elm_Gesture_Layer
13716     */
13717    struct _Elm_Gesture_Momentum_Info
13718      {  /* Report line ends, timestamps, and momentum computed        */
13719         Evas_Coord x1; /**< Final-swipe direction starting point on X */
13720         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
13721         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
13722         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
13723
13724         unsigned int tx; /**< Timestamp of start of final x-swipe */
13725         unsigned int ty; /**< Timestamp of start of final y-swipe */
13726
13727         Evas_Coord mx; /**< Momentum on X */
13728         Evas_Coord my; /**< Momentum on Y */
13729
13730         unsigned int n;  /**< Number of fingers */
13731      };
13732
13733    /**
13734     * @typedef Elm_Gesture_Momentum_Info
13735     * holds momentum info for user
13736     * @ingroup Elm_Gesture_Layer
13737     */
13738     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
13739
13740    /**
13741     * @struct _Elm_Gesture_Line_Info
13742     * Struct holds line info for user
13743     * @ingroup Elm_Gesture_Layer
13744     */
13745    struct _Elm_Gesture_Line_Info
13746      {  /* Report line ends, timestamps, and momentum computed      */
13747         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
13748         double angle;              /**< Angle (direction) of lines  */
13749      };
13750
13751    /**
13752     * @typedef Elm_Gesture_Line_Info
13753     * Holds line info for user
13754     * @ingroup Elm_Gesture_Layer
13755     */
13756     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
13757
13758    /**
13759     * @struct _Elm_Gesture_Zoom_Info
13760     * Struct holds zoom info for user
13761     * @ingroup Elm_Gesture_Layer
13762     */
13763    struct _Elm_Gesture_Zoom_Info
13764      {
13765         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
13766         Evas_Coord radius; /**< Holds radius between fingers reported to user */
13767         double zoom;            /**< Zoom value: 1.0 means no zoom             */
13768         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
13769      };
13770
13771    /**
13772     * @typedef Elm_Gesture_Zoom_Info
13773     * Holds zoom info for user
13774     * @ingroup Elm_Gesture_Layer
13775     */
13776    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
13777
13778    /**
13779     * @struct _Elm_Gesture_Rotate_Info
13780     * Struct holds rotation info for user
13781     * @ingroup Elm_Gesture_Layer
13782     */
13783    struct _Elm_Gesture_Rotate_Info
13784      {
13785         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
13786         Evas_Coord radius; /**< Holds radius between fingers reported to user */
13787         double base_angle; /**< Holds start-angle */
13788         double angle;      /**< Rotation value: 0.0 means no rotation         */
13789         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
13790      };
13791
13792    /**
13793     * @typedef Elm_Gesture_Rotate_Info
13794     * Holds rotation info for user
13795     * @ingroup Elm_Gesture_Layer
13796     */
13797    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
13798
13799    /**
13800     * @typedef Elm_Gesture_Event_Cb
13801     * User callback used to stream gesture info from gesture layer
13802     * @param data user data
13803     * @param event_info gesture report info
13804     * Returns a flag field to be applied on the causing event.
13805     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13806     * upon the event, in an irreversible way.
13807     *
13808     * @ingroup Elm_Gesture_Layer
13809     */
13810    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13811
13812    /**
13813     * Use function to set callbacks to be notified about
13814     * change of state of gesture.
13815     * When a user registers a callback with this function
13816     * this means this gesture has to be tested.
13817     *
13818     * When ALL callbacks for a gesture are set to NULL
13819     * it means user isn't interested in gesture-state
13820     * and it will not be tested.
13821     *
13822     * @param obj Pointer to gesture-layer.
13823     * @param idx The gesture you would like to track its state.
13824     * @param cb callback function pointer.
13825     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13826     * @param data user info to be sent to callback (usually, Smart Data)
13827     *
13828     * @ingroup Elm_Gesture_Layer
13829     */
13830    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);
13831
13832    /**
13833     * Call this function to get repeat-events settings.
13834     *
13835     * @param obj Pointer to gesture-layer.
13836     *
13837     * @return repeat events settings.
13838     * @see elm_gesture_layer_hold_events_set()
13839     * @ingroup Elm_Gesture_Layer
13840     */
13841    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13842
13843    /**
13844     * This function called in order to make gesture-layer repeat events.
13845     * Set this of you like to get the raw events only if gestures were not detected.
13846     * Clear this if you like gesture layer to fwd events as testing gestures.
13847     *
13848     * @param obj Pointer to gesture-layer.
13849     * @param r Repeat: TRUE/FALSE
13850     *
13851     * @ingroup Elm_Gesture_Layer
13852     */
13853    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13854
13855    /**
13856     * This function sets step-value for zoom action.
13857     * Set step to any positive value.
13858     * Cancel step setting by setting to 0.0
13859     *
13860     * @param obj Pointer to gesture-layer.
13861     * @param s new zoom step value.
13862     *
13863     * @ingroup Elm_Gesture_Layer
13864     */
13865    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13866
13867    /**
13868     * This function sets step-value for rotate action.
13869     * Set step to any positive value.
13870     * Cancel step setting by setting to 0.0
13871     *
13872     * @param obj Pointer to gesture-layer.
13873     * @param s new roatate step value.
13874     *
13875     * @ingroup Elm_Gesture_Layer
13876     */
13877    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13878
13879    /**
13880     * This function called to attach gesture-layer to an Evas_Object.
13881     * @param obj Pointer to gesture-layer.
13882     * @param t Pointer to underlying object (AKA Target)
13883     *
13884     * @return TRUE, FALSE on success, failure.
13885     *
13886     * @ingroup Elm_Gesture_Layer
13887     */
13888    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13889
13890    /**
13891     * Call this function to construct a new gesture-layer object.
13892     * This does not activate the gesture layer. You have to
13893     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13894     *
13895     * @param parent the parent object.
13896     *
13897     * @return Pointer to new gesture-layer object.
13898     *
13899     * @ingroup Elm_Gesture_Layer
13900     */
13901    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13902
13903    /**
13904     * @defgroup Thumb Thumb
13905     *
13906     * @image html img/widget/thumb/preview-00.png
13907     * @image latex img/widget/thumb/preview-00.eps
13908     *
13909     * A thumb object is used for displaying the thumbnail of an image or video.
13910     * You must have compiled Elementary with Ethumb_Client support and the DBus
13911     * service must be present and auto-activated in order to have thumbnails to
13912     * be generated.
13913     *
13914     * Once the thumbnail object becomes visible, it will check if there is a
13915     * previously generated thumbnail image for the file set on it. If not, it
13916     * will start generating this thumbnail.
13917     *
13918     * Different config settings will cause different thumbnails to be generated
13919     * even on the same file.
13920     *
13921     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13922     * Ethumb documentation to change this path, and to see other configuration
13923     * options.
13924     *
13925     * Signals that you can add callbacks for are:
13926     *
13927     * - "clicked" - This is called when a user has clicked the thumb without dragging
13928     *             around.
13929     * - "clicked,double" - This is called when a user has double-clicked the thumb.
13930     * - "press" - This is called when a user has pressed down the thumb.
13931     * - "generate,start" - The thumbnail generation started.
13932     * - "generate,stop" - The generation process stopped.
13933     * - "generate,error" - The generation failed.
13934     * - "load,error" - The thumbnail image loading failed.
13935     *
13936     * available styles:
13937     * - default
13938     * - noframe
13939     *
13940     * An example of use of thumbnail:
13941     *
13942     * - @ref thumb_example_01
13943     */
13944
13945    /**
13946     * @addtogroup Thumb
13947     * @{
13948     */
13949
13950    /**
13951     * @enum _Elm_Thumb_Animation_Setting
13952     * @typedef Elm_Thumb_Animation_Setting
13953     *
13954     * Used to set if a video thumbnail is animating or not.
13955     *
13956     * @ingroup Thumb
13957     */
13958    typedef enum _Elm_Thumb_Animation_Setting
13959      {
13960         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13961         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
13962         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
13963         ELM_THUMB_ANIMATION_LAST
13964      } Elm_Thumb_Animation_Setting;
13965
13966    /**
13967     * Add a new thumb object to the parent.
13968     *
13969     * @param parent The parent object.
13970     * @return The new object or NULL if it cannot be created.
13971     *
13972     * @see elm_thumb_file_set()
13973     * @see elm_thumb_ethumb_client_get()
13974     *
13975     * @ingroup Thumb
13976     */
13977    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13978
13979    /**
13980     * Reload thumbnail if it was generated before.
13981     *
13982     * @param obj The thumb object to reload
13983     *
13984     * This is useful if the ethumb client configuration changed, like its
13985     * size, aspect or any other property one set in the handle returned
13986     * by elm_thumb_ethumb_client_get().
13987     *
13988     * If the options didn't change, the thumbnail won't be generated again, but
13989     * the old one will still be used.
13990     *
13991     * @see elm_thumb_file_set()
13992     *
13993     * @ingroup Thumb
13994     */
13995    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13996
13997    /**
13998     * Set the file that will be used as thumbnail.
13999     *
14000     * @param obj The thumb object.
14001     * @param file The path to file that will be used as thumb.
14002     * @param key The key used in case of an EET file.
14003     *
14004     * The file can be an image or a video (in that case, acceptable extensions are:
14005     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
14006     * function elm_thumb_animate().
14007     *
14008     * @see elm_thumb_file_get()
14009     * @see elm_thumb_reload()
14010     * @see elm_thumb_animate()
14011     *
14012     * @ingroup Thumb
14013     */
14014    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
14015
14016    /**
14017     * Get the image or video path and key used to generate the thumbnail.
14018     *
14019     * @param obj The thumb object.
14020     * @param file Pointer to filename.
14021     * @param key Pointer to key.
14022     *
14023     * @see elm_thumb_file_set()
14024     * @see elm_thumb_path_get()
14025     *
14026     * @ingroup Thumb
14027     */
14028    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
14029
14030    /**
14031     * Get the path and key to the image or video generated by ethumb.
14032     *
14033     * One just need to make sure that the thumbnail was generated before getting
14034     * its path; otherwise, the path will be NULL. One way to do that is by asking
14035     * for the path when/after the "generate,stop" smart callback is called.
14036     *
14037     * @param obj The thumb object.
14038     * @param file Pointer to thumb path.
14039     * @param key Pointer to thumb key.
14040     *
14041     * @see elm_thumb_file_get()
14042     *
14043     * @ingroup Thumb
14044     */
14045    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
14046
14047    /**
14048     * Set the animation state for the thumb object. If its content is an animated
14049     * video, you may start/stop the animation or tell it to play continuously and
14050     * looping.
14051     *
14052     * @param obj The thumb object.
14053     * @param setting The animation setting.
14054     *
14055     * @see elm_thumb_file_set()
14056     *
14057     * @ingroup Thumb
14058     */
14059    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
14060
14061    /**
14062     * Get the animation state for the thumb object.
14063     *
14064     * @param obj The thumb object.
14065     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
14066     * on errors.
14067     *
14068     * @see elm_thumb_animate_set()
14069     *
14070     * @ingroup Thumb
14071     */
14072    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14073
14074    /**
14075     * Get the ethumb_client handle so custom configuration can be made.
14076     *
14077     * @return Ethumb_Client instance or NULL.
14078     *
14079     * This must be called before the objects are created to be sure no object is
14080     * visible and no generation started.
14081     *
14082     * Example of usage:
14083     *
14084     * @code
14085     * #include <Elementary.h>
14086     * #ifndef ELM_LIB_QUICKLAUNCH
14087     * EAPI_MAIN int
14088     * elm_main(int argc, char **argv)
14089     * {
14090     *    Ethumb_Client *client;
14091     *
14092     *    elm_need_ethumb();
14093     *
14094     *    // ... your code
14095     *
14096     *    client = elm_thumb_ethumb_client_get();
14097     *    if (!client)
14098     *      {
14099     *         ERR("could not get ethumb_client");
14100     *         return 1;
14101     *      }
14102     *    ethumb_client_size_set(client, 100, 100);
14103     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
14104     *    // ... your code
14105     *
14106     *    // Create elm_thumb objects here
14107     *
14108     *    elm_run();
14109     *    elm_shutdown();
14110     *    return 0;
14111     * }
14112     * #endif
14113     * ELM_MAIN()
14114     * @endcode
14115     *
14116     * @note There's only one client handle for Ethumb, so once a configuration
14117     * change is done to it, any other request for thumbnails (for any thumbnail
14118     * object) will use that configuration. Thus, this configuration is global.
14119     *
14120     * @ingroup Thumb
14121     */
14122    EAPI void                        *elm_thumb_ethumb_client_get(void);
14123
14124    /**
14125     * Get the ethumb_client connection state.
14126     *
14127     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
14128     * otherwise.
14129     */
14130    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
14131
14132    /**
14133     * Make the thumbnail 'editable'.
14134     *
14135     * @param obj Thumb object.
14136     * @param set Turn on or off editability. Default is @c EINA_FALSE.
14137     *
14138     * This means the thumbnail is a valid drag target for drag and drop, and can be
14139     * cut or pasted too.
14140     *
14141     * @see elm_thumb_editable_get()
14142     *
14143     * @ingroup Thumb
14144     */
14145    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
14146
14147    /**
14148     * Make the thumbnail 'editable'.
14149     *
14150     * @param obj Thumb object.
14151     * @return Editability.
14152     *
14153     * This means the thumbnail is a valid drag target for drag and drop, and can be
14154     * cut or pasted too.
14155     *
14156     * @see elm_thumb_editable_set()
14157     *
14158     * @ingroup Thumb
14159     */
14160    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14161
14162    /**
14163     * @}
14164     */
14165
14166    /**
14167     * @defgroup Web Web
14168     *
14169     * @image html img/widget/web/preview-00.png
14170     * @image latex img/widget/web/preview-00.eps
14171     *
14172     * A web object is used for displaying web pages (HTML/CSS/JS)
14173     * using WebKit-EFL. You must have compiled Elementary with
14174     * ewebkit support.
14175     *
14176     * Signals that you can add callbacks for are:
14177     * @li "download,request": A file download has been requested. Event info is
14178     * a pointer to a Elm_Web_Download
14179     * @li "editorclient,contents,changed": Editor client's contents changed
14180     * @li "editorclient,selection,changed": Editor client's selection changed
14181     * @li "frame,created": A new frame was created. Event info is an
14182     * Evas_Object which can be handled with WebKit's ewk_frame API
14183     * @li "icon,received": An icon was received by the main frame
14184     * @li "inputmethod,changed": Input method changed. Event info is an
14185     * Eina_Bool indicating whether it's enabled or not
14186     * @li "js,windowobject,clear": JS window object has been cleared
14187     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
14188     * is a char *link[2], where the first string contains the URL the link
14189     * points to, and the second one the title of the link
14190     * @li "link,hover,out": Mouse cursor left the link
14191     * @li "load,document,finished": Loading of a document finished. Event info
14192     * is the frame that finished loading
14193     * @li "load,error": Load failed. Event info is a pointer to
14194     * Elm_Web_Frame_Load_Error
14195     * @li "load,finished": Load finished. Event info is NULL on success, on
14196     * error it's a pointer to Elm_Web_Frame_Load_Error
14197     * @li "load,newwindow,show": A new window was created and is ready to be
14198     * shown
14199     * @li "load,progress": Overall load progress. Event info is a pointer to
14200     * a double containing a value between 0.0 and 1.0
14201     * @li "load,provisional": Started provisional load
14202     * @li "load,started": Loading of a document started
14203     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
14204     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
14205     * the menubar is visible, or EINA_FALSE in case it's not
14206     * @li "menubar,visible,set": Informs menubar visibility. Event info is
14207     * an Eina_Bool indicating the visibility
14208     * @li "popup,created": A dropdown widget was activated, requesting its
14209     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
14210     * @li "popup,willdelete": The web object is ready to destroy the popup
14211     * object created. Event info is a pointer to Elm_Web_Menu
14212     * @li "ready": Page is fully loaded
14213     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
14214     * info is a pointer to Eina_Bool where the visibility state should be set
14215     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
14216     * is an Eina_Bool with the visibility state set
14217     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
14218     * a string with the new text
14219     * @li "statusbar,visible,get": Queries visibility of the status bar.
14220     * Event info is a pointer to Eina_Bool where the visibility state should be
14221     * set.
14222     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
14223     * an Eina_Bool with the visibility value
14224     * @li "title,changed": Title of the main frame changed. Event info is a
14225     * string with the new title
14226     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
14227     * is a pointer to Eina_Bool where the visibility state should be set
14228     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
14229     * info is an Eina_Bool with the visibility state
14230     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
14231     * a string with the text to show
14232     * @li "uri,changed": URI of the main frame changed. Event info is a string
14233     * with the new URI
14234     * @li "view,resized": The web object internal's view changed sized
14235     * @li "windows,close,request": A JavaScript request to close the current
14236     * window was requested
14237     * @li "zoom,animated,end": Animated zoom finished
14238     *
14239     * available styles:
14240     * - default
14241     *
14242     * An example of use of web:
14243     *
14244     * - @ref web_example_01 TBD
14245     */
14246
14247    /**
14248     * @addtogroup Web
14249     * @{
14250     */
14251
14252    /**
14253     * Structure used to report load errors.
14254     *
14255     * Load errors are reported as signal by elm_web. All the strings are
14256     * temporary references and should @b not be used after the signal
14257     * callback returns. If it's required, make copies with strdup() or
14258     * eina_stringshare_add() (they are not even guaranteed to be
14259     * stringshared, so must use eina_stringshare_add() and not
14260     * eina_stringshare_ref()).
14261     */
14262    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
14263
14264    /**
14265     * Structure used to report load errors.
14266     *
14267     * Load errors are reported as signal by elm_web. All the strings are
14268     * temporary references and should @b not be used after the signal
14269     * callback returns. If it's required, make copies with strdup() or
14270     * eina_stringshare_add() (they are not even guaranteed to be
14271     * stringshared, so must use eina_stringshare_add() and not
14272     * eina_stringshare_ref()).
14273     */
14274    struct _Elm_Web_Frame_Load_Error
14275      {
14276         int code; /**< Numeric error code */
14277         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
14278         const char *domain; /**< Error domain name */
14279         const char *description; /**< Error description (already localized) */
14280         const char *failing_url; /**< The URL that failed to load */
14281         Evas_Object *frame; /**< Frame object that produced the error */
14282      };
14283
14284    /**
14285     * The possibles types that the items in a menu can be
14286     */
14287    typedef enum _Elm_Web_Menu_Item_Type
14288      {
14289         ELM_WEB_MENU_SEPARATOR,
14290         ELM_WEB_MENU_GROUP,
14291         ELM_WEB_MENU_OPTION
14292      } Elm_Web_Menu_Item_Type;
14293
14294    /**
14295     * Structure describing the items in a menu
14296     */
14297    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
14298
14299    /**
14300     * Structure describing the items in a menu
14301     */
14302    struct _Elm_Web_Menu_Item
14303      {
14304         const char *text; /**< The text for the item */
14305         Elm_Web_Menu_Item_Type type; /**< The type of the item */
14306      };
14307
14308    /**
14309     * Structure describing the menu of a popup
14310     *
14311     * This structure will be passed as the @c event_info for the "popup,create"
14312     * signal, which is emitted when a dropdown menu is opened. Users wanting
14313     * to handle these popups by themselves should listen to this signal and
14314     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
14315     * property as @c EINA_FALSE means that the user will not handle the popup
14316     * and the default implementation will be used.
14317     *
14318     * When the popup is ready to be dismissed, a "popup,willdelete" signal
14319     * will be emitted to notify the user that it can destroy any objects and
14320     * free all data related to it.
14321     *
14322     * @see elm_web_popup_selected_set()
14323     * @see elm_web_popup_destroy()
14324     */
14325    typedef struct _Elm_Web_Menu Elm_Web_Menu;
14326
14327    /**
14328     * Structure describing the menu of a popup
14329     *
14330     * This structure will be passed as the @c event_info for the "popup,create"
14331     * signal, which is emitted when a dropdown menu is opened. Users wanting
14332     * to handle these popups by themselves should listen to this signal and
14333     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
14334     * property as @c EINA_FALSE means that the user will not handle the popup
14335     * and the default implementation will be used.
14336     *
14337     * When the popup is ready to be dismissed, a "popup,willdelete" signal
14338     * will be emitted to notify the user that it can destroy any objects and
14339     * free all data related to it.
14340     *
14341     * @see elm_web_popup_selected_set()
14342     * @see elm_web_popup_destroy()
14343     */
14344    struct _Elm_Web_Menu
14345      {
14346         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
14347         int x; /**< The X position of the popup, relative to the elm_web object */
14348         int y; /**< The Y position of the popup, relative to the elm_web object */
14349         int width; /**< Width of the popup menu */
14350         int height; /**< Height of the popup menu */
14351
14352         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. */
14353      };
14354
14355    typedef struct _Elm_Web_Download Elm_Web_Download;
14356    struct _Elm_Web_Download
14357      {
14358         const char *url;
14359      };
14360
14361    /**
14362     * Types of zoom available.
14363     */
14364    typedef enum _Elm_Web_Zoom_Mode
14365      {
14366         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_web_zoom_set */
14367         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
14368         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
14369         ELM_WEB_ZOOM_MODE_LAST
14370      } Elm_Web_Zoom_Mode;
14371
14372    /**
14373     * Opaque handler containing the features (such as statusbar, menubar, etc)
14374     * that are to be set on a newly requested window.
14375     */
14376    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
14377
14378    /**
14379     * Callback type for the create_window hook.
14380     *
14381     * The function parameters are:
14382     * @li @p data User data pointer set when setting the hook function
14383     * @li @p obj The elm_web object requesting the new window
14384     * @li @p js Set to @c EINA_TRUE if the request was originated from
14385     * JavaScript. @c EINA_FALSE otherwise.
14386     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
14387     * the features requested for the new window.
14388     *
14389     * The returned value of the function should be the @c elm_web widget where
14390     * the request will be loaded. That is, if a new window or tab is created,
14391     * the elm_web widget in it should be returned, and @b NOT the window
14392     * object.
14393     * Returning @c NULL should cancel the request.
14394     *
14395     * @see elm_web_window_create_hook_set()
14396     */
14397    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
14398
14399    /**
14400     * Callback type for the JS alert hook.
14401     *
14402     * The function parameters are:
14403     * @li @p data User data pointer set when setting the hook function
14404     * @li @p obj The elm_web object requesting the new window
14405     * @li @p message The message to show in the alert dialog
14406     *
14407     * The function should return the object representing the alert dialog.
14408     * Elm_Web will run a second main loop to handle the dialog and normal
14409     * flow of the application will be restored when the object is deleted, so
14410     * the user should handle the popup properly in order to delete the object
14411     * when the action is finished.
14412     * If the function returns @c NULL the popup will be ignored.
14413     *
14414     * @see elm_web_dialog_alert_hook_set()
14415     */
14416    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
14417
14418    /**
14419     * Callback type for the JS confirm hook.
14420     *
14421     * The function parameters are:
14422     * @li @p data User data pointer set when setting the hook function
14423     * @li @p obj The elm_web object requesting the new window
14424     * @li @p message The message to show in the confirm dialog
14425     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
14426     * the user selected @c Ok, @c EINA_FALSE otherwise.
14427     *
14428     * The function should return the object representing the confirm dialog.
14429     * Elm_Web will run a second main loop to handle the dialog and normal
14430     * flow of the application will be restored when the object is deleted, so
14431     * the user should handle the popup properly in order to delete the object
14432     * when the action is finished.
14433     * If the function returns @c NULL the popup will be ignored.
14434     *
14435     * @see elm_web_dialog_confirm_hook_set()
14436     */
14437    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
14438
14439    /**
14440     * Callback type for the JS prompt hook.
14441     *
14442     * The function parameters are:
14443     * @li @p data User data pointer set when setting the hook function
14444     * @li @p obj The elm_web object requesting the new window
14445     * @li @p message The message to show in the prompt dialog
14446     * @li @p def_value The default value to present the user in the entry
14447     * @li @p value Pointer where to store the value given by the user. Must
14448     * be a malloc'ed string or @c NULL if the user cancelled the popup.
14449     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
14450     * the user selected @c Ok, @c EINA_FALSE otherwise.
14451     *
14452     * The function should return the object representing the prompt dialog.
14453     * Elm_Web will run a second main loop to handle the dialog and normal
14454     * flow of the application will be restored when the object is deleted, so
14455     * the user should handle the popup properly in order to delete the object
14456     * when the action is finished.
14457     * If the function returns @c NULL the popup will be ignored.
14458     *
14459     * @see elm_web_dialog_prompt_hook_set()
14460     */
14461    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
14462
14463    /**
14464     * Callback type for the JS file selector hook.
14465     *
14466     * The function parameters are:
14467     * @li @p data User data pointer set when setting the hook function
14468     * @li @p obj The elm_web object requesting the new window
14469     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
14470     * @li @p accept_types Mime types accepted
14471     * @li @p selected Pointer where to store the list of malloc'ed strings
14472     * containing the path to each file selected. Must be @c NULL if the file
14473     * dialog is cancelled
14474     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
14475     * the user selected @c Ok, @c EINA_FALSE otherwise.
14476     *
14477     * The function should return the object representing the file selector
14478     * dialog.
14479     * Elm_Web will run a second main loop to handle the dialog and normal
14480     * flow of the application will be restored when the object is deleted, so
14481     * the user should handle the popup properly in order to delete the object
14482     * when the action is finished.
14483     * If the function returns @c NULL the popup will be ignored.
14484     *
14485     * @see elm_web_dialog_file selector_hook_set()
14486     */
14487    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);
14488
14489    /**
14490     * Callback type for the JS console message hook.
14491     *
14492     * When a console message is added from JavaScript, any set function to the
14493     * console message hook will be called for the user to handle. There is no
14494     * default implementation of this hook.
14495     *
14496     * The function parameters are:
14497     * @li @p data User data pointer set when setting the hook function
14498     * @li @p obj The elm_web object that originated the message
14499     * @li @p message The message sent
14500     * @li @p line_number The line number
14501     * @li @p source_id Source id
14502     *
14503     * @see elm_web_console_message_hook_set()
14504     */
14505    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
14506
14507    /**
14508     * Add a new web object to the parent.
14509     *
14510     * @param parent The parent object.
14511     * @return The new object or NULL if it cannot be created.
14512     *
14513     * @see elm_web_uri_set()
14514     * @see elm_web_webkit_view_get()
14515     */
14516    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14517
14518    /**
14519     * Get internal ewk_view object from web object.
14520     *
14521     * Elementary may not provide some low level features of EWebKit,
14522     * instead of cluttering the API with proxy methods we opted to
14523     * return the internal reference. Be careful using it as it may
14524     * interfere with elm_web behavior.
14525     *
14526     * @param obj The web object.
14527     * @return The internal ewk_view object or NULL if it does not
14528     *         exist. (Failure to create or Elementary compiled without
14529     *         ewebkit)
14530     *
14531     * @see elm_web_add()
14532     */
14533    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14534
14535    /**
14536     * Sets the function to call when a new window is requested
14537     *
14538     * This hook will be called when a request to create a new window is
14539     * issued from the web page loaded.
14540     * There is no default implementation for this feature, so leaving this
14541     * unset or passing @c NULL in @p func will prevent new windows from
14542     * opening.
14543     *
14544     * @param obj The web object where to set the hook function
14545     * @param func The hook function to be called when a window is requested
14546     * @param data User data
14547     */
14548    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
14549
14550    /**
14551     * Sets the function to call when an alert dialog
14552     *
14553     * This hook will be called when a JavaScript alert dialog is requested.
14554     * If no function is set or @c NULL is passed in @p func, the default
14555     * implementation will take place.
14556     *
14557     * @param obj The web object where to set the hook function
14558     * @param func The callback function to be used
14559     * @param data User data
14560     *
14561     * @see elm_web_inwin_mode_set()
14562     */
14563    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
14564
14565    /**
14566     * Sets the function to call when an confirm dialog
14567     *
14568     * This hook will be called when a JavaScript confirm dialog is requested.
14569     * If no function is set or @c NULL is passed in @p func, the default
14570     * implementation will take place.
14571     *
14572     * @param obj The web object where to set the hook function
14573     * @param func The callback function to be used
14574     * @param data User data
14575     *
14576     * @see elm_web_inwin_mode_set()
14577     */
14578    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
14579
14580    /**
14581     * Sets the function to call when an prompt dialog
14582     *
14583     * This hook will be called when a JavaScript prompt dialog is requested.
14584     * If no function is set or @c NULL is passed in @p func, the default
14585     * implementation will take place.
14586     *
14587     * @param obj The web object where to set the hook function
14588     * @param func The callback function to be used
14589     * @param data User data
14590     *
14591     * @see elm_web_inwin_mode_set()
14592     */
14593    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
14594
14595    /**
14596     * Sets the function to call when an file selector dialog
14597     *
14598     * This hook will be called when a JavaScript file selector dialog is
14599     * requested.
14600     * If no function is set or @c NULL is passed in @p func, the default
14601     * implementation will take place.
14602     *
14603     * @param obj The web object where to set the hook function
14604     * @param func The callback function to be used
14605     * @param data User data
14606     *
14607     * @see elm_web_inwin_mode_set()
14608     */
14609    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
14610
14611    /**
14612     * Sets the function to call when a console message is emitted from JS
14613     *
14614     * This hook will be called when a console message is emitted from
14615     * JavaScript. There is no default implementation for this feature.
14616     *
14617     * @param obj The web object where to set the hook function
14618     * @param func The callback function to be used
14619     * @param data User data
14620     */
14621    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
14622
14623    /**
14624     * Gets the status of the tab propagation
14625     *
14626     * @param obj The web object to query
14627     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
14628     *
14629     * @see elm_web_tab_propagate_set()
14630     */
14631    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
14632
14633    /**
14634     * Sets whether to use tab propagation
14635     *
14636     * If tab propagation is enabled, whenever the user presses the Tab key,
14637     * Elementary will handle it and switch focus to the next widget.
14638     * The default value is disabled, where WebKit will handle the Tab key to
14639     * cycle focus though its internal objects, jumping to the next widget
14640     * only when that cycle ends.
14641     *
14642     * @param obj The web object
14643     * @param propagate Whether to propagate Tab keys to Elementary or not
14644     */
14645    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
14646
14647    /**
14648     * Sets the URI for the web object
14649     *
14650     * It must be a full URI, with resource included, in the form
14651     * http://www.enlightenment.org or file:///tmp/something.html
14652     *
14653     * @param obj The web object
14654     * @param uri The URI to set
14655     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
14656     */
14657    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
14658
14659    /**
14660     * Gets the current URI for the object
14661     *
14662     * The returned string must not be freed and is guaranteed to be
14663     * stringshared.
14664     *
14665     * @param obj The web object
14666     * @return A stringshared internal string with the current URI, or NULL on
14667     * failure
14668     */
14669    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
14670
14671    /**
14672     * Gets the current title
14673     *
14674     * The returned string must not be freed and is guaranteed to be
14675     * stringshared.
14676     *
14677     * @param obj The web object
14678     * @return A stringshared internal string with the current title, or NULL on
14679     * failure
14680     */
14681    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
14682
14683    /**
14684     * Sets the background color to be used by the web object
14685     *
14686     * This is the color that will be used by default when the loaded page
14687     * does not set it's own. Color values are pre-multiplied.
14688     *
14689     * @param obj The web object
14690     * @param r Red component
14691     * @param g Green component
14692     * @param b Blue component
14693     * @param a Alpha component
14694     */
14695    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
14696
14697    /**
14698     * Gets the background color to be used by the web object
14699     *
14700     * This is the color that will be used by default when the loaded page
14701     * does not set it's own. Color values are pre-multiplied.
14702     *
14703     * @param obj The web object
14704     * @param r Red component
14705     * @param g Green component
14706     * @param b Blue component
14707     * @param a Alpha component
14708     */
14709    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
14710
14711    /**
14712     * Gets a copy of the currently selected text
14713     *
14714     * The string returned must be freed by the user when it's done with it.
14715     *
14716     * @param obj The web object
14717     * @return A newly allocated string, or NULL if nothing is selected or an
14718     * error occurred
14719     */
14720    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
14721
14722    /**
14723     * Tells the web object which index in the currently open popup was selected
14724     *
14725     * When the user handles the popup creation from the "popup,created" signal,
14726     * it needs to tell the web object which item was selected by calling this
14727     * function with the index corresponding to the item.
14728     *
14729     * @param obj The web object
14730     * @param index The index selected
14731     *
14732     * @see elm_web_popup_destroy()
14733     */
14734    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
14735
14736    /**
14737     * Dismisses an open dropdown popup
14738     *
14739     * When the popup from a dropdown widget is to be dismissed, either after
14740     * selecting an option or to cancel it, this function must be called, which
14741     * will later emit an "popup,willdelete" signal to notify the user that
14742     * any memory and objects related to this popup can be freed.
14743     *
14744     * @param obj The web object
14745     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
14746     * if there was no menu to destroy
14747     */
14748    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
14749
14750    /**
14751     * Searches the given string in a document.
14752     *
14753     * @param obj The web object where to search the text
14754     * @param string String to search
14755     * @param case_sensitive If search should be case sensitive or not
14756     * @param forward If search is from cursor and on or backwards
14757     * @param wrap If search should wrap at the end
14758     *
14759     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
14760     * or failure
14761     */
14762    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
14763
14764    /**
14765     * Marks matches of the given string in a document.
14766     *
14767     * @param obj The web object where to search text
14768     * @param string String to match
14769     * @param case_sensitive If match should be case sensitive or not
14770     * @param highlight If matches should be highlighted
14771     * @param limit Maximum amount of matches, or zero to unlimited
14772     *
14773     * @return number of matched @a string
14774     */
14775    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
14776
14777    /**
14778     * Clears all marked matches in the document
14779     *
14780     * @param obj The web object
14781     *
14782     * @return EINA_TRUE on success, EINA_FALSE otherwise
14783     */
14784    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
14785
14786    /**
14787     * Sets whether to highlight the matched marks
14788     *
14789     * If enabled, marks set with elm_web_text_matches_mark() will be
14790     * highlighted.
14791     *
14792     * @param obj The web object
14793     * @param highlight Whether to highlight the marks or not
14794     *
14795     * @return EINA_TRUE on success, EINA_FALSE otherwise
14796     */
14797    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
14798
14799    /**
14800     * Gets whether highlighting marks is enabled
14801     *
14802     * @param The web object
14803     *
14804     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
14805     * otherwise
14806     */
14807    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
14808
14809    /**
14810     * Gets the overall loading progress of the page
14811     *
14812     * Returns the estimated loading progress of the page, with a value between
14813     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
14814     * included in the page.
14815     *
14816     * @param The web object
14817     *
14818     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
14819     * failure
14820     */
14821    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
14822
14823    /**
14824     * Stops loading the current page
14825     *
14826     * Cancels the loading of the current page in the web object. This will
14827     * cause a "load,error" signal to be emitted, with the is_cancellation
14828     * flag set to EINA_TRUE.
14829     *
14830     * @param obj The web object
14831     *
14832     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
14833     */
14834    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
14835
14836    /**
14837     * Requests a reload of the current document in the object
14838     *
14839     * @param obj The web object
14840     *
14841     * @return EINA_TRUE on success, EINA_FALSE otherwise
14842     */
14843    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
14844
14845    /**
14846     * Requests a reload of the current document, avoiding any existing caches
14847     *
14848     * @param obj The web object
14849     *
14850     * @return EINA_TRUE on success, EINA_FALSE otherwise
14851     */
14852    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
14853
14854    /**
14855     * Goes back one step in the browsing history
14856     *
14857     * This is equivalent to calling elm_web_object_navigate(obj, -1);
14858     *
14859     * @param obj The web object
14860     *
14861     * @return EINA_TRUE on success, EINA_FALSE otherwise
14862     *
14863     * @see elm_web_history_enable_set()
14864     * @see elm_web_back_possible()
14865     * @see elm_web_forward()
14866     * @see elm_web_navigate()
14867     */
14868    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
14869
14870    /**
14871     * Goes forward one step in the browsing history
14872     *
14873     * This is equivalent to calling elm_web_object_navigate(obj, 1);
14874     *
14875     * @param obj The web object
14876     *
14877     * @return EINA_TRUE on success, EINA_FALSE otherwise
14878     *
14879     * @see elm_web_history_enable_set()
14880     * @see elm_web_forward_possible()
14881     * @see elm_web_back()
14882     * @see elm_web_navigate()
14883     */
14884    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
14885
14886    /**
14887     * Jumps the given number of steps in the browsing history
14888     *
14889     * The @p steps value can be a negative integer to back in history, or a
14890     * positive to move forward.
14891     *
14892     * @param obj The web object
14893     * @param steps The number of steps to jump
14894     *
14895     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14896     * history exists to jump the given number of steps
14897     *
14898     * @see elm_web_history_enable_set()
14899     * @see elm_web_navigate_possible()
14900     * @see elm_web_back()
14901     * @see elm_web_forward()
14902     */
14903    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
14904
14905    /**
14906     * Queries whether it's possible to go back in history
14907     *
14908     * @param obj The web object
14909     *
14910     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14911     * otherwise
14912     */
14913    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
14914
14915    /**
14916     * Queries whether it's possible to go forward in history
14917     *
14918     * @param obj The web object
14919     *
14920     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14921     * otherwise
14922     */
14923    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
14924
14925    /**
14926     * Queries whether it's possible to jump the given number of steps
14927     *
14928     * The @p steps value can be a negative integer to back in history, or a
14929     * positive to move forward.
14930     *
14931     * @param obj The web object
14932     * @param steps The number of steps to check for
14933     *
14934     * @return EINA_TRUE if enough history exists to perform the given jump,
14935     * EINA_FALSE otherwise
14936     */
14937    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
14938
14939    /**
14940     * Gets whether browsing history is enabled for the given object
14941     *
14942     * @param obj The web object
14943     *
14944     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14945     */
14946    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
14947
14948    /**
14949     * Enables or disables the browsing history
14950     *
14951     * @param obj The web object
14952     * @param enable Whether to enable or disable the browsing history
14953     */
14954    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14955
14956    /**
14957     * Sets the zoom level of the web object
14958     *
14959     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14960     * values meaning zoom in and lower meaning zoom out. This function will
14961     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14962     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14963     *
14964     * @param obj The web object
14965     * @param zoom The zoom level to set
14966     */
14967    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
14968
14969    /**
14970     * Gets the current zoom level set on the web object
14971     *
14972     * Note that this is the zoom level set on the web object and not that
14973     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14974     * the two zoom levels should match, but for the other two modes the
14975     * Webkit zoom is calculated internally to match the chosen mode without
14976     * changing the zoom level set for the web object.
14977     *
14978     * @param obj The web object
14979     *
14980     * @return The zoom level set on the object
14981     */
14982    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
14983
14984    /**
14985     * Sets the zoom mode to use
14986     *
14987     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14988     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14989     *
14990     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14991     * with the elm_web_zoom_set() function.
14992     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14993     * make sure the entirety of the web object's contents are shown.
14994     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14995     * fit the contents in the web object's size, without leaving any space
14996     * unused.
14997     *
14998     * @param obj The web object
14999     * @param mode The mode to set
15000     */
15001    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
15002
15003    /**
15004     * Gets the currently set zoom mode
15005     *
15006     * @param obj The web object
15007     *
15008     * @return The current zoom mode set for the object, or
15009     * ::ELM_WEB_ZOOM_MODE_LAST on error
15010     */
15011    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
15012
15013    /**
15014     * Shows the given region in the web object
15015     *
15016     * @param obj The web object
15017     * @param x The x coordinate of the region to show
15018     * @param y The y coordinate of the region to show
15019     * @param w The width of the region to show
15020     * @param h The height of the region to show
15021     */
15022    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
15023
15024    /**
15025     * Brings in the region to the visible area
15026     *
15027     * Like elm_web_region_show(), but it animates the scrolling of the object
15028     * to show the area
15029     *
15030     * @param obj The web object
15031     * @param x The x coordinate of the region to show
15032     * @param y The y coordinate of the region to show
15033     * @param w The width of the region to show
15034     * @param h The height of the region to show
15035     */
15036    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
15037
15038    /**
15039     * Sets the default dialogs to use an Inwin instead of a normal window
15040     *
15041     * If set, then the default implementation for the JavaScript dialogs and
15042     * file selector will be opened in an Inwin. Otherwise they will use a
15043     * normal separated window.
15044     *
15045     * @param obj The web object
15046     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
15047     */
15048    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
15049
15050    /**
15051     * Gets whether Inwin mode is set for the current object
15052     *
15053     * @param obj The web object
15054     *
15055     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
15056     */
15057    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
15058
15059    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
15060    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
15061    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);
15062    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
15063
15064    /**
15065     * @}
15066     */
15067
15068    /**
15069     * @defgroup Hoversel Hoversel
15070     *
15071     * @image html img/widget/hoversel/preview-00.png
15072     * @image latex img/widget/hoversel/preview-00.eps
15073     *
15074     * A hoversel is a button that pops up a list of items (automatically
15075     * choosing the direction to display) that have a label and, optionally, an
15076     * icon to select from. It is a convenience widget to avoid the need to do
15077     * all the piecing together yourself. It is intended for a small number of
15078     * items in the hoversel menu (no more than 8), though is capable of many
15079     * more.
15080     *
15081     * Signals that you can add callbacks for are:
15082     * "clicked" - the user clicked the hoversel button and popped up the sel
15083     * "selected" - an item in the hoversel list is selected. event_info is the item
15084     * "dismissed" - the hover is dismissed
15085     *
15086     * Default contents parts of the hoversel widget that you can use for are:
15087     * @li "icon" - An icon of the hoversel
15088     * 
15089     * Default text parts of the hoversel widget that you can use for are:
15090     * @li "default" - Label of the hoversel
15091     *  
15092     * Supported elm_object common APIs.
15093     * @li elm_object_disabled_set
15094     * @li elm_object_text_set
15095     * @li elm_object_part_text_set
15096     * @li elm_object_text_get
15097     * @li elm_object_part_text_get
15098     * @li elm_object_content_set
15099     * @li elm_object_part_content_set
15100     * @li elm_object_content_unset
15101     * @li elm_object_part_content_unset
15102     *
15103     * Supported elm_object_item common APIs.
15104     * @li elm_object_item_text_get
15105     * @li elm_object_item_part_text_get
15106     *
15107     * See @ref tutorial_hoversel for an example.
15108     * @{
15109     */
15110
15111    /**
15112     * @brief Add a new Hoversel object
15113     *
15114     * @param parent The parent object
15115     * @return The new object or NULL if it cannot be created
15116     */
15117    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15118
15119    /**
15120     * @brief This sets the hoversel to expand horizontally.
15121     *
15122     * @param obj The hoversel object
15123     * @param horizontal If true, the hover will expand horizontally to the
15124     * right.
15125     *
15126     * @note The initial button will display horizontally regardless of this
15127     * setting.
15128     */
15129    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15130
15131    /**
15132     * @brief This returns whether the hoversel is set to expand horizontally.
15133     *
15134     * @param obj The hoversel object
15135     * @return If true, the hover will expand horizontally to the right.
15136     *
15137     * @see elm_hoversel_horizontal_set()
15138     */
15139    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15140
15141    /**
15142     * @brief Set the Hover parent
15143     *
15144     * @param obj The hoversel object
15145     * @param parent The parent to use
15146     *
15147     * Sets the hover parent object, the area that will be darkened when the
15148     * hoversel is clicked. Should probably be the window that the hoversel is
15149     * in. See @ref Hover objects for more information.
15150     */
15151    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15152    /**
15153     * @brief Get the Hover parent
15154     *
15155     * @param obj The hoversel object
15156     * @return The used parent
15157     *
15158     * Gets the hover parent object.
15159     *
15160     * @see elm_hoversel_hover_parent_set()
15161     */
15162    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15163
15164    /**
15165     * @brief Set the hoversel button label
15166     *
15167     * @param obj The hoversel object
15168     * @param label The label text.
15169     *
15170     * This sets the label of the button that is always visible (before it is
15171     * clicked and expanded).
15172     *
15173     * @deprecated elm_object_text_set()
15174     */
15175    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15176
15177    /**
15178     * @brief Get the hoversel button label
15179     *
15180     * @param obj The hoversel object
15181     * @return The label text.
15182     *
15183     * @deprecated elm_object_text_get()
15184     */
15185    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15186
15187    /**
15188     * @brief Set the icon of the hoversel button
15189     *
15190     * @param obj The hoversel object
15191     * @param icon The icon object
15192     *
15193     * Sets the icon of the button that is always visible (before it is clicked
15194     * and expanded).  Once the icon object is set, a previously set one will be
15195     * deleted, if you want to keep that old content object, use the
15196     * elm_hoversel_icon_unset() function.
15197     *
15198     * @see elm_object_content_set() for the button widget
15199     * @deprecated Use elm_object_item_part_content_set() instead
15200     */
15201    EINA_DEPRECATED EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15202
15203    /**
15204     * @brief Get the icon of the hoversel button
15205     *
15206     * @param obj The hoversel object
15207     * @return The icon object
15208     *
15209     * Get the icon of the button that is always visible (before it is clicked
15210     * and expanded). Also see elm_object_content_get() for the button widget.
15211     *
15212     * @see elm_hoversel_icon_set()
15213     * @deprecated Use elm_object_item_part_content_get() instead
15214     */
15215    EINA_DEPRECATED EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15216
15217    /**
15218     * @brief Get and unparent the icon of the hoversel button
15219     *
15220     * @param obj The hoversel object
15221     * @return The icon object that was being used
15222     *
15223     * Unparent and return the icon of the button that is always visible
15224     * (before it is clicked and expanded).
15225     *
15226     * @see elm_hoversel_icon_set()
15227     * @see elm_object_content_unset() for the button widget
15228     * @deprecated Use elm_object_item_part_content_unset() instead
15229     */
15230    EINA_DEPRECATED EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15231
15232    /**
15233     * @brief This triggers the hoversel popup from code, the same as if the user
15234     * had clicked the button.
15235     *
15236     * @param obj The hoversel object
15237     */
15238    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
15239
15240    /**
15241     * @brief This dismisses the hoversel popup as if the user had clicked
15242     * outside the hover.
15243     *
15244     * @param obj The hoversel object
15245     */
15246    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
15247
15248    /**
15249     * @brief Returns whether the hoversel is expanded.
15250     *
15251     * @param obj The hoversel object
15252     * @return  This will return EINA_TRUE if the hoversel is expanded or
15253     * EINA_FALSE if it is not expanded.
15254     */
15255    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15256
15257    /**
15258     * @brief This will remove all the children items from the hoversel.
15259     *
15260     * @param obj The hoversel object
15261     *
15262     * @warning Should @b not be called while the hoversel is active; use
15263     * elm_hoversel_expanded_get() to check first.
15264     *
15265     * @see elm_hoversel_item_del_cb_set()
15266     * @see elm_hoversel_item_del()
15267     */
15268    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15269
15270    /**
15271     * @brief Get the list of items within the given hoversel.
15272     *
15273     * @param obj The hoversel object
15274     * @return Returns a list of Elm_Object_Item*
15275     *
15276     * @see elm_hoversel_item_add()
15277     */
15278    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15279
15280    /**
15281     * @brief Add an item to the hoversel button
15282     *
15283     * @param obj The hoversel object
15284     * @param label The text label to use for the item (NULL if not desired)
15285     * @param icon_file An image file path on disk to use for the icon or standard
15286     * icon name (NULL if not desired)
15287     * @param icon_type The icon type if relevant
15288     * @param func Convenience function to call when this item is selected
15289     * @param data Data to pass to item-related functions
15290     * @return A handle to the item added.
15291     *
15292     * This adds an item to the hoversel to show when it is clicked. Note: if you
15293     * need to use an icon from an edje file then use
15294     * elm_hoversel_item_icon_set() right after the this function, and set
15295     * icon_file to NULL here.
15296     *
15297     * For more information on what @p icon_file and @p icon_type are see the
15298     * @ref Icon "icon documentation".
15299     */
15300    EAPI Elm_Object_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);
15301
15302    /**
15303     * @brief Delete an item from the hoversel
15304     *
15305     * @param it The item to delete
15306     *
15307     * This deletes the item from the hoversel (should not be called while the
15308     * hoversel is active; use elm_hoversel_expanded_get() to check first).
15309     *
15310     * @see elm_hoversel_item_add()
15311     * @see elm_hoversel_item_del_cb_set()
15312     */
15313    EAPI void               elm_hoversel_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15314
15315    /**
15316     * @brief Set the function to be called when an item from the hoversel is
15317     * freed.
15318     *
15319     * @param item The item to set the callback on
15320     * @param func The function called
15321     *
15322     * That function will receive these parameters:
15323     * @li void * item data
15324     * @li Evas_Object * hoversel object
15325     * @li Elm_Object_Item * hoversel item
15326     *
15327     * @see elm_hoversel_item_add()
15328     */
15329    EAPI void               elm_hoversel_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15330
15331    /**
15332     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
15333     * that will be passed to associated function callbacks.
15334     *
15335     * @param it The item to get the data from
15336     * @return The data pointer set with elm_hoversel_item_add()
15337     *
15338     * @see elm_hoversel_item_add()
15339     * @deprecated Use elm_object_item_data_get() instead
15340     */
15341    EINA_DEPRECATED EAPI void              *elm_hoversel_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15342
15343    /**
15344     * @brief This returns the label text of the given hoversel item.
15345     *
15346     * @param it The item to get the label
15347     * @return The label text of the hoversel item
15348     *
15349     * @see elm_hoversel_item_add()
15350     * @deprecated Use elm_object_item_text_get() instead
15351     */
15352    EINA_DEPRECATED EAPI const char        *elm_hoversel_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15353
15354    /**
15355     * @brief This sets the icon for the given hoversel item.
15356     *
15357     * @param item The item to set the icon
15358     * @param icon_file An image file path on disk to use for the icon or standard
15359     * icon name
15360     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
15361     * to NULL if the icon is not an edje file
15362     * @param icon_type The icon type
15363     *
15364     * The icon can be loaded from the standard set, from an image file, or from
15365     * an edje file.
15366     *
15367     * @see elm_hoversel_item_add()
15368     */
15369    EAPI void               elm_hoversel_item_icon_set(Elm_Object_Item *it, const char *icon_file, const char *icon_group, Elm_Icon_Type icon_type) EINA_ARG_NONNULL(1);
15370
15371    /**
15372     * @brief Get the icon object of the hoversel item
15373     *
15374     * @param item The item to get the icon from
15375     * @param icon_file The image file path on disk used for the icon or standard
15376     * icon name
15377     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
15378     * if the icon is not an edje file
15379     * @param icon_type The icon type
15380     *
15381     * @see elm_hoversel_item_icon_set()
15382     * @see elm_hoversel_item_add()
15383     */
15384    EAPI void               elm_hoversel_item_icon_get(const Elm_Object_Item *it, const char **icon_file, const char **icon_group, Elm_Icon_Type *icon_type) EINA_ARG_NONNULL(1);
15385
15386    /**
15387     * @}
15388     */
15389
15390    /**
15391     * @defgroup Toolbar Toolbar
15392     * @ingroup Elementary
15393     *
15394     * @image html img/widget/toolbar/preview-00.png
15395     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
15396     *
15397     * @image html img/toolbar.png
15398     * @image latex img/toolbar.eps width=\textwidth
15399     *
15400     * A toolbar is a widget that displays a list of items inside
15401     * a box. It can be scrollable, show a menu with items that don't fit
15402     * to toolbar size or even crop them.
15403     *
15404     * Only one item can be selected at a time.
15405     *
15406     * Items can have multiple states, or show menus when selected by the user.
15407     *
15408     * Smart callbacks one can listen to:
15409     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
15410     * - "language,changed" - when the program language changes
15411     *
15412     * Available styles for it:
15413     * - @c "default"
15414     * - @c "transparent" - no background or shadow, just show the content
15415     *
15416     * Default text parts of the toolbar items that you can use for are:
15417     * @li "default" - label of the toolbar item
15418     *  
15419     * Supported elm_object_item common APIs.
15420     * @li elm_object_item_disabled_set
15421     * @li elm_object_item_text_set
15422     * @li elm_object_item_part_text_set
15423     * @li elm_object_item_text_get
15424     * @li elm_object_item_part_text_get
15425     *
15426     * List of examples:
15427     * @li @ref toolbar_example_01
15428     * @li @ref toolbar_example_02
15429     * @li @ref toolbar_example_03
15430     */
15431
15432    /**
15433     * @addtogroup Toolbar
15434     * @{
15435     */
15436
15437    /**
15438     * @enum _Elm_Toolbar_Shrink_Mode
15439     * @typedef Elm_Toolbar_Shrink_Mode
15440     *
15441     * Set toolbar's items display behavior, it can be scrollabel,
15442     * show a menu with exceeding items, or simply hide them.
15443     *
15444     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
15445     * from elm config.
15446     *
15447     * Values <b> don't </b> work as bitmask, only one can be choosen.
15448     *
15449     * @see elm_toolbar_mode_shrink_set()
15450     * @see elm_toolbar_mode_shrink_get()
15451     *
15452     * @ingroup Toolbar
15453     */
15454    typedef enum _Elm_Toolbar_Shrink_Mode
15455      {
15456         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
15457         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
15458         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
15459         ELM_TOOLBAR_SHRINK_MENU,   /**< Inserts a button to pop up a menu with exceeding items. */
15460         ELM_TOOLBAR_SHRINK_LAST    /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
15461      } Elm_Toolbar_Shrink_Mode;
15462
15463    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(). */
15464
15465    /**
15466     * Add a new toolbar widget to the given parent Elementary
15467     * (container) object.
15468     *
15469     * @param parent The parent object.
15470     * @return a new toolbar widget handle or @c NULL, on errors.
15471     *
15472     * This function inserts a new toolbar widget on the canvas.
15473     *
15474     * @ingroup Toolbar
15475     */
15476    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15477
15478    /**
15479     * Set the icon size, in pixels, to be used by toolbar items.
15480     *
15481     * @param obj The toolbar object
15482     * @param icon_size The icon size in pixels
15483     *
15484     * @note Default value is @c 32. It reads value from elm config.
15485     *
15486     * @see elm_toolbar_icon_size_get()
15487     *
15488     * @ingroup Toolbar
15489     */
15490    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
15491
15492    /**
15493     * Get the icon size, in pixels, to be used by toolbar items.
15494     *
15495     * @param obj The toolbar object.
15496     * @return The icon size in pixels.
15497     *
15498     * @see elm_toolbar_icon_size_set() for details.
15499     *
15500     * @ingroup Toolbar
15501     */
15502    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15503
15504    /**
15505     * Sets icon lookup order, for toolbar items' icons.
15506     *
15507     * @param obj The toolbar object.
15508     * @param order The icon lookup order.
15509     *
15510     * Icons added before calling this function will not be affected.
15511     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
15512     *
15513     * @see elm_toolbar_icon_order_lookup_get()
15514     *
15515     * @ingroup Toolbar
15516     */
15517    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
15518
15519    /**
15520     * Gets the icon lookup order.
15521     *
15522     * @param obj The toolbar object.
15523     * @return The icon lookup order.
15524     *
15525     * @see elm_toolbar_icon_order_lookup_set() for details.
15526     *
15527     * @ingroup Toolbar
15528     */
15529    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15530
15531    /**
15532     * Set whether the toolbar should always have an item selected.
15533     *
15534     * @param obj The toolbar object.
15535     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
15536     * disable it.
15537     *
15538     * This will cause the toolbar to always have an item selected, and clicking
15539     * the selected item will not cause a selected event to be emitted. Enabling this mode
15540     * will immediately select the first toolbar item.
15541     *
15542     * Always-selected is disabled by default.
15543     *
15544     * @see elm_toolbar_always_select_mode_get().
15545     *
15546     * @ingroup Toolbar
15547     */
15548    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15549
15550    /**
15551     * Get whether the toolbar should always have an item selected.
15552     *
15553     * @param obj The toolbar object.
15554     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
15555     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
15556     *
15557     * @see elm_toolbar_always_select_mode_set() for details.
15558     *
15559     * @ingroup Toolbar
15560     */
15561    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15562
15563    /**
15564     * Set whether the toolbar items' should be selected by the user or not.
15565     *
15566     * @param obj The toolbar object.
15567     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
15568     * enable it.
15569     *
15570     * This will turn off the ability to select items entirely and they will
15571     * neither appear selected nor emit selected signals. The clicked
15572     * callback function will still be called.
15573     *
15574     * Selection is enabled by default.
15575     *
15576     * @see elm_toolbar_no_select_mode_get().
15577     *
15578     * @ingroup Toolbar
15579     */
15580    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
15581
15582    /**
15583     * Set whether the toolbar items' should be selected by the user or not.
15584     *
15585     * @param obj The toolbar object.
15586     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
15587     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
15588     *
15589     * @see elm_toolbar_no_select_mode_set() for details.
15590     *
15591     * @ingroup Toolbar
15592     */
15593    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15594
15595    /**
15596     * Append item to the toolbar.
15597     *
15598     * @param obj The toolbar object.
15599     * @param icon A string with icon name or the absolute path of an image file.
15600     * @param label The label of the item.
15601     * @param func The function to call when the item is clicked.
15602     * @param data The data to associate with the item for related callbacks.
15603     * @return The created item or @c NULL upon failure.
15604     *
15605     * A new item will be created and appended to the toolbar, i.e., will
15606     * be set as @b last item.
15607     *
15608     * Items created with this method can be deleted with
15609     * elm_toolbar_item_del().
15610     *
15611     * Associated @p data can be properly freed when item is deleted if a
15612     * callback function is set with elm_toolbar_item_del_cb_set().
15613     *
15614     * If a function is passed as argument, it will be called everytime this item
15615     * is selected, i.e., the user clicks over an unselected item.
15616     * If such function isn't needed, just passing
15617     * @c NULL as @p func is enough. The same should be done for @p data.
15618     *
15619     * Toolbar will load icon image from fdo or current theme.
15620     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15621     * If an absolute path is provided it will load it direct from a file.
15622     *
15623     * @see elm_toolbar_item_icon_set()
15624     * @see elm_toolbar_item_del()
15625     * @see elm_toolbar_item_del_cb_set()
15626     *
15627     * @ingroup Toolbar
15628     */
15629    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);
15630
15631    /**
15632     * Prepend item to the toolbar.
15633     *
15634     * @param obj The toolbar object.
15635     * @param icon A string with icon name or the absolute path of an image file.
15636     * @param label The label of the item.
15637     * @param func The function to call when the item is clicked.
15638     * @param data The data to associate with the item for related callbacks.
15639     * @return The created item or @c NULL upon failure.
15640     *
15641     * A new item will be created and prepended to the toolbar, i.e., will
15642     * be set as @b first item.
15643     *
15644     * Items created with this method can be deleted with
15645     * elm_toolbar_item_del().
15646     *
15647     * Associated @p data can be properly freed when item is deleted if a
15648     * callback function is set with elm_toolbar_item_del_cb_set().
15649     *
15650     * If a function is passed as argument, it will be called everytime this item
15651     * is selected, i.e., the user clicks over an unselected item.
15652     * If such function isn't needed, just passing
15653     * @c NULL as @p func is enough. The same should be done for @p data.
15654     *
15655     * Toolbar will load icon image from fdo or current theme.
15656     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15657     * If an absolute path is provided it will load it direct from a file.
15658     *
15659     * @see elm_toolbar_item_icon_set()
15660     * @see elm_toolbar_item_del()
15661     * @see elm_toolbar_item_del_cb_set()
15662     *
15663     * @ingroup Toolbar
15664     */
15665    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);
15666
15667    /**
15668     * Insert a new item into the toolbar object before item @p before.
15669     *
15670     * @param obj The toolbar object.
15671     * @param before The toolbar item to insert before.
15672     * @param icon A string with icon name or the absolute path of an image file.
15673     * @param label The label of the item.
15674     * @param func The function to call when the item is clicked.
15675     * @param data The data to associate with the item for related callbacks.
15676     * @return The created item or @c NULL upon failure.
15677     *
15678     * A new item will be created and added to the toolbar. Its position in
15679     * this toolbar will be just before item @p before.
15680     *
15681     * Items created with this method can be deleted with
15682     * elm_toolbar_item_del().
15683     *
15684     * Associated @p data can be properly freed when item is deleted if a
15685     * callback function is set with elm_toolbar_item_del_cb_set().
15686     *
15687     * If a function is passed as argument, it will be called everytime this item
15688     * is selected, i.e., the user clicks over an unselected item.
15689     * If such function isn't needed, just passing
15690     * @c NULL as @p func is enough. The same should be done for @p data.
15691     *
15692     * Toolbar will load icon image from fdo or current theme.
15693     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15694     * If an absolute path is provided it will load it direct from a file.
15695     *
15696     * @see elm_toolbar_item_icon_set()
15697     * @see elm_toolbar_item_del()
15698     * @see elm_toolbar_item_del_cb_set()
15699     *
15700     * @ingroup Toolbar
15701     */
15702    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);
15703
15704    /**
15705     * Insert a new item into the toolbar object after item @p after.
15706     *
15707     * @param obj The toolbar object.
15708     * @param after The toolbar item to insert after.
15709     * @param icon A string with icon name or the absolute path of an image file.
15710     * @param label The label of the item.
15711     * @param func The function to call when the item is clicked.
15712     * @param data The data to associate with the item for related callbacks.
15713     * @return The created item or @c NULL upon failure.
15714     *
15715     * A new item will be created and added to the toolbar. Its position in
15716     * this toolbar will be just after item @p after.
15717     *
15718     * Items created with this method can be deleted with
15719     * elm_toolbar_item_del().
15720     *
15721     * Associated @p data can be properly freed when item is deleted if a
15722     * callback function is set with elm_toolbar_item_del_cb_set().
15723     *
15724     * If a function is passed as argument, it will be called everytime this item
15725     * is selected, i.e., the user clicks over an unselected item.
15726     * If such function isn't needed, just passing
15727     * @c NULL as @p func is enough. The same should be done for @p data.
15728     *
15729     * Toolbar will load icon image from fdo or current theme.
15730     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15731     * If an absolute path is provided it will load it direct from a file.
15732     *
15733     * @see elm_toolbar_item_icon_set()
15734     * @see elm_toolbar_item_del()
15735     * @see elm_toolbar_item_del_cb_set()
15736     *
15737     * @ingroup Toolbar
15738     */
15739    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);
15740
15741    /**
15742     * Get the first item in the given toolbar widget's list of
15743     * items.
15744     *
15745     * @param obj The toolbar object
15746     * @return The first item or @c NULL, if it has no items (and on
15747     * errors)
15748     *
15749     * @see elm_toolbar_item_append()
15750     * @see elm_toolbar_last_item_get()
15751     *
15752     * @ingroup Toolbar
15753     */
15754    EAPI Elm_Object_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15755
15756    /**
15757     * Get the last item in the given toolbar widget's list of
15758     * items.
15759     *
15760     * @param obj The toolbar object
15761     * @return The last item or @c NULL, if it has no items (and on
15762     * errors)
15763     *
15764     * @see elm_toolbar_item_prepend()
15765     * @see elm_toolbar_first_item_get()
15766     *
15767     * @ingroup Toolbar
15768     */
15769    EAPI Elm_Object_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15770
15771    /**
15772     * Get the item after @p item in toolbar.
15773     *
15774     * @param it The toolbar item.
15775     * @return The item after @p item, or @c NULL if none or on failure.
15776     *
15777     * @note If it is the last item, @c NULL will be returned.
15778     *
15779     * @see elm_toolbar_item_append()
15780     *
15781     * @ingroup Toolbar
15782     */
15783    EAPI Elm_Object_Item       *elm_toolbar_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15784
15785    /**
15786     * Get the item before @p item in toolbar.
15787     *
15788     * @param item The toolbar item.
15789     * @return The item before @p item, or @c NULL if none or on failure.
15790     *
15791     * @note If it is the first item, @c NULL will be returned.
15792     *
15793     * @see elm_toolbar_item_prepend()
15794     *
15795     * @ingroup Toolbar
15796     */
15797    EAPI Elm_Object_Item       *elm_toolbar_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15798
15799    /**
15800     * Get the toolbar object from an item.
15801     *
15802     * @param it The item.
15803     * @return The toolbar object.
15804     *
15805     * This returns the toolbar object itself that an item belongs to.
15806     *
15807          * @deprecated use elm_object_item_object_get() instead.
15808     * @ingroup Toolbar
15809     */
15810    EINA_DEPRECATED EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15811
15812    /**
15813     * Set the priority of a toolbar item.
15814     *
15815     * @param it The toolbar item.
15816     * @param priority The item priority. The default is zero.
15817     *
15818     * This is used only when the toolbar shrink mode is set to
15819     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
15820     * When space is less than required, items with low priority
15821     * will be removed from the toolbar and added to a dynamically-created menu,
15822     * while items with higher priority will remain on the toolbar,
15823     * with the same order they were added.
15824     *
15825     * @see elm_toolbar_item_priority_get()
15826     *
15827     * @ingroup Toolbar
15828     */
15829    EAPI void                    elm_toolbar_item_priority_set(Elm_Object_Item *it, int priority) EINA_ARG_NONNULL(1);
15830
15831    /**
15832     * Get the priority of a toolbar item.
15833     *
15834     * @param it The toolbar item.
15835     * @return The @p item priority, or @c 0 on failure.
15836     *
15837     * @see elm_toolbar_item_priority_set() for details.
15838     *
15839     * @ingroup Toolbar
15840     */
15841    EAPI int                     elm_toolbar_item_priority_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15842
15843    /**
15844     * Get the label of item.
15845     *
15846     * @param it The item of toolbar.
15847     * @return The label of item.
15848     *
15849     * The return value is a pointer to the label associated to @p item when
15850     * it was created, with function elm_toolbar_item_append() or similar,
15851     * or later,
15852     * with function elm_toolbar_item_label_set. If no label
15853     * was passed as argument, it will return @c NULL.
15854     *
15855     * @see elm_toolbar_item_label_set() for more details.
15856     * @see elm_toolbar_item_append()
15857     *
15858          * @deprecated use elm_object_item_text_get() instead.
15859     * @ingroup Toolbar
15860     */
15861    EINA_DEPRECATED EAPI const char             *elm_toolbar_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15862
15863    /**
15864     * Set the label of item.
15865     *
15866     * @param it The item of toolbar.
15867     * @param text The label of item.
15868     *
15869     * The label to be displayed by the item.
15870     * Label will be placed at icons bottom (if set).
15871     *
15872     * If a label was passed as argument on item creation, with function
15873     * elm_toolbar_item_append() or similar, it will be already
15874     * displayed by the item.
15875     *
15876     * @see elm_toolbar_item_label_get()
15877     * @see elm_toolbar_item_append()
15878     *
15879          * @deprecated use elm_object_item_text_set() instead
15880     * @ingroup Toolbar
15881     */
15882    EINA_DEPRECATED EAPI void                    elm_toolbar_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
15883
15884    /**
15885     * Return the data associated with a given toolbar widget item.
15886     *
15887     * @param it The toolbar widget item handle.
15888     * @return The data associated with @p item.
15889     *
15890     * @see elm_toolbar_item_data_set()
15891     *
15892     * @deprecated use elm_object_item_data_get() instead.
15893     * @ingroup Toolbar
15894     */
15895    EINA_DEPRECATED EAPI void                   *elm_toolbar_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15896
15897    /**
15898     * Set the data associated with a given toolbar widget item.
15899     *
15900     * @param it The toolbar widget item handle
15901     * @param data The new data pointer to set to @p item.
15902     *
15903     * This sets new item data on @p item.
15904     *
15905     * @warning The old data pointer won't be touched by this function, so
15906     * the user had better to free that old data himself/herself.
15907     *
15908     * @deprecated use elm_object_item_data_set() instead.
15909     * @ingroup Toolbar
15910     */
15911    EINA_DEPRECATED EAPI void                    elm_toolbar_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
15912
15913    /**
15914     * Returns a pointer to a toolbar item by its label.
15915     *
15916     * @param obj The toolbar object.
15917     * @param label The label of the item to find.
15918     *
15919     * @return The pointer to the toolbar item matching @p label or @c NULL
15920     * on failure.
15921     *
15922     * @ingroup Toolbar
15923     */
15924    EAPI Elm_Object_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15925
15926    /*
15927     * Get whether the @p item is selected or not.
15928     *
15929     * @param it The toolbar item.
15930     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15931     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15932     *
15933     * @see elm_toolbar_selected_item_set() for details.
15934     * @see elm_toolbar_item_selected_get()
15935     *
15936     * @ingroup Toolbar
15937     */
15938    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15939
15940    /**
15941     * Set the selected state of an item.
15942     *
15943     * @param it The toolbar item
15944     * @param selected The selected state
15945     *
15946     * This sets the selected state of the given item @p it.
15947     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15948     *
15949     * If a new item is selected the previosly selected will be unselected.
15950     * Previoulsy selected item can be get with function
15951     * elm_toolbar_selected_item_get().
15952     *
15953     * Selected items will be highlighted.
15954     *
15955     * @see elm_toolbar_item_selected_get()
15956     * @see elm_toolbar_selected_item_get()
15957     *
15958     * @ingroup Toolbar
15959     */
15960    EAPI void                    elm_toolbar_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
15961
15962    /**
15963     * Get the selected item.
15964     *
15965     * @param obj The toolbar object.
15966     * @return The selected toolbar item.
15967     *
15968     * The selected item can be unselected with function
15969     * elm_toolbar_item_selected_set().
15970     *
15971     * The selected item always will be highlighted on toolbar.
15972     *
15973     * @see elm_toolbar_selected_items_get()
15974     *
15975     * @ingroup Toolbar
15976     */
15977    EAPI Elm_Object_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15978
15979    /**
15980     * Set the icon associated with @p item.
15981     *
15982     * @param obj The parent of this item.
15983     * @param it The toolbar item.
15984     * @param icon A string with icon name or the absolute path of an image file.
15985     *
15986     * Toolbar will load icon image from fdo or current theme.
15987     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15988     * If an absolute path is provided it will load it direct from a file.
15989     *
15990     * @see elm_toolbar_icon_order_lookup_set()
15991     * @see elm_toolbar_icon_order_lookup_get()
15992     *
15993     * @ingroup Toolbar
15994     */
15995    EAPI void                    elm_toolbar_item_icon_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1);
15996
15997    /**
15998     * Get the string used to set the icon of @p item.
15999     *
16000     * @param it The toolbar item.
16001     * @return The string associated with the icon object.
16002     *
16003     * @see elm_toolbar_item_icon_set() for details.
16004     *
16005     * @ingroup Toolbar
16006     */
16007    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16008
16009    /**
16010     * Get the object of @p item.
16011     *
16012     * @param it The toolbar item.
16013     * @return The object
16014     *
16015     * @ingroup Toolbar
16016     */
16017    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16018
16019    /**
16020     * Get the icon object of @p item.
16021     *
16022     * @param it The toolbar item.
16023     * @return The icon object
16024     *
16025     * @see elm_toolbar_item_icon_set(), elm_toolbar_item_icon_file_set(),
16026     * or elm_toolbar_item_icon_memfile_set() for details.
16027     *
16028     * @ingroup Toolbar
16029     */
16030    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16031
16032    /**
16033     * Set the icon associated with @p item to an image in a binary buffer.
16034     *
16035     * @param it The toolbar item.
16036     * @param img The binary data that will be used as an image
16037     * @param size The size of binary data @p img
16038     * @param format Optional format of @p img to pass to the image loader
16039     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
16040     *
16041     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
16042     *
16043     * @note The icon image set by this function can be changed by
16044     * elm_toolbar_item_icon_set().
16045     *
16046     * @ingroup Toolbar
16047     */
16048    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);
16049
16050    /**
16051     * Set the icon associated with @p item to an image in a binary buffer.
16052     *
16053     * @param it The toolbar item.
16054     * @param file The file that contains the image
16055     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
16056     *
16057     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
16058     *
16059     * @note The icon image set by this function can be changed by
16060     * elm_toolbar_item_icon_set().
16061     *
16062     * @ingroup Toolbar
16063     */
16064    EAPI Eina_Bool elm_toolbar_item_icon_file_set(Elm_Object_Item *it, const char *file, const char *key) EINA_ARG_NONNULL(1);
16065
16066    /**
16067     * Delete them item from the toolbar.
16068     *
16069     * @param it The item of toolbar to be deleted.
16070     *
16071     * @see elm_toolbar_item_append()
16072     * @see elm_toolbar_item_del_cb_set()
16073     *
16074     * @ingroup Toolbar
16075     */
16076    EAPI void                    elm_toolbar_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16077
16078    /**
16079     * Set the function called when a toolbar item is freed.
16080     *
16081     * @param it The item to set the callback on.
16082     * @param func The function called.
16083     *
16084     * If there is a @p func, then it will be called prior item's memory release.
16085     * That will be called with the following arguments:
16086     * @li item's data;
16087     * @li item's Evas object;
16088     * @li item itself;
16089     *
16090     * This way, a data associated to a toolbar item could be properly freed.
16091     *
16092     * @ingroup Toolbar
16093     */
16094    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16095
16096    /**
16097     * Get a value whether toolbar item is disabled or not.
16098     *
16099     * @param it The item.
16100     * @return The disabled state.
16101     *
16102     * @see elm_toolbar_item_disabled_set() for more details.
16103     *
16104     * @deprecated use elm_object_item_disabled_get() instead.
16105     * @ingroup Toolbar
16106     */
16107    EINA_DEPRECATED EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16108
16109    /**
16110     * Sets the disabled/enabled state of a toolbar item.
16111     *
16112     * @param it The item.
16113     * @param disabled The disabled state.
16114     *
16115     * A disabled item cannot be selected or unselected. It will also
16116     * change its appearance (generally greyed out). This sets the
16117     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16118     * enabled).
16119     *
16120     * @deprecated use elm_object_item_disabled_set() instead.
16121     * @ingroup Toolbar
16122     */
16123    EINA_DEPRECATED EAPI void                    elm_toolbar_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16124
16125    /**
16126     * Set or unset item as a separator.
16127     *
16128     * @param it The toolbar item.
16129     * @param setting @c EINA_TRUE to set item @p item as separator or
16130     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16131     *
16132     * Items aren't set as separator by default.
16133     *
16134     * If set as separator it will display separator theme, so won't display
16135     * icons or label.
16136     *
16137     * @see elm_toolbar_item_separator_get()
16138     *
16139     * @ingroup Toolbar
16140     */
16141    EAPI void                    elm_toolbar_item_separator_set(Elm_Object_Item *it, Eina_Bool separator) EINA_ARG_NONNULL(1);
16142
16143    /**
16144     * Get a value whether item is a separator or not.
16145     *
16146     * @param it The toolbar item.
16147     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16148     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16149     *
16150     * @see elm_toolbar_item_separator_set() for details.
16151     *
16152     * @ingroup Toolbar
16153     */
16154    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16155
16156    /**
16157     * Set the shrink state of toolbar @p obj.
16158     *
16159     * @param obj The toolbar object.
16160     * @param shrink_mode Toolbar's items display behavior.
16161     *
16162     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
16163     * but will enforce a minimun size so all the items will fit, won't scroll
16164     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
16165     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
16166     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
16167     *
16168     * @ingroup Toolbar
16169     */
16170    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
16171
16172    /**
16173     * Get the shrink mode of toolbar @p obj.
16174     *
16175     * @param obj The toolbar object.
16176     * @return Toolbar's items display behavior.
16177     *
16178     * @see elm_toolbar_mode_shrink_set() for details.
16179     *
16180     * @ingroup Toolbar
16181     */
16182    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16183
16184    /**
16185     * Enable/disable homogeneous mode.
16186     *
16187     * @param obj The toolbar object
16188     * @param homogeneous Assume the items within the toolbar are of the
16189     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
16190     *
16191     * This will enable the homogeneous mode where items are of the same size.
16192     * @see elm_toolbar_homogeneous_get()
16193     *
16194     * @ingroup Toolbar
16195     */
16196    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
16197
16198    /**
16199     * Get whether the homogeneous mode is enabled.
16200     *
16201     * @param obj The toolbar object.
16202     * @return Assume the items within the toolbar are of the same height
16203     * and width (EINA_TRUE = on, EINA_FALSE = off).
16204     *
16205     * @see elm_toolbar_homogeneous_set()
16206     *
16207     * @ingroup Toolbar
16208     */
16209    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16210
16211    /**
16212     * Set the parent object of the toolbar items' menus.
16213     *
16214     * @param obj The toolbar object.
16215     * @param parent The parent of the menu objects.
16216     *
16217     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
16218     *
16219     * For more details about setting the parent for toolbar menus, see
16220     * elm_menu_parent_set().
16221     *
16222     * @see elm_menu_parent_set() for details.
16223     * @see elm_toolbar_item_menu_set() for details.
16224     *
16225     * @ingroup Toolbar
16226     */
16227    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16228
16229    /**
16230     * Get the parent object of the toolbar items' menus.
16231     *
16232     * @param obj The toolbar object.
16233     * @return The parent of the menu objects.
16234     *
16235     * @see elm_toolbar_menu_parent_set() for details.
16236     *
16237     * @ingroup Toolbar
16238     */
16239    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16240
16241    /**
16242     * Set the alignment of the items.
16243     *
16244     * @param obj The toolbar object.
16245     * @param align The new alignment, a float between <tt> 0.0 </tt>
16246     * and <tt> 1.0 </tt>.
16247     *
16248     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
16249     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
16250     * items.
16251     *
16252     * Centered items by default.
16253     *
16254     * @see elm_toolbar_align_get()
16255     *
16256     * @ingroup Toolbar
16257     */
16258    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
16259
16260    /**
16261     * Get the alignment of the items.
16262     *
16263     * @param obj The toolbar object.
16264     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
16265     * <tt> 1.0 </tt>.
16266     *
16267     * @see elm_toolbar_align_set() for details.
16268     *
16269     * @ingroup Toolbar
16270     */
16271    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16272
16273    /**
16274     * Set whether the toolbar item opens a menu.
16275     *
16276     * @param it The toolbar item.
16277     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
16278     *
16279     * A toolbar item can be set to be a menu, using this function.
16280     *
16281     * Once it is set to be a menu, it can be manipulated through the
16282     * menu-like function elm_toolbar_menu_parent_set() and the other
16283     * elm_menu functions, using the Evas_Object @c menu returned by
16284     * elm_toolbar_item_menu_get().
16285     *
16286     * So, items to be displayed in this item's menu should be added with
16287     * elm_menu_item_add().
16288     *
16289     * The following code exemplifies the most basic usage:
16290     * @code
16291     * tb = elm_toolbar_add(win)
16292     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
16293     * elm_toolbar_item_menu_set(item, EINA_TRUE);
16294     * elm_toolbar_menu_parent_set(tb, win);
16295     * menu = elm_toolbar_item_menu_get(item);
16296     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
16297     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
16298     * NULL);
16299     * @endcode
16300     *
16301     * @see elm_toolbar_item_menu_get()
16302     *
16303     * @ingroup Toolbar
16304     */
16305    EAPI void                    elm_toolbar_item_menu_set(Elm_Object_Item *it, Eina_Bool menu) EINA_ARG_NONNULL(1);
16306
16307    /**
16308     * Get toolbar item's menu.
16309     *
16310     * @param it The toolbar item.
16311     * @return Item's menu object or @c NULL on failure.
16312     *
16313     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
16314     * this function will set it.
16315     *
16316     * @see elm_toolbar_item_menu_set() for details.
16317     *
16318     * @ingroup Toolbar
16319     */
16320    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16321
16322    /**
16323     * Add a new state to @p item.
16324     *
16325     * @param it The toolbar item.
16326     * @param icon A string with icon name or the absolute path of an image file.
16327     * @param label The label of the new state.
16328     * @param func The function to call when the item is clicked when this
16329     * state is selected.
16330     * @param data The data to associate with the state.
16331     * @return The toolbar item state, or @c NULL upon failure.
16332     *
16333     * Toolbar will load icon image from fdo or current theme.
16334     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
16335     * If an absolute path is provided it will load it direct from a file.
16336     *
16337     * States created with this function can be removed with
16338     * elm_toolbar_item_state_del().
16339     *
16340     * @see elm_toolbar_item_state_del()
16341     * @see elm_toolbar_item_state_sel()
16342     * @see elm_toolbar_item_state_get()
16343     *
16344     * @ingroup Toolbar
16345     */
16346    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);
16347
16348    /**
16349     * Delete a previoulsy added state to @p item.
16350     *
16351     * @param it The toolbar item.
16352     * @param state The state to be deleted.
16353     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
16354     *
16355     * @see elm_toolbar_item_state_add()
16356     */
16357    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
16358
16359    /**
16360     * Set @p state as the current state of @p it.
16361     *
16362     * @param it The toolbar item.
16363     * @param state The state to use.
16364     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
16365     *
16366     * If @p state is @c NULL, it won't select any state and the default item's
16367     * icon and label will be used. It's the same behaviour than
16368     * elm_toolbar_item_state_unser().
16369     *
16370     * @see elm_toolbar_item_state_unset()
16371     *
16372     * @ingroup Toolbar
16373     */
16374    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
16375
16376    /**
16377     * Unset the state of @p it.
16378     *
16379     * @param it The toolbar item.
16380     *
16381     * The default icon and label from this item will be displayed.
16382     *
16383     * @see elm_toolbar_item_state_set() for more details.
16384     *
16385     * @ingroup Toolbar
16386     */
16387    EAPI void                    elm_toolbar_item_state_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16388
16389    /**
16390     * Get the current state of @p it.
16391     *
16392     * @param it The toolbar item.
16393     * @return The selected state or @c NULL if none is selected or on failure.
16394     *
16395     * @see elm_toolbar_item_state_set() for details.
16396     * @see elm_toolbar_item_state_unset()
16397     * @see elm_toolbar_item_state_add()
16398     *
16399     * @ingroup Toolbar
16400     */
16401    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16402
16403    /**
16404     * Get the state after selected state in toolbar's @p item.
16405     *
16406     * @param it The toolbar item to change state.
16407     * @return The state after current state, or @c NULL on failure.
16408     *
16409     * If last state is selected, this function will return first state.
16410     *
16411     * @see elm_toolbar_item_state_set()
16412     * @see elm_toolbar_item_state_add()
16413     *
16414     * @ingroup Toolbar
16415     */
16416    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16417
16418    /**
16419     * Get the state before selected state in toolbar's @p item.
16420     *
16421     * @param it The toolbar item to change state.
16422     * @return The state before current state, or @c NULL on failure.
16423     *
16424     * If first state is selected, this function will return last state.
16425     *
16426     * @see elm_toolbar_item_state_set()
16427     * @see elm_toolbar_item_state_add()
16428     *
16429     * @ingroup Toolbar
16430     */
16431    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16432
16433    /**
16434     * Set the text to be shown in a given toolbar item's tooltips.
16435     *
16436     * @param it toolbar item.
16437     * @param text The text to set in the content.
16438     *
16439     * Setup the text as tooltip to object. The item can have only one tooltip,
16440     * so any previous tooltip data - set with this function or
16441     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
16442     *
16443     * @see elm_object_tooltip_text_set() for more details.
16444     *
16445     * @ingroup Toolbar
16446     */
16447    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Object_Item *it, const char *text) EINA_ARG_NONNULL(1);
16448
16449    /**
16450     * Set the content to be shown in the tooltip item.
16451     *
16452     * Setup the tooltip to item. The item can have only one tooltip,
16453     * so any previous tooltip data is removed. @p func(with @p data) will
16454     * be called every time that need show the tooltip and it should
16455     * return a valid Evas_Object. This object is then managed fully by
16456     * tooltip system and is deleted when the tooltip is gone.
16457     *
16458     * @param it the toolbar item being attached a tooltip.
16459     * @param func the function used to create the tooltip contents.
16460     * @param data what to provide to @a func as callback data/context.
16461     * @param del_cb called when data is not needed anymore, either when
16462     *        another callback replaces @a func, the tooltip is unset with
16463     *        elm_toolbar_item_tooltip_unset() or the owner @a item
16464     *        dies. This callback receives as the first parameter the
16465     *        given @a data, and @c event_info is the item.
16466     *
16467     * @see elm_object_tooltip_content_cb_set() for more details.
16468     *
16469     * @ingroup Toolbar
16470     */
16471    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);
16472
16473    /**
16474     * Unset tooltip from item.
16475     *
16476     * @param it toolbar item to remove previously set tooltip.
16477     *
16478     * Remove tooltip from item. The callback provided as del_cb to
16479     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
16480     * it is not used anymore.
16481     *
16482     * @see elm_object_tooltip_unset() for more details.
16483     * @see elm_toolbar_item_tooltip_content_cb_set()
16484     *
16485     * @ingroup Toolbar
16486     */
16487    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16488
16489    /**
16490     * Sets a different style for this item tooltip.
16491     *
16492     * @note before you set a style you should define a tooltip with
16493     *       elm_toolbar_item_tooltip_content_cb_set() or
16494     *       elm_toolbar_item_tooltip_text_set()
16495     *
16496     * @param it toolbar item with tooltip already set.
16497     * @param style the theme style to use (default, transparent, ...)
16498     *
16499     * @see elm_object_tooltip_style_set() for more details.
16500     *
16501     * @ingroup Toolbar
16502     */
16503    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
16504
16505    /**
16506     * Get the style for this item tooltip.
16507     *
16508     * @param it toolbar item with tooltip already set.
16509     * @return style the theme style in use, defaults to "default". If the
16510     *         object does not have a tooltip set, then NULL is returned.
16511     *
16512     * @see elm_object_tooltip_style_get() for more details.
16513     * @see elm_toolbar_item_tooltip_style_set()
16514     *
16515     * @ingroup Toolbar
16516     */
16517    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16518
16519    /**
16520     * Set the type of mouse pointer/cursor decoration to be shown,
16521     * when the mouse pointer is over the given toolbar widget item
16522     *
16523     * @param it toolbar item to customize cursor on
16524     * @param cursor the cursor type's name
16525     *
16526     * This function works analogously as elm_object_cursor_set(), but
16527     * here the cursor's changing area is restricted to the item's
16528     * area, and not the whole widget's. Note that that item cursors
16529     * have precedence over widget cursors, so that a mouse over an
16530     * item with custom cursor set will always show @b that cursor.
16531     *
16532     * If this function is called twice for an object, a previously set
16533     * cursor will be unset on the second call.
16534     *
16535     * @see elm_object_cursor_set()
16536     * @see elm_toolbar_item_cursor_get()
16537     * @see elm_toolbar_item_cursor_unset()
16538     *
16539     * @ingroup Toolbar
16540     */
16541    EAPI void             elm_toolbar_item_cursor_set(Elm_Object_Item *it, const char *cursor) EINA_ARG_NONNULL(1);
16542
16543    /*
16544     * Get the type of mouse pointer/cursor decoration set to be shown,
16545     * when the mouse pointer is over the given toolbar widget item
16546     *
16547     * @param it toolbar item with custom cursor set
16548     * @return the cursor type's name or @c NULL, if no custom cursors
16549     * were set to @p item (and on errors)
16550     *
16551     * @see elm_object_cursor_get()
16552     * @see elm_toolbar_item_cursor_set()
16553     * @see elm_toolbar_item_cursor_unset()
16554     *
16555     * @ingroup Toolbar
16556     */
16557    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16558
16559    /**
16560     * Unset any custom mouse pointer/cursor decoration set to be
16561     * shown, when the mouse pointer is over the given toolbar widget
16562     * item, thus making it show the @b default cursor again.
16563     *
16564     * @param it a toolbar item
16565     *
16566     * Use this call to undo any custom settings on this item's cursor
16567     * decoration, bringing it back to defaults (no custom style set).
16568     *
16569     * @see elm_object_cursor_unset()
16570     * @see elm_toolbar_item_cursor_set()
16571     *
16572     * @ingroup Toolbar
16573     */
16574    EAPI void             elm_toolbar_item_cursor_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16575
16576    /**
16577     * Set a different @b style for a given custom cursor set for a
16578     * toolbar item.
16579     *
16580     * @param it toolbar item with custom cursor set
16581     * @param style the <b>theme style</b> to use (e.g. @c "default",
16582     * @c "transparent", etc)
16583     *
16584     * This function only makes sense when one is using custom mouse
16585     * cursor decorations <b>defined in a theme file</b>, which can have,
16586     * given a cursor name/type, <b>alternate styles</b> on it. It
16587     * works analogously as elm_object_cursor_style_set(), but here
16588     * applyed only to toolbar item objects.
16589     *
16590     * @warning Before you set a cursor style you should have definen a
16591     *       custom cursor previously on the item, with
16592     *       elm_toolbar_item_cursor_set()
16593     *
16594     * @see elm_toolbar_item_cursor_engine_only_set()
16595     * @see elm_toolbar_item_cursor_style_get()
16596     *
16597     * @ingroup Toolbar
16598     */
16599    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
16600
16601    /**
16602     * Get the current @b style set for a given toolbar item's custom
16603     * cursor
16604     *
16605     * @param it toolbar item with custom cursor set.
16606     * @return style the cursor style in use. If the object does not
16607     *         have a cursor set, then @c NULL is returned.
16608     *
16609     * @see elm_toolbar_item_cursor_style_set() for more details
16610     *
16611     * @ingroup Toolbar
16612     */
16613    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16614
16615    /**
16616     * Set if the (custom)cursor for a given toolbar item should be
16617     * searched in its theme, also, or should only rely on the
16618     * rendering engine.
16619     *
16620     * @param it item with custom (custom) cursor already set on
16621     * @param engine_only Use @c EINA_TRUE to have cursors looked for
16622     * only on those provided by the rendering engine, @c EINA_FALSE to
16623     * have them searched on the widget's theme, as well.
16624     *
16625     * @note This call is of use only if you've set a custom cursor
16626     * for toolbar items, with elm_toolbar_item_cursor_set().
16627     *
16628     * @note By default, cursors will only be looked for between those
16629     * provided by the rendering engine.
16630     *
16631     * @ingroup Toolbar
16632     */
16633    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16634
16635    /**
16636     * Get if the (custom) cursor for a given toolbar item is being
16637     * searched in its theme, also, or is only relying on the rendering
16638     * engine.
16639     *
16640     * @param it a toolbar item
16641     * @return @c EINA_TRUE, if cursors are being looked for only on
16642     * those provided by the rendering engine, @c EINA_FALSE if they
16643     * are being searched on the widget's theme, as well.
16644     *
16645     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
16646     *
16647     * @ingroup Toolbar
16648     */
16649    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16650
16651    /**
16652     * Change a toolbar's orientation
16653     * @param obj The toolbar object
16654     * @param vertical If @c EINA_TRUE, the toolbar is vertical
16655     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
16656     * @ingroup Toolbar
16657     * @deprecated use elm_toolbar_horizontal_set() instead.
16658     */
16659    EINA_DEPRECATED EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
16660
16661    /**
16662     * Change a toolbar's orientation
16663     * @param obj The toolbar object
16664     * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
16665     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
16666     * @ingroup Toolbar
16667     */
16668    EAPI void             elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16669
16670    /**
16671     * Get a toolbar's orientation
16672     * @param obj The toolbar object
16673     * @return If @c EINA_TRUE, the toolbar is vertical
16674     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
16675     * @ingroup Toolbar
16676     * @deprecated use elm_toolbar_horizontal_get() instead.
16677     */
16678    EINA_DEPRECATED EAPI Eina_Bool        elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16679
16680    /**
16681     * Get a toolbar's orientation
16682     * @param obj The toolbar object
16683     * @return If @c EINA_TRUE, the toolbar is horizontal
16684     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
16685     * @ingroup Toolbar
16686     */
16687    EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
16688
16689    /**
16690     * Get the number of items in a toolbar
16691     * @param obj The toolbar object
16692     * @return The number of items in @p obj toolbar
16693     * @ingroup Toolbar
16694     */
16695    EAPI unsigned int elm_toolbar_items_count(const Evas_Object *obj) EINA_ARG_NONNULL(1) EINA_PURE;
16696    /**
16697     * @}
16698     */
16699
16700    /**
16701     * @defgroup Tooltips Tooltips
16702     *
16703     * The Tooltip is an (internal, for now) smart object used to show a
16704     * content in a frame on mouse hover of objects(or widgets), with
16705     * tips/information about them.
16706     *
16707     * @{
16708     */
16709
16710    EAPI double       elm_tooltip_delay_get(void);
16711    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
16712    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
16713    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
16714    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
16715    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
16716 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
16717    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);
16718    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16719    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
16720    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16721    EAPI Eina_Bool    elm_object_tooltip_window_mode_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
16722    EAPI Eina_Bool    elm_object_tooltip_window_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16723
16724    /**
16725     * @}
16726     */
16727
16728    /**
16729     * @defgroup Cursors Cursors
16730     *
16731     * The Elementary cursor is an internal smart object used to
16732     * customize the mouse cursor displayed over objects (or
16733     * widgets). In the most common scenario, the cursor decoration
16734     * comes from the graphical @b engine Elementary is running
16735     * on. Those engines may provide different decorations for cursors,
16736     * and Elementary provides functions to choose them (think of X11
16737     * cursors, as an example).
16738     *
16739     * There's also the possibility of, besides using engine provided
16740     * cursors, also use ones coming from Edje theming files. Both
16741     * globally and per widget, Elementary makes it possible for one to
16742     * make the cursors lookup to be held on engines only or on
16743     * Elementary's theme file, too. To set cursor's hot spot,
16744     * two data items should be added to cursor's theme: "hot_x" and
16745     * "hot_y", that are the offset from upper-left corner of the cursor
16746     * (coordinates 0,0).
16747     *
16748     * @{
16749     */
16750
16751    /**
16752     * Set the cursor to be shown when mouse is over the object
16753     *
16754     * Set the cursor that will be displayed when mouse is over the
16755     * object. The object can have only one cursor set to it, so if
16756     * this function is called twice for an object, the previous set
16757     * will be unset.
16758     * If using X cursors, a definition of all the valid cursor names
16759     * is listed on Elementary_Cursors.h. If an invalid name is set
16760     * the default cursor will be used.
16761     *
16762     * @param obj the object being set a cursor.
16763     * @param cursor the cursor name to be used.
16764     *
16765     * @ingroup Cursors
16766     */
16767    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
16768
16769    /**
16770     * Get the cursor to be shown when mouse is over the object
16771     *
16772     * @param obj an object with cursor already set.
16773     * @return the cursor name.
16774     *
16775     * @ingroup Cursors
16776     */
16777    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16778
16779    /**
16780     * Unset cursor for object
16781     *
16782     * Unset cursor for object, and set the cursor to default if the mouse
16783     * was over this object.
16784     *
16785     * @param obj Target object
16786     * @see elm_object_cursor_set()
16787     *
16788     * @ingroup Cursors
16789     */
16790    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16791
16792    /**
16793     * Sets a different style for this object cursor.
16794     *
16795     * @note before you set a style you should define a cursor with
16796     *       elm_object_cursor_set()
16797     *
16798     * @param obj an object with cursor already set.
16799     * @param style the theme style to use (default, transparent, ...)
16800     *
16801     * @ingroup Cursors
16802     */
16803    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
16804
16805    /**
16806     * Get the style for this object cursor.
16807     *
16808     * @param obj an object with cursor already set.
16809     * @return style the theme style in use, defaults to "default". If the
16810     *         object does not have a cursor set, then NULL is returned.
16811     *
16812     * @ingroup Cursors
16813     */
16814    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16815
16816    /**
16817     * Set if the cursor set should be searched on the theme or should use
16818     * the provided by the engine, only.
16819     *
16820     * @note before you set if should look on theme you should define a cursor
16821     * with elm_object_cursor_set(). By default it will only look for cursors
16822     * provided by the engine.
16823     *
16824     * @param obj an object with cursor already set.
16825     * @param engine_only boolean to define it cursors should be looked only
16826     * between the provided by the engine or searched on widget's theme as well.
16827     *
16828     * @ingroup Cursors
16829     */
16830    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16831
16832    /**
16833     * Get the cursor engine only usage for this object cursor.
16834     *
16835     * @param obj an object with cursor already set.
16836     * @return engine_only boolean to define it cursors should be
16837     * looked only between the provided by the engine or searched on
16838     * widget's theme as well. If the object does not have a cursor
16839     * set, then EINA_FALSE is returned.
16840     *
16841     * @ingroup Cursors
16842     */
16843    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16844
16845    /**
16846     * Get the configured cursor engine only usage
16847     *
16848     * This gets the globally configured exclusive usage of engine cursors.
16849     *
16850     * @return 1 if only engine cursors should be used
16851     * @ingroup Cursors
16852     */
16853    EAPI int          elm_cursor_engine_only_get(void);
16854
16855    /**
16856     * Set the configured cursor engine only usage
16857     *
16858     * This sets the globally configured exclusive usage of engine cursors.
16859     * It won't affect cursors set before changing this value.
16860     *
16861     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
16862     * look for them on theme before.
16863     * @return EINA_TRUE if value is valid and setted (0 or 1)
16864     * @ingroup Cursors
16865     */
16866    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
16867
16868    /**
16869     * @}
16870     */
16871
16872    /**
16873     * @defgroup Menu Menu
16874     *
16875     * @image html img/widget/menu/preview-00.png
16876     * @image latex img/widget/menu/preview-00.eps
16877     *
16878     * A menu is a list of items displayed above its parent. When the menu is
16879     * showing its parent is darkened. Each item can have a sub-menu. The menu
16880     * object can be used to display a menu on a right click event, in a toolbar,
16881     * anywhere.
16882     *
16883     * Signals that you can add callbacks for are:
16884     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
16885     *
16886     * Default contents parts of the menu items that you can use for are:
16887     * @li "default" - A main content of the menu item
16888     *
16889     * Default text parts of the menu items that you can use for are:
16890     * @li "default" - label in the menu item
16891     *
16892     * @see @ref tutorial_menu
16893     * @{
16894     */
16895
16896    /**
16897     * @brief Add a new menu to the parent
16898     *
16899     * @param parent The parent object.
16900     * @return The new object or NULL if it cannot be created.
16901     */
16902    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16903
16904    /**
16905     * @brief Set the parent for the given menu widget
16906     *
16907     * @param obj The menu object.
16908     * @param parent The new parent.
16909     */
16910    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16911
16912    /**
16913     * @brief Get the parent for the given menu widget
16914     *
16915     * @param obj The menu object.
16916     * @return The parent.
16917     *
16918     * @see elm_menu_parent_set()
16919     */
16920    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16921
16922    /**
16923     * @brief Move the menu to a new position
16924     *
16925     * @param obj The menu object.
16926     * @param x The new position.
16927     * @param y The new position.
16928     *
16929     * Sets the top-left position of the menu to (@p x,@p y).
16930     *
16931     * @note @p x and @p y coordinates are relative to parent.
16932     */
16933    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
16934
16935    /**
16936     * @brief Close a opened menu
16937     *
16938     * @param obj the menu object
16939     * @return void
16940     *
16941     * Hides the menu and all it's sub-menus.
16942     */
16943    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
16944
16945    /**
16946     * @brief Returns a list of @p item's items.
16947     *
16948     * @param obj The menu object
16949     * @return An Eina_List* of @p item's items
16950     */
16951    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16952
16953    /**
16954     * @brief Get the Evas_Object of an Elm_Object_Item
16955     *
16956     * @param it The menu item object.
16957     * @return The edje object containing the swallowed content
16958     *
16959     * @warning Don't manipulate this object!
16960     *
16961     */
16962    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16963
16964    /**
16965     * @brief Add an item at the end of the given menu widget
16966     *
16967     * @param obj The menu object.
16968     * @param parent The parent menu item (optional)
16969     * @param icon An icon display on the item. The icon will be destryed by the menu.
16970     * @param label The label of the item.
16971     * @param func Function called when the user select the item.
16972     * @param data Data sent by the callback.
16973     * @return Returns the new item.
16974     */
16975    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);
16976
16977    /**
16978     * @brief Add an object swallowed in an item at the end of the given menu
16979     * widget
16980     *
16981     * @param obj The menu object.
16982     * @param parent The parent menu item (optional)
16983     * @param subobj The object to swallow
16984     * @param func Function called when the user select the item.
16985     * @param data Data sent by the callback.
16986     * @return Returns the new item.
16987     *
16988     * Add an evas object as an item to the menu.
16989     */
16990    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);
16991
16992    /**
16993     * @brief Set the label of a menu item
16994     *
16995     * @param it The menu item object.
16996     * @param label The label to set for @p item
16997     *
16998     * @warning Don't use this funcion on items created with
16999     * elm_menu_item_add_object() or elm_menu_item_separator_add().
17000     *
17001     * @deprecated Use elm_object_item_text_set() instead
17002     */
17003    EINA_DEPRECATED EAPI void               elm_menu_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
17004
17005    /**
17006     * @brief Get the label of a menu item
17007     *
17008     * @param it The menu item object.
17009     * @return The label of @p item
17010          * @deprecated Use elm_object_item_text_get() instead
17011     */
17012    EINA_DEPRECATED EAPI const char        *elm_menu_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17013
17014    /**
17015     * @brief Set the icon of a menu item to the standard icon with name @p icon
17016     *
17017     * @param it The menu item object.
17018     * @param icon The icon object to set for the content of @p item
17019     *
17020     * Once this icon is set, any previously set icon will be deleted.
17021     */
17022    EAPI void               elm_menu_item_object_icon_name_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1, 2);
17023
17024    /**
17025     * @brief Get the string representation from the icon of a menu item
17026     *
17027     * @param it The menu item object.
17028     * @return The string representation of @p item's icon or NULL
17029     *
17030     * @see elm_menu_item_object_icon_name_set()
17031     */
17032    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17033
17034    /**
17035     * @brief Set the content object of a menu item
17036     *
17037     * @param it The menu item object
17038     * @param The content object or NULL
17039     * @return EINA_TRUE on success, else EINA_FALSE
17040     *
17041     * Use this function to change the object swallowed by a menu item, deleting
17042     * any previously swallowed object.
17043     *
17044     * @deprecated Use elm_object_item_content_set() instead
17045     */
17046    EINA_DEPRECATED EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Object_Item *it, Evas_Object *obj) EINA_ARG_NONNULL(1);
17047
17048    /**
17049     * @brief Get the content object of a menu item
17050     *
17051     * @param it The menu item object
17052     * @return The content object or NULL
17053     * @note If @p item was added with elm_menu_item_add_object, this
17054     * function will return the object passed, else it will return the
17055     * icon object.
17056     *
17057     * @see elm_menu_item_object_content_set()
17058     *
17059     * @deprecated Use elm_object_item_content_get() instead
17060     */
17061    EINA_DEPRECATED EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17062
17063    /**
17064     * @brief Set the selected state of @p item.
17065     *
17066     * @param it The menu item object.
17067     * @param selected The selected/unselected state of the item
17068     */
17069    EAPI void               elm_menu_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
17070
17071    /**
17072     * @brief Get the selected state of @p item.
17073     *
17074     * @param it The menu item object.
17075     * @return The selected/unselected state of the item
17076     *
17077     * @see elm_menu_item_selected_set()
17078     */
17079    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17080
17081    /**
17082     * @brief Set the disabled state of @p item.
17083     *
17084     * @param it The menu item object.
17085     * @param disabled The enabled/disabled state of the item
17086     * @deprecated Use elm_object_item_disabled_set() instead
17087     */
17088    EINA_DEPRECATED EAPI void               elm_menu_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17089
17090    /**
17091     * @brief Get the disabled state of @p item.
17092     *
17093     * @param it The menu item object.
17094     * @return The enabled/disabled state of the item
17095     *
17096     * @see elm_menu_item_disabled_set()
17097     * @deprecated Use elm_object_item_disabled_get() instead
17098     */
17099    EINA_DEPRECATED EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17100
17101    /**
17102     * @brief Add a separator item to menu @p obj under @p parent.
17103     *
17104     * @param obj The menu object
17105     * @param parent The item to add the separator under
17106     * @return The created item or NULL on failure
17107     *
17108     * This is item is a @ref Separator.
17109     */
17110    EAPI Elm_Object_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Object_Item *parent) EINA_ARG_NONNULL(1);
17111
17112    /**
17113     * @brief Returns whether @p item is a separator.
17114     *
17115     * @param it The item to check
17116     * @return If true, @p item is a separator
17117     *
17118     * @see elm_menu_item_separator_add()
17119     */
17120    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17121
17122    /**
17123     * @brief Deletes an item from the menu.
17124     *
17125     * @param it The item to delete.
17126     *
17127     * @see elm_menu_item_add()
17128     */
17129    EAPI void               elm_menu_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17130
17131    /**
17132     * @brief Set the function called when a menu item is deleted.
17133     *
17134     * @param it The item to set the callback on
17135     * @param func The function called
17136     *
17137     * @see elm_menu_item_add()
17138     * @see elm_menu_item_del()
17139     */
17140    EAPI void               elm_menu_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17141
17142    /**
17143     * @brief Returns the data associated with menu item @p item.
17144     *
17145     * @param it The item
17146     * @return The data associated with @p item or NULL if none was set.
17147     *
17148     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
17149     *
17150     * @deprecated Use elm_object_item_data_get() instead
17151     */
17152    EINA_DEPRECATED EAPI void              *elm_menu_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17153
17154    /**
17155     * @brief Sets the data to be associated with menu item @p item.
17156     *
17157     * @param it The item
17158     * @param data The data to be associated with @p item
17159     *
17160     * @deprecated Use elm_object_item_data_set() instead
17161     */
17162    EINA_DEPRECATED EAPI void               elm_menu_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
17163
17164    /**
17165     * @brief Returns a list of @p item's subitems.
17166     *
17167     * @param it The item
17168     * @return An Eina_List* of @p item's subitems
17169     *
17170     * @see elm_menu_add()
17171     */
17172    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17173
17174    /**
17175     * @brief Get the position of a menu item
17176     *
17177     * @param it The menu item
17178     * @return The item's index
17179     *
17180     * This function returns the index position of a menu item in a menu.
17181     * For a sub-menu, this number is relative to the first item in the sub-menu.
17182     *
17183     * @note Index values begin with 0
17184     */
17185    EAPI unsigned int       elm_menu_item_index_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
17186
17187    /**
17188     * @brief @brief Return a menu item's owner menu
17189     *
17190     * @param it The menu item
17191     * @return The menu object owning @p item, or NULL on failure
17192     *
17193     * Use this function to get the menu object owning an item.
17194     */
17195    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
17196
17197    /**
17198     * @brief Get the selected item in the menu
17199     *
17200     * @param obj The menu object
17201     * @return The selected item, or NULL if none
17202     *
17203     * @see elm_menu_item_selected_get()
17204     * @see elm_menu_item_selected_set()
17205     */
17206    EAPI Elm_Object_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
17207
17208    /**
17209     * @brief Get the last item in the menu
17210     *
17211     * @param obj The menu object
17212     * @return The last item, or NULL if none
17213     */
17214    EAPI Elm_Object_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
17215
17216    /**
17217     * @brief Get the first item in the menu
17218     *
17219     * @param obj The menu object
17220     * @return The first item, or NULL if none
17221     */
17222    EAPI Elm_Object_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
17223
17224    /**
17225     * @brief Get the next item in the menu.
17226     *
17227     * @param it The menu item object.
17228     * @return The item after it, or NULL if none
17229     */
17230    EAPI Elm_Object_Item *elm_menu_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17231
17232    /**
17233     * @brief Get the previous item in the menu.
17234     *
17235     * @param it The menu item object.
17236     * @return The item before it, or NULL if none
17237     */
17238    EAPI Elm_Object_Item *elm_menu_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17239
17240    /**
17241     * @}
17242     */
17243
17244    /**
17245     * @defgroup List List
17246     * @ingroup Elementary
17247     *
17248     * @image html img/widget/list/preview-00.png
17249     * @image latex img/widget/list/preview-00.eps width=\textwidth
17250     *
17251     * @image html img/list.png
17252     * @image latex img/list.eps width=\textwidth
17253     *
17254     * A list widget is a container whose children are displayed vertically or
17255     * horizontally, in order, and can be selected.
17256     * The list can accept only one or multiple items selection. Also has many
17257     * modes of items displaying.
17258     *
17259     * A list is a very simple type of list widget.  For more robust
17260     * lists, @ref Genlist should probably be used.
17261     *
17262     * Smart callbacks one can listen to:
17263     * - @c "activated" - The user has double-clicked or pressed
17264     *   (enter|return|spacebar) on an item. The @c event_info parameter
17265     *   is the item that was activated.
17266     * - @c "clicked,double" - The user has double-clicked an item.
17267     *   The @c event_info parameter is the item that was double-clicked.
17268     * - "selected" - when the user selected an item
17269     * - "unselected" - when the user unselected an item
17270     * - "longpressed" - an item in the list is long-pressed
17271     * - "edge,top" - the list is scrolled until the top edge
17272     * - "edge,bottom" - the list is scrolled until the bottom edge
17273     * - "edge,left" - the list is scrolled until the left edge
17274     * - "edge,right" - the list is scrolled until the right edge
17275     * - "language,changed" - the program's language changed
17276     *
17277     * Available styles for it:
17278     * - @c "default"
17279     *
17280     * List of examples:
17281     * @li @ref list_example_01
17282     * @li @ref list_example_02
17283     * @li @ref list_example_03
17284     */
17285
17286    /**
17287     * @addtogroup List
17288     * @{
17289     */
17290
17291    /**
17292     * @enum _Elm_List_Mode
17293     * @typedef Elm_List_Mode
17294     *
17295     * Set list's resize behavior, transverse axis scroll and
17296     * items cropping. See each mode's description for more details.
17297     *
17298     * @note Default value is #ELM_LIST_SCROLL.
17299     *
17300     * Values <b> don't </b> work as bitmask, only one can be choosen.
17301     *
17302     * @see elm_list_mode_set()
17303     * @see elm_list_mode_get()
17304     *
17305     * @ingroup List
17306     */
17307    typedef enum _Elm_List_Mode
17308      {
17309         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. */
17310         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). */
17311         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. */
17312         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. */
17313         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
17314      } Elm_List_Mode;
17315
17316    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().  */
17317
17318    /**
17319     * Add a new list widget to the given parent Elementary
17320     * (container) object.
17321     *
17322     * @param parent The parent object.
17323     * @return a new list widget handle or @c NULL, on errors.
17324     *
17325     * This function inserts a new list widget on the canvas.
17326     *
17327     * @ingroup List
17328     */
17329    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17330
17331    /**
17332     * Starts the list.
17333     *
17334     * @param obj The list object
17335     *
17336     * @note Call before running show() on the list object.
17337     * @warning If not called, it won't display the list properly.
17338     *
17339     * @code
17340     * li = elm_list_add(win);
17341     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
17342     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
17343     * elm_list_go(li);
17344     * evas_object_show(li);
17345     * @endcode
17346     *
17347     * @ingroup List
17348     */
17349    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
17350
17351    /**
17352     * Enable or disable multiple items selection on the list object.
17353     *
17354     * @param obj The list object
17355     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
17356     * disable it.
17357     *
17358     * Disabled by default. If disabled, the user can select a single item of
17359     * the list each time. Selected items are highlighted on list.
17360     * If enabled, many items can be selected.
17361     *
17362     * If a selected item is selected again, it will be unselected.
17363     *
17364     * @see elm_list_multi_select_get()
17365     *
17366     * @ingroup List
17367     */
17368    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
17369
17370    /**
17371     * Get a value whether multiple items selection is enabled or not.
17372     *
17373     * @see elm_list_multi_select_set() for details.
17374     *
17375     * @param obj The list object.
17376     * @return @c EINA_TRUE means multiple items selection is enabled.
17377     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
17378     * @c EINA_FALSE is returned.
17379     *
17380     * @ingroup List
17381     */
17382    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17383
17384    /**
17385     * Set which mode to use for the list object.
17386     *
17387     * @param obj The list object
17388     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
17389     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
17390     *
17391     * Set list's resize behavior, transverse axis scroll and
17392     * items cropping. See each mode's description for more details.
17393     *
17394     * @note Default value is #ELM_LIST_SCROLL.
17395     *
17396     * Only one can be set, if a previous one was set, it will be changed
17397     * by the new mode set. Bitmask won't work as well.
17398     *
17399     * @see elm_list_mode_get()
17400     *
17401     * @ingroup List
17402     */
17403    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17404
17405    /**
17406     * Get the mode the list is at.
17407     *
17408     * @param obj The list object
17409     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
17410     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
17411     *
17412     * @note see elm_list_mode_set() for more information.
17413     *
17414     * @ingroup List
17415     */
17416    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17417
17418    /**
17419     * Enable or disable horizontal mode on the list object.
17420     *
17421     * @param obj The list object.
17422     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
17423     * disable it, i.e., to enable vertical mode.
17424     *
17425     * @note Vertical mode is set by default.
17426     *
17427     * On horizontal mode items are displayed on list from left to right,
17428     * instead of from top to bottom. Also, the list will scroll horizontally.
17429     * Each item will presents left icon on top and right icon, or end, at
17430     * the bottom.
17431     *
17432     * @see elm_list_horizontal_get()
17433     *
17434     * @ingroup List
17435     */
17436    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17437
17438    /**
17439     * Get a value whether horizontal mode is enabled or not.
17440     *
17441     * @param obj The list object.
17442     * @return @c EINA_TRUE means horizontal mode selection is enabled.
17443     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
17444     * @c EINA_FALSE is returned.
17445     *
17446     * @see elm_list_horizontal_set() for details.
17447     *
17448     * @ingroup List
17449     */
17450    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17451
17452    /**
17453     * Enable or disable always select mode on the list object.
17454     *
17455     * @param obj The list object
17456     * @param always_select @c EINA_TRUE to enable always select mode or
17457     * @c EINA_FALSE to disable it.
17458     *
17459     * @note Always select mode is disabled by default.
17460     *
17461     * Default behavior of list items is to only call its callback function
17462     * the first time it's pressed, i.e., when it is selected. If a selected
17463     * item is pressed again, and multi-select is disabled, it won't call
17464     * this function (if multi-select is enabled it will unselect the item).
17465     *
17466     * If always select is enabled, it will call the callback function
17467     * everytime a item is pressed, so it will call when the item is selected,
17468     * and again when a selected item is pressed.
17469     *
17470     * @see elm_list_always_select_mode_get()
17471     * @see elm_list_multi_select_set()
17472     *
17473     * @ingroup List
17474     */
17475    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
17476
17477    /**
17478     * Get a value whether always select mode is enabled or not, meaning that
17479     * an item will always call its callback function, even if already selected.
17480     *
17481     * @param obj The list object
17482     * @return @c EINA_TRUE means horizontal mode selection is enabled.
17483     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
17484     * @c EINA_FALSE is returned.
17485     *
17486     * @see elm_list_always_select_mode_set() for details.
17487     *
17488     * @ingroup List
17489     */
17490    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17491
17492    /**
17493     * Set bouncing behaviour when the scrolled content reaches an edge.
17494     *
17495     * Tell the internal scroller object whether it should bounce or not
17496     * when it reaches the respective edges for each axis.
17497     *
17498     * @param obj The list object
17499     * @param h_bounce Whether to bounce or not in the horizontal axis.
17500     * @param v_bounce Whether to bounce or not in the vertical axis.
17501     *
17502     * @see elm_scroller_bounce_set()
17503     *
17504     * @ingroup List
17505     */
17506    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17507
17508    /**
17509     * Get the bouncing behaviour of the internal scroller.
17510     *
17511     * Get whether the internal scroller should bounce when the edge of each
17512     * axis is reached scrolling.
17513     *
17514     * @param obj The list object.
17515     * @param h_bounce Pointer where to store the bounce state of the horizontal
17516     * axis.
17517     * @param v_bounce Pointer where to store the bounce state of the vertical
17518     * axis.
17519     *
17520     * @see elm_scroller_bounce_get()
17521     * @see elm_list_bounce_set()
17522     *
17523     * @ingroup List
17524     */
17525    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17526
17527    /**
17528     * Set the scrollbar policy.
17529     *
17530     * @param obj The list object
17531     * @param policy_h Horizontal scrollbar policy.
17532     * @param policy_v Vertical scrollbar policy.
17533     *
17534     * This sets the scrollbar visibility policy for the given scroller.
17535     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
17536     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
17537     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
17538     * This applies respectively for the horizontal and vertical scrollbars.
17539     *
17540     * The both are disabled by default, i.e., are set to
17541     * #ELM_SCROLLER_POLICY_OFF.
17542     *
17543     * @ingroup List
17544     */
17545    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17546
17547    /**
17548     * Get the scrollbar policy.
17549     *
17550     * @see elm_list_scroller_policy_get() for details.
17551     *
17552     * @param obj The list object.
17553     * @param policy_h Pointer where to store horizontal scrollbar policy.
17554     * @param policy_v Pointer where to store vertical scrollbar policy.
17555     *
17556     * @ingroup List
17557     */
17558    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);
17559
17560    /**
17561     * Append a new item to the list object.
17562     *
17563     * @param obj The list object.
17564     * @param label The label of the list item.
17565     * @param icon The icon object to use for the left side of the item. An
17566     * icon can be any Evas object, but usually it is an icon created
17567     * with elm_icon_add().
17568     * @param end The icon object to use for the right side of the item. An
17569     * icon can be any Evas object.
17570     * @param func The function to call when the item is clicked.
17571     * @param data The data to associate with the item for related callbacks.
17572     *
17573     * @return The created item or @c NULL upon failure.
17574     *
17575     * A new item will be created and appended to the list, i.e., will
17576     * be set as @b last item.
17577     *
17578     * Items created with this method can be deleted with
17579     * elm_list_item_del().
17580     *
17581     * Associated @p data can be properly freed when item is deleted if a
17582     * callback function is set with elm_list_item_del_cb_set().
17583     *
17584     * If a function is passed as argument, it will be called everytime this item
17585     * is selected, i.e., the user clicks over an unselected item.
17586     * If always select is enabled it will call this function every time
17587     * user clicks over an item (already selected or not).
17588     * If such function isn't needed, just passing
17589     * @c NULL as @p func is enough. The same should be done for @p data.
17590     *
17591     * Simple example (with no function callback or data associated):
17592     * @code
17593     * li = elm_list_add(win);
17594     * ic = elm_icon_add(win);
17595     * elm_icon_file_set(ic, "path/to/image", NULL);
17596     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
17597     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
17598     * elm_list_go(li);
17599     * evas_object_show(li);
17600     * @endcode
17601     *
17602     * @see elm_list_always_select_mode_set()
17603     * @see elm_list_item_del()
17604     * @see elm_list_item_del_cb_set()
17605     * @see elm_list_clear()
17606     * @see elm_icon_add()
17607     *
17608     * @ingroup List
17609     */
17610    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);
17611
17612    /**
17613     * Prepend a new item to the list object.
17614     *
17615     * @param obj The list object.
17616     * @param label The label of the list item.
17617     * @param icon The icon object to use for the left side of the item. An
17618     * icon can be any Evas object, but usually it is an icon created
17619     * with elm_icon_add().
17620     * @param end The icon object to use for the right side of the item. An
17621     * icon can be any Evas object.
17622     * @param func The function to call when the item is clicked.
17623     * @param data The data to associate with the item for related callbacks.
17624     *
17625     * @return The created item or @c NULL upon failure.
17626     *
17627     * A new item will be created and prepended to the list, i.e., will
17628     * be set as @b first item.
17629     *
17630     * Items created with this method can be deleted with
17631     * elm_list_item_del().
17632     *
17633     * Associated @p data can be properly freed when item is deleted if a
17634     * callback function is set with elm_list_item_del_cb_set().
17635     *
17636     * If a function is passed as argument, it will be called everytime this item
17637     * is selected, i.e., the user clicks over an unselected item.
17638     * If always select is enabled it will call this function every time
17639     * user clicks over an item (already selected or not).
17640     * If such function isn't needed, just passing
17641     * @c NULL as @p func is enough. The same should be done for @p data.
17642     *
17643     * @see elm_list_item_append() for a simple code example.
17644     * @see elm_list_always_select_mode_set()
17645     * @see elm_list_item_del()
17646     * @see elm_list_item_del_cb_set()
17647     * @see elm_list_clear()
17648     * @see elm_icon_add()
17649     *
17650     * @ingroup List
17651     */
17652    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);
17653
17654    /**
17655     * Insert a new item into the list object before item @p before.
17656     *
17657     * @param obj The list object.
17658     * @param before The list item to insert before.
17659     * @param label The label of the list item.
17660     * @param icon The icon object to use for the left side of the item. An
17661     * icon can be any Evas object, but usually it is an icon created
17662     * with elm_icon_add().
17663     * @param end The icon object to use for the right side of the item. An
17664     * icon can be any Evas object.
17665     * @param func The function to call when the item is clicked.
17666     * @param data The data to associate with the item for related callbacks.
17667     *
17668     * @return The created item or @c NULL upon failure.
17669     *
17670     * A new item will be created and added to the list. Its position in
17671     * this list will be just before item @p before.
17672     *
17673     * Items created with this method can be deleted with
17674     * elm_list_item_del().
17675     *
17676     * Associated @p data can be properly freed when item is deleted if a
17677     * callback function is set with elm_list_item_del_cb_set().
17678     *
17679     * If a function is passed as argument, it will be called everytime this item
17680     * is selected, i.e., the user clicks over an unselected item.
17681     * If always select is enabled it will call this function every time
17682     * user clicks over an item (already selected or not).
17683     * If such function isn't needed, just passing
17684     * @c NULL as @p func is enough. The same should be done for @p data.
17685     *
17686     * @see elm_list_item_append() for a simple code example.
17687     * @see elm_list_always_select_mode_set()
17688     * @see elm_list_item_del()
17689     * @see elm_list_item_del_cb_set()
17690     * @see elm_list_clear()
17691     * @see elm_icon_add()
17692     *
17693     * @ingroup List
17694     */
17695    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);
17696
17697    /**
17698     * Insert a new item into the list object after item @p after.
17699     *
17700     * @param obj The list object.
17701     * @param after The list item to insert after.
17702     * @param label The label of the list item.
17703     * @param icon The icon object to use for the left side of the item. An
17704     * icon can be any Evas object, but usually it is an icon created
17705     * with elm_icon_add().
17706     * @param end The icon object to use for the right side of the item. An
17707     * icon can be any Evas object.
17708     * @param func The function to call when the item is clicked.
17709     * @param data The data to associate with the item for related callbacks.
17710     *
17711     * @return The created item or @c NULL upon failure.
17712     *
17713     * A new item will be created and added to the list. Its position in
17714     * this list will be just after item @p after.
17715     *
17716     * Items created with this method can be deleted with
17717     * elm_list_item_del().
17718     *
17719     * Associated @p data can be properly freed when item is deleted if a
17720     * callback function is set with elm_list_item_del_cb_set().
17721     *
17722     * If a function is passed as argument, it will be called everytime this item
17723     * is selected, i.e., the user clicks over an unselected item.
17724     * If always select is enabled it will call this function every time
17725     * user clicks over an item (already selected or not).
17726     * If such function isn't needed, just passing
17727     * @c NULL as @p func is enough. The same should be done for @p data.
17728     *
17729     * @see elm_list_item_append() for a simple code example.
17730     * @see elm_list_always_select_mode_set()
17731     * @see elm_list_item_del()
17732     * @see elm_list_item_del_cb_set()
17733     * @see elm_list_clear()
17734     * @see elm_icon_add()
17735     *
17736     * @ingroup List
17737     */
17738    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);
17739
17740    /**
17741     * Insert a new item into the sorted list object.
17742     *
17743     * @param obj The list object.
17744     * @param label The label of the list item.
17745     * @param icon The icon object to use for the left side of the item. An
17746     * icon can be any Evas object, but usually it is an icon created
17747     * with elm_icon_add().
17748     * @param end The icon object to use for the right side of the item. An
17749     * icon can be any Evas object.
17750     * @param func The function to call when the item is clicked.
17751     * @param data The data to associate with the item for related callbacks.
17752     * @param cmp_func The comparing function to be used to sort list
17753     * items <b>by #Elm_List_Item item handles</b>. This function will
17754     * receive two items and compare them, returning a non-negative integer
17755     * if the second item should be place after the first, or negative value
17756     * if should be placed before.
17757     *
17758     * @return The created item or @c NULL upon failure.
17759     *
17760     * @note This function inserts values into a list object assuming it was
17761     * sorted and the result will be sorted.
17762     *
17763     * A new item will be created and added to the list. Its position in
17764     * this list will be found comparing the new item with previously inserted
17765     * items using function @p cmp_func.
17766     *
17767     * Items created with this method can be deleted with
17768     * elm_list_item_del().
17769     *
17770     * Associated @p data can be properly freed when item is deleted if a
17771     * callback function is set with elm_list_item_del_cb_set().
17772     *
17773     * If a function is passed as argument, it will be called everytime this item
17774     * is selected, i.e., the user clicks over an unselected item.
17775     * If always select is enabled it will call this function every time
17776     * user clicks over an item (already selected or not).
17777     * If such function isn't needed, just passing
17778     * @c NULL as @p func is enough. The same should be done for @p data.
17779     *
17780     * @see elm_list_item_append() for a simple code example.
17781     * @see elm_list_always_select_mode_set()
17782     * @see elm_list_item_del()
17783     * @see elm_list_item_del_cb_set()
17784     * @see elm_list_clear()
17785     * @see elm_icon_add()
17786     *
17787     * @ingroup List
17788     */
17789    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);
17790
17791    /**
17792     * Remove all list's items.
17793     *
17794     * @param obj The list object
17795     *
17796     * @see elm_list_item_del()
17797     * @see elm_list_item_append()
17798     *
17799     * @ingroup List
17800     */
17801    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17802
17803    /**
17804     * Get a list of all the list items.
17805     *
17806     * @param obj The list object
17807     * @return An @c Eina_List of list items, #Elm_List_Item,
17808     * or @c NULL on failure.
17809     *
17810     * @see elm_list_item_append()
17811     * @see elm_list_item_del()
17812     * @see elm_list_clear()
17813     *
17814     * @ingroup List
17815     */
17816    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17817
17818    /**
17819     * Get the selected item.
17820     *
17821     * @param obj The list object.
17822     * @return The selected list item.
17823     *
17824     * The selected item can be unselected with function
17825     * elm_list_item_selected_set().
17826     *
17827     * The selected item always will be highlighted on list.
17828     *
17829     * @see elm_list_selected_items_get()
17830     *
17831     * @ingroup List
17832     */
17833    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17834
17835    /**
17836     * Return a list of the currently selected list items.
17837     *
17838     * @param obj The list object.
17839     * @return An @c Eina_List of list items, #Elm_List_Item,
17840     * or @c NULL on failure.
17841     *
17842     * Multiple items can be selected if multi select is enabled. It can be
17843     * done with elm_list_multi_select_set().
17844     *
17845     * @see elm_list_selected_item_get()
17846     * @see elm_list_multi_select_set()
17847     *
17848     * @ingroup List
17849     */
17850    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17851
17852    /**
17853     * Set the selected state of an item.
17854     *
17855     * @param item The list item
17856     * @param selected The selected state
17857     *
17858     * This sets the selected state of the given item @p it.
17859     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
17860     *
17861     * If a new item is selected the previosly selected will be unselected,
17862     * unless multiple selection is enabled with elm_list_multi_select_set().
17863     * Previoulsy selected item can be get with function
17864     * elm_list_selected_item_get().
17865     *
17866     * Selected items will be highlighted.
17867     *
17868     * @see elm_list_item_selected_get()
17869     * @see elm_list_selected_item_get()
17870     * @see elm_list_multi_select_set()
17871     *
17872     * @ingroup List
17873     */
17874    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17875
17876    /*
17877     * Get whether the @p item is selected or not.
17878     *
17879     * @param item The list item.
17880     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
17881     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
17882     *
17883     * @see elm_list_selected_item_set() for details.
17884     * @see elm_list_item_selected_get()
17885     *
17886     * @ingroup List
17887     */
17888    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17889
17890    /**
17891     * Set or unset item as a separator.
17892     *
17893     * @param it The list item.
17894     * @param setting @c EINA_TRUE to set item @p it as separator or
17895     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
17896     *
17897     * Items aren't set as separator by default.
17898     *
17899     * If set as separator it will display separator theme, so won't display
17900     * icons or label.
17901     *
17902     * @see elm_list_item_separator_get()
17903     *
17904     * @ingroup List
17905     */
17906    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
17907
17908    /**
17909     * Get a value whether item is a separator or not.
17910     *
17911     * @see elm_list_item_separator_set() for details.
17912     *
17913     * @param it The list item.
17914     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
17915     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
17916     *
17917     * @ingroup List
17918     */
17919    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17920
17921    /**
17922     * Show @p item in the list view.
17923     *
17924     * @param item The list item to be shown.
17925     *
17926     * It won't animate list until item is visible. If such behavior is wanted,
17927     * use elm_list_bring_in() intead.
17928     *
17929     * @ingroup List
17930     */
17931    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17932
17933    /**
17934     * Bring in the given item to list view.
17935     *
17936     * @param item The item.
17937     *
17938     * This causes list to jump to the given item @p item and show it
17939     * (by scrolling), if it is not fully visible.
17940     *
17941     * This may use animation to do so and take a period of time.
17942     *
17943     * If animation isn't wanted, elm_list_item_show() can be used.
17944     *
17945     * @ingroup List
17946     */
17947    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17948
17949    /**
17950     * Delete them item from the list.
17951     *
17952     * @param item The item of list to be deleted.
17953     *
17954     * If deleting all list items is required, elm_list_clear()
17955     * should be used instead of getting items list and deleting each one.
17956     *
17957     * @see elm_list_clear()
17958     * @see elm_list_item_append()
17959     * @see elm_list_item_del_cb_set()
17960     *
17961     * @ingroup List
17962     */
17963    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17964
17965    /**
17966     * Set the function called when a list item is freed.
17967     *
17968     * @param item The item to set the callback on
17969     * @param func The function called
17970     *
17971     * If there is a @p func, then it will be called prior item's memory release.
17972     * That will be called with the following arguments:
17973     * @li item's data;
17974     * @li item's Evas object;
17975     * @li item itself;
17976     *
17977     * This way, a data associated to a list item could be properly freed.
17978     *
17979     * @ingroup List
17980     */
17981    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17982
17983    /**
17984     * Get the data associated to the item.
17985     *
17986     * @param item The list item
17987     * @return The data associated to @p item
17988     *
17989     * The return value is a pointer to data associated to @p item when it was
17990     * created, with function elm_list_item_append() or similar. If no data
17991     * was passed as argument, it will return @c NULL.
17992     *
17993     * @see elm_list_item_append()
17994     *
17995     * @ingroup List
17996     */
17997    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17998
17999    /**
18000     * Get the left side icon associated to the item.
18001     *
18002     * @param item The list item
18003     * @return The left side icon associated to @p item
18004     *
18005     * The return value is a pointer to the icon associated to @p item when
18006     * it was
18007     * created, with function elm_list_item_append() or similar, or later
18008     * with function elm_list_item_icon_set(). If no icon
18009     * was passed as argument, it will return @c NULL.
18010     *
18011     * @see elm_list_item_append()
18012     * @see elm_list_item_icon_set()
18013     *
18014     * @ingroup List
18015     */
18016    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18017
18018    /**
18019     * Set the left side icon associated to the item.
18020     *
18021     * @param item The list item
18022     * @param icon The left side icon object to associate with @p item
18023     *
18024     * The icon object to use at left side of the item. An
18025     * icon can be any Evas object, but usually it is an icon created
18026     * with elm_icon_add().
18027     *
18028     * Once the icon object is set, a previously set one will be deleted.
18029     * @warning Setting the same icon for two items will cause the icon to
18030     * dissapear from the first item.
18031     *
18032     * If an icon was passed as argument on item creation, with function
18033     * elm_list_item_append() or similar, it will be already
18034     * associated to the item.
18035     *
18036     * @see elm_list_item_append()
18037     * @see elm_list_item_icon_get()
18038     *
18039     * @ingroup List
18040     */
18041    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
18042
18043    /**
18044     * Get the right side icon associated to the item.
18045     *
18046     * @param item The list item
18047     * @return The right side icon associated to @p item
18048     *
18049     * The return value is a pointer to the icon associated to @p item when
18050     * it was
18051     * created, with function elm_list_item_append() or similar, or later
18052     * with function elm_list_item_icon_set(). If no icon
18053     * was passed as argument, it will return @c NULL.
18054     *
18055     * @see elm_list_item_append()
18056     * @see elm_list_item_icon_set()
18057     *
18058     * @ingroup List
18059     */
18060    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18061
18062    /**
18063     * Set the right side icon associated to the item.
18064     *
18065     * @param item The list item
18066     * @param end The right side icon object to associate with @p item
18067     *
18068     * The icon object to use at right side of the item. An
18069     * icon can be any Evas object, but usually it is an icon created
18070     * with elm_icon_add().
18071     *
18072     * Once the icon object is set, a previously set one will be deleted.
18073     * @warning Setting the same icon for two items will cause the icon to
18074     * dissapear from the first item.
18075     *
18076     * If an icon was passed as argument on item creation, with function
18077     * elm_list_item_append() or similar, it will be already
18078     * associated to the item.
18079     *
18080     * @see elm_list_item_append()
18081     * @see elm_list_item_end_get()
18082     *
18083     * @ingroup List
18084     */
18085    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
18086
18087    /**
18088     * Gets the base object of the item.
18089     *
18090     * @param item The list item
18091     * @return The base object associated with @p item
18092     *
18093     * Base object is the @c Evas_Object that represents that item.
18094     *
18095     * @ingroup List
18096     */
18097    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18098    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18099
18100    /**
18101     * Get the label of item.
18102     *
18103     * @param item The item of list.
18104     * @return The label of item.
18105     *
18106     * The return value is a pointer to the label associated to @p item when
18107     * it was created, with function elm_list_item_append(), or later
18108     * with function elm_list_item_label_set. If no label
18109     * was passed as argument, it will return @c NULL.
18110     *
18111     * @see elm_list_item_label_set() for more details.
18112     * @see elm_list_item_append()
18113     *
18114     * @ingroup List
18115     */
18116    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18117
18118    /**
18119     * Set the label of item.
18120     *
18121     * @param item The item of list.
18122     * @param text The label of item.
18123     *
18124     * The label to be displayed by the item.
18125     * Label will be placed between left and right side icons (if set).
18126     *
18127     * If a label was passed as argument on item creation, with function
18128     * elm_list_item_append() or similar, it will be already
18129     * displayed by the item.
18130     *
18131     * @see elm_list_item_label_get()
18132     * @see elm_list_item_append()
18133     *
18134     * @ingroup List
18135     */
18136    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
18137
18138    /**
18139     * Get the item before @p it in list.
18140     *
18141     * @param it The list item.
18142     * @return The item before @p it, or @c NULL if none or on failure.
18143     *
18144     * @note If it is the first item, @c NULL will be returned.
18145     *
18146     * @see elm_list_item_append()
18147     * @see elm_list_items_get()
18148     *
18149     * @ingroup List
18150     */
18151    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
18152
18153    /**
18154     * Get the item after @p it in list.
18155     *
18156     * @param it The list item.
18157     * @return The item after @p it, or @c NULL if none or on failure.
18158     *
18159     * @note If it is the last item, @c NULL will be returned.
18160     *
18161     * @see elm_list_item_append()
18162     * @see elm_list_items_get()
18163     *
18164     * @ingroup List
18165     */
18166    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
18167
18168    /**
18169     * Sets the disabled/enabled state of a list item.
18170     *
18171     * @param it The item.
18172     * @param disabled The disabled state.
18173     *
18174     * A disabled item cannot be selected or unselected. It will also
18175     * change its appearance (generally greyed out). This sets the
18176     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
18177     * enabled).
18178     *
18179     * @ingroup List
18180     */
18181    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18182
18183    /**
18184     * Get a value whether list item is disabled or not.
18185     *
18186     * @param it The item.
18187     * @return The disabled state.
18188     *
18189     * @see elm_list_item_disabled_set() for more details.
18190     *
18191     * @ingroup List
18192     */
18193    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
18194
18195    /**
18196     * Set the text to be shown in a given list item's tooltips.
18197     *
18198     * @param item Target item.
18199     * @param text The text to set in the content.
18200     *
18201     * Setup the text as tooltip to object. The item can have only one tooltip,
18202     * so any previous tooltip data - set with this function or
18203     * elm_list_item_tooltip_content_cb_set() - is removed.
18204     *
18205     * @see elm_object_tooltip_text_set() for more details.
18206     *
18207     * @ingroup List
18208     */
18209    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
18210
18211    /**
18212     * @brief Disable size restrictions on an object's tooltip
18213     * @param item The tooltip's anchor object
18214     * @param disable If EINA_TRUE, size restrictions are disabled
18215     * @return EINA_FALSE on failure, EINA_TRUE on success
18216     *
18217     * This function allows a tooltip to expand beyond its parant window's canvas.
18218     * It will instead be limited only by the size of the display.
18219     */
18220    EAPI Eina_Bool        elm_list_item_tooltip_window_mode_set(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
18221    /**
18222     * @brief Retrieve size restriction state of an object's tooltip
18223     * @param obj The tooltip's anchor object
18224     * @return If EINA_TRUE, size restrictions are disabled
18225     *
18226     * This function returns whether a tooltip is allowed to expand beyond
18227     * its parant window's canvas.
18228     * It will instead be limited only by the size of the display.
18229     */
18230    EAPI Eina_Bool        elm_list_item_tooltip_window_mode_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18231
18232    /**
18233     * Set the content to be shown in the tooltip item.
18234     *
18235     * Setup the tooltip to item. The item can have only one tooltip,
18236     * so any previous tooltip data is removed. @p func(with @p data) will
18237     * be called every time that need show the tooltip and it should
18238     * return a valid Evas_Object. This object is then managed fully by
18239     * tooltip system and is deleted when the tooltip is gone.
18240     *
18241     * @param item the list item being attached a tooltip.
18242     * @param func the function used to create the tooltip contents.
18243     * @param data what to provide to @a func as callback data/context.
18244     * @param del_cb called when data is not needed anymore, either when
18245     *        another callback replaces @a func, the tooltip is unset with
18246     *        elm_list_item_tooltip_unset() or the owner @a item
18247     *        dies. This callback receives as the first parameter the
18248     *        given @a data, and @c event_info is the item.
18249     *
18250     * @see elm_object_tooltip_content_cb_set() for more details.
18251     *
18252     * @ingroup List
18253     */
18254    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);
18255
18256    /**
18257     * Unset tooltip from item.
18258     *
18259     * @param item list item to remove previously set tooltip.
18260     *
18261     * Remove tooltip from item. The callback provided as del_cb to
18262     * elm_list_item_tooltip_content_cb_set() will be called to notify
18263     * it is not used anymore.
18264     *
18265     * @see elm_object_tooltip_unset() for more details.
18266     * @see elm_list_item_tooltip_content_cb_set()
18267     *
18268     * @ingroup List
18269     */
18270    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
18271
18272    /**
18273     * Sets a different style for this item tooltip.
18274     *
18275     * @note before you set a style you should define a tooltip with
18276     *       elm_list_item_tooltip_content_cb_set() or
18277     *       elm_list_item_tooltip_text_set()
18278     *
18279     * @param item list item with tooltip already set.
18280     * @param style the theme style to use (default, transparent, ...)
18281     *
18282     * @see elm_object_tooltip_style_set() for more details.
18283     *
18284     * @ingroup List
18285     */
18286    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
18287
18288    /**
18289     * Get the style for this item tooltip.
18290     *
18291     * @param item list item with tooltip already set.
18292     * @return style the theme style in use, defaults to "default". If the
18293     *         object does not have a tooltip set, then NULL is returned.
18294     *
18295     * @see elm_object_tooltip_style_get() for more details.
18296     * @see elm_list_item_tooltip_style_set()
18297     *
18298     * @ingroup List
18299     */
18300    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18301
18302    /**
18303     * Set the type of mouse pointer/cursor decoration to be shown,
18304     * when the mouse pointer is over the given list widget item
18305     *
18306     * @param item list item to customize cursor on
18307     * @param cursor the cursor type's name
18308     *
18309     * This function works analogously as elm_object_cursor_set(), but
18310     * here the cursor's changing area is restricted to the item's
18311     * area, and not the whole widget's. Note that that item cursors
18312     * have precedence over widget cursors, so that a mouse over an
18313     * item with custom cursor set will always show @b that cursor.
18314     *
18315     * If this function is called twice for an object, a previously set
18316     * cursor will be unset on the second call.
18317     *
18318     * @see elm_object_cursor_set()
18319     * @see elm_list_item_cursor_get()
18320     * @see elm_list_item_cursor_unset()
18321     *
18322     * @ingroup List
18323     */
18324    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
18325
18326    /*
18327     * Get the type of mouse pointer/cursor decoration set to be shown,
18328     * when the mouse pointer is over the given list widget item
18329     *
18330     * @param item list item with custom cursor set
18331     * @return the cursor type's name or @c NULL, if no custom cursors
18332     * were set to @p item (and on errors)
18333     *
18334     * @see elm_object_cursor_get()
18335     * @see elm_list_item_cursor_set()
18336     * @see elm_list_item_cursor_unset()
18337     *
18338     * @ingroup List
18339     */
18340    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18341
18342    /**
18343     * Unset any custom mouse pointer/cursor decoration set to be
18344     * shown, when the mouse pointer is over the given list widget
18345     * item, thus making it show the @b default cursor again.
18346     *
18347     * @param item a list item
18348     *
18349     * Use this call to undo any custom settings on this item's cursor
18350     * decoration, bringing it back to defaults (no custom style set).
18351     *
18352     * @see elm_object_cursor_unset()
18353     * @see elm_list_item_cursor_set()
18354     *
18355     * @ingroup List
18356     */
18357    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
18358
18359    /**
18360     * Set a different @b style for a given custom cursor set for a
18361     * list item.
18362     *
18363     * @param item list item with custom cursor set
18364     * @param style the <b>theme style</b> to use (e.g. @c "default",
18365     * @c "transparent", etc)
18366     *
18367     * This function only makes sense when one is using custom mouse
18368     * cursor decorations <b>defined in a theme file</b>, which can have,
18369     * given a cursor name/type, <b>alternate styles</b> on it. It
18370     * works analogously as elm_object_cursor_style_set(), but here
18371     * applyed only to list item objects.
18372     *
18373     * @warning Before you set a cursor style you should have definen a
18374     *       custom cursor previously on the item, with
18375     *       elm_list_item_cursor_set()
18376     *
18377     * @see elm_list_item_cursor_engine_only_set()
18378     * @see elm_list_item_cursor_style_get()
18379     *
18380     * @ingroup List
18381     */
18382    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
18383
18384    /**
18385     * Get the current @b style set for a given list item's custom
18386     * cursor
18387     *
18388     * @param item list item with custom cursor set.
18389     * @return style the cursor style in use. If the object does not
18390     *         have a cursor set, then @c NULL is returned.
18391     *
18392     * @see elm_list_item_cursor_style_set() for more details
18393     *
18394     * @ingroup List
18395     */
18396    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18397
18398    /**
18399     * Set if the (custom)cursor for a given list item should be
18400     * searched in its theme, also, or should only rely on the
18401     * rendering engine.
18402     *
18403     * @param item item with custom (custom) cursor already set on
18404     * @param engine_only Use @c EINA_TRUE to have cursors looked for
18405     * only on those provided by the rendering engine, @c EINA_FALSE to
18406     * have them searched on the widget's theme, as well.
18407     *
18408     * @note This call is of use only if you've set a custom cursor
18409     * for list items, with elm_list_item_cursor_set().
18410     *
18411     * @note By default, cursors will only be looked for between those
18412     * provided by the rendering engine.
18413     *
18414     * @ingroup List
18415     */
18416    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18417
18418    /**
18419     * Get if the (custom) cursor for a given list item is being
18420     * searched in its theme, also, or is only relying on the rendering
18421     * engine.
18422     *
18423     * @param item a list item
18424     * @return @c EINA_TRUE, if cursors are being looked for only on
18425     * those provided by the rendering engine, @c EINA_FALSE if they
18426     * are being searched on the widget's theme, as well.
18427     *
18428     * @see elm_list_item_cursor_engine_only_set(), for more details
18429     *
18430     * @ingroup List
18431     */
18432    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18433
18434    /**
18435     * @}
18436     */
18437
18438    /**
18439     * @defgroup Slider Slider
18440     * @ingroup Elementary
18441     *
18442     * @image html img/widget/slider/preview-00.png
18443     * @image latex img/widget/slider/preview-00.eps width=\textwidth
18444     *
18445     * The slider adds a dragable ā€œsliderā€ widget for selecting the value of
18446     * something within a range.
18447     *
18448     * A slider can be horizontal or vertical. It can contain an Icon and has a
18449     * primary label as well as a units label (that is formatted with floating
18450     * point values and thus accepts a printf-style format string, like
18451     * ā€œ%1.2f unitsā€. There is also an indicator string that may be somewhere
18452     * else (like on the slider itself) that also accepts a format string like
18453     * units. Label, Icon Unit and Indicator strings/objects are optional.
18454     *
18455     * A slider may be inverted which means values invert, with high vales being
18456     * on the left or top and low values on the right or bottom (as opposed to
18457     * normally being low on the left or top and high on the bottom and right).
18458     *
18459     * The slider should have its minimum and maximum values set by the
18460     * application with  elm_slider_min_max_set() and value should also be set by
18461     * the application before use with  elm_slider_value_set(). The span of the
18462     * slider is its length (horizontally or vertically). This will be scaled by
18463     * the object or applications scaling factor. At any point code can query the
18464     * slider for its value with elm_slider_value_get().
18465     *
18466     * Smart callbacks one can listen to:
18467     * - "changed" - Whenever the slider value is changed by the user.
18468     * - "slider,drag,start" - dragging the slider indicator around has started.
18469     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
18470     * - "delay,changed" - A short time after the value is changed by the user.
18471     * This will be called only when the user stops dragging for
18472     * a very short period or when they release their
18473     * finger/mouse, so it avoids possibly expensive reactions to
18474     * the value change.
18475     *
18476     * Available styles for it:
18477     * - @c "default"
18478     *
18479     * Default contents parts of the slider widget that you can use for are:
18480     * @li "icon" - An icon of the slider
18481     * @li "end" - A end part content of the slider
18482     *
18483     * Default text parts of the silder widget that you can use for are:
18484     * @li "default" - Label of the silder
18485     * Here is an example on its usage:
18486     * @li @ref slider_example
18487     */
18488
18489    /**
18490     * @addtogroup Slider
18491     * @{
18492     */
18493
18494    /**
18495     * Add a new slider widget to the given parent Elementary
18496     * (container) object.
18497     *
18498     * @param parent The parent object.
18499     * @return a new slider widget handle or @c NULL, on errors.
18500     *
18501     * This function inserts a new slider widget on the canvas.
18502     *
18503     * @ingroup Slider
18504     */
18505    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18506
18507    /**
18508     * Set the label of a given slider widget
18509     *
18510     * @param obj The progress bar object
18511     * @param label The text label string, in UTF-8
18512     *
18513     * @ingroup Slider
18514     * @deprecated use elm_object_text_set() instead.
18515     */
18516    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18517
18518    /**
18519     * Get the label of a given slider widget
18520     *
18521     * @param obj The progressbar object
18522     * @return The text label string, in UTF-8
18523     *
18524     * @ingroup Slider
18525     * @deprecated use elm_object_text_get() instead.
18526     */
18527    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18528
18529    /**
18530     * Set the icon object of the slider object.
18531     *
18532     * @param obj The slider object.
18533     * @param icon The icon object.
18534     *
18535     * On horizontal mode, icon is placed at left, and on vertical mode,
18536     * placed at top.
18537     *
18538     * @note Once the icon object is set, a previously set one will be deleted.
18539     * If you want to keep that old content object, use the
18540     * elm_slider_icon_unset() function.
18541     *
18542     * @warning If the object being set does not have minimum size hints set,
18543     * it won't get properly displayed.
18544     *
18545     * @ingroup Slider
18546     * @deprecated use elm_object_part_content_set() instead.
18547     */
18548    EINA_DEPRECATED EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18549
18550    /**
18551     * Unset an icon set on a given slider widget.
18552     *
18553     * @param obj The slider object.
18554     * @return The icon object that was being used, if any was set, or
18555     * @c NULL, otherwise (and on errors).
18556     *
18557     * On horizontal mode, icon is placed at left, and on vertical mode,
18558     * placed at top.
18559     *
18560     * This call will unparent and return the icon object which was set
18561     * for this widget, previously, on success.
18562     *
18563     * @see elm_slider_icon_set() for more details
18564     * @see elm_slider_icon_get()
18565     * @deprecated use elm_object_part_content_unset() instead.
18566     *
18567     * @ingroup Slider
18568     */
18569    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18570
18571    /**
18572     * Retrieve the icon object set for a given slider widget.
18573     *
18574     * @param obj The slider object.
18575     * @return The icon object's handle, if @p obj had one set, or @c NULL,
18576     * otherwise (and on errors).
18577     *
18578     * On horizontal mode, icon is placed at left, and on vertical mode,
18579     * placed at top.
18580     *
18581     * @see elm_slider_icon_set() for more details
18582     * @see elm_slider_icon_unset()
18583     *
18584     * @deprecated use elm_object_part_content_get() instead.
18585     *
18586     * @ingroup Slider
18587     */
18588    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18589
18590    /**
18591     * Set the end object of the slider object.
18592     *
18593     * @param obj The slider object.
18594     * @param end The end object.
18595     *
18596     * On horizontal mode, end is placed at left, and on vertical mode,
18597     * placed at bottom.
18598     *
18599     * @note Once the icon object is set, a previously set one will be deleted.
18600     * If you want to keep that old content object, use the
18601     * elm_slider_end_unset() function.
18602     *
18603     * @warning If the object being set does not have minimum size hints set,
18604     * it won't get properly displayed.
18605     *
18606     * @deprecated use elm_object_part_content_set() instead.
18607     *
18608     * @ingroup Slider
18609     */
18610    EINA_DEPRECATED EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
18611
18612    /**
18613     * Unset an end object set on a given slider widget.
18614     *
18615     * @param obj The slider object.
18616     * @return The end object that was being used, if any was set, or
18617     * @c NULL, otherwise (and on errors).
18618     *
18619     * On horizontal mode, end is placed at left, and on vertical mode,
18620     * placed at bottom.
18621     *
18622     * This call will unparent and return the icon object which was set
18623     * for this widget, previously, on success.
18624     *
18625     * @see elm_slider_end_set() for more details.
18626     * @see elm_slider_end_get()
18627     *
18628     * @deprecated use elm_object_part_content_unset() instead
18629     * instead.
18630     *
18631     * @ingroup Slider
18632     */
18633    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18634
18635    /**
18636     * Retrieve the end object set for a given slider widget.
18637     *
18638     * @param obj The slider object.
18639     * @return The end object's handle, if @p obj had one set, or @c NULL,
18640     * otherwise (and on errors).
18641     *
18642     * On horizontal mode, icon is placed at right, and on vertical mode,
18643     * placed at bottom.
18644     *
18645     * @see elm_slider_end_set() for more details.
18646     * @see elm_slider_end_unset()
18647     *
18648     *
18649     * @deprecated use elm_object_part_content_get() instead
18650     * instead.
18651     *
18652     * @ingroup Slider
18653     */
18654    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18655
18656    /**
18657     * Set the (exact) length of the bar region of a given slider widget.
18658     *
18659     * @param obj The slider object.
18660     * @param size The length of the slider's bar region.
18661     *
18662     * This sets the minimum width (when in horizontal mode) or height
18663     * (when in vertical mode) of the actual bar area of the slider
18664     * @p obj. This in turn affects the object's minimum size. Use
18665     * this when you're not setting other size hints expanding on the
18666     * given direction (like weight and alignment hints) and you would
18667     * like it to have a specific size.
18668     *
18669     * @note Icon, end, label, indicator and unit text around @p obj
18670     * will require their
18671     * own space, which will make @p obj to require more the @p size,
18672     * actually.
18673     *
18674     * @see elm_slider_span_size_get()
18675     *
18676     * @ingroup Slider
18677     */
18678    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
18679
18680    /**
18681     * Get the length set for the bar region of a given slider widget
18682     *
18683     * @param obj The slider object.
18684     * @return The length of the slider's bar region.
18685     *
18686     * If that size was not set previously, with
18687     * elm_slider_span_size_set(), this call will return @c 0.
18688     *
18689     * @ingroup Slider
18690     */
18691    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18692
18693    /**
18694     * Set the format string for the unit label.
18695     *
18696     * @param obj The slider object.
18697     * @param format The format string for the unit display.
18698     *
18699     * Unit label is displayed all the time, if set, after slider's bar.
18700     * In horizontal mode, at right and in vertical mode, at bottom.
18701     *
18702     * If @c NULL, unit label won't be visible. If not it sets the format
18703     * string for the label text. To the label text is provided a floating point
18704     * value, so the label text can display up to 1 floating point value.
18705     * Note that this is optional.
18706     *
18707     * Use a format string such as "%1.2f meters" for example, and it will
18708     * display values like: "3.14 meters" for a value equal to 3.14159.
18709     *
18710     * Default is unit label disabled.
18711     *
18712     * @see elm_slider_indicator_format_get()
18713     *
18714     * @ingroup Slider
18715     */
18716    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
18717
18718    /**
18719     * Get the unit label format of the slider.
18720     *
18721     * @param obj The slider object.
18722     * @return The unit label format string in UTF-8.
18723     *
18724     * Unit label is displayed all the time, if set, after slider's bar.
18725     * In horizontal mode, at right and in vertical mode, at bottom.
18726     *
18727     * @see elm_slider_unit_format_set() for more
18728     * information on how this works.
18729     *
18730     * @ingroup Slider
18731     */
18732    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18733
18734    /**
18735     * Set the format string for the indicator label.
18736     *
18737     * @param obj The slider object.
18738     * @param indicator The format string for the indicator display.
18739     *
18740     * The slider may display its value somewhere else then unit label,
18741     * for example, above the slider knob that is dragged around. This function
18742     * sets the format string used for this.
18743     *
18744     * If @c NULL, indicator label won't be visible. If not it sets the format
18745     * string for the label text. To the label text is provided a floating point
18746     * value, so the label text can display up to 1 floating point value.
18747     * Note that this is optional.
18748     *
18749     * Use a format string such as "%1.2f meters" for example, and it will
18750     * display values like: "3.14 meters" for a value equal to 3.14159.
18751     *
18752     * Default is indicator label disabled.
18753     *
18754     * @see elm_slider_indicator_format_get()
18755     *
18756     * @ingroup Slider
18757     */
18758    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
18759
18760    /**
18761     * Get the indicator label format of the slider.
18762     *
18763     * @param obj The slider object.
18764     * @return The indicator label format string in UTF-8.
18765     *
18766     * The slider may display its value somewhere else then unit label,
18767     * for example, above the slider knob that is dragged around. This function
18768     * gets the format string used for this.
18769     *
18770     * @see elm_slider_indicator_format_set() for more
18771     * information on how this works.
18772     *
18773     * @ingroup Slider
18774     */
18775    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18776
18777    /**
18778     * Set the format function pointer for the indicator label
18779     *
18780     * @param obj The slider object.
18781     * @param func The indicator format function.
18782     * @param free_func The freeing function for the format string.
18783     *
18784     * Set the callback function to format the indicator string.
18785     *
18786     * @see elm_slider_indicator_format_set() for more info on how this works.
18787     *
18788     * @ingroup Slider
18789     */
18790   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);
18791
18792   /**
18793    * Set the format function pointer for the units label
18794    *
18795    * @param obj The slider object.
18796    * @param func The units format function.
18797    * @param free_func The freeing function for the format string.
18798    *
18799    * Set the callback function to format the indicator string.
18800    *
18801    * @see elm_slider_units_format_set() for more info on how this works.
18802    *
18803    * @ingroup Slider
18804    */
18805   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);
18806
18807   /**
18808    * Set the orientation of a given slider widget.
18809    *
18810    * @param obj The slider object.
18811    * @param horizontal Use @c EINA_TRUE to make @p obj to be
18812    * @b horizontal, @c EINA_FALSE to make it @b vertical.
18813    *
18814    * Use this function to change how your slider is to be
18815    * disposed: vertically or horizontally.
18816    *
18817    * By default it's displayed horizontally.
18818    *
18819    * @see elm_slider_horizontal_get()
18820    *
18821    * @ingroup Slider
18822    */
18823    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
18824
18825    /**
18826     * Retrieve the orientation of a given slider widget
18827     *
18828     * @param obj The slider object.
18829     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
18830     * @c EINA_FALSE if it's @b vertical (and on errors).
18831     *
18832     * @see elm_slider_horizontal_set() for more details.
18833     *
18834     * @ingroup Slider
18835     */
18836    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18837
18838    /**
18839     * Set the minimum and maximum values for the slider.
18840     *
18841     * @param obj The slider object.
18842     * @param min The minimum value.
18843     * @param max The maximum value.
18844     *
18845     * Define the allowed range of values to be selected by the user.
18846     *
18847     * If actual value is less than @p min, it will be updated to @p min. If it
18848     * is bigger then @p max, will be updated to @p max. Actual value can be
18849     * get with elm_slider_value_get().
18850     *
18851     * By default, min is equal to 0.0, and max is equal to 1.0.
18852     *
18853     * @warning Maximum must be greater than minimum, otherwise behavior
18854     * is undefined.
18855     *
18856     * @see elm_slider_min_max_get()
18857     *
18858     * @ingroup Slider
18859     */
18860    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
18861
18862    /**
18863     * Get the minimum and maximum values of the slider.
18864     *
18865     * @param obj The slider object.
18866     * @param min Pointer where to store the minimum value.
18867     * @param max Pointer where to store the maximum value.
18868     *
18869     * @note If only one value is needed, the other pointer can be passed
18870     * as @c NULL.
18871     *
18872     * @see elm_slider_min_max_set() for details.
18873     *
18874     * @ingroup Slider
18875     */
18876    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
18877
18878    /**
18879     * Set the value the slider displays.
18880     *
18881     * @param obj The slider object.
18882     * @param val The value to be displayed.
18883     *
18884     * Value will be presented on the unit label following format specified with
18885     * elm_slider_unit_format_set() and on indicator with
18886     * elm_slider_indicator_format_set().
18887     *
18888     * @warning The value must to be between min and max values. This values
18889     * are set by elm_slider_min_max_set().
18890     *
18891     * @see elm_slider_value_get()
18892     * @see elm_slider_unit_format_set()
18893     * @see elm_slider_indicator_format_set()
18894     * @see elm_slider_min_max_set()
18895     *
18896     * @ingroup Slider
18897     */
18898    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
18899
18900    /**
18901     * Get the value displayed by the spinner.
18902     *
18903     * @param obj The spinner object.
18904     * @return The value displayed.
18905     *
18906     * @see elm_spinner_value_set() for details.
18907     *
18908     * @ingroup Slider
18909     */
18910    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18911
18912    /**
18913     * Invert a given slider widget's displaying values order
18914     *
18915     * @param obj The slider object.
18916     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
18917     * @c EINA_FALSE to bring it back to default, non-inverted values.
18918     *
18919     * A slider may be @b inverted, in which state it gets its
18920     * values inverted, with high vales being on the left or top and
18921     * low values on the right or bottom, as opposed to normally have
18922     * the low values on the former and high values on the latter,
18923     * respectively, for horizontal and vertical modes.
18924     *
18925     * @see elm_slider_inverted_get()
18926     *
18927     * @ingroup Slider
18928     */
18929    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
18930
18931    /**
18932     * Get whether a given slider widget's displaying values are
18933     * inverted or not.
18934     *
18935     * @param obj The slider object.
18936     * @return @c EINA_TRUE, if @p obj has inverted values,
18937     * @c EINA_FALSE otherwise (and on errors).
18938     *
18939     * @see elm_slider_inverted_set() for more details.
18940     *
18941     * @ingroup Slider
18942     */
18943    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18944
18945    /**
18946     * Set whether to enlarge slider indicator (augmented knob) or not.
18947     *
18948     * @param obj The slider object.
18949     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
18950     * let the knob always at default size.
18951     *
18952     * By default, indicator will be bigger while dragged by the user.
18953     *
18954     * @warning It won't display values set with
18955     * elm_slider_indicator_format_set() if you disable indicator.
18956     *
18957     * @ingroup Slider
18958     */
18959    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
18960
18961    /**
18962     * Get whether a given slider widget's enlarging indicator or not.
18963     *
18964     * @param obj The slider object.
18965     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
18966     * @c EINA_FALSE otherwise (and on errors).
18967     *
18968     * @see elm_slider_indicator_show_set() for details.
18969     *
18970     * @ingroup Slider
18971     */
18972    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18973
18974    /**
18975     * @}
18976     */
18977
18978    /**
18979     * @addtogroup Actionslider Actionslider
18980     *
18981     * @image html img/widget/actionslider/preview-00.png
18982     * @image latex img/widget/actionslider/preview-00.eps
18983     *
18984     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18985     * properties. The user drags and releases the indicator, to choose a label.
18986     *
18987     * Labels occupy the following positions.
18988     * a. Left
18989     * b. Right
18990     * c. Center
18991     *
18992     * Positions can be enabled or disabled.
18993     *
18994     * Magnets can be set on the above positions.
18995     *
18996     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18997     *
18998     * @note By default all positions are set as enabled.
18999     *
19000     * Signals that you can add callbacks for are:
19001     *
19002     * "selected" - when user selects an enabled position (the label is passed
19003     *              as event info)".
19004     * @n
19005     * "pos_changed" - when the indicator reaches any of the positions("left",
19006     *                 "right" or "center").
19007     *
19008     * See an example of actionslider usage @ref actionslider_example_page "here"
19009     * @{
19010     */
19011    typedef enum _Elm_Actionslider_Pos
19012      {
19013         ELM_ACTIONSLIDER_NONE = 0,
19014         ELM_ACTIONSLIDER_LEFT = 1 << 0,
19015         ELM_ACTIONSLIDER_CENTER = 1 << 1,
19016         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
19017         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
19018      } Elm_Actionslider_Pos;
19019
19020    /**
19021     * Add a new actionslider to the parent.
19022     *
19023     * @param parent The parent object
19024     * @return The new actionslider object or NULL if it cannot be created
19025     */
19026    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19027
19028    /**
19029     * Set actionslider labels.
19030     *
19031     * @param obj The actionslider object
19032     * @param left_label The label to be set on the left.
19033     * @param center_label The label to be set on the center.
19034     * @param right_label The label to be set on the right.
19035     * @deprecated use elm_object_text_set() instead.
19036     */
19037    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);
19038
19039    /**
19040     * Get actionslider labels.
19041     *
19042     * @param obj The actionslider object
19043     * @param left_label A char** to place the left_label of @p obj into.
19044     * @param center_label A char** to place the center_label of @p obj into.
19045     * @param right_label A char** to place the right_label of @p obj into.
19046     * @deprecated use elm_object_text_set() instead.
19047     */
19048    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);
19049
19050    /**
19051     * Get actionslider selected label.
19052     *
19053     * @param obj The actionslider object
19054     * @return The selected label
19055     */
19056    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19057
19058    /**
19059     * Set actionslider indicator position.
19060     *
19061     * @param obj The actionslider object.
19062     * @param pos The position of the indicator.
19063     */
19064    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
19065
19066    /**
19067     * Get actionslider indicator position.
19068     *
19069     * @param obj The actionslider object.
19070     * @return The position of the indicator.
19071     */
19072    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19073
19074    /**
19075     * Set actionslider magnet position. To make multiple positions magnets @c or
19076     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
19077     *
19078     * @param obj The actionslider object.
19079     * @param pos Bit mask indicating the magnet positions.
19080     */
19081    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
19082
19083    /**
19084     * Get actionslider magnet position.
19085     *
19086     * @param obj The actionslider object.
19087     * @return The positions with magnet property.
19088     */
19089    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19090
19091    /**
19092     * Set actionslider enabled position. To set multiple positions as enabled @c or
19093     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
19094     *
19095     * @note All the positions are enabled by default.
19096     *
19097     * @param obj The actionslider object.
19098     * @param pos Bit mask indicating the enabled positions.
19099     */
19100    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
19101
19102    /**
19103     * Get actionslider enabled position.
19104     *
19105     * @param obj The actionslider object.
19106     * @return The enabled positions.
19107     */
19108    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19109
19110    /**
19111     * Set the label used on the indicator.
19112     *
19113     * @param obj The actionslider object
19114     * @param label The label to be set on the indicator.
19115     * @deprecated use elm_object_text_set() instead.
19116     */
19117    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19118
19119    /**
19120     * Get the label used on the indicator object.
19121     *
19122     * @param obj The actionslider object
19123     * @return The indicator label
19124     * @deprecated use elm_object_text_get() instead.
19125     */
19126    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
19127
19128    /**
19129     * @}
19130     */
19131
19132    /**
19133     * @defgroup Genlist Genlist
19134     *
19135     * @image html img/widget/genlist/preview-00.png
19136     * @image latex img/widget/genlist/preview-00.eps
19137     * @image html img/genlist.png
19138     * @image latex img/genlist.eps
19139     *
19140     * This widget aims to have more expansive list than the simple list in
19141     * Elementary that could have more flexible items and allow many more entries
19142     * while still being fast and low on memory usage. At the same time it was
19143     * also made to be able to do tree structures. But the price to pay is more
19144     * complexity when it comes to usage. If all you want is a simple list with
19145     * icons and a single text, use the normal @ref List object.
19146     *
19147     * Genlist has a fairly large API, mostly because it's relatively complex,
19148     * trying to be both expansive, powerful and efficient. First we will begin
19149     * an overview on the theory behind genlist.
19150     *
19151     * @section Genlist_Item_Class Genlist item classes - creating items
19152     *
19153     * In order to have the ability to add and delete items on the fly, genlist
19154     * implements a class (callback) system where the application provides a
19155     * structure with information about that type of item (genlist may contain
19156     * multiple different items with different classes, states and styles).
19157     * Genlist will call the functions in this struct (methods) when an item is
19158     * "realized" (i.e., created dynamically, while the user is scrolling the
19159     * grid). All objects will simply be deleted when no longer needed with
19160     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
19161     * following members:
19162     * - @c item_style - This is a constant string and simply defines the name
19163     *   of the item style. It @b must be specified and the default should be @c
19164     *   "default".
19165     *
19166     * - @c func - A struct with pointers to functions that will be called when
19167     *   an item is going to be actually created. All of them receive a @c data
19168     *   parameter that will point to the same data passed to
19169     *   elm_genlist_item_append() and related item creation functions, and a @c
19170     *   obj parameter that points to the genlist object itself.
19171     *
19172     * The function pointers inside @c func are @c text_get, @c content_get, @c
19173     * state_get and @c del. The 3 first functions also receive a @c part
19174     * parameter described below. A brief description of these functions follows:
19175     *
19176     * - @c text_get - The @c part parameter is the name string of one of the
19177     *   existing text parts in the Edje group implementing the item's theme.
19178     *   This function @b must return a strdup'()ed string, as the caller will
19179     *   free() it when done. See #Elm_Genlist_Item_Text_Get_Cb.
19180     * - @c content_get - The @c part parameter is the name string of one of the
19181     *   existing (content) swallow parts in the Edje group implementing the item's
19182     *   theme. It must return @c NULL, when no content is desired, or a valid
19183     *   object handle, otherwise.  The object will be deleted by the genlist on
19184     *   its deletion or when the item is "unrealized".  See
19185     *   #Elm_Genlist_Item_Content_Get_Cb.
19186     * - @c func.state_get - The @c part parameter is the name string of one of
19187     *   the state parts in the Edje group implementing the item's theme. Return
19188     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
19189     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
19190     *   and @c "elm" as "emission" and "source" arguments, respectively, when
19191     *   the state is true (the default is false), where @c XXX is the name of
19192     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
19193     * - @c func.del - This is intended for use when genlist items are deleted,
19194     *   so any data attached to the item (e.g. its data parameter on creation)
19195     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
19196     *
19197     * available item styles:
19198     * - default
19199     * - default_style - The text part is a textblock
19200     *
19201     * @image html img/widget/genlist/preview-04.png
19202     * @image latex img/widget/genlist/preview-04.eps
19203     *
19204     * - double_label
19205     *
19206     * @image html img/widget/genlist/preview-01.png
19207     * @image latex img/widget/genlist/preview-01.eps
19208     *
19209     * - icon_top_text_bottom
19210     *
19211     * @image html img/widget/genlist/preview-02.png
19212     * @image latex img/widget/genlist/preview-02.eps
19213     *
19214     * - group_index
19215     *
19216     * @image html img/widget/genlist/preview-03.png
19217     * @image latex img/widget/genlist/preview-03.eps
19218     *
19219     * @section Genlist_Items Structure of items
19220     *
19221     * An item in a genlist can have 0 or more texts (they can be regular
19222     * text or textblock Evas objects - that's up to the style to determine), 0
19223     * or more contents (which are simply objects swallowed into the genlist item's
19224     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
19225     * behavior left to the user to define. The Edje part names for each of
19226     * these properties will be looked up, in the theme file for the genlist,
19227     * under the Edje (string) data items named @c "labels", @c "contents" and @c
19228     * "states", respectively. For each of those properties, if more than one
19229     * part is provided, they must have names listed separated by spaces in the
19230     * data fields. For the default genlist item theme, we have @b one text 
19231     * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
19232     * "elm.swallow.end") and @b no state parts.
19233     *
19234     * A genlist item may be at one of several styles. Elementary provides one
19235     * by default - "default", but this can be extended by system or application
19236     * custom themes/overlays/extensions (see @ref Theme "themes" for more
19237     * details).
19238     *
19239     * @section Genlist_Manipulation Editing and Navigating
19240     *
19241     * Items can be added by several calls. All of them return a @ref
19242     * Elm_Genlist_Item handle that is an internal member inside the genlist.
19243     * They all take a data parameter that is meant to be used for a handle to
19244     * the applications internal data (eg the struct with the original item
19245     * data). The parent parameter is the parent genlist item this belongs to if
19246     * it is a tree or an indexed group, and NULL if there is no parent. The
19247     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
19248     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
19249     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
19250     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
19251     * is set then this item is group index item that is displayed at the top
19252     * until the next group comes. The func parameter is a convenience callback
19253     * that is called when the item is selected and the data parameter will be
19254     * the func_data parameter, obj be the genlist object and event_info will be
19255     * the genlist item.
19256     *
19257     * elm_genlist_item_append() adds an item to the end of the list, or if
19258     * there is a parent, to the end of all the child items of the parent.
19259     * elm_genlist_item_prepend() is the same but adds to the beginning of
19260     * the list or children list. elm_genlist_item_insert_before() inserts at
19261     * item before another item and elm_genlist_item_insert_after() inserts after
19262     * the indicated item.
19263     *
19264     * The application can clear the list with elm_genlist_clear() which deletes
19265     * all the items in the list and elm_genlist_item_del() will delete a specific
19266     * item. elm_genlist_item_subitems_clear() will clear all items that are
19267     * children of the indicated parent item.
19268     *
19269     * To help inspect list items you can jump to the item at the top of the list
19270     * with elm_genlist_first_item_get() which will return the item pointer, and
19271     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
19272     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
19273     * and previous items respectively relative to the indicated item. Using
19274     * these calls you can walk the entire item list/tree. Note that as a tree
19275     * the items are flattened in the list, so elm_genlist_item_parent_get() will
19276     * let you know which item is the parent (and thus know how to skip them if
19277     * wanted).
19278     *
19279     * @section Genlist_Muti_Selection Multi-selection
19280     *
19281     * If the application wants multiple items to be able to be selected,
19282     * elm_genlist_multi_select_set() can enable this. If the list is
19283     * single-selection only (the default), then elm_genlist_selected_item_get()
19284     * will return the selected item, if any, or NULL if none is selected. If the
19285     * list is multi-select then elm_genlist_selected_items_get() will return a
19286     * list (that is only valid as long as no items are modified (added, deleted,
19287     * selected or unselected)).
19288     *
19289     * @section Genlist_Usage_Hints Usage hints
19290     *
19291     * There are also convenience functions. elm_genlist_item_genlist_get() will
19292     * return the genlist object the item belongs to. elm_genlist_item_show()
19293     * will make the scroller scroll to show that specific item so its visible.
19294     * elm_genlist_item_data_get() returns the data pointer set by the item
19295     * creation functions.
19296     *
19297     * If an item changes (state of boolean changes, text or contents change),
19298     * then use elm_genlist_item_update() to have genlist update the item with
19299     * the new state. Genlist will re-realize the item thus call the functions
19300     * in the _Elm_Genlist_Item_Class for that item.
19301     *
19302     * To programmatically (un)select an item use elm_genlist_item_selected_set().
19303     * To get its selected state use elm_genlist_item_selected_get(). Similarly
19304     * to expand/contract an item and get its expanded state, use
19305     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
19306     * again to make an item disabled (unable to be selected and appear
19307     * differently) use elm_genlist_item_disabled_set() to set this and
19308     * elm_genlist_item_disabled_get() to get the disabled state.
19309     *
19310     * In general to indicate how the genlist should expand items horizontally to
19311     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
19312     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
19313     * mode means that if items are too wide to fit, the scroller will scroll
19314     * horizontally. Otherwise items are expanded to fill the width of the
19315     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
19316     * to the viewport width and limited to that size. This can be combined with
19317     * a different style that uses edjes' ellipsis feature (cutting text off like
19318     * this: "tex...").
19319     *
19320     * Items will only call their selection func and callback when first becoming
19321     * selected. Any further clicks will do nothing, unless you enable always
19322     * select with elm_genlist_always_select_mode_set(). This means even if
19323     * selected, every click will make the selected callbacks be called.
19324     * elm_genlist_no_select_mode_set() will turn off the ability to select
19325     * items entirely and they will neither appear selected nor call selected
19326     * callback functions.
19327     *
19328     * Remember that you can create new styles and add your own theme augmentation
19329     * per application with elm_theme_extension_add(). If you absolutely must
19330     * have a specific style that overrides any theme the user or system sets up
19331     * you can use elm_theme_overlay_add() to add such a file.
19332     *
19333     * @section Genlist_Implementation Implementation
19334     *
19335     * Evas tracks every object you create. Every time it processes an event
19336     * (mouse move, down, up etc.) it needs to walk through objects and find out
19337     * what event that affects. Even worse every time it renders display updates,
19338     * in order to just calculate what to re-draw, it needs to walk through many
19339     * many many objects. Thus, the more objects you keep active, the more
19340     * overhead Evas has in just doing its work. It is advisable to keep your
19341     * active objects to the minimum working set you need. Also remember that
19342     * object creation and deletion carries an overhead, so there is a
19343     * middle-ground, which is not easily determined. But don't keep massive lists
19344     * of objects you can't see or use. Genlist does this with list objects. It
19345     * creates and destroys them dynamically as you scroll around. It groups them
19346     * into blocks so it can determine the visibility etc. of a whole block at
19347     * once as opposed to having to walk the whole list. This 2-level list allows
19348     * for very large numbers of items to be in the list (tests have used up to
19349     * 2,000,000 items). Also genlist employs a queue for adding items. As items
19350     * may be different sizes, every item added needs to be calculated as to its
19351     * size and thus this presents a lot of overhead on populating the list, this
19352     * genlist employs a queue. Any item added is queued and spooled off over
19353     * time, actually appearing some time later, so if your list has many members
19354     * you may find it takes a while for them to all appear, with your process
19355     * consuming a lot of CPU while it is busy spooling.
19356     *
19357     * Genlist also implements a tree structure, but it does so with callbacks to
19358     * the application, with the application filling in tree structures when
19359     * requested (allowing for efficient building of a very deep tree that could
19360     * even be used for file-management). See the above smart signal callbacks for
19361     * details.
19362     *
19363     * @section Genlist_Smart_Events Genlist smart events
19364     *
19365     * Signals that you can add callbacks for are:
19366     * - @c "activated" - The user has double-clicked or pressed
19367     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
19368     *   item that was activated.
19369     * - @c "clicked,double" - The user has double-clicked an item.  The @c
19370     *   event_info parameter is the item that was double-clicked.
19371     * - @c "selected" - This is called when a user has made an item selected.
19372     *   The event_info parameter is the genlist item that was selected.
19373     * - @c "unselected" - This is called when a user has made an item
19374     *   unselected. The event_info parameter is the genlist item that was
19375     *   unselected.
19376     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
19377     *   called and the item is now meant to be expanded. The event_info
19378     *   parameter is the genlist item that was indicated to expand.  It is the
19379     *   job of this callback to then fill in the child items.
19380     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
19381     *   called and the item is now meant to be contracted. The event_info
19382     *   parameter is the genlist item that was indicated to contract. It is the
19383     *   job of this callback to then delete the child items.
19384     * - @c "expand,request" - This is called when a user has indicated they want
19385     *   to expand a tree branch item. The callback should decide if the item can
19386     *   expand (has any children) and then call elm_genlist_item_expanded_set()
19387     *   appropriately to set the state. The event_info parameter is the genlist
19388     *   item that was indicated to expand.
19389     * - @c "contract,request" - This is called when a user has indicated they
19390     *   want to contract a tree branch item. The callback should decide if the
19391     *   item can contract (has any children) and then call
19392     *   elm_genlist_item_expanded_set() appropriately to set the state. The
19393     *   event_info parameter is the genlist item that was indicated to contract.
19394     * - @c "realized" - This is called when the item in the list is created as a
19395     *   real evas object. event_info parameter is the genlist item that was
19396     *   created. The object may be deleted at any time, so it is up to the
19397     *   caller to not use the object pointer from elm_genlist_item_object_get()
19398     *   in a way where it may point to freed objects.
19399     * - @c "unrealized" - This is called just before an item is unrealized.
19400     *   After this call content objects provided will be deleted and the item
19401     *   object itself delete or be put into a floating cache.
19402     * - @c "drag,start,up" - This is called when the item in the list has been
19403     *   dragged (not scrolled) up.
19404     * - @c "drag,start,down" - This is called when the item in the list has been
19405     *   dragged (not scrolled) down.
19406     * - @c "drag,start,left" - This is called when the item in the list has been
19407     *   dragged (not scrolled) left.
19408     * - @c "drag,start,right" - This is called when the item in the list has
19409     *   been dragged (not scrolled) right.
19410     * - @c "drag,stop" - This is called when the item in the list has stopped
19411     *   being dragged.
19412     * - @c "drag" - This is called when the item in the list is being dragged.
19413     * - @c "longpressed" - This is called when the item is pressed for a certain
19414     *   amount of time. By default it's 1 second.
19415     * - @c "scroll,anim,start" - This is called when scrolling animation has
19416     *   started.
19417     * - @c "scroll,anim,stop" - This is called when scrolling animation has
19418     *   stopped.
19419     * - @c "scroll,drag,start" - This is called when dragging the content has
19420     *   started.
19421     * - @c "scroll,drag,stop" - This is called when dragging the content has
19422     *   stopped.
19423     * - @c "edge,top" - This is called when the genlist is scrolled until
19424     *   the top edge.
19425     * - @c "edge,bottom" - This is called when the genlist is scrolled
19426     *   until the bottom edge.
19427     * - @c "edge,left" - This is called when the genlist is scrolled
19428     *   until the left edge.
19429     * - @c "edge,right" - This is called when the genlist is scrolled
19430     *   until the right edge.
19431     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
19432     *   swiped left.
19433     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
19434     *   swiped right.
19435     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
19436     *   swiped up.
19437     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
19438     *   swiped down.
19439     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
19440     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
19441     *   multi-touch pinched in.
19442     * - @c "swipe" - This is called when the genlist is swiped.
19443     * - @c "moved" - This is called when a genlist item is moved.
19444     * - @c "language,changed" - This is called when the program's language is
19445     *   changed.
19446     *
19447     * @section Genlist_Examples Examples
19448     *
19449     * Here is a list of examples that use the genlist, trying to show some of
19450     * its capabilities:
19451     * - @ref genlist_example_01
19452     * - @ref genlist_example_02
19453     * - @ref genlist_example_03
19454     * - @ref genlist_example_04
19455     * - @ref genlist_example_05
19456     */
19457
19458    /**
19459     * @addtogroup Genlist
19460     * @{
19461     */
19462
19463    /**
19464     * @enum _Elm_Genlist_Item_Flags
19465     * @typedef Elm_Genlist_Item_Flags
19466     *
19467     * Defines if the item is of any special type (has subitems or it's the
19468     * index of a group), or is just a simple item.
19469     *
19470     * @ingroup Genlist
19471     */
19472    typedef enum _Elm_Genlist_Item_Flags
19473      {
19474         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
19475         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
19476         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
19477      } Elm_Genlist_Item_Flags;
19478    typedef enum _Elm_Genlist_Item_Field_Flags
19479      {
19480         ELM_GENLIST_ITEM_FIELD_ALL = 0,
19481         ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
19482         ELM_GENLIST_ITEM_FIELD_CONTENT = (1 << 1),
19483         ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
19484      } Elm_Genlist_Item_Field_Flags;
19485    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
19486    #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
19487    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
19488    #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
19489    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
19490
19491    /**
19492     * Text fetching class function for Elm_Gen_Item_Class.
19493     * @param data The data passed in the item creation function
19494     * @param obj The base widget object
19495     * @param part The part name of the swallow
19496     * @return The allocated (NOT stringshared) string to set as the text
19497     */
19498    typedef char        *(*Elm_Genlist_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
19499
19500    /**
19501     * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
19502     * @param data The data passed in the item creation function
19503     * @param obj The base widget object
19504     * @param part The part name of the swallow
19505     * @return The content object to swallow
19506     */
19507    typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part);
19508
19509    /**
19510     * State fetching class function for Elm_Gen_Item_Class.
19511     * @param data The data passed in the item creation function
19512     * @param obj The base widget object
19513     * @param part The part name of the swallow
19514     * @return The hell if I know
19515     */
19516    typedef Eina_Bool    (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
19517
19518    /**
19519     * Deletion class function for Elm_Gen_Item_Class.
19520     * @param data The data passed in the item creation function
19521     * @param obj The base widget object
19522     */
19523    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj);
19524
19525    /**
19526     * @struct _Elm_Genlist_Item_Class
19527     *
19528     * Genlist item class definition structs.
19529     *
19530     * This struct contains the style and fetching functions that will define the
19531     * contents of each item.
19532     *
19533     * @see @ref Genlist_Item_Class
19534     */
19535    struct _Elm_Genlist_Item_Class
19536      {
19537         const char                *item_style; /**< style of this class. */
19538         struct Elm_Genlist_Item_Class_Func
19539           {
19540              Elm_Genlist_Item_Text_Get_Cb    text_get; /**< Text fetching class function for genlist item classes.*/
19541              Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
19542              Elm_Genlist_Item_State_Get_Cb   state_get; /**< State fetching class function for genlist item classes. */
19543              Elm_Genlist_Item_Del_Cb         del; /**< Deletion class function for genlist item classes. */
19544           } func;
19545      };
19546    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
19547    /**
19548     * Add a new genlist widget to the given parent Elementary
19549     * (container) object
19550     *
19551     * @param parent The parent object
19552     * @return a new genlist widget handle or @c NULL, on errors
19553     *
19554     * This function inserts a new genlist widget on the canvas.
19555     *
19556     * @see elm_genlist_item_append()
19557     * @see elm_genlist_item_del()
19558     * @see elm_genlist_clear()
19559     *
19560     * @ingroup Genlist
19561     */
19562    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19563
19564    /**
19565     * Remove all items from a given genlist widget.
19566     *
19567     * @param obj The genlist object
19568     *
19569     * This removes (and deletes) all items in @p obj, leaving it empty.
19570     *
19571     * @see elm_genlist_item_del(), to remove just one item.
19572     *
19573     * @ingroup Genlist
19574     */
19575    EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
19576
19577    /**
19578     * Enable or disable multi-selection in the genlist
19579     *
19580     * @param obj The genlist object
19581     * @param multi Multi-select enable/disable. Default is disabled.
19582     *
19583     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
19584     * the list. This allows more than 1 item to be selected. To retrieve the list
19585     * of selected items, use elm_genlist_selected_items_get().
19586     *
19587     * @see elm_genlist_selected_items_get()
19588     * @see elm_genlist_multi_select_get()
19589     *
19590     * @ingroup Genlist
19591     */
19592    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
19593
19594    /**
19595     * Gets if multi-selection in genlist is enabled or disabled.
19596     *
19597     * @param obj The genlist object
19598     * @return Multi-select enabled/disabled
19599     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
19600     *
19601     * @see elm_genlist_multi_select_set()
19602     *
19603     * @ingroup Genlist
19604     */
19605    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19606
19607    /**
19608     * This sets the horizontal stretching mode.
19609     *
19610     * @param obj The genlist object
19611     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
19612     *
19613     * This sets the mode used for sizing items horizontally. Valid modes
19614     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
19615     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
19616     * the scroller will scroll horizontally. Otherwise items are expanded
19617     * to fill the width of the viewport of the scroller. If it is
19618     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
19619     * limited to that size.
19620     *
19621     * @see elm_genlist_horizontal_get()
19622     *
19623     * @ingroup Genlist
19624     */
19625    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
19626    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
19627
19628    /**
19629     * Gets the horizontal stretching mode.
19630     *
19631     * @param obj The genlist object
19632     * @return The mode to use
19633     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
19634     *
19635     * @see elm_genlist_horizontal_set()
19636     *
19637     * @ingroup Genlist
19638     */
19639    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19640    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19641
19642    /**
19643     * Set the always select mode.
19644     *
19645     * @param obj The genlist object
19646     * @param always_select The always select mode (@c EINA_TRUE = on, @c
19647     * EINA_FALSE = off). Default is @c EINA_FALSE.
19648     *
19649     * Items will only call their selection func and callback when first
19650     * becoming selected. Any further clicks will do nothing, unless you
19651     * enable always select with elm_genlist_always_select_mode_set().
19652     * This means that, even if selected, every click will make the selected
19653     * callbacks be called.
19654     *
19655     * @see elm_genlist_always_select_mode_get()
19656     *
19657     * @ingroup Genlist
19658     */
19659    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
19660
19661    /**
19662     * Get the always select mode.
19663     *
19664     * @param obj The genlist object
19665     * @return The always select mode
19666     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19667     *
19668     * @see elm_genlist_always_select_mode_set()
19669     *
19670     * @ingroup Genlist
19671     */
19672    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19673
19674    /**
19675     * Enable/disable the no select mode.
19676     *
19677     * @param obj The genlist object
19678     * @param no_select The no select mode
19679     * (EINA_TRUE = on, EINA_FALSE = off)
19680     *
19681     * This will turn off the ability to select items entirely and they
19682     * will neither appear selected nor call selected callback functions.
19683     *
19684     * @see elm_genlist_no_select_mode_get()
19685     *
19686     * @ingroup Genlist
19687     */
19688    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
19689
19690    /**
19691     * Gets whether the no select mode is enabled.
19692     *
19693     * @param obj The genlist object
19694     * @return The no select mode
19695     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19696     *
19697     * @see elm_genlist_no_select_mode_set()
19698     *
19699     * @ingroup Genlist
19700     */
19701    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19702
19703    /**
19704     * Enable/disable compress mode.
19705     *
19706     * @param obj The genlist object
19707     * @param compress The compress mode
19708     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
19709     *
19710     * This will enable the compress mode where items are "compressed"
19711     * horizontally to fit the genlist scrollable viewport width. This is
19712     * special for genlist.  Do not rely on
19713     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
19714     * work as genlist needs to handle it specially.
19715     *
19716     * @see elm_genlist_compress_mode_get()
19717     *
19718     * @ingroup Genlist
19719     */
19720    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
19721
19722    /**
19723     * Get whether the compress mode is enabled.
19724     *
19725     * @param obj The genlist object
19726     * @return The compress mode
19727     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19728     *
19729     * @see elm_genlist_compress_mode_set()
19730     *
19731     * @ingroup Genlist
19732     */
19733    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19734
19735    /**
19736     * Enable/disable height-for-width mode.
19737     *
19738     * @param obj The genlist object
19739     * @param setting The height-for-width mode (@c EINA_TRUE = on,
19740     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
19741     *
19742     * With height-for-width mode the item width will be fixed (restricted
19743     * to a minimum of) to the list width when calculating its size in
19744     * order to allow the height to be calculated based on it. This allows,
19745     * for instance, text block to wrap lines if the Edje part is
19746     * configured with "text.min: 0 1".
19747     *
19748     * @note This mode will make list resize slower as it will have to
19749     *       recalculate every item height again whenever the list width
19750     *       changes!
19751     *
19752     * @note When height-for-width mode is enabled, it also enables
19753     *       compress mode (see elm_genlist_compress_mode_set()) and
19754     *       disables homogeneous (see elm_genlist_homogeneous_set()).
19755     *
19756     * @ingroup Genlist
19757     */
19758    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
19759
19760    /**
19761     * Get whether the height-for-width mode is enabled.
19762     *
19763     * @param obj The genlist object
19764     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
19765     * off)
19766     *
19767     * @ingroup Genlist
19768     */
19769    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19770
19771    /**
19772     * Enable/disable horizontal and vertical bouncing effect.
19773     *
19774     * @param obj The genlist object
19775     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
19776     * EINA_FALSE = off). Default is @c EINA_FALSE.
19777     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
19778     * EINA_FALSE = off). Default is @c EINA_TRUE.
19779     *
19780     * This will enable or disable the scroller bouncing effect for the
19781     * genlist. See elm_scroller_bounce_set() for details.
19782     *
19783     * @see elm_scroller_bounce_set()
19784     * @see elm_genlist_bounce_get()
19785     *
19786     * @ingroup Genlist
19787     */
19788    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
19789
19790    /**
19791     * Get whether the horizontal and vertical bouncing effect is enabled.
19792     *
19793     * @param obj The genlist object
19794     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
19795     * option is set.
19796     * @param v_bounce Pointer to a bool to receive if the bounce vertically
19797     * option is set.
19798     *
19799     * @see elm_genlist_bounce_set()
19800     *
19801     * @ingroup Genlist
19802     */
19803    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
19804
19805    /**
19806     * Enable/disable homogeneous mode.
19807     *
19808     * @param obj The genlist object
19809     * @param homogeneous Assume the items within the genlist are of the
19810     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
19811     * EINA_FALSE.
19812     *
19813     * This will enable the homogeneous mode where items are of the same
19814     * height and width so that genlist may do the lazy-loading at its
19815     * maximum (which increases the performance for scrolling the list). This
19816     * implies 'compressed' mode.
19817     *
19818     * @see elm_genlist_compress_mode_set()
19819     * @see elm_genlist_homogeneous_get()
19820     *
19821     * @ingroup Genlist
19822     */
19823    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
19824
19825    /**
19826     * Get whether the homogeneous mode is enabled.
19827     *
19828     * @param obj The genlist object
19829     * @return Assume the items within the genlist are of the same height
19830     * and width (EINA_TRUE = on, EINA_FALSE = off)
19831     *
19832     * @see elm_genlist_homogeneous_set()
19833     *
19834     * @ingroup Genlist
19835     */
19836    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19837
19838    /**
19839     * Set the maximum number of items within an item block
19840     *
19841     * @param obj The genlist object
19842     * @param n   Maximum number of items within an item block. Default is 32.
19843     *
19844     * This will configure the block count to tune to the target with
19845     * particular performance matrix.
19846     *
19847     * A block of objects will be used to reduce the number of operations due to
19848     * many objects in the screen. It can determine the visibility, or if the
19849     * object has changed, it theme needs to be updated, etc. doing this kind of
19850     * calculation to the entire block, instead of per object.
19851     *
19852     * The default value for the block count is enough for most lists, so unless
19853     * you know you will have a lot of objects visible in the screen at the same
19854     * time, don't try to change this.
19855     *
19856     * @see elm_genlist_block_count_get()
19857     * @see @ref Genlist_Implementation
19858     *
19859     * @ingroup Genlist
19860     */
19861    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
19862
19863    /**
19864     * Get the maximum number of items within an item block
19865     *
19866     * @param obj The genlist object
19867     * @return Maximum number of items within an item block
19868     *
19869     * @see elm_genlist_block_count_set()
19870     *
19871     * @ingroup Genlist
19872     */
19873    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19874
19875    /**
19876     * Set the timeout in seconds for the longpress event.
19877     *
19878     * @param obj The genlist object
19879     * @param timeout timeout in seconds. Default is 1.
19880     *
19881     * This option will change how long it takes to send an event "longpressed"
19882     * after the mouse down signal is sent to the list. If this event occurs, no
19883     * "clicked" event will be sent.
19884     *
19885     * @see elm_genlist_longpress_timeout_set()
19886     *
19887     * @ingroup Genlist
19888     */
19889    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19890
19891    /**
19892     * Get the timeout in seconds for the longpress event.
19893     *
19894     * @param obj The genlist object
19895     * @return timeout in seconds
19896     *
19897     * @see elm_genlist_longpress_timeout_get()
19898     *
19899     * @ingroup Genlist
19900     */
19901    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19902
19903    /**
19904     * Append a new item in a given genlist widget.
19905     *
19906     * @param obj The genlist object
19907     * @param itc The item class for the item
19908     * @param data The item data
19909     * @param parent The parent item, or NULL if none
19910     * @param flags Item flags
19911     * @param func Convenience function called when the item is selected
19912     * @param func_data Data passed to @p func above.
19913     * @return A handle to the item added or @c NULL if not possible
19914     *
19915     * This adds the given item to the end of the list or the end of
19916     * the children list if the @p parent is given.
19917     *
19918     * @see elm_genlist_item_prepend()
19919     * @see elm_genlist_item_insert_before()
19920     * @see elm_genlist_item_insert_after()
19921     * @see elm_genlist_item_del()
19922     *
19923     * @ingroup Genlist
19924     */
19925    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);
19926
19927    /**
19928     * Prepend a new item in a given genlist widget.
19929     *
19930     * @param obj The genlist object
19931     * @param itc The item class for the item
19932     * @param data The item data
19933     * @param parent The parent item, or NULL if none
19934     * @param flags Item flags
19935     * @param func Convenience function called when the item is selected
19936     * @param func_data Data passed to @p func above.
19937     * @return A handle to the item added or NULL if not possible
19938     *
19939     * This adds an item to the beginning of the list or beginning of the
19940     * children of the parent if given.
19941     *
19942     * @see elm_genlist_item_append()
19943     * @see elm_genlist_item_insert_before()
19944     * @see elm_genlist_item_insert_after()
19945     * @see elm_genlist_item_del()
19946     *
19947     * @ingroup Genlist
19948     */
19949    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);
19950
19951    /**
19952     * Insert an item before another in a genlist widget
19953     *
19954     * @param obj The genlist object
19955     * @param itc The item class for the item
19956     * @param data The item data
19957     * @param before The item to place this new one before.
19958     * @param flags Item flags
19959     * @param func Convenience function called when the item is selected
19960     * @param func_data Data passed to @p func above.
19961     * @return A handle to the item added or @c NULL if not possible
19962     *
19963     * This inserts an item before another in the list. It will be in the
19964     * same tree level or group as the item it is inserted before.
19965     *
19966     * @see elm_genlist_item_append()
19967     * @see elm_genlist_item_prepend()
19968     * @see elm_genlist_item_insert_after()
19969     * @see elm_genlist_item_del()
19970     *
19971     * @ingroup Genlist
19972     */
19973    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);
19974
19975    /**
19976     * Insert an item after another in a genlist widget
19977     *
19978     * @param obj The genlist object
19979     * @param itc The item class for the item
19980     * @param data The item data
19981     * @param after The item to place this new one after.
19982     * @param flags Item flags
19983     * @param func Convenience function called when the item is selected
19984     * @param func_data Data passed to @p func above.
19985     * @return A handle to the item added or @c NULL if not possible
19986     *
19987     * This inserts an item after another in the list. It will be in the
19988     * same tree level or group as the item it is inserted after.
19989     *
19990     * @see elm_genlist_item_append()
19991     * @see elm_genlist_item_prepend()
19992     * @see elm_genlist_item_insert_before()
19993     * @see elm_genlist_item_del()
19994     *
19995     * @ingroup Genlist
19996     */
19997    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);
19998
19999    /**
20000     * Insert a new item into the sorted genlist object
20001     *
20002     * @param obj The genlist object
20003     * @param itc The item class for the item
20004     * @param data The item data
20005     * @param parent The parent item, or NULL if none
20006     * @param flags Item flags
20007     * @param comp The function called for the sort
20008     * @param func Convenience function called when item selected
20009     * @param func_data Data passed to @p func above.
20010     * @return A handle to the item added or NULL if not possible
20011     *
20012     * @ingroup Genlist
20013     */
20014    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);
20015    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);
20016
20017    /* operations to retrieve existing items */
20018    /**
20019     * Get the selectd item in the genlist.
20020     *
20021     * @param obj The genlist object
20022     * @return The selected item, or NULL if none is selected.
20023     *
20024     * This gets the selected item in the list (if multi-selection is enabled, only
20025     * the item that was first selected in the list is returned - which is not very
20026     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
20027     * used).
20028     *
20029     * If no item is selected, NULL is returned.
20030     *
20031     * @see elm_genlist_selected_items_get()
20032     *
20033     * @ingroup Genlist
20034     */
20035    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20036
20037    /**
20038     * Get a list of selected items in the genlist.
20039     *
20040     * @param obj The genlist object
20041     * @return The list of selected items, or NULL if none are selected.
20042     *
20043     * It returns a list of the selected items. This list pointer is only valid so
20044     * long as the selection doesn't change (no items are selected or unselected, or
20045     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
20046     * pointers. The order of the items in this list is the order which they were
20047     * selected, i.e. the first item in this list is the first item that was
20048     * selected, and so on.
20049     *
20050     * @note If not in multi-select mode, consider using function
20051     * elm_genlist_selected_item_get() instead.
20052     *
20053     * @see elm_genlist_multi_select_set()
20054     * @see elm_genlist_selected_item_get()
20055     *
20056     * @ingroup Genlist
20057     */
20058    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20059
20060    /**
20061     * Get the mode item style of items in the genlist
20062     * @param obj The genlist object
20063     * @return The mode item style string, or NULL if none is specified
20064     *
20065     * This is a constant string and simply defines the name of the
20066     * style that will be used for mode animations. It can be
20067     * @c NULL if you don't plan to use Genlist mode. See
20068     * elm_genlist_item_mode_set() for more info.
20069     *
20070     * @ingroup Genlist
20071     */
20072    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20073
20074    /**
20075     * Set the mode item style of items in the genlist
20076     * @param obj The genlist object
20077     * @param style The mode item style string, or NULL if none is desired
20078     *
20079     * This is a constant string and simply defines the name of the
20080     * style that will be used for mode animations. It can be
20081     * @c NULL if you don't plan to use Genlist mode. See
20082     * elm_genlist_item_mode_set() for more info.
20083     *
20084     * @ingroup Genlist
20085     */
20086    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
20087
20088    /**
20089     * Get a list of realized items in genlist
20090     *
20091     * @param obj The genlist object
20092     * @return The list of realized items, nor NULL if none are realized.
20093     *
20094     * This returns a list of the realized items in the genlist. The list
20095     * contains Elm_Genlist_Item pointers. The list must be freed by the
20096     * caller when done with eina_list_free(). The item pointers in the
20097     * list are only valid so long as those items are not deleted or the
20098     * genlist is not deleted.
20099     *
20100     * @see elm_genlist_realized_items_update()
20101     *
20102     * @ingroup Genlist
20103     */
20104    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20105
20106    /**
20107     * Get the item that is at the x, y canvas coords.
20108     *
20109     * @param obj The gelinst object.
20110     * @param x The input x coordinate
20111     * @param y The input y coordinate
20112     * @param posret The position relative to the item returned here
20113     * @return The item at the coordinates or NULL if none
20114     *
20115     * This returns the item at the given coordinates (which are canvas
20116     * relative, not object-relative). If an item is at that coordinate,
20117     * that item handle is returned, and if @p posret is not NULL, the
20118     * integer pointed to is set to a value of -1, 0 or 1, depending if
20119     * the coordinate is on the upper portion of that item (-1), on the
20120     * middle section (0) or on the lower part (1). If NULL is returned as
20121     * an item (no item found there), then posret may indicate -1 or 1
20122     * based if the coordinate is above or below all items respectively in
20123     * the genlist.
20124     *
20125     * @ingroup Genlist
20126     */
20127    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);
20128
20129    /**
20130     * Get the first item in the genlist
20131     *
20132     * This returns the first item in the list.
20133     *
20134     * @param obj The genlist object
20135     * @return The first item, or NULL if none
20136     *
20137     * @ingroup Genlist
20138     */
20139    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20140
20141    /**
20142     * Get the last item in the genlist
20143     *
20144     * This returns the last item in the list.
20145     *
20146     * @return The last item, or NULL if none
20147     *
20148     * @ingroup Genlist
20149     */
20150    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20151
20152    /**
20153     * Set the scrollbar policy
20154     *
20155     * @param obj The genlist object
20156     * @param policy_h Horizontal scrollbar policy.
20157     * @param policy_v Vertical scrollbar policy.
20158     *
20159     * This sets the scrollbar visibility policy for the given genlist
20160     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
20161     * made visible if it is needed, and otherwise kept hidden.
20162     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
20163     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
20164     * respectively for the horizontal and vertical scrollbars. Default is
20165     * #ELM_SMART_SCROLLER_POLICY_AUTO
20166     *
20167     * @see elm_genlist_scroller_policy_get()
20168     *
20169     * @ingroup Genlist
20170     */
20171    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
20172
20173    /**
20174     * Get the scrollbar policy
20175     *
20176     * @param obj The genlist object
20177     * @param policy_h Pointer to store the horizontal scrollbar policy.
20178     * @param policy_v Pointer to store the vertical scrollbar policy.
20179     *
20180     * @see elm_genlist_scroller_policy_set()
20181     *
20182     * @ingroup Genlist
20183     */
20184    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);
20185
20186    /**
20187     * Get the @b next item in a genlist widget's internal list of items,
20188     * given a handle to one of those items.
20189     *
20190     * @param item The genlist item to fetch next from
20191     * @return The item after @p item, or @c NULL if there's none (and
20192     * on errors)
20193     *
20194     * This returns the item placed after the @p item, on the container
20195     * genlist.
20196     *
20197     * @see elm_genlist_item_prev_get()
20198     *
20199     * @ingroup Genlist
20200     */
20201    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20202
20203    /**
20204     * Get the @b previous item in a genlist widget's internal list of items,
20205     * given a handle to one of those items.
20206     *
20207     * @param item The genlist item to fetch previous from
20208     * @return The item before @p item, or @c NULL if there's none (and
20209     * on errors)
20210     *
20211     * This returns the item placed before the @p item, on the container
20212     * genlist.
20213     *
20214     * @see elm_genlist_item_next_get()
20215     *
20216     * @ingroup Genlist
20217     */
20218    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20219
20220    /**
20221     * Get the genlist object's handle which contains a given genlist
20222     * item
20223     *
20224     * @param item The item to fetch the container from
20225     * @return The genlist (parent) object
20226     *
20227     * This returns the genlist object itself that an item belongs to.
20228     *
20229     * @ingroup Genlist
20230     */
20231    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20232
20233    /**
20234     * Get the parent item of the given item
20235     *
20236     * @param it The item
20237     * @return The parent of the item or @c NULL if it has no parent.
20238     *
20239     * This returns the item that was specified as parent of the item @p it on
20240     * elm_genlist_item_append() and insertion related functions.
20241     *
20242     * @ingroup Genlist
20243     */
20244    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20245
20246    /**
20247     * Remove all sub-items (children) of the given item
20248     *
20249     * @param it The item
20250     *
20251     * This removes all items that are children (and their descendants) of the
20252     * given item @p it.
20253     *
20254     * @see elm_genlist_clear()
20255     * @see elm_genlist_item_del()
20256     *
20257     * @ingroup Genlist
20258     */
20259    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20260
20261    /**
20262     * Set whether a given genlist item is selected or not
20263     *
20264     * @param it The item
20265     * @param selected Use @c EINA_TRUE, to make it selected, @c
20266     * EINA_FALSE to make it unselected
20267     *
20268     * This sets the selected state of an item. If multi selection is
20269     * not enabled on the containing genlist and @p selected is @c
20270     * EINA_TRUE, any other previously selected items will get
20271     * unselected in favor of this new one.
20272     *
20273     * @see elm_genlist_item_selected_get()
20274     *
20275     * @ingroup Genlist
20276     */
20277    EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
20278
20279    /**
20280     * Get whether a given genlist item is selected or not
20281     *
20282     * @param it The item
20283     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
20284     *
20285     * @see elm_genlist_item_selected_set() for more details
20286     *
20287     * @ingroup Genlist
20288     */
20289    EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20290
20291    /**
20292     * Sets the expanded state of an item.
20293     *
20294     * @param it The item
20295     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
20296     *
20297     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
20298     * expanded or not.
20299     *
20300     * The theme will respond to this change visually, and a signal "expanded" or
20301     * "contracted" will be sent from the genlist with a pointer to the item that
20302     * has been expanded/contracted.
20303     *
20304     * Calling this function won't show or hide any child of this item (if it is
20305     * a parent). You must manually delete and create them on the callbacks fo
20306     * the "expanded" or "contracted" signals.
20307     *
20308     * @see elm_genlist_item_expanded_get()
20309     *
20310     * @ingroup Genlist
20311     */
20312    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
20313
20314    /**
20315     * Get the expanded state of an item
20316     *
20317     * @param it The item
20318     * @return The expanded state
20319     *
20320     * This gets the expanded state of an item.
20321     *
20322     * @see elm_genlist_item_expanded_set()
20323     *
20324     * @ingroup Genlist
20325     */
20326    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20327
20328    /**
20329     * Get the depth of expanded item
20330     *
20331     * @param it The genlist item object
20332     * @return The depth of expanded item
20333     *
20334     * @ingroup Genlist
20335     */
20336    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20337
20338    /**
20339     * Set whether a given genlist item is disabled or not.
20340     *
20341     * @param it The item
20342     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
20343     * to enable it back.
20344     *
20345     * A disabled item cannot be selected or unselected. It will also
20346     * change its appearance, to signal the user it's disabled.
20347     *
20348     * @see elm_genlist_item_disabled_get()
20349     *
20350     * @ingroup Genlist
20351     */
20352    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20353
20354    /**
20355     * Get whether a given genlist item is disabled or not.
20356     *
20357     * @param it The item
20358     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
20359     * (and on errors).
20360     *
20361     * @see elm_genlist_item_disabled_set() for more details
20362     *
20363     * @ingroup Genlist
20364     */
20365    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20366
20367    /**
20368     * Sets the display only state of an item.
20369     *
20370     * @param it The item
20371     * @param display_only @c EINA_TRUE if the item is display only, @c
20372     * EINA_FALSE otherwise.
20373     *
20374     * A display only item cannot be selected or unselected. It is for
20375     * display only and not selecting or otherwise clicking, dragging
20376     * etc. by the user, thus finger size rules will not be applied to
20377     * this item.
20378     *
20379     * It's good to set group index items to display only state.
20380     *
20381     * @see elm_genlist_item_display_only_get()
20382     *
20383     * @ingroup Genlist
20384     */
20385    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
20386
20387    /**
20388     * Get the display only state of an item
20389     *
20390     * @param it The item
20391     * @return @c EINA_TRUE if the item is display only, @c
20392     * EINA_FALSE otherwise.
20393     *
20394     * @see elm_genlist_item_display_only_set()
20395     *
20396     * @ingroup Genlist
20397     */
20398    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20399
20400    /**
20401     * Show the portion of a genlist's internal list containing a given
20402     * item, immediately.
20403     *
20404     * @param it The item to display
20405     *
20406     * This causes genlist to jump to the given item @p it and show it (by
20407     * immediately scrolling to that position), if it is not fully visible.
20408     *
20409     * @see elm_genlist_item_bring_in()
20410     * @see elm_genlist_item_top_show()
20411     * @see elm_genlist_item_middle_show()
20412     *
20413     * @ingroup Genlist
20414     */
20415    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20416
20417    /**
20418     * Animatedly bring in, to the visible are of a genlist, a given
20419     * item on it.
20420     *
20421     * @param it The item to display
20422     *
20423     * This causes genlist to jump to the given item @p it and show it (by
20424     * animatedly scrolling), if it is not fully visible. This may use animation
20425     * to do so and take a period of time
20426     *
20427     * @see elm_genlist_item_show()
20428     * @see elm_genlist_item_top_bring_in()
20429     * @see elm_genlist_item_middle_bring_in()
20430     *
20431     * @ingroup Genlist
20432     */
20433    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20434
20435    /**
20436     * Show the portion of a genlist's internal list containing a given
20437     * item, immediately.
20438     *
20439     * @param it The item to display
20440     *
20441     * This causes genlist to jump to the given item @p it and show it (by
20442     * immediately scrolling to that position), if it is not fully visible.
20443     *
20444     * The item will be positioned at the top of the genlist viewport.
20445     *
20446     * @see elm_genlist_item_show()
20447     * @see elm_genlist_item_top_bring_in()
20448     *
20449     * @ingroup Genlist
20450     */
20451    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20452
20453    /**
20454     * Animatedly bring in, to the visible are of a genlist, a given
20455     * item on it.
20456     *
20457     * @param it The item
20458     *
20459     * This causes genlist to jump to the given item @p it and show it (by
20460     * animatedly scrolling), if it is not fully visible. This may use animation
20461     * to do so and take a period of time
20462     *
20463     * The item will be positioned at the top of the genlist viewport.
20464     *
20465     * @see elm_genlist_item_bring_in()
20466     * @see elm_genlist_item_top_show()
20467     *
20468     * @ingroup Genlist
20469     */
20470    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20471
20472    /**
20473     * Show the portion of a genlist's internal list containing a given
20474     * item, immediately.
20475     *
20476     * @param it The item to display
20477     *
20478     * This causes genlist to jump to the given item @p it and show it (by
20479     * immediately scrolling to that position), if it is not fully visible.
20480     *
20481     * The item will be positioned at the middle of the genlist viewport.
20482     *
20483     * @see elm_genlist_item_show()
20484     * @see elm_genlist_item_middle_bring_in()
20485     *
20486     * @ingroup Genlist
20487     */
20488    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20489
20490    /**
20491     * Animatedly bring in, to the visible are of a genlist, a given
20492     * item on it.
20493     *
20494     * @param it The item
20495     *
20496     * This causes genlist to jump to the given item @p it and show it (by
20497     * animatedly scrolling), if it is not fully visible. This may use animation
20498     * to do so and take a period of time
20499     *
20500     * The item will be positioned at the middle of the genlist viewport.
20501     *
20502     * @see elm_genlist_item_bring_in()
20503     * @see elm_genlist_item_middle_show()
20504     *
20505     * @ingroup Genlist
20506     */
20507    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20508
20509    /**
20510     * Remove a genlist item from the its parent, deleting it.
20511     *
20512     * @param item The item to be removed.
20513     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
20514     *
20515     * @see elm_genlist_clear(), to remove all items in a genlist at
20516     * once.
20517     *
20518     * @ingroup Genlist
20519     */
20520    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20521
20522    /**
20523     * Return the data associated to a given genlist item
20524     *
20525     * @param item The genlist item.
20526     * @return the data associated to this item.
20527     *
20528     * This returns the @c data value passed on the
20529     * elm_genlist_item_append() and related item addition calls.
20530     *
20531     * @see elm_genlist_item_append()
20532     * @see elm_genlist_item_data_set()
20533     *
20534     * @ingroup Genlist
20535     */
20536    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20537
20538    /**
20539     * Set the data associated to a given genlist item
20540     *
20541     * @param item The genlist item
20542     * @param data The new data pointer to set on it
20543     *
20544     * This @b overrides the @c data value passed on the
20545     * elm_genlist_item_append() and related item addition calls. This
20546     * function @b won't call elm_genlist_item_update() automatically,
20547     * so you'd issue it afterwards if you want to hove the item
20548     * updated to reflect the that new data.
20549     *
20550     * @see elm_genlist_item_data_get()
20551     *
20552     * @ingroup Genlist
20553     */
20554    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
20555
20556    /**
20557     * Tells genlist to "orphan" contents fetchs by the item class
20558     *
20559     * @param it The item
20560     *
20561     * This instructs genlist to release references to contents in the item,
20562     * meaning that they will no longer be managed by genlist and are
20563     * floating "orphans" that can be re-used elsewhere if the user wants
20564     * to.
20565     *
20566     * @ingroup Genlist
20567     */
20568    EAPI void               elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20569    EINA_DEPRECATED EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20570
20571    /**
20572     * Get the real Evas object created to implement the view of a
20573     * given genlist item
20574     *
20575     * @param item The genlist item.
20576     * @return the Evas object implementing this item's view.
20577     *
20578     * This returns the actual Evas object used to implement the
20579     * specified genlist item's view. This may be @c NULL, as it may
20580     * not have been created or may have been deleted, at any time, by
20581     * the genlist. <b>Do not modify this object</b> (move, resize,
20582     * show, hide, etc.), as the genlist is controlling it. This
20583     * function is for querying, emitting custom signals or hooking
20584     * lower level callbacks for events on that object. Do not delete
20585     * this object under any circumstances.
20586     *
20587     * @see elm_genlist_item_data_get()
20588     *
20589     * @ingroup Genlist
20590     */
20591    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20592
20593    /**
20594     * Update the contents of an item
20595     *
20596     * @param it The item
20597     *
20598     * This updates an item by calling all the item class functions again
20599     * to get the contents, texts and states. Use this when the original
20600     * item data has changed and the changes are desired to be reflected.
20601     *
20602     * Use elm_genlist_realized_items_update() to update all already realized
20603     * items.
20604     *
20605     * @see elm_genlist_realized_items_update()
20606     *
20607     * @ingroup Genlist
20608     */
20609    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20610
20611    /**
20612     * Promote an item to the top of the list
20613     *
20614     * @param it The item
20615     *
20616     * @ingroup Genlist
20617     */
20618    EAPI void               elm_genlist_item_promote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
20619
20620    /**
20621     * Demote an item to the end of the list
20622     *
20623     * @param it The item
20624     *
20625     * @ingroup Genlist
20626     */
20627    EAPI void               elm_genlist_item_demote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
20628
20629    /**
20630     * Update the part of an item
20631     *
20632     * @param it The item
20633     * @param parts The name of item's part
20634     * @param itf The flags of item's part type
20635     *
20636     * This updates an item's part by calling item's fetching functions again
20637     * to get the contents, texts and states. Use this when the original
20638     * item data has changed and the changes are desired to be reflected.
20639     * Second parts argument is used for globbing to match '*', '?', and '.'
20640     * It can be used at updating multi fields.
20641     *
20642     * Use elm_genlist_realized_items_update() to update an item's all
20643     * property.
20644     *
20645     * @see elm_genlist_item_update()
20646     *
20647     * @ingroup Genlist
20648     */
20649    EAPI void               elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
20650
20651    /**
20652     * Update the item class of an item
20653     *
20654     * @param it The item
20655     * @param itc The item class for the item
20656     *
20657     * This sets another class fo the item, changing the way that it is
20658     * displayed. After changing the item class, elm_genlist_item_update() is
20659     * called on the item @p it.
20660     *
20661     * @ingroup Genlist
20662     */
20663    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
20664    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20665
20666    /**
20667     * Set the text to be shown in a given genlist item's tooltips.
20668     *
20669     * @param item The genlist item
20670     * @param text The text to set in the content
20671     *
20672     * This call will setup the text to be used as tooltip to that item
20673     * (analogous to elm_object_tooltip_text_set(), but being item
20674     * tooltips with higher precedence than object tooltips). It can
20675     * have only one tooltip at a time, so any previous tooltip data
20676     * will get removed.
20677     *
20678     * In order to set a content or something else as a tooltip, look at
20679     * elm_genlist_item_tooltip_content_cb_set().
20680     *
20681     * @ingroup Genlist
20682     */
20683    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
20684
20685    /**
20686     * Set the content to be shown in a given genlist item's tooltips
20687     *
20688     * @param item The genlist item.
20689     * @param func The function returning the tooltip contents.
20690     * @param data What to provide to @a func as callback data/context.
20691     * @param del_cb Called when data is not needed anymore, either when
20692     *        another callback replaces @p func, the tooltip is unset with
20693     *        elm_genlist_item_tooltip_unset() or the owner @p item
20694     *        dies. This callback receives as its first parameter the
20695     *        given @p data, being @c event_info the item handle.
20696     *
20697     * This call will setup the tooltip's contents to @p item
20698     * (analogous to elm_object_tooltip_content_cb_set(), but being
20699     * item tooltips with higher precedence than object tooltips). It
20700     * can have only one tooltip at a time, so any previous tooltip
20701     * content will get removed. @p func (with @p data) will be called
20702     * every time Elementary needs to show the tooltip and it should
20703     * return a valid Evas object, which will be fully managed by the
20704     * tooltip system, getting deleted when the tooltip is gone.
20705     *
20706     * In order to set just a text as a tooltip, look at
20707     * elm_genlist_item_tooltip_text_set().
20708     *
20709     * @ingroup Genlist
20710     */
20711    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);
20712
20713    /**
20714     * Unset a tooltip from a given genlist item
20715     *
20716     * @param item genlist item to remove a previously set tooltip from.
20717     *
20718     * This call removes any tooltip set on @p item. The callback
20719     * provided as @c del_cb to
20720     * elm_genlist_item_tooltip_content_cb_set() will be called to
20721     * notify it is not used anymore (and have resources cleaned, if
20722     * need be).
20723     *
20724     * @see elm_genlist_item_tooltip_content_cb_set()
20725     *
20726     * @ingroup Genlist
20727     */
20728    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20729
20730    /**
20731     * Set a different @b style for a given genlist item's tooltip.
20732     *
20733     * @param item genlist item with tooltip set
20734     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
20735     * "default", @c "transparent", etc)
20736     *
20737     * Tooltips can have <b>alternate styles</b> to be displayed on,
20738     * which are defined by the theme set on Elementary. This function
20739     * works analogously as elm_object_tooltip_style_set(), but here
20740     * applied only to genlist item objects. The default style for
20741     * tooltips is @c "default".
20742     *
20743     * @note before you set a style you should define a tooltip with
20744     *       elm_genlist_item_tooltip_content_cb_set() or
20745     *       elm_genlist_item_tooltip_text_set()
20746     *
20747     * @see elm_genlist_item_tooltip_style_get()
20748     *
20749     * @ingroup Genlist
20750     */
20751    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
20752
20753    /**
20754     * Get the style set a given genlist item's tooltip.
20755     *
20756     * @param item genlist item with tooltip already set on.
20757     * @return style the theme style in use, which defaults to
20758     *         "default". If the object does not have a tooltip set,
20759     *         then @c NULL is returned.
20760     *
20761     * @see elm_genlist_item_tooltip_style_set() for more details
20762     *
20763     * @ingroup Genlist
20764     */
20765    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20766
20767    /**
20768     * @brief Disable size restrictions on an object's tooltip
20769     * @param item The tooltip's anchor object
20770     * @param disable If EINA_TRUE, size restrictions are disabled
20771     * @return EINA_FALSE on failure, EINA_TRUE on success
20772     *
20773     * This function allows a tooltip to expand beyond its parant window's canvas.
20774     * It will instead be limited only by the size of the display.
20775     */
20776    EAPI Eina_Bool          elm_genlist_item_tooltip_window_mode_set(Elm_Genlist_Item *item, Eina_Bool disable);
20777
20778    /**
20779     * @brief Retrieve size restriction state of an object's tooltip
20780     * @param item The tooltip's anchor object
20781     * @return If EINA_TRUE, size restrictions are disabled
20782     *
20783     * This function returns whether a tooltip is allowed to expand beyond
20784     * its parant window's canvas.
20785     * It will instead be limited only by the size of the display.
20786     */
20787    EAPI Eina_Bool          elm_genlist_item_tooltip_window_mode_get(const Elm_Genlist_Item *item);
20788
20789    /**
20790     * Set the type of mouse pointer/cursor decoration to be shown,
20791     * when the mouse pointer is over the given genlist widget item
20792     *
20793     * @param item genlist item to customize cursor on
20794     * @param cursor the cursor type's name
20795     *
20796     * This function works analogously as elm_object_cursor_set(), but
20797     * here the cursor's changing area is restricted to the item's
20798     * area, and not the whole widget's. Note that that item cursors
20799     * have precedence over widget cursors, so that a mouse over @p
20800     * item will always show cursor @p type.
20801     *
20802     * If this function is called twice for an object, a previously set
20803     * cursor will be unset on the second call.
20804     *
20805     * @see elm_object_cursor_set()
20806     * @see elm_genlist_item_cursor_get()
20807     * @see elm_genlist_item_cursor_unset()
20808     *
20809     * @ingroup Genlist
20810     */
20811    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
20812
20813    /**
20814     * Get the type of mouse pointer/cursor decoration set to be shown,
20815     * when the mouse pointer is over the given genlist widget item
20816     *
20817     * @param item genlist item with custom cursor set
20818     * @return the cursor type's name or @c NULL, if no custom cursors
20819     * were set to @p item (and on errors)
20820     *
20821     * @see elm_object_cursor_get()
20822     * @see elm_genlist_item_cursor_set() for more details
20823     * @see elm_genlist_item_cursor_unset()
20824     *
20825     * @ingroup Genlist
20826     */
20827    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20828
20829    /**
20830     * Unset any custom mouse pointer/cursor decoration set to be
20831     * shown, when the mouse pointer is over the given genlist widget
20832     * item, thus making it show the @b default cursor again.
20833     *
20834     * @param item a genlist item
20835     *
20836     * Use this call to undo any custom settings on this item's cursor
20837     * decoration, bringing it back to defaults (no custom style set).
20838     *
20839     * @see elm_object_cursor_unset()
20840     * @see elm_genlist_item_cursor_set() for more details
20841     *
20842     * @ingroup Genlist
20843     */
20844    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20845
20846    /**
20847     * Set a different @b style for a given custom cursor set for a
20848     * genlist item.
20849     *
20850     * @param item genlist item with custom cursor set
20851     * @param style the <b>theme style</b> to use (e.g. @c "default",
20852     * @c "transparent", etc)
20853     *
20854     * This function only makes sense when one is using custom mouse
20855     * cursor decorations <b>defined in a theme file</b> , which can
20856     * have, given a cursor name/type, <b>alternate styles</b> on
20857     * it. It works analogously as elm_object_cursor_style_set(), but
20858     * here applied only to genlist item objects.
20859     *
20860     * @warning Before you set a cursor style you should have defined a
20861     *       custom cursor previously on the item, with
20862     *       elm_genlist_item_cursor_set()
20863     *
20864     * @see elm_genlist_item_cursor_engine_only_set()
20865     * @see elm_genlist_item_cursor_style_get()
20866     *
20867     * @ingroup Genlist
20868     */
20869    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
20870
20871    /**
20872     * Get the current @b style set for a given genlist item's custom
20873     * cursor
20874     *
20875     * @param item genlist item with custom cursor set.
20876     * @return style the cursor style in use. If the object does not
20877     *         have a cursor set, then @c NULL is returned.
20878     *
20879     * @see elm_genlist_item_cursor_style_set() for more details
20880     *
20881     * @ingroup Genlist
20882     */
20883    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20884
20885    /**
20886     * Set if the (custom) cursor for a given genlist item should be
20887     * searched in its theme, also, or should only rely on the
20888     * rendering engine.
20889     *
20890     * @param item item with custom (custom) cursor already set on
20891     * @param engine_only Use @c EINA_TRUE to have cursors looked for
20892     * only on those provided by the rendering engine, @c EINA_FALSE to
20893     * have them searched on the widget's theme, as well.
20894     *
20895     * @note This call is of use only if you've set a custom cursor
20896     * for genlist items, with elm_genlist_item_cursor_set().
20897     *
20898     * @note By default, cursors will only be looked for between those
20899     * provided by the rendering engine.
20900     *
20901     * @ingroup Genlist
20902     */
20903    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
20904
20905    /**
20906     * Get if the (custom) cursor for a given genlist item is being
20907     * searched in its theme, also, or is only relying on the rendering
20908     * engine.
20909     *
20910     * @param item a genlist item
20911     * @return @c EINA_TRUE, if cursors are being looked for only on
20912     * those provided by the rendering engine, @c EINA_FALSE if they
20913     * are being searched on the widget's theme, as well.
20914     *
20915     * @see elm_genlist_item_cursor_engine_only_set(), for more details
20916     *
20917     * @ingroup Genlist
20918     */
20919    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20920
20921    /**
20922     * Get the index of the item. It is only valid once displayed.
20923     *
20924     * @param item a genlist item
20925     * @return the position inside the list of item.
20926     *
20927     * @ingroup Genlist
20928     */
20929    EAPI int elm_genlist_item_index_get(Elm_Gen_Item *it);
20930
20931    /**
20932     * Update the contents of all realized items.
20933     *
20934     * @param obj The genlist object.
20935     *
20936     * This updates all realized items by calling all the item class functions again
20937     * to get the contents, texts and states. Use this when the original
20938     * item data has changed and the changes are desired to be reflected.
20939     *
20940     * To update just one item, use elm_genlist_item_update().
20941     *
20942     * @see elm_genlist_realized_items_get()
20943     * @see elm_genlist_item_update()
20944     *
20945     * @ingroup Genlist
20946     */
20947    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
20948
20949    /**
20950     * Activate a genlist mode on an item
20951     *
20952     * @param item The genlist item
20953     * @param mode Mode name
20954     * @param mode_set Boolean to define set or unset mode.
20955     *
20956     * A genlist mode is a different way of selecting an item. Once a mode is
20957     * activated on an item, any other selected item is immediately unselected.
20958     * This feature provides an easy way of implementing a new kind of animation
20959     * for selecting an item, without having to entirely rewrite the item style
20960     * theme. However, the elm_genlist_selected_* API can't be used to get what
20961     * item is activate for a mode.
20962     *
20963     * The current item style will still be used, but applying a genlist mode to
20964     * an item will select it using a different kind of animation.
20965     *
20966     * The current active item for a mode can be found by
20967     * elm_genlist_mode_item_get().
20968     *
20969     * The characteristics of genlist mode are:
20970     * - Only one mode can be active at any time, and for only one item.
20971     * - Genlist handles deactivating other items when one item is activated.
20972     * - A mode is defined in the genlist theme (edc), and more modes can easily
20973     *   be added.
20974     * - A mode style and the genlist item style are different things. They
20975     *   can be combined to provide a default style to the item, with some kind
20976     *   of animation for that item when the mode is activated.
20977     *
20978     * When a mode is activated on an item, a new view for that item is created.
20979     * The theme of this mode defines the animation that will be used to transit
20980     * the item from the old view to the new view. This second (new) view will be
20981     * active for that item while the mode is active on the item, and will be
20982     * destroyed after the mode is totally deactivated from that item.
20983     *
20984     * @see elm_genlist_mode_get()
20985     * @see elm_genlist_mode_item_get()
20986     *
20987     * @ingroup Genlist
20988     */
20989    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
20990
20991    /**
20992     * Get the last (or current) genlist mode used.
20993     *
20994     * @param obj The genlist object
20995     *
20996     * This function just returns the name of the last used genlist mode. It will
20997     * be the current mode if it's still active.
20998     *
20999     * @see elm_genlist_item_mode_set()
21000     * @see elm_genlist_mode_item_get()
21001     *
21002     * @ingroup Genlist
21003     */
21004    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21005
21006    /**
21007     * Get active genlist mode item
21008     *
21009     * @param obj The genlist object
21010     * @return The active item for that current mode. Or @c NULL if no item is
21011     * activated with any mode.
21012     *
21013     * This function returns the item that was activated with a mode, by the
21014     * function elm_genlist_item_mode_set().
21015     *
21016     * @see elm_genlist_item_mode_set()
21017     * @see elm_genlist_mode_get()
21018     *
21019     * @ingroup Genlist
21020     */
21021    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21022
21023    /**
21024     * Set reorder mode
21025     *
21026     * @param obj The genlist object
21027     * @param reorder_mode The reorder mode
21028     * (EINA_TRUE = on, EINA_FALSE = off)
21029     *
21030     * @ingroup Genlist
21031     */
21032    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
21033
21034    /**
21035     * Get the reorder mode
21036     *
21037     * @param obj The genlist object
21038     * @return The reorder mode
21039     * (EINA_TRUE = on, EINA_FALSE = off)
21040     *
21041     * @ingroup Genlist
21042     */
21043    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21044
21045    /**
21046     * @}
21047     */
21048
21049    /**
21050     * @defgroup Check Check
21051     *
21052     * @image html img/widget/check/preview-00.png
21053     * @image latex img/widget/check/preview-00.eps
21054     * @image html img/widget/check/preview-01.png
21055     * @image latex img/widget/check/preview-01.eps
21056     * @image html img/widget/check/preview-02.png
21057     * @image latex img/widget/check/preview-02.eps
21058     *
21059     * @brief The check widget allows for toggling a value between true and
21060     * false.
21061     *
21062     * Check objects are a lot like radio objects in layout and functionality
21063     * except they do not work as a group, but independently and only toggle the
21064     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
21065     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
21066     * returns the current state. For convenience, like the radio objects, you
21067     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
21068     * for it to modify.
21069     *
21070     * Signals that you can add callbacks for are:
21071     * "changed" - This is called whenever the user changes the state of one of
21072     *             the check object(event_info is NULL).
21073     *
21074     * Default contents parts of the check widget that you can use for are:
21075     * @li "icon" - An icon of the check
21076     *
21077     * Default text parts of the check widget that you can use for are:
21078     * @li "elm.text" - Label of the check
21079     *
21080     * @ref tutorial_check should give you a firm grasp of how to use this widget
21081     * .
21082     * @{
21083     */
21084    /**
21085     * @brief Add a new Check object
21086     *
21087     * @param parent The parent object
21088     * @return The new object or NULL if it cannot be created
21089     */
21090    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21091
21092    /**
21093     * @brief Set the text label of the check object
21094     *
21095     * @param obj The check object
21096     * @param label The text label string in UTF-8
21097     *
21098     * @deprecated use elm_object_text_set() instead.
21099     */
21100    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21101
21102    /**
21103     * @brief Get the text label of the check object
21104     *
21105     * @param obj The check object
21106     * @return The text label string in UTF-8
21107     *
21108     * @deprecated use elm_object_text_get() instead.
21109     */
21110    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21111
21112    /**
21113     * @brief Set the icon object of the check object
21114     *
21115     * @param obj The check object
21116     * @param icon The icon object
21117     *
21118     * Once the icon object is set, a previously set one will be deleted.
21119     * If you want to keep that old content object, use the
21120     * elm_object_content_unset() function.
21121     *
21122     * @deprecated use elm_object_part_content_set() instead.
21123     *
21124     */
21125    EINA_DEPRECATED EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21126
21127    /**
21128     * @brief Get the icon object of the check object
21129     *
21130     * @param obj The check object
21131     * @return The icon object
21132     *
21133     * @deprecated use elm_object_part_content_get() instead.
21134     *
21135     */
21136    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21137
21138    /**
21139     * @brief Unset the icon used for the check object
21140     *
21141     * @param obj The check object
21142     * @return The icon object that was being used
21143     *
21144     * Unparent and return the icon object which was set for this widget.
21145     *
21146     * @deprecated use elm_object_part_content_unset() instead.
21147     *
21148     */
21149    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21150
21151    /**
21152     * @brief Set the on/off state of the check object
21153     *
21154     * @param obj The check object
21155     * @param state The state to use (1 == on, 0 == off)
21156     *
21157     * This sets the state of the check. If set
21158     * with elm_check_state_pointer_set() the state of that variable is also
21159     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
21160     */
21161    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21162
21163    /**
21164     * @brief Get the state of the check object
21165     *
21166     * @param obj The check object
21167     * @return The boolean state
21168     */
21169    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21170
21171    /**
21172     * @brief Set a convenience pointer to a boolean to change
21173     *
21174     * @param obj The check object
21175     * @param statep Pointer to the boolean to modify
21176     *
21177     * This sets a pointer to a boolean, that, in addition to the check objects
21178     * state will also be modified directly. To stop setting the object pointed
21179     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
21180     * then when this is called, the check objects state will also be modified to
21181     * reflect the value of the boolean @p statep points to, just like calling
21182     * elm_check_state_set().
21183     */
21184    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
21185    EINA_DEPRECATED EAPI void         elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
21186    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);
21187
21188    /**
21189     * @}
21190     */
21191
21192    /**
21193     * @defgroup Radio Radio
21194     *
21195     * @image html img/widget/radio/preview-00.png
21196     * @image latex img/widget/radio/preview-00.eps
21197     *
21198     * @brief Radio is a widget that allows for 1 or more options to be displayed
21199     * and have the user choose only 1 of them.
21200     *
21201     * A radio object contains an indicator, an optional Label and an optional
21202     * icon object. While it's possible to have a group of only one radio they,
21203     * are normally used in groups of 2 or more. To add a radio to a group use
21204     * elm_radio_group_add(). The radio object(s) will select from one of a set
21205     * of integer values, so any value they are configuring needs to be mapped to
21206     * a set of integers. To configure what value that radio object represents,
21207     * use  elm_radio_state_value_set() to set the integer it represents. To set
21208     * the value the whole group(which one is currently selected) is to indicate
21209     * use elm_radio_value_set() on any group member, and to get the groups value
21210     * use elm_radio_value_get(). For convenience the radio objects are also able
21211     * to directly set an integer(int) to the value that is selected. To specify
21212     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
21213     * The radio objects will modify this directly. That implies the pointer must
21214     * point to valid memory for as long as the radio objects exist.
21215     *
21216     * Signals that you can add callbacks for are:
21217     * @li changed - This is called whenever the user changes the state of one of
21218     * the radio objects within the group of radio objects that work together.
21219     *
21220     * Default contents parts of the radio widget that you can use for are:
21221     * @li "icon" - An icon of the radio
21222     *
21223     * @ref tutorial_radio show most of this API in action.
21224     * @{
21225     */
21226
21227    /**
21228     * @brief Add a new radio to the parent
21229     *
21230     * @param parent The parent object
21231     * @return The new object or NULL if it cannot be created
21232     */
21233    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21234
21235    /**
21236     * @brief Set the text label of the radio object
21237     *
21238     * @param obj The radio object
21239     * @param label The text label string in UTF-8
21240     *
21241     * @deprecated use elm_object_text_set() instead.
21242     */
21243    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21244
21245    /**
21246     * @brief Get the text label of the radio object
21247     *
21248     * @param obj The radio object
21249     * @return The text label string in UTF-8
21250     *
21251     * @deprecated use elm_object_text_set() instead.
21252     */
21253    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21254
21255    /**
21256     * @brief Set the icon object of the radio object
21257     *
21258     * @param obj The radio object
21259     * @param icon The icon object
21260     *
21261     * Once the icon object is set, a previously set one will be deleted. If you
21262     * want to keep that old content object, use the elm_radio_icon_unset()
21263     * function.
21264     *
21265     * @deprecated use elm_object_part_content_set() instead.
21266     *
21267     */
21268    EINA_DEPRECATED EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21269
21270    /**
21271     * @brief Get the icon object of the radio object
21272     *
21273     * @param obj The radio object
21274     * @return The icon object
21275     *
21276     * @see elm_radio_icon_set()
21277     *
21278     * @deprecated use elm_object_part_content_get() instead.
21279     *
21280     */
21281    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21282
21283    /**
21284     * @brief Unset the icon used for the radio object
21285     *
21286     * @param obj The radio object
21287     * @return The icon object that was being used
21288     *
21289     * Unparent and return the icon object which was set for this widget.
21290     *
21291     * @see elm_radio_icon_set()
21292     * @deprecated use elm_object_part_content_unset() instead.
21293     *
21294     */
21295    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21296
21297    /**
21298     * @brief Add this radio to a group of other radio objects
21299     *
21300     * @param obj The radio object
21301     * @param group Any object whose group the @p obj is to join.
21302     *
21303     * Radio objects work in groups. Each member should have a different integer
21304     * value assigned. In order to have them work as a group, they need to know
21305     * about each other. This adds the given radio object to the group of which
21306     * the group object indicated is a member.
21307     */
21308    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
21309
21310    /**
21311     * @brief Set the integer value that this radio object represents
21312     *
21313     * @param obj The radio object
21314     * @param value The value to use if this radio object is selected
21315     *
21316     * This sets the value of the radio.
21317     */
21318    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
21319
21320    /**
21321     * @brief Get the integer value that this radio object represents
21322     *
21323     * @param obj The radio object
21324     * @return The value used if this radio object is selected
21325     *
21326     * This gets the value of the radio.
21327     *
21328     * @see elm_radio_value_set()
21329     */
21330    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21331
21332    /**
21333     * @brief Set the value of the radio.
21334     *
21335     * @param obj The radio object
21336     * @param value The value to use for the group
21337     *
21338     * This sets the value of the radio group and will also set the value if
21339     * pointed to, to the value supplied, but will not call any callbacks.
21340     */
21341    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
21342
21343    /**
21344     * @brief Get the state of the radio object
21345     *
21346     * @param obj The radio object
21347     * @return The integer state
21348     */
21349    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21350
21351    /**
21352     * @brief Set a convenience pointer to a integer to change
21353     *
21354     * @param obj The radio object
21355     * @param valuep Pointer to the integer to modify
21356     *
21357     * This sets a pointer to a integer, that, in addition to the radio objects
21358     * state will also be modified directly. To stop setting the object pointed
21359     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
21360     * when this is called, the radio objects state will also be modified to
21361     * reflect the value of the integer valuep points to, just like calling
21362     * elm_radio_value_set().
21363     */
21364    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
21365
21366    /**
21367     * @}
21368     */
21369
21370    /**
21371     * @defgroup Pager Pager
21372     *
21373     * @image html img/widget/pager/preview-00.png
21374     * @image latex img/widget/pager/preview-00.eps
21375     *
21376     * @brief Widget that allows flipping between one or more ā€œpagesā€
21377     * of objects.
21378     *
21379     * The flipping between pages of objects is animated. All content
21380     * in the pager is kept in a stack, being the last content added
21381     * (visible one) on the top of that stack.
21382     *
21383     * Objects can be pushed or popped from the stack or deleted as
21384     * well. Pushes and pops will animate the widget accordingly to its
21385     * style (a pop will also delete the child object once the
21386     * animation is finished). Any object already in the pager can be
21387     * promoted to the top (from its current stacking position) through
21388     * the use of elm_pager_content_promote(). New objects are pushed
21389     * to the top with elm_pager_content_push(). When the top item is
21390     * no longer wanted, simply pop it with elm_pager_content_pop() and
21391     * it will also be deleted. If an object is no longer needed and is
21392     * not the top item, just delete it as normal. You can query which
21393     * objects are the top and bottom with
21394     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
21395     *
21396     * Signals that you can add callbacks for are:
21397     * - @c "show,finished" - when a new page is actually shown on the top
21398     * - @c "hide,finished" - when a previous page is hidden
21399     *
21400     * Only after the first of that signals the child object is
21401     * guaranteed to be visible, as in @c evas_object_visible_get().
21402     *
21403     * This widget has the following styles available:
21404     * - @c "default"
21405     * - @c "fade"
21406     * - @c "fade_translucide"
21407     * - @c "fade_invisible"
21408     *
21409     * @note These styles affect only the flipping animations on the
21410     * default theme; the appearance when not animating is unaffected
21411     * by them.
21412     *
21413     * @ref tutorial_pager gives a good overview of the usage of the API.
21414     * @{
21415     */
21416
21417    /**
21418     * Add a new pager to the parent
21419     *
21420     * @param parent The parent object
21421     * @return The new object or NULL if it cannot be created
21422     *
21423     * @ingroup Pager
21424     */
21425    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21426
21427    /**
21428     * @brief Push an object to the top of the pager stack (and show it).
21429     *
21430     * @param obj The pager object
21431     * @param content The object to push
21432     *
21433     * The object pushed becomes a child of the pager, it will be controlled and
21434     * deleted when the pager is deleted.
21435     *
21436     * @note If the content is already in the stack use
21437     * elm_pager_content_promote().
21438     * @warning Using this function on @p content already in the stack results in
21439     * undefined behavior.
21440     */
21441    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
21442
21443    /**
21444     * @brief Pop the object that is on top of the stack
21445     *
21446     * @param obj The pager object
21447     *
21448     * This pops the object that is on the top(visible) of the pager, makes it
21449     * disappear, then deletes the object. The object that was underneath it on
21450     * the stack will become visible.
21451     */
21452    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
21453
21454    /**
21455     * @brief Moves an object already in the pager stack to the top of the stack.
21456     *
21457     * @param obj The pager object
21458     * @param content The object to promote
21459     *
21460     * This will take the @p content and move it to the top of the stack as
21461     * if it had been pushed there.
21462     *
21463     * @note If the content isn't already in the stack use
21464     * elm_pager_content_push().
21465     * @warning Using this function on @p content not already in the stack
21466     * results in undefined behavior.
21467     */
21468    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
21469
21470    /**
21471     * @brief Return the object at the bottom of the pager stack
21472     *
21473     * @param obj The pager object
21474     * @return The bottom object or NULL if none
21475     */
21476    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21477
21478    /**
21479     * @brief  Return the object at the top of the pager stack
21480     *
21481     * @param obj The pager object
21482     * @return The top object or NULL if none
21483     */
21484    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21485
21486    /**
21487     * @}
21488     */
21489
21490    /**
21491     * @defgroup Slideshow Slideshow
21492     *
21493     * @image html img/widget/slideshow/preview-00.png
21494     * @image latex img/widget/slideshow/preview-00.eps
21495     *
21496     * This widget, as the name indicates, is a pre-made image
21497     * slideshow panel, with API functions acting on (child) image
21498     * items presentation. Between those actions, are:
21499     * - advance to next/previous image
21500     * - select the style of image transition animation
21501     * - set the exhibition time for each image
21502     * - start/stop the slideshow
21503     *
21504     * The transition animations are defined in the widget's theme,
21505     * consequently new animations can be added without having to
21506     * update the widget's code.
21507     *
21508     * @section Slideshow_Items Slideshow items
21509     *
21510     * For slideshow items, just like for @ref Genlist "genlist" ones,
21511     * the user defines a @b classes, specifying functions that will be
21512     * called on the item's creation and deletion times.
21513     *
21514     * The #Elm_Slideshow_Item_Class structure contains the following
21515     * members:
21516     *
21517     * - @c func.get - When an item is displayed, this function is
21518     *   called, and it's where one should create the item object, de
21519     *   facto. For example, the object can be a pure Evas image object
21520     *   or an Elementary @ref Photocam "photocam" widget. See
21521     *   #SlideshowItemGetFunc.
21522     * - @c func.del - When an item is no more displayed, this function
21523     *   is called, where the user must delete any data associated to
21524     *   the item. See #SlideshowItemDelFunc.
21525     *
21526     * @section Slideshow_Caching Slideshow caching
21527     *
21528     * The slideshow provides facilities to have items adjacent to the
21529     * one being displayed <b>already "realized"</b> (i.e. loaded) for
21530     * you, so that the system does not have to decode image data
21531     * anymore at the time it has to actually switch images on its
21532     * viewport. The user is able to set the numbers of items to be
21533     * cached @b before and @b after the current item, in the widget's
21534     * item list.
21535     *
21536     * Smart events one can add callbacks for are:
21537     *
21538     * - @c "changed" - when the slideshow switches its view to a new
21539     *   item. event_info parameter in callback contains the current visible item
21540     * - @c "transition,end" - when a slide transition ends. event_info parameter
21541     *   in callback contains the current visible item
21542     *
21543     * List of examples for the slideshow widget:
21544     * @li @ref slideshow_example
21545     */
21546
21547    /**
21548     * @addtogroup Slideshow
21549     * @{
21550     */
21551
21552    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
21553    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
21554    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
21555    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
21556
21557    /**
21558     * @struct _Elm_Slideshow_Item_Class
21559     *
21560     * Slideshow item class definition. See @ref Slideshow_Items for
21561     * field details.
21562     */
21563    struct _Elm_Slideshow_Item_Class
21564      {
21565         struct _Elm_Slideshow_Item_Class_Func
21566           {
21567              SlideshowItemGetFunc get;
21568              SlideshowItemDelFunc del;
21569           } func;
21570      }; /**< #Elm_Slideshow_Item_Class member definitions */
21571
21572    /**
21573     * Add a new slideshow widget to the given parent Elementary
21574     * (container) object
21575     *
21576     * @param parent The parent object
21577     * @return A new slideshow widget handle or @c NULL, on errors
21578     *
21579     * This function inserts a new slideshow widget on the canvas.
21580     *
21581     * @ingroup Slideshow
21582     */
21583    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21584
21585    /**
21586     * Add (append) a new item in a given slideshow widget.
21587     *
21588     * @param obj The slideshow object
21589     * @param itc The item class for the item
21590     * @param data The item's data
21591     * @return A handle to the item added or @c NULL, on errors
21592     *
21593     * Add a new item to @p obj's internal list of items, appending it.
21594     * The item's class must contain the function really fetching the
21595     * image object to show for this item, which could be an Evas image
21596     * object or an Elementary photo, for example. The @p data
21597     * parameter is going to be passed to both class functions of the
21598     * item.
21599     *
21600     * @see #Elm_Slideshow_Item_Class
21601     * @see elm_slideshow_item_sorted_insert()
21602     * @see elm_object_item_data_set()
21603     *
21604     * @ingroup Slideshow
21605     */
21606    EAPI Elm_Object_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
21607
21608    /**
21609     * Insert a new item into the given slideshow widget, using the @p func
21610     * function to sort items (by item handles).
21611     *
21612     * @param obj The slideshow object
21613     * @param itc The item class for the item
21614     * @param data The item's data
21615     * @param func The comparing function to be used to sort slideshow
21616     * items <b>by #Elm_Slideshow_Item item handles</b>
21617     * @return Returns The slideshow item handle, on success, or
21618     * @c NULL, on errors
21619     *
21620     * Add a new item to @p obj's internal list of items, in a position
21621     * determined by the @p func comparing function. The item's class
21622     * must contain the function really fetching the image object to
21623     * show for this item, which could be an Evas image object or an
21624     * Elementary photo, for example. The @p data parameter is going to
21625     * be passed to both class functions of the item.
21626     *
21627     * @see #Elm_Slideshow_Item_Class
21628     * @see elm_slideshow_item_add()
21629     *
21630     * @ingroup Slideshow
21631     */
21632    EAPI Elm_Object_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);
21633
21634    /**
21635     * Display a given slideshow widget's item, programmatically.
21636     *
21637     * @param it The item to display on @p obj's viewport
21638     *
21639     * The change between the current item and @p item will use the
21640     * transition @p obj is set to use (@see
21641     * elm_slideshow_transition_set()).
21642     *
21643     * @ingroup Slideshow
21644     */
21645    EAPI void                elm_slideshow_show(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
21646
21647    /**
21648     * Slide to the @b next item, in a given slideshow widget
21649     *
21650     * @param obj The slideshow object
21651     *
21652     * The sliding animation @p obj is set to use will be the
21653     * transition effect used, after this call is issued.
21654     *
21655     * @note If the end of the slideshow's internal list of items is
21656     * reached, it'll wrap around to the list's beginning, again.
21657     *
21658     * @ingroup Slideshow
21659     */
21660    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
21661
21662    /**
21663     * Slide to the @b previous item, in a given slideshow widget
21664     *
21665     * @param obj The slideshow object
21666     *
21667     * The sliding animation @p obj is set to use will be the
21668     * transition effect used, after this call is issued.
21669     *
21670     * @note If the beginning of the slideshow's internal list of items
21671     * is reached, it'll wrap around to the list's end, again.
21672     *
21673     * @ingroup Slideshow
21674     */
21675    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
21676
21677    /**
21678     * Returns the list of sliding transition/effect names available, for a
21679     * given slideshow widget.
21680     *
21681     * @param obj The slideshow object
21682     * @return The list of transitions (list of @b stringshared strings
21683     * as data)
21684     *
21685     * The transitions, which come from @p obj's theme, must be an EDC
21686     * data item named @c "transitions" on the theme file, with (prefix)
21687     * names of EDC programs actually implementing them.
21688     *
21689     * The available transitions for slideshows on the default theme are:
21690     * - @c "fade" - the current item fades out, while the new one
21691     *   fades in to the slideshow's viewport.
21692     * - @c "black_fade" - the current item fades to black, and just
21693     *   then, the new item will fade in.
21694     * - @c "horizontal" - the current item slides horizontally, until
21695     *   it gets out of the slideshow's viewport, while the new item
21696     *   comes from the left to take its place.
21697     * - @c "vertical" - the current item slides vertically, until it
21698     *   gets out of the slideshow's viewport, while the new item comes
21699     *   from the bottom to take its place.
21700     * - @c "square" - the new item starts to appear from the middle of
21701     *   the current one, but with a tiny size, growing until its
21702     *   target (full) size and covering the old one.
21703     *
21704     * @warning The stringshared strings get no new references
21705     * exclusive to the user grabbing the list, here, so if you'd like
21706     * to use them out of this call's context, you'd better @c
21707     * eina_stringshare_ref() them.
21708     *
21709     * @see elm_slideshow_transition_set()
21710     *
21711     * @ingroup Slideshow
21712     */
21713    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21714
21715    /**
21716     * Set the current slide transition/effect in use for a given
21717     * slideshow widget
21718     *
21719     * @param obj The slideshow object
21720     * @param transition The new transition's name string
21721     *
21722     * If @p transition is implemented in @p obj's theme (i.e., is
21723     * contained in the list returned by
21724     * elm_slideshow_transitions_get()), this new sliding effect will
21725     * be used on the widget.
21726     *
21727     * @see elm_slideshow_transitions_get() for more details
21728     *
21729     * @ingroup Slideshow
21730     */
21731    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
21732
21733    /**
21734     * Get the current slide transition/effect in use for a given
21735     * slideshow widget
21736     *
21737     * @param obj The slideshow object
21738     * @return The current transition's name
21739     *
21740     * @see elm_slideshow_transition_set() for more details
21741     *
21742     * @ingroup Slideshow
21743     */
21744    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21745
21746    /**
21747     * Set the interval between each image transition on a given
21748     * slideshow widget, <b>and start the slideshow, itself</b>
21749     *
21750     * @param obj The slideshow object
21751     * @param timeout The new displaying timeout for images
21752     *
21753     * After this call, the slideshow widget will start cycling its
21754     * view, sequentially and automatically, with the images of the
21755     * items it has. The time between each new image displayed is going
21756     * to be @p timeout, in @b seconds. If a different timeout was set
21757     * previously and an slideshow was in progress, it will continue
21758     * with the new time between transitions, after this call.
21759     *
21760     * @note A value less than or equal to 0 on @p timeout will disable
21761     * the widget's internal timer, thus halting any slideshow which
21762     * could be happening on @p obj.
21763     *
21764     * @see elm_slideshow_timeout_get()
21765     *
21766     * @ingroup Slideshow
21767     */
21768    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
21769
21770    /**
21771     * Get the interval set for image transitions on a given slideshow
21772     * widget.
21773     *
21774     * @param obj The slideshow object
21775     * @return Returns the timeout set on it
21776     *
21777     * @see elm_slideshow_timeout_set() for more details
21778     *
21779     * @ingroup Slideshow
21780     */
21781    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21782
21783    /**
21784     * Set if, after a slideshow is started, for a given slideshow
21785     * widget, its items should be displayed cyclically or not.
21786     *
21787     * @param obj The slideshow object
21788     * @param loop Use @c EINA_TRUE to make it cycle through items or
21789     * @c EINA_FALSE for it to stop at the end of @p obj's internal
21790     * list of items
21791     *
21792     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
21793     * ignore what is set by this functions, i.e., they'll @b always
21794     * cycle through items. This affects only the "automatic"
21795     * slideshow, as set by elm_slideshow_timeout_set().
21796     *
21797     * @see elm_slideshow_loop_get()
21798     *
21799     * @ingroup Slideshow
21800     */
21801    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
21802
21803    /**
21804     * Get if, after a slideshow is started, for a given slideshow
21805     * widget, its items are to be displayed cyclically or not.
21806     *
21807     * @param obj The slideshow object
21808     * @return @c EINA_TRUE, if the items in @p obj will be cycled
21809     * through or @c EINA_FALSE, otherwise
21810     *
21811     * @see elm_slideshow_loop_set() for more details
21812     *
21813     * @ingroup Slideshow
21814     */
21815    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21816
21817    /**
21818     * Remove all items from a given slideshow widget
21819     *
21820     * @param obj The slideshow object
21821     *
21822     * This removes (and deletes) all items in @p obj, leaving it
21823     * empty.
21824     *
21825     * @see elm_slideshow_item_del(), to remove just one item.
21826     *
21827     * @ingroup Slideshow
21828     */
21829    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21830
21831    /**
21832     * Get the internal list of items in a given slideshow widget.
21833     *
21834     * @param obj The slideshow object
21835     * @return The list of items (#Elm_Object_Item as data) or
21836     * @c NULL on errors.
21837     *
21838     * This list is @b not to be modified in any way and must not be
21839     * freed. Use the list members with functions like
21840     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
21841     *
21842     * @warning This list is only valid until @p obj object's internal
21843     * items list is changed. It should be fetched again with another
21844     * call to this function when changes happen.
21845     *
21846     * @ingroup Slideshow
21847     */
21848    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21849
21850    /**
21851     * Delete a given item from a slideshow widget.
21852     *
21853     * @param it The slideshow item
21854     *
21855     * @ingroup Slideshow
21856     */
21857    EAPI void                elm_slideshow_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
21858
21859    /**
21860     * Return the data associated with a given slideshow item
21861     *
21862     * @param it The slideshow item
21863     * @return Returns the data associated to this item
21864     *
21865     * @deprecated use elm_object_item_data_get() instead
21866     * @ingroup Slideshow
21867     */
21868    EINA_DEPRECATED EAPI void               *elm_slideshow_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
21869
21870    /**
21871     * Returns the currently displayed item, in a given slideshow widget
21872     *
21873     * @param obj The slideshow object
21874     * @return A handle to the item being displayed in @p obj or
21875     * @c NULL, if none is (and on errors)
21876     *
21877     * @ingroup Slideshow
21878     */
21879    EAPI Elm_Object_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21880
21881    /**
21882     * Get the real Evas object created to implement the view of a
21883     * given slideshow item
21884     *
21885     * @param item The slideshow item.
21886     * @return the Evas object implementing this item's view.
21887     *
21888     * This returns the actual Evas object used to implement the
21889     * specified slideshow item's view. This may be @c NULL, as it may
21890     * not have been created or may have been deleted, at any time, by
21891     * the slideshow. <b>Do not modify this object</b> (move, resize,
21892     * show, hide, etc.), as the slideshow is controlling it. This
21893     * function is for querying, emitting custom signals or hooking
21894     * lower level callbacks for events on that object. Do not delete
21895     * this object under any circumstances.
21896     *
21897     * @see elm_slideshow_item_data_get()
21898     *
21899     * @ingroup Slideshow
21900     */
21901    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Object_Item* it) EINA_ARG_NONNULL(1);
21902
21903    /**
21904     * Get the the item, in a given slideshow widget, placed at
21905     * position @p nth, in its internal items list
21906     *
21907     * @param obj The slideshow object
21908     * @param nth The number of the item to grab a handle to (0 being
21909     * the first)
21910     * @return The item stored in @p obj at position @p nth or @c NULL,
21911     * if there's no item with that index (and on errors)
21912     *
21913     * @ingroup Slideshow
21914     */
21915    EAPI Elm_Object_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
21916
21917    /**
21918     * Set the current slide layout in use for a given slideshow widget
21919     *
21920     * @param obj The slideshow object
21921     * @param layout The new layout's name string
21922     *
21923     * If @p layout is implemented in @p obj's theme (i.e., is contained
21924     * in the list returned by elm_slideshow_layouts_get()), this new
21925     * images layout will be used on the widget.
21926     *
21927     * @see elm_slideshow_layouts_get() for more details
21928     *
21929     * @ingroup Slideshow
21930     */
21931    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
21932
21933    /**
21934     * Get the current slide layout in use for a given slideshow widget
21935     *
21936     * @param obj The slideshow object
21937     * @return The current layout's name
21938     *
21939     * @see elm_slideshow_layout_set() for more details
21940     *
21941     * @ingroup Slideshow
21942     */
21943    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21944
21945    /**
21946     * Returns the list of @b layout names available, for a given
21947     * slideshow widget.
21948     *
21949     * @param obj The slideshow object
21950     * @return The list of layouts (list of @b stringshared strings
21951     * as data)
21952     *
21953     * Slideshow layouts will change how the widget is to dispose each
21954     * image item in its viewport, with regard to cropping, scaling,
21955     * etc.
21956     *
21957     * The layouts, which come from @p obj's theme, must be an EDC
21958     * data item name @c "layouts" on the theme file, with (prefix)
21959     * names of EDC programs actually implementing them.
21960     *
21961     * The available layouts for slideshows on the default theme are:
21962     * - @c "fullscreen" - item images with original aspect, scaled to
21963     *   touch top and down slideshow borders or, if the image's heigh
21964     *   is not enough, left and right slideshow borders.
21965     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
21966     *   one, but always leaving 10% of the slideshow's dimensions of
21967     *   distance between the item image's borders and the slideshow
21968     *   borders, for each axis.
21969     *
21970     * @warning The stringshared strings get no new references
21971     * exclusive to the user grabbing the list, here, so if you'd like
21972     * to use them out of this call's context, you'd better @c
21973     * eina_stringshare_ref() them.
21974     *
21975     * @see elm_slideshow_layout_set()
21976     *
21977     * @ingroup Slideshow
21978     */
21979    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21980
21981    /**
21982     * Set the number of items to cache, on a given slideshow widget,
21983     * <b>before the current item</b>
21984     *
21985     * @param obj The slideshow object
21986     * @param count Number of items to cache before the current one
21987     *
21988     * The default value for this property is @c 2. See
21989     * @ref Slideshow_Caching "slideshow caching" for more details.
21990     *
21991     * @see elm_slideshow_cache_before_get()
21992     *
21993     * @ingroup Slideshow
21994     */
21995    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
21996
21997    /**
21998     * Retrieve the number of items to cache, on a given slideshow widget,
21999     * <b>before the current item</b>
22000     *
22001     * @param obj The slideshow object
22002     * @return The number of items set to be cached before the current one
22003     *
22004     * @see elm_slideshow_cache_before_set() for more details
22005     *
22006     * @ingroup Slideshow
22007     */
22008    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22009
22010    /**
22011     * Set the number of items to cache, on a given slideshow widget,
22012     * <b>after the current item</b>
22013     *
22014     * @param obj The slideshow object
22015     * @param count Number of items to cache after the current one
22016     *
22017     * The default value for this property is @c 2. See
22018     * @ref Slideshow_Caching "slideshow caching" for more details.
22019     *
22020     * @see elm_slideshow_cache_after_get()
22021     *
22022     * @ingroup Slideshow
22023     */
22024    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
22025
22026    /**
22027     * Retrieve the number of items to cache, on a given slideshow widget,
22028     * <b>after the current item</b>
22029     *
22030     * @param obj The slideshow object
22031     * @return The number of items set to be cached after the current one
22032     *
22033     * @see elm_slideshow_cache_after_set() for more details
22034     *
22035     * @ingroup Slideshow
22036     */
22037    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22038
22039    /**
22040     * Get the number of items stored in a given slideshow widget
22041     *
22042     * @param obj The slideshow object
22043     * @return The number of items on @p obj, at the moment of this call
22044     *
22045     * @ingroup Slideshow
22046     */
22047    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22048
22049    /**
22050     * @}
22051     */
22052
22053    /**
22054     * @defgroup Fileselector File Selector
22055     *
22056     * @image html img/widget/fileselector/preview-00.png
22057     * @image latex img/widget/fileselector/preview-00.eps
22058     *
22059     * A file selector is a widget that allows a user to navigate
22060     * through a file system, reporting file selections back via its
22061     * API.
22062     *
22063     * It contains shortcut buttons for home directory (@c ~) and to
22064     * jump one directory upwards (..), as well as cancel/ok buttons to
22065     * confirm/cancel a given selection. After either one of those two
22066     * former actions, the file selector will issue its @c "done" smart
22067     * callback.
22068     *
22069     * There's a text entry on it, too, showing the name of the current
22070     * selection. There's the possibility of making it editable, so it
22071     * is useful on file saving dialogs on applications, where one
22072     * gives a file name to save contents to, in a given directory in
22073     * the system. This custom file name will be reported on the @c
22074     * "done" smart callback (explained in sequence).
22075     *
22076     * Finally, it has a view to display file system items into in two
22077     * possible forms:
22078     * - list
22079     * - grid
22080     *
22081     * If Elementary is built with support of the Ethumb thumbnailing
22082     * library, the second form of view will display preview thumbnails
22083     * of files which it supports.
22084     *
22085     * Smart callbacks one can register to:
22086     *
22087     * - @c "selected" - the user has clicked on a file (when not in
22088     *      folders-only mode) or directory (when in folders-only mode)
22089     * - @c "directory,open" - the list has been populated with new
22090     *      content (@c event_info is a pointer to the directory's
22091     *      path, a @b stringshared string)
22092     * - @c "done" - the user has clicked on the "ok" or "cancel"
22093     *      buttons (@c event_info is a pointer to the selection's
22094     *      path, a @b stringshared string)
22095     *
22096     * Here is an example on its usage:
22097     * @li @ref fileselector_example
22098     */
22099
22100    /**
22101     * @addtogroup Fileselector
22102     * @{
22103     */
22104
22105    /**
22106     * Defines how a file selector widget is to layout its contents
22107     * (file system entries).
22108     */
22109    typedef enum _Elm_Fileselector_Mode
22110      {
22111         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
22112         ELM_FILESELECTOR_GRID, /**< layout as a grid */
22113         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
22114      } Elm_Fileselector_Mode;
22115
22116    /**
22117     * Add a new file selector widget to the given parent Elementary
22118     * (container) object
22119     *
22120     * @param parent The parent object
22121     * @return a new file selector widget handle or @c NULL, on errors
22122     *
22123     * This function inserts a new file selector widget on the canvas.
22124     *
22125     * @ingroup Fileselector
22126     */
22127    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22128
22129    /**
22130     * Enable/disable the file name entry box where the user can type
22131     * in a name for a file, in a given file selector widget
22132     *
22133     * @param obj The file selector object
22134     * @param is_save @c EINA_TRUE to make the file selector a "saving
22135     * dialog", @c EINA_FALSE otherwise
22136     *
22137     * Having the entry editable is useful on file saving dialogs on
22138     * applications, where one gives a file name to save contents to,
22139     * in a given directory in the system. This custom file name will
22140     * be reported on the @c "done" smart callback.
22141     *
22142     * @see elm_fileselector_is_save_get()
22143     *
22144     * @ingroup Fileselector
22145     */
22146    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
22147
22148    /**
22149     * Get whether the given file selector is in "saving dialog" mode
22150     *
22151     * @param obj The file selector object
22152     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
22153     * mode, @c EINA_FALSE otherwise (and on errors)
22154     *
22155     * @see elm_fileselector_is_save_set() for more details
22156     *
22157     * @ingroup Fileselector
22158     */
22159    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22160
22161    /**
22162     * Enable/disable folder-only view for a given file selector widget
22163     *
22164     * @param obj The file selector object
22165     * @param only @c EINA_TRUE to make @p obj only display
22166     * directories, @c EINA_FALSE to make files to be displayed in it
22167     * too
22168     *
22169     * If enabled, the widget's view will only display folder items,
22170     * naturally.
22171     *
22172     * @see elm_fileselector_folder_only_get()
22173     *
22174     * @ingroup Fileselector
22175     */
22176    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
22177
22178    /**
22179     * Get whether folder-only view is set for a given file selector
22180     * widget
22181     *
22182     * @param obj The file selector object
22183     * @return only @c EINA_TRUE if @p obj is only displaying
22184     * directories, @c EINA_FALSE if files are being displayed in it
22185     * too (and on errors)
22186     *
22187     * @see elm_fileselector_folder_only_get()
22188     *
22189     * @ingroup Fileselector
22190     */
22191    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22192
22193    /**
22194     * Enable/disable the "ok" and "cancel" buttons on a given file
22195     * selector widget
22196     *
22197     * @param obj The file selector object
22198     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
22199     *
22200     * @note A file selector without those buttons will never emit the
22201     * @c "done" smart event, and is only usable if one is just hooking
22202     * to the other two events.
22203     *
22204     * @see elm_fileselector_buttons_ok_cancel_get()
22205     *
22206     * @ingroup Fileselector
22207     */
22208    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
22209
22210    /**
22211     * Get whether the "ok" and "cancel" buttons on a given file
22212     * selector widget are being shown.
22213     *
22214     * @param obj The file selector object
22215     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
22216     * otherwise (and on errors)
22217     *
22218     * @see elm_fileselector_buttons_ok_cancel_set() for more details
22219     *
22220     * @ingroup Fileselector
22221     */
22222    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22223
22224    /**
22225     * Enable/disable a tree view in the given file selector widget,
22226     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
22227     *
22228     * @param obj The file selector object
22229     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
22230     * disable
22231     *
22232     * In a tree view, arrows are created on the sides of directories,
22233     * allowing them to expand in place.
22234     *
22235     * @note If it's in other mode, the changes made by this function
22236     * will only be visible when one switches back to "list" mode.
22237     *
22238     * @see elm_fileselector_expandable_get()
22239     *
22240     * @ingroup Fileselector
22241     */
22242    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
22243
22244    /**
22245     * Get whether tree view is enabled for the given file selector
22246     * widget
22247     *
22248     * @param obj The file selector object
22249     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
22250     * otherwise (and or errors)
22251     *
22252     * @see elm_fileselector_expandable_set() for more details
22253     *
22254     * @ingroup Fileselector
22255     */
22256    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22257
22258    /**
22259     * Set, programmatically, the @b directory that a given file
22260     * selector widget will display contents from
22261     *
22262     * @param obj The file selector object
22263     * @param path The path to display in @p obj
22264     *
22265     * This will change the @b directory that @p obj is displaying. It
22266     * will also clear the text entry area on the @p obj object, which
22267     * displays select files' names.
22268     *
22269     * @see elm_fileselector_path_get()
22270     *
22271     * @ingroup Fileselector
22272     */
22273    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
22274
22275    /**
22276     * Get the parent directory's path that a given file selector
22277     * widget is displaying
22278     *
22279     * @param obj The file selector object
22280     * @return The (full) path of the directory the file selector is
22281     * displaying, a @b stringshared string
22282     *
22283     * @see elm_fileselector_path_set()
22284     *
22285     * @ingroup Fileselector
22286     */
22287    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22288
22289    /**
22290     * Set, programmatically, the currently selected file/directory in
22291     * the given file selector widget
22292     *
22293     * @param obj The file selector object
22294     * @param path The (full) path to a file or directory
22295     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
22296     * latter case occurs if the directory or file pointed to do not
22297     * exist.
22298     *
22299     * @see elm_fileselector_selected_get()
22300     *
22301     * @ingroup Fileselector
22302     */
22303    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
22304
22305    /**
22306     * Get the currently selected item's (full) path, in the given file
22307     * selector widget
22308     *
22309     * @param obj The file selector object
22310     * @return The absolute path of the selected item, a @b
22311     * stringshared string
22312     *
22313     * @note Custom editions on @p obj object's text entry, if made,
22314     * will appear on the return string of this function, naturally.
22315     *
22316     * @see elm_fileselector_selected_set() for more details
22317     *
22318     * @ingroup Fileselector
22319     */
22320    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22321
22322    /**
22323     * Set the mode in which a given file selector widget will display
22324     * (layout) file system entries in its view
22325     *
22326     * @param obj The file selector object
22327     * @param mode The mode of the fileselector, being it one of
22328     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
22329     * first one, naturally, will display the files in a list. The
22330     * latter will make the widget to display its entries in a grid
22331     * form.
22332     *
22333     * @note By using elm_fileselector_expandable_set(), the user may
22334     * trigger a tree view for that list.
22335     *
22336     * @note If Elementary is built with support of the Ethumb
22337     * thumbnailing library, the second form of view will display
22338     * preview thumbnails of files which it supports. You must have
22339     * elm_need_ethumb() called in your Elementary for thumbnailing to
22340     * work, though.
22341     *
22342     * @see elm_fileselector_expandable_set().
22343     * @see elm_fileselector_mode_get().
22344     *
22345     * @ingroup Fileselector
22346     */
22347    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
22348
22349    /**
22350     * Get the mode in which a given file selector widget is displaying
22351     * (layouting) file system entries in its view
22352     *
22353     * @param obj The fileselector object
22354     * @return The mode in which the fileselector is at
22355     *
22356     * @see elm_fileselector_mode_set() for more details
22357     *
22358     * @ingroup Fileselector
22359     */
22360    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22361
22362    /**
22363     * @}
22364     */
22365
22366    /**
22367     * @defgroup Progressbar Progress bar
22368     *
22369     * The progress bar is a widget for visually representing the
22370     * progress status of a given job/task.
22371     *
22372     * A progress bar may be horizontal or vertical. It may display an
22373     * icon besides it, as well as primary and @b units labels. The
22374     * former is meant to label the widget as a whole, while the
22375     * latter, which is formatted with floating point values (and thus
22376     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
22377     * units"</c>), is meant to label the widget's <b>progress
22378     * value</b>. Label, icon and unit strings/objects are @b optional
22379     * for progress bars.
22380     *
22381     * A progress bar may be @b inverted, in which state it gets its
22382     * values inverted, with high values being on the left or top and
22383     * low values on the right or bottom, as opposed to normally have
22384     * the low values on the former and high values on the latter,
22385     * respectively, for horizontal and vertical modes.
22386     *
22387     * The @b span of the progress, as set by
22388     * elm_progressbar_span_size_set(), is its length (horizontally or
22389     * vertically), unless one puts size hints on the widget to expand
22390     * on desired directions, by any container. That length will be
22391     * scaled by the object or applications scaling factor. At any
22392     * point code can query the progress bar for its value with
22393     * elm_progressbar_value_get().
22394     *
22395     * Available widget styles for progress bars:
22396     * - @c "default"
22397     * - @c "wheel" (simple style, no text, no progression, only
22398     *      "pulse" effect is available)
22399     *
22400     * Default contents parts of the progressbar widget that you can use for are:
22401     * @li "icon" - An icon of the progressbar
22402     *
22403     * Here is an example on its usage:
22404     * @li @ref progressbar_example
22405     */
22406
22407    /**
22408     * Add a new progress bar widget to the given parent Elementary
22409     * (container) object
22410     *
22411     * @param parent The parent object
22412     * @return a new progress bar widget handle or @c NULL, on errors
22413     *
22414     * This function inserts a new progress bar widget on the canvas.
22415     *
22416     * @ingroup Progressbar
22417     */
22418    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22419
22420    /**
22421     * Set whether a given progress bar widget is at "pulsing mode" or
22422     * not.
22423     *
22424     * @param obj The progress bar object
22425     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
22426     * @c EINA_FALSE to put it back to its default one
22427     *
22428     * By default, progress bars will display values from the low to
22429     * high value boundaries. There are, though, contexts in which the
22430     * state of progression of a given task is @b unknown.  For those,
22431     * one can set a progress bar widget to a "pulsing state", to give
22432     * the user an idea that some computation is being held, but
22433     * without exact progress values. In the default theme it will
22434     * animate its bar with the contents filling in constantly and back
22435     * to non-filled, in a loop. To start and stop this pulsing
22436     * animation, one has to explicitly call elm_progressbar_pulse().
22437     *
22438     * @see elm_progressbar_pulse_get()
22439     * @see elm_progressbar_pulse()
22440     *
22441     * @ingroup Progressbar
22442     */
22443    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
22444
22445    /**
22446     * Get whether a given progress bar widget is at "pulsing mode" or
22447     * not.
22448     *
22449     * @param obj The progress bar object
22450     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
22451     * if it's in the default one (and on errors)
22452     *
22453     * @ingroup Progressbar
22454     */
22455    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22456
22457    /**
22458     * Start/stop a given progress bar "pulsing" animation, if its
22459     * under that mode
22460     *
22461     * @param obj The progress bar object
22462     * @param state @c EINA_TRUE, to @b start the pulsing animation,
22463     * @c EINA_FALSE to @b stop it
22464     *
22465     * @note This call won't do anything if @p obj is not under "pulsing mode".
22466     *
22467     * @see elm_progressbar_pulse_set() for more details.
22468     *
22469     * @ingroup Progressbar
22470     */
22471    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
22472
22473    /**
22474     * Set the progress value (in percentage) on a given progress bar
22475     * widget
22476     *
22477     * @param obj The progress bar object
22478     * @param val The progress value (@b must be between @c 0.0 and @c
22479     * 1.0)
22480     *
22481     * Use this call to set progress bar levels.
22482     *
22483     * @note If you passes a value out of the specified range for @p
22484     * val, it will be interpreted as the @b closest of the @b boundary
22485     * values in the range.
22486     *
22487     * @ingroup Progressbar
22488     */
22489    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
22490
22491    /**
22492     * Get the progress value (in percentage) on a given progress bar
22493     * widget
22494     *
22495     * @param obj The progress bar object
22496     * @return The value of the progressbar
22497     *
22498     * @see elm_progressbar_value_set() for more details
22499     *
22500     * @ingroup Progressbar
22501     */
22502    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22503
22504    /**
22505     * Set the label of a given progress bar widget
22506     *
22507     * @param obj The progress bar object
22508     * @param label The text label string, in UTF-8
22509     *
22510     * @ingroup Progressbar
22511     * @deprecated use elm_object_text_set() instead.
22512     */
22513    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
22514
22515    /**
22516     * Get the label of a given progress bar widget
22517     *
22518     * @param obj The progressbar object
22519     * @return The text label string, in UTF-8
22520     *
22521     * @ingroup Progressbar
22522     * @deprecated use elm_object_text_set() instead.
22523     */
22524    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22525
22526    /**
22527     * Set the icon object of a given progress bar widget
22528     *
22529     * @param obj The progress bar object
22530     * @param icon The icon object
22531     *
22532     * Use this call to decorate @p obj with an icon next to it.
22533     *
22534     * @note Once the icon object is set, a previously set one will be
22535     * deleted. If you want to keep that old content object, use the
22536     * elm_progressbar_icon_unset() function.
22537     *
22538     * @see elm_progressbar_icon_get()
22539     * @deprecated use elm_object_part_content_set() instead.
22540     *
22541     * @ingroup Progressbar
22542     */
22543    EINA_DEPRECATED EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
22544
22545    /**
22546     * Retrieve the icon object set for a given progress bar widget
22547     *
22548     * @param obj The progress bar object
22549     * @return The icon object's handle, if @p obj had one set, or @c NULL,
22550     * otherwise (and on errors)
22551     *
22552     * @see elm_progressbar_icon_set() for more details
22553     * @deprecated use elm_object_part_content_get() instead.
22554     *
22555     * @ingroup Progressbar
22556     */
22557    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22558
22559    /**
22560     * Unset an icon set on a given progress bar widget
22561     *
22562     * @param obj The progress bar object
22563     * @return The icon object that was being used, if any was set, or
22564     * @c NULL, otherwise (and on errors)
22565     *
22566     * This call will unparent and return the icon object which was set
22567     * for this widget, previously, on success.
22568     *
22569     * @see elm_progressbar_icon_set() for more details
22570     * @deprecated use elm_object_part_content_unset() instead.
22571     *
22572     * @ingroup Progressbar
22573     */
22574    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22575
22576    /**
22577     * Set the (exact) length of the bar region of a given progress bar
22578     * widget
22579     *
22580     * @param obj The progress bar object
22581     * @param size The length of the progress bar's bar region
22582     *
22583     * This sets the minimum width (when in horizontal mode) or height
22584     * (when in vertical mode) of the actual bar area of the progress
22585     * bar @p obj. This in turn affects the object's minimum size. Use
22586     * this when you're not setting other size hints expanding on the
22587     * given direction (like weight and alignment hints) and you would
22588     * like it to have a specific size.
22589     *
22590     * @note Icon, label and unit text around @p obj will require their
22591     * own space, which will make @p obj to require more the @p size,
22592     * actually.
22593     *
22594     * @see elm_progressbar_span_size_get()
22595     *
22596     * @ingroup Progressbar
22597     */
22598    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
22599
22600    /**
22601     * Get the length set for the bar region of a given progress bar
22602     * widget
22603     *
22604     * @param obj The progress bar object
22605     * @return The length of the progress bar's bar region
22606     *
22607     * If that size was not set previously, with
22608     * elm_progressbar_span_size_set(), this call will return @c 0.
22609     *
22610     * @ingroup Progressbar
22611     */
22612    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22613
22614    /**
22615     * Set the format string for a given progress bar widget's units
22616     * label
22617     *
22618     * @param obj The progress bar object
22619     * @param format The format string for @p obj's units label
22620     *
22621     * If @c NULL is passed on @p format, it will make @p obj's units
22622     * area to be hidden completely. If not, it'll set the <b>format
22623     * string</b> for the units label's @b text. The units label is
22624     * provided a floating point value, so the units text is up display
22625     * at most one floating point falue. Note that the units label is
22626     * optional. Use a format string such as "%1.2f meters" for
22627     * example.
22628     *
22629     * @note The default format string for a progress bar is an integer
22630     * percentage, as in @c "%.0f %%".
22631     *
22632     * @see elm_progressbar_unit_format_get()
22633     *
22634     * @ingroup Progressbar
22635     */
22636    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
22637
22638    /**
22639     * Retrieve the format string set for a given progress bar widget's
22640     * units label
22641     *
22642     * @param obj The progress bar object
22643     * @return The format set string for @p obj's units label or
22644     * @c NULL, if none was set (and on errors)
22645     *
22646     * @see elm_progressbar_unit_format_set() for more details
22647     *
22648     * @ingroup Progressbar
22649     */
22650    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22651
22652    /**
22653     * Set the orientation of a given progress bar widget
22654     *
22655     * @param obj The progress bar object
22656     * @param horizontal Use @c EINA_TRUE to make @p obj to be
22657     * @b horizontal, @c EINA_FALSE to make it @b vertical
22658     *
22659     * Use this function to change how your progress bar is to be
22660     * disposed: vertically or horizontally.
22661     *
22662     * @see elm_progressbar_horizontal_get()
22663     *
22664     * @ingroup Progressbar
22665     */
22666    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22667
22668    /**
22669     * Retrieve the orientation of a given progress bar widget
22670     *
22671     * @param obj The progress bar object
22672     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22673     * @c EINA_FALSE if it's @b vertical (and on errors)
22674     *
22675     * @see elm_progressbar_horizontal_set() for more details
22676     *
22677     * @ingroup Progressbar
22678     */
22679    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22680
22681    /**
22682     * Invert a given progress bar widget's displaying values order
22683     *
22684     * @param obj The progress bar object
22685     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
22686     * @c EINA_FALSE to bring it back to default, non-inverted values.
22687     *
22688     * A progress bar may be @b inverted, in which state it gets its
22689     * values inverted, with high values being on the left or top and
22690     * low values on the right or bottom, as opposed to normally have
22691     * the low values on the former and high values on the latter,
22692     * respectively, for horizontal and vertical modes.
22693     *
22694     * @see elm_progressbar_inverted_get()
22695     *
22696     * @ingroup Progressbar
22697     */
22698    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
22699
22700    /**
22701     * Get whether a given progress bar widget's displaying values are
22702     * inverted or not
22703     *
22704     * @param obj The progress bar object
22705     * @return @c EINA_TRUE, if @p obj has inverted values,
22706     * @c EINA_FALSE otherwise (and on errors)
22707     *
22708     * @see elm_progressbar_inverted_set() for more details
22709     *
22710     * @ingroup Progressbar
22711     */
22712    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22713
22714    /**
22715     * @defgroup Separator Separator
22716     *
22717     * @brief Separator is a very thin object used to separate other objects.
22718     *
22719     * A separator can be vertical or horizontal.
22720     *
22721     * @ref tutorial_separator is a good example of how to use a separator.
22722     * @{
22723     */
22724    /**
22725     * @brief Add a separator object to @p parent
22726     *
22727     * @param parent The parent object
22728     *
22729     * @return The separator object, or NULL upon failure
22730     */
22731    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22732    /**
22733     * @brief Set the horizontal mode of a separator object
22734     *
22735     * @param obj The separator object
22736     * @param horizontal If true, the separator is horizontal
22737     */
22738    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22739    /**
22740     * @brief Get the horizontal mode of a separator object
22741     *
22742     * @param obj The separator object
22743     * @return If true, the separator is horizontal
22744     *
22745     * @see elm_separator_horizontal_set()
22746     */
22747    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22748    /**
22749     * @}
22750     */
22751
22752    /**
22753     * @defgroup Spinner Spinner
22754     * @ingroup Elementary
22755     *
22756     * @image html img/widget/spinner/preview-00.png
22757     * @image latex img/widget/spinner/preview-00.eps
22758     *
22759     * A spinner is a widget which allows the user to increase or decrease
22760     * numeric values using arrow buttons, or edit values directly, clicking
22761     * over it and typing the new value.
22762     *
22763     * By default the spinner will not wrap and has a label
22764     * of "%.0f" (just showing the integer value of the double).
22765     *
22766     * A spinner has a label that is formatted with floating
22767     * point values and thus accepts a printf-style format string, like
22768     * ā€œ%1.2f unitsā€.
22769     *
22770     * It also allows specific values to be replaced by pre-defined labels.
22771     *
22772     * Smart callbacks one can register to:
22773     *
22774     * - "changed" - Whenever the spinner value is changed.
22775     * - "delay,changed" - A short time after the value is changed by the user.
22776     *    This will be called only when the user stops dragging for a very short
22777     *    period or when they release their finger/mouse, so it avoids possibly
22778     *    expensive reactions to the value change.
22779     *
22780     * Available styles for it:
22781     * - @c "default";
22782     * - @c "vertical": up/down buttons at the right side and text left aligned.
22783     *
22784     * Here is an example on its usage:
22785     * @ref spinner_example
22786     */
22787
22788    /**
22789     * @addtogroup Spinner
22790     * @{
22791     */
22792
22793    /**
22794     * Add a new spinner widget to the given parent Elementary
22795     * (container) object.
22796     *
22797     * @param parent The parent object.
22798     * @return a new spinner widget handle or @c NULL, on errors.
22799     *
22800     * This function inserts a new spinner widget on the canvas.
22801     *
22802     * @ingroup Spinner
22803     *
22804     */
22805    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22806
22807    /**
22808     * Set the format string of the displayed label.
22809     *
22810     * @param obj The spinner object.
22811     * @param fmt The format string for the label display.
22812     *
22813     * If @c NULL, this sets the format to "%.0f". If not it sets the format
22814     * string for the label text. The label text is provided a floating point
22815     * value, so the label text can display up to 1 floating point value.
22816     * Note that this is optional.
22817     *
22818     * Use a format string such as "%1.2f meters" for example, and it will
22819     * display values like: "3.14 meters" for a value equal to 3.14159.
22820     *
22821     * Default is "%0.f".
22822     *
22823     * @see elm_spinner_label_format_get()
22824     *
22825     * @ingroup Spinner
22826     */
22827    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
22828
22829    /**
22830     * Get the label format of the spinner.
22831     *
22832     * @param obj The spinner object.
22833     * @return The text label format string in UTF-8.
22834     *
22835     * @see elm_spinner_label_format_set() for details.
22836     *
22837     * @ingroup Spinner
22838     */
22839    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22840
22841    /**
22842     * Set the minimum and maximum values for the spinner.
22843     *
22844     * @param obj The spinner object.
22845     * @param min The minimum value.
22846     * @param max The maximum value.
22847     *
22848     * Define the allowed range of values to be selected by the user.
22849     *
22850     * If actual value is less than @p min, it will be updated to @p min. If it
22851     * is bigger then @p max, will be updated to @p max. Actual value can be
22852     * get with elm_spinner_value_get().
22853     *
22854     * By default, min is equal to 0, and max is equal to 100.
22855     *
22856     * @warning Maximum must be greater than minimum.
22857     *
22858     * @see elm_spinner_min_max_get()
22859     *
22860     * @ingroup Spinner
22861     */
22862    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
22863
22864    /**
22865     * Get the minimum and maximum values of the spinner.
22866     *
22867     * @param obj The spinner object.
22868     * @param min Pointer where to store the minimum value.
22869     * @param max Pointer where to store the maximum value.
22870     *
22871     * @note If only one value is needed, the other pointer can be passed
22872     * as @c NULL.
22873     *
22874     * @see elm_spinner_min_max_set() for details.
22875     *
22876     * @ingroup Spinner
22877     */
22878    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
22879
22880    /**
22881     * Set the step used to increment or decrement the spinner value.
22882     *
22883     * @param obj The spinner object.
22884     * @param step The step value.
22885     *
22886     * This value will be incremented or decremented to the displayed value.
22887     * It will be incremented while the user keep right or top arrow pressed,
22888     * and will be decremented while the user keep left or bottom arrow pressed.
22889     *
22890     * The interval to increment / decrement can be set with
22891     * elm_spinner_interval_set().
22892     *
22893     * By default step value is equal to 1.
22894     *
22895     * @see elm_spinner_step_get()
22896     *
22897     * @ingroup Spinner
22898     */
22899    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
22900
22901    /**
22902     * Get the step used to increment or decrement the spinner value.
22903     *
22904     * @param obj The spinner object.
22905     * @return The step value.
22906     *
22907     * @see elm_spinner_step_get() for more details.
22908     *
22909     * @ingroup Spinner
22910     */
22911    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22912
22913    /**
22914     * Set the value the spinner displays.
22915     *
22916     * @param obj The spinner object.
22917     * @param val The value to be displayed.
22918     *
22919     * Value will be presented on the label following format specified with
22920     * elm_spinner_format_set().
22921     *
22922     * @warning The value must to be between min and max values. This values
22923     * are set by elm_spinner_min_max_set().
22924     *
22925     * @see elm_spinner_value_get().
22926     * @see elm_spinner_format_set().
22927     * @see elm_spinner_min_max_set().
22928     *
22929     * @ingroup Spinner
22930     */
22931    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
22932
22933    /**
22934     * Get the value displayed by the spinner.
22935     *
22936     * @param obj The spinner object.
22937     * @return The value displayed.
22938     *
22939     * @see elm_spinner_value_set() for details.
22940     *
22941     * @ingroup Spinner
22942     */
22943    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22944
22945    /**
22946     * Set whether the spinner should wrap when it reaches its
22947     * minimum or maximum value.
22948     *
22949     * @param obj The spinner object.
22950     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
22951     * disable it.
22952     *
22953     * Disabled by default. If disabled, when the user tries to increment the
22954     * value,
22955     * but displayed value plus step value is bigger than maximum value,
22956     * the spinner
22957     * won't allow it. The same happens when the user tries to decrement it,
22958     * but the value less step is less than minimum value.
22959     *
22960     * When wrap is enabled, in such situations it will allow these changes,
22961     * but will get the value that would be less than minimum and subtracts
22962     * from maximum. Or add the value that would be more than maximum to
22963     * the minimum.
22964     *
22965     * E.g.:
22966     * @li min value = 10
22967     * @li max value = 50
22968     * @li step value = 20
22969     * @li displayed value = 20
22970     *
22971     * When the user decrement value (using left or bottom arrow), it will
22972     * displays @c 40, because max - (min - (displayed - step)) is
22973     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
22974     *
22975     * @see elm_spinner_wrap_get().
22976     *
22977     * @ingroup Spinner
22978     */
22979    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
22980
22981    /**
22982     * Get whether the spinner should wrap when it reaches its
22983     * minimum or maximum value.
22984     *
22985     * @param obj The spinner object
22986     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
22987     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22988     *
22989     * @see elm_spinner_wrap_set() for details.
22990     *
22991     * @ingroup Spinner
22992     */
22993    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22994
22995    /**
22996     * Set whether the spinner can be directly edited by the user or not.
22997     *
22998     * @param obj The spinner object.
22999     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
23000     * don't allow users to edit it directly.
23001     *
23002     * Spinner objects can have edition @b disabled, in which state they will
23003     * be changed only by arrows.
23004     * Useful for contexts
23005     * where you don't want your users to interact with it writting the value.
23006     * Specially
23007     * when using special values, the user can see real value instead
23008     * of special label on edition.
23009     *
23010     * It's enabled by default.
23011     *
23012     * @see elm_spinner_editable_get()
23013     *
23014     * @ingroup Spinner
23015     */
23016    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
23017
23018    /**
23019     * Get whether the spinner can be directly edited by the user or not.
23020     *
23021     * @param obj The spinner object.
23022     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
23023     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23024     *
23025     * @see elm_spinner_editable_set() for details.
23026     *
23027     * @ingroup Spinner
23028     */
23029    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23030
23031    /**
23032     * Set a special string to display in the place of the numerical value.
23033     *
23034     * @param obj The spinner object.
23035     * @param value The value to be replaced.
23036     * @param label The label to be used.
23037     *
23038     * It's useful for cases when a user should select an item that is
23039     * better indicated by a label than a value. For example, weekdays or months.
23040     *
23041     * E.g.:
23042     * @code
23043     * sp = elm_spinner_add(win);
23044     * elm_spinner_min_max_set(sp, 1, 3);
23045     * elm_spinner_special_value_add(sp, 1, "January");
23046     * elm_spinner_special_value_add(sp, 2, "February");
23047     * elm_spinner_special_value_add(sp, 3, "March");
23048     * evas_object_show(sp);
23049     * @endcode
23050     *
23051     * @ingroup Spinner
23052     */
23053    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
23054
23055    /**
23056     * Set the interval on time updates for an user mouse button hold
23057     * on spinner widgets' arrows.
23058     *
23059     * @param obj The spinner object.
23060     * @param interval The (first) interval value in seconds.
23061     *
23062     * This interval value is @b decreased while the user holds the
23063     * mouse pointer either incrementing or decrementing spinner's value.
23064     *
23065     * This helps the user to get to a given value distant from the
23066     * current one easier/faster, as it will start to change quicker and
23067     * quicker on mouse button holds.
23068     *
23069     * The calculation for the next change interval value, starting from
23070     * the one set with this call, is the previous interval divided by
23071     * @c 1.05, so it decreases a little bit.
23072     *
23073     * The default starting interval value for automatic changes is
23074     * @c 0.85 seconds.
23075     *
23076     * @see elm_spinner_interval_get()
23077     *
23078     * @ingroup Spinner
23079     */
23080    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23081
23082    /**
23083     * Get the interval on time updates for an user mouse button hold
23084     * on spinner widgets' arrows.
23085     *
23086     * @param obj The spinner object.
23087     * @return The (first) interval value, in seconds, set on it.
23088     *
23089     * @see elm_spinner_interval_set() for more details.
23090     *
23091     * @ingroup Spinner
23092     */
23093    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23094
23095    /**
23096     * @}
23097     */
23098
23099    /**
23100     * @defgroup Index Index
23101     *
23102     * @image html img/widget/index/preview-00.png
23103     * @image latex img/widget/index/preview-00.eps
23104     *
23105     * An index widget gives you an index for fast access to whichever
23106     * group of other UI items one might have. It's a list of text
23107     * items (usually letters, for alphabetically ordered access).
23108     *
23109     * Index widgets are by default hidden and just appear when the
23110     * user clicks over it's reserved area in the canvas. In its
23111     * default theme, it's an area one @ref Fingers "finger" wide on
23112     * the right side of the index widget's container.
23113     *
23114     * When items on the index are selected, smart callbacks get
23115     * called, so that its user can make other container objects to
23116     * show a given area or child object depending on the index item
23117     * selected. You'd probably be using an index together with @ref
23118     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
23119     * "general grids".
23120     *
23121     * Smart events one  can add callbacks for are:
23122     * - @c "changed" - When the selected index item changes. @c
23123     *      event_info is the selected item's data pointer.
23124     * - @c "delay,changed" - When the selected index item changes, but
23125     *      after a small idling period. @c event_info is the selected
23126     *      item's data pointer.
23127     * - @c "selected" - When the user releases a mouse button and
23128     *      selects an item. @c event_info is the selected item's data
23129     *      pointer.
23130     * - @c "level,up" - when the user moves a finger from the first
23131     *      level to the second level
23132     * - @c "level,down" - when the user moves a finger from the second
23133     *      level to the first level
23134     *
23135     * The @c "delay,changed" event is so that it'll wait a small time
23136     * before actually reporting those events and, moreover, just the
23137     * last event happening on those time frames will actually be
23138     * reported.
23139     *
23140     * Here are some examples on its usage:
23141     * @li @ref index_example_01
23142     * @li @ref index_example_02
23143     */
23144
23145    /**
23146     * @addtogroup Index
23147     * @{
23148     */
23149
23150    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
23151
23152    /**
23153     * Add a new index widget to the given parent Elementary
23154     * (container) object
23155     *
23156     * @param parent The parent object
23157     * @return a new index widget handle or @c NULL, on errors
23158     *
23159     * This function inserts a new index widget on the canvas.
23160     *
23161     * @ingroup Index
23162     */
23163    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23164
23165    /**
23166     * Set whether a given index widget is or not visible,
23167     * programatically.
23168     *
23169     * @param obj The index object
23170     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
23171     *
23172     * Not to be confused with visible as in @c evas_object_show() --
23173     * visible with regard to the widget's auto hiding feature.
23174     *
23175     * @see elm_index_active_get()
23176     *
23177     * @ingroup Index
23178     */
23179    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
23180
23181    /**
23182     * Get whether a given index widget is currently visible or not.
23183     *
23184     * @param obj The index object
23185     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
23186     *
23187     * @see elm_index_active_set() for more details
23188     *
23189     * @ingroup Index
23190     */
23191    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23192
23193    /**
23194     * Set the items level for a given index widget.
23195     *
23196     * @param obj The index object.
23197     * @param level @c 0 or @c 1, the currently implemented levels.
23198     *
23199     * @see elm_index_item_level_get()
23200     *
23201     * @ingroup Index
23202     */
23203    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
23204
23205    /**
23206     * Get the items level set for a given index widget.
23207     *
23208     * @param obj The index object.
23209     * @return @c 0 or @c 1, which are the levels @p obj might be at.
23210     *
23211     * @see elm_index_item_level_set() for more information
23212     *
23213     * @ingroup Index
23214     */
23215    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23216
23217    /**
23218     * Returns the last selected item, for a given index widget.
23219     *
23220     * @param obj The index object.
23221     * @return The last item @b selected on @p obj (or @c NULL, on errors).
23222     *
23223     * @ingroup Index
23224     */
23225    EAPI Elm_Index_Item *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
23226
23227    /**
23228     * Append a new item on a given index widget.
23229     *
23230     * @param obj The index object.
23231     * @param letter Letter under which the item should be indexed
23232     * @param item The item data to set for the index's item
23233     *
23234     * Despite the most common usage of the @p letter argument is for
23235     * single char strings, one could use arbitrary strings as index
23236     * entries.
23237     *
23238     * @c item will be the pointer returned back on @c "changed", @c
23239     * "delay,changed" and @c "selected" smart events.
23240     *
23241     * @ingroup Index
23242     */
23243    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
23244
23245    /**
23246     * Prepend a new item on a given index widget.
23247     *
23248     * @param obj The index object.
23249     * @param letter Letter under which the item should be indexed
23250     * @param item The item data to set for the index's item
23251     *
23252     * Despite the most common usage of the @p letter argument is for
23253     * single char strings, one could use arbitrary strings as index
23254     * entries.
23255     *
23256     * @c item will be the pointer returned back on @c "changed", @c
23257     * "delay,changed" and @c "selected" smart events.
23258     *
23259     * @ingroup Index
23260     */
23261    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
23262
23263    /**
23264     * Append a new item, on a given index widget, <b>after the item
23265     * having @p relative as data</b>.
23266     *
23267     * @param obj The index object.
23268     * @param letter Letter under which the item should be indexed
23269     * @param item The item data to set for the index's item
23270     * @param relative The index item to be the predecessor of this new one
23271     *
23272     * Despite the most common usage of the @p letter argument is for
23273     * single char strings, one could use arbitrary strings as index
23274     * entries.
23275     *
23276     * @c item will be the pointer returned back on @c "changed", @c
23277     * "delay,changed" and @c "selected" smart events.
23278     *
23279     * @note If @p relative is @c NULL this function will behave as
23280     * elm_index_item_append().
23281     *
23282     * @ingroup Index
23283     */
23284    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const Elm_Index_Item *relative) EINA_ARG_NONNULL(1);
23285
23286    /**
23287     * Prepend a new item, on a given index widget, <b>after the item
23288     * having @p relative as data</b>.
23289     *
23290     * @param obj The index object.
23291     * @param letter Letter under which the item should be indexed
23292     * @param item The item data to set for the index's item
23293     * @param relative The index item to be the successor of this new one
23294     *
23295     * Despite the most common usage of the @p letter argument is for
23296     * single char strings, one could use arbitrary strings as index
23297     * entries.
23298     *
23299     * @c item will be the pointer returned back on @c "changed", @c
23300     * "delay,changed" and @c "selected" smart events.
23301     *
23302     * @note If @p relative is @c NULL this function will behave as
23303     * elm_index_item_prepend().
23304     *
23305     * @ingroup Index
23306     */
23307    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const Elm_Index_Item *relative) EINA_ARG_NONNULL(1);
23308
23309    /**
23310     * Insert a new item into the given index widget, using @p cmp_func
23311     * function to sort items (by item handles).
23312     *
23313     * @param obj The index object.
23314     * @param letter Letter under which the item should be indexed
23315     * @param item The item data to set for the index's item
23316     * @param cmp_func The comparing function to be used to sort index
23317     * items <b>by #Elm_Index_Item item handles</b>
23318     * @param cmp_data_func A @b fallback function to be called for the
23319     * sorting of index items <b>by item data</b>). It will be used
23320     * when @p cmp_func returns @c 0 (equality), which means an index
23321     * item with provided item data already exists. To decide which
23322     * data item should be pointed to by the index item in question, @p
23323     * cmp_data_func will be used. If @p cmp_data_func returns a
23324     * non-negative value, the previous index item data will be
23325     * replaced by the given @p item pointer. If the previous data need
23326     * to be freed, it should be done by the @p cmp_data_func function,
23327     * because all references to it will be lost. If this function is
23328     * not provided (@c NULL is given), index items will be @b
23329     * duplicated, if @p cmp_func returns @c 0.
23330     *
23331     * Despite the most common usage of the @p letter argument is for
23332     * single char strings, one could use arbitrary strings as index
23333     * entries.
23334     *
23335     * @c item will be the pointer returned back on @c "changed", @c
23336     * "delay,changed" and @c "selected" smart events.
23337     *
23338     * @ingroup Index
23339     */
23340    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);
23341
23342    /**
23343     * Remove an item from a given index widget, <b>to be referenced by
23344     * it's data value</b>.
23345     *
23346     * @param obj The index object
23347     * @param item The item to be removed from @p obj
23348     *
23349     * If a deletion callback is set, via elm_index_item_del_cb_set(),
23350     * that callback function will be called by this one.
23351     *
23352     * @ingroup Index
23353     */
23354    EAPI void            elm_index_item_del(Evas_Object *obj, Elm_Index_Item *item) EINA_ARG_NONNULL(1);
23355
23356    /**
23357     * Find a given index widget's item, <b>using item data</b>.
23358     *
23359     * @param obj The index object
23360     * @param item The item data pointed to by the desired index item
23361     * @return The index item handle, if found, or @c NULL otherwise
23362     *
23363     * @ingroup Index
23364     */
23365    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
23366
23367    /**
23368     * Removes @b all items from a given index widget.
23369     *
23370     * @param obj The index object.
23371     *
23372     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
23373     * that callback function will be called for each item in @p obj.
23374     *
23375     * @ingroup Index
23376     */
23377    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23378
23379    /**
23380     * Go to a given items level on a index widget
23381     *
23382     * @param obj The index object
23383     * @param level The index level (one of @c 0 or @c 1)
23384     *
23385     * @ingroup Index
23386     */
23387    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
23388
23389    /**
23390     * Return the data associated with a given index widget item
23391     *
23392     * @param it The index widget item handle
23393     * @return The data associated with @p it
23394     *
23395     * @see elm_index_item_data_set()
23396     *
23397     * @ingroup Index
23398     */
23399    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
23400
23401    /**
23402     * Set the data associated with a given index widget item
23403     *
23404     * @param it The index widget item handle
23405     * @param data The new data pointer to set to @p it
23406     *
23407     * This sets new item data on @p it.
23408     *
23409     * @warning The old data pointer won't be touched by this function, so
23410     * the user had better to free that old data himself/herself.
23411     *
23412     * @ingroup Index
23413     */
23414    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
23415
23416    /**
23417     * Set the function to be called when a given index widget item is freed.
23418     *
23419     * @param it The item to set the callback on
23420     * @param func The function to call on the item's deletion
23421     *
23422     * When called, @p func will have both @c data and @c event_info
23423     * arguments with the @p it item's data value and, naturally, the
23424     * @c obj argument with a handle to the parent index widget.
23425     *
23426     * @ingroup Index
23427     */
23428    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
23429
23430    /**
23431     * Get the letter (string) set on a given index widget item.
23432     *
23433     * @param it The index item handle
23434     * @return The letter string set on @p it
23435     *
23436     * @ingroup Index
23437     */
23438    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
23439
23440    /**
23441     * @}
23442     */
23443
23444    /**
23445     * @defgroup Photocam Photocam
23446     *
23447     * @image html img/widget/photocam/preview-00.png
23448     * @image latex img/widget/photocam/preview-00.eps
23449     *
23450     * This is a widget specifically for displaying high-resolution digital
23451     * camera photos giving speedy feedback (fast load), low memory footprint
23452     * and zooming and panning as well as fitting logic. It is entirely focused
23453     * on jpeg images, and takes advantage of properties of the jpeg format (via
23454     * evas loader features in the jpeg loader).
23455     *
23456     * Signals that you can add callbacks for are:
23457     * @li "clicked" - This is called when a user has clicked the photo without
23458     *                 dragging around.
23459     * @li "press" - This is called when a user has pressed down on the photo.
23460     * @li "longpressed" - This is called when a user has pressed down on the
23461     *                     photo for a long time without dragging around.
23462     * @li "clicked,double" - This is called when a user has double-clicked the
23463     *                        photo.
23464     * @li "load" - Photo load begins.
23465     * @li "loaded" - This is called when the image file load is complete for the
23466     *                first view (low resolution blurry version).
23467     * @li "load,detail" - Photo detailed data load begins.
23468     * @li "loaded,detail" - This is called when the image file load is complete
23469     *                      for the detailed image data (full resolution needed).
23470     * @li "zoom,start" - Zoom animation started.
23471     * @li "zoom,stop" - Zoom animation stopped.
23472     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
23473     * @li "scroll" - the content has been scrolled (moved)
23474     * @li "scroll,anim,start" - scrolling animation has started
23475     * @li "scroll,anim,stop" - scrolling animation has stopped
23476     * @li "scroll,drag,start" - dragging the contents around has started
23477     * @li "scroll,drag,stop" - dragging the contents around has stopped
23478     *
23479     * @ref tutorial_photocam shows the API in action.
23480     * @{
23481     */
23482
23483    /**
23484     * @brief Types of zoom available.
23485     */
23486    typedef enum _Elm_Photocam_Zoom_Mode
23487      {
23488         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_photocam_zoom_set */
23489         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
23490         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
23491         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT_IN, /**< Unzoom until photo fits in photocam */
23492         ELM_PHOTOCAM_ZOOM_MODE_LAST
23493      } Elm_Photocam_Zoom_Mode;
23494
23495    /**
23496     * @brief Add a new Photocam object
23497     *
23498     * @param parent The parent object
23499     * @return The new object or NULL if it cannot be created
23500     */
23501    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23502
23503    /**
23504     * @brief Set the photo file to be shown
23505     *
23506     * @param obj The photocam object
23507     * @param file The photo file
23508     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
23509     *
23510     * This sets (and shows) the specified file (with a relative or absolute
23511     * path) and will return a load error (same error that
23512     * evas_object_image_load_error_get() will return). The image will change and
23513     * adjust its size at this point and begin a background load process for this
23514     * photo that at some time in the future will be displayed at the full
23515     * quality needed.
23516     */
23517    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
23518
23519    /**
23520     * @brief Returns the path of the current image file
23521     *
23522     * @param obj The photocam object
23523     * @return Returns the path
23524     *
23525     * @see elm_photocam_file_set()
23526     */
23527    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23528
23529    /**
23530     * @brief Set the zoom level of the photo
23531     *
23532     * @param obj The photocam object
23533     * @param zoom The zoom level to set
23534     *
23535     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
23536     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
23537     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
23538     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
23539     * 16, 32, etc.).
23540     */
23541    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
23542
23543    /**
23544     * @brief Get the zoom level of the photo
23545     *
23546     * @param obj The photocam object
23547     * @return The current zoom level
23548     *
23549     * This returns the current zoom level of the photocam object. Note that if
23550     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
23551     * (which is the default), the zoom level may be changed at any time by the
23552     * photocam object itself to account for photo size and photocam viewpoer
23553     * size.
23554     *
23555     * @see elm_photocam_zoom_set()
23556     * @see elm_photocam_zoom_mode_set()
23557     */
23558    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23559
23560    /**
23561     * @brief Set the zoom mode
23562     *
23563     * @param obj The photocam object
23564     * @param mode The desired mode
23565     *
23566     * This sets the zoom mode to manual or one of several automatic levels.
23567     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
23568     * elm_photocam_zoom_set() and will stay at that level until changed by code
23569     * or until zoom mode is changed. This is the default mode. The Automatic
23570     * modes will allow the photocam object to automatically adjust zoom mode
23571     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
23572     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
23573     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
23574     * pixels within the frame are left unfilled.
23575     */
23576    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
23577
23578    /**
23579     * @brief Get the zoom mode
23580     *
23581     * @param obj The photocam object
23582     * @return The current zoom mode
23583     *
23584     * This gets the current zoom mode of the photocam object.
23585     *
23586     * @see elm_photocam_zoom_mode_set()
23587     */
23588    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23589
23590    /**
23591     * @brief Get the current image pixel width and height
23592     *
23593     * @param obj The photocam object
23594     * @param w A pointer to the width return
23595     * @param h A pointer to the height return
23596     *
23597     * This gets the current photo pixel width and height (for the original).
23598     * The size will be returned in the integers @p w and @p h that are pointed
23599     * to.
23600     */
23601    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
23602
23603    /**
23604     * @brief Get the area of the image that is currently shown
23605     *
23606     * @param obj
23607     * @param x A pointer to the X-coordinate of region
23608     * @param y A pointer to the Y-coordinate of region
23609     * @param w A pointer to the width
23610     * @param h A pointer to the height
23611     *
23612     * @see elm_photocam_image_region_show()
23613     * @see elm_photocam_image_region_bring_in()
23614     */
23615    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
23616
23617    /**
23618     * @brief Set the viewed portion of the image
23619     *
23620     * @param obj The photocam object
23621     * @param x X-coordinate of region in image original pixels
23622     * @param y Y-coordinate of region in image original pixels
23623     * @param w Width of region in image original pixels
23624     * @param h Height of region in image original pixels
23625     *
23626     * This shows the region of the image without using animation.
23627     */
23628    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
23629
23630    /**
23631     * @brief Bring in the viewed portion of the image
23632     *
23633     * @param obj The photocam object
23634     * @param x X-coordinate of region in image original pixels
23635     * @param y Y-coordinate of region in image original pixels
23636     * @param w Width of region in image original pixels
23637     * @param h Height of region in image original pixels
23638     *
23639     * This shows the region of the image using animation.
23640     */
23641    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
23642
23643    /**
23644     * @brief Set the paused state for photocam
23645     *
23646     * @param obj The photocam object
23647     * @param paused The pause state to set
23648     *
23649     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
23650     * photocam. The default is off. This will stop zooming using animation on
23651     * zoom levels changes and change instantly. This will stop any existing
23652     * animations that are running.
23653     */
23654    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23655
23656    /**
23657     * @brief Get the paused state for photocam
23658     *
23659     * @param obj The photocam object
23660     * @return The current paused state
23661     *
23662     * This gets the current paused state for the photocam object.
23663     *
23664     * @see elm_photocam_paused_set()
23665     */
23666    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23667
23668    /**
23669     * @brief Get the internal low-res image used for photocam
23670     *
23671     * @param obj The photocam object
23672     * @return The internal image object handle, or NULL if none exists
23673     *
23674     * This gets the internal image object inside photocam. Do not modify it. It
23675     * is for inspection only, and hooking callbacks to. Nothing else. It may be
23676     * deleted at any time as well.
23677     */
23678    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23679
23680    /**
23681     * @brief Set the photocam scrolling bouncing.
23682     *
23683     * @param obj The photocam object
23684     * @param h_bounce bouncing for horizontal
23685     * @param v_bounce bouncing for vertical
23686     */
23687    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23688
23689    /**
23690     * @brief Get the photocam scrolling bouncing.
23691     *
23692     * @param obj The photocam object
23693     * @param h_bounce bouncing for horizontal
23694     * @param v_bounce bouncing for vertical
23695     *
23696     * @see elm_photocam_bounce_set()
23697     */
23698    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
23699
23700    /**
23701     * @}
23702     */
23703
23704    /**
23705     * @defgroup Map Map
23706     * @ingroup Elementary
23707     *
23708     * @image html img/widget/map/preview-00.png
23709     * @image latex img/widget/map/preview-00.eps
23710     *
23711     * This is a widget specifically for displaying a map. It uses basically
23712     * OpenStreetMap provider http://www.openstreetmap.org/,
23713     * but custom providers can be added.
23714     *
23715     * It supports some basic but yet nice features:
23716     * @li zoom and scroll
23717     * @li markers with content to be displayed when user clicks over it
23718     * @li group of markers
23719     * @li routes
23720     *
23721     * Smart callbacks one can listen to:
23722     *
23723     * - "clicked" - This is called when a user has clicked the map without
23724     *   dragging around.
23725     * - "press" - This is called when a user has pressed down on the map.
23726     * - "longpressed" - This is called when a user has pressed down on the map
23727     *   for a long time without dragging around.
23728     * - "clicked,double" - This is called when a user has double-clicked
23729     *   the map.
23730     * - "load,detail" - Map detailed data load begins.
23731     * - "loaded,detail" - This is called when all currently visible parts of
23732     *   the map are loaded.
23733     * - "zoom,start" - Zoom animation started.
23734     * - "zoom,stop" - Zoom animation stopped.
23735     * - "zoom,change" - Zoom changed when using an auto zoom mode.
23736     * - "scroll" - the content has been scrolled (moved).
23737     * - "scroll,anim,start" - scrolling animation has started.
23738     * - "scroll,anim,stop" - scrolling animation has stopped.
23739     * - "scroll,drag,start" - dragging the contents around has started.
23740     * - "scroll,drag,stop" - dragging the contents around has stopped.
23741     * - "downloaded" - This is called when all currently required map images
23742     *   are downloaded.
23743     * - "route,load" - This is called when route request begins.
23744     * - "route,loaded" - This is called when route request ends.
23745     * - "name,load" - This is called when name request begins.
23746     * - "name,loaded- This is called when name request ends.
23747     *
23748     * Available style for map widget:
23749     * - @c "default"
23750     *
23751     * Available style for markers:
23752     * - @c "radio"
23753     * - @c "radio2"
23754     * - @c "empty"
23755     *
23756     * Available style for marker bubble:
23757     * - @c "default"
23758     *
23759     * List of examples:
23760     * @li @ref map_example_01
23761     * @li @ref map_example_02
23762     * @li @ref map_example_03
23763     */
23764
23765    /**
23766     * @addtogroup Map
23767     * @{
23768     */
23769
23770    /**
23771     * @enum _Elm_Map_Zoom_Mode
23772     * @typedef Elm_Map_Zoom_Mode
23773     *
23774     * Set map's zoom behavior. It can be set to manual or automatic.
23775     *
23776     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
23777     *
23778     * Values <b> don't </b> work as bitmask, only one can be choosen.
23779     *
23780     * @note Valid sizes are 2^zoom, consequently the map may be smaller
23781     * than the scroller view.
23782     *
23783     * @see elm_map_zoom_mode_set()
23784     * @see elm_map_zoom_mode_get()
23785     *
23786     * @ingroup Map
23787     */
23788    typedef enum _Elm_Map_Zoom_Mode
23789      {
23790         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controlled manually by elm_map_zoom_set(). It's set by default. */
23791         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
23792         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
23793         ELM_MAP_ZOOM_MODE_LAST
23794      } Elm_Map_Zoom_Mode;
23795
23796    /**
23797     * @enum _Elm_Map_Route_Sources
23798     * @typedef Elm_Map_Route_Sources
23799     *
23800     * Set route service to be used. By default used source is
23801     * #ELM_MAP_ROUTE_SOURCE_YOURS.
23802     *
23803     * @see elm_map_route_source_set()
23804     * @see elm_map_route_source_get()
23805     *
23806     * @ingroup Map
23807     */
23808    typedef enum _Elm_Map_Route_Sources
23809      {
23810         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
23811         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. */
23812         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
23813         ELM_MAP_ROUTE_SOURCE_LAST
23814      } Elm_Map_Route_Sources;
23815
23816    typedef enum _Elm_Map_Name_Sources
23817      {
23818         ELM_MAP_NAME_SOURCE_NOMINATIM,
23819         ELM_MAP_NAME_SOURCE_LAST
23820      } Elm_Map_Name_Sources;
23821
23822    /**
23823     * @enum _Elm_Map_Route_Type
23824     * @typedef Elm_Map_Route_Type
23825     *
23826     * Set type of transport used on route.
23827     *
23828     * @see elm_map_route_add()
23829     *
23830     * @ingroup Map
23831     */
23832    typedef enum _Elm_Map_Route_Type
23833      {
23834         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
23835         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
23836         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
23837         ELM_MAP_ROUTE_TYPE_LAST
23838      } Elm_Map_Route_Type;
23839
23840    /**
23841     * @enum _Elm_Map_Route_Method
23842     * @typedef Elm_Map_Route_Method
23843     *
23844     * Set the routing method, what should be priorized, time or distance.
23845     *
23846     * @see elm_map_route_add()
23847     *
23848     * @ingroup Map
23849     */
23850    typedef enum _Elm_Map_Route_Method
23851      {
23852         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
23853         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
23854         ELM_MAP_ROUTE_METHOD_LAST
23855      } Elm_Map_Route_Method;
23856
23857    typedef enum _Elm_Map_Name_Method
23858      {
23859         ELM_MAP_NAME_METHOD_SEARCH,
23860         ELM_MAP_NAME_METHOD_REVERSE,
23861         ELM_MAP_NAME_METHOD_LAST
23862      } Elm_Map_Name_Method;
23863
23864    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(). */
23865    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(). */
23866    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(). */
23867    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(). */
23868    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
23869    typedef struct _Elm_Map_Track           Elm_Map_Track;
23870
23871    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. */
23872    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
23873    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
23874    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
23875
23876    typedef char        *(*ElmMapModuleSourceFunc) (void);
23877    typedef int          (*ElmMapModuleZoomMinFunc) (void);
23878    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
23879    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
23880    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
23881    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
23882    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
23883    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
23884    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
23885
23886    /**
23887     * Add a new map widget to the given parent Elementary (container) object.
23888     *
23889     * @param parent The parent object.
23890     * @return a new map widget handle or @c NULL, on errors.
23891     *
23892     * This function inserts a new map widget on the canvas.
23893     *
23894     * @ingroup Map
23895     */
23896    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23897
23898    /**
23899     * Set the zoom level of the map.
23900     *
23901     * @param obj The map object.
23902     * @param zoom The zoom level to set.
23903     *
23904     * This sets the zoom level.
23905     *
23906     * It will respect limits defined by elm_map_source_zoom_min_set() and
23907     * elm_map_source_zoom_max_set().
23908     *
23909     * By default these values are 0 (world map) and 18 (maximum zoom).
23910     *
23911     * This function should be used when zoom mode is set to
23912     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
23913     * with elm_map_zoom_mode_set().
23914     *
23915     * @see elm_map_zoom_mode_set().
23916     * @see elm_map_zoom_get().
23917     *
23918     * @ingroup Map
23919     */
23920    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23921
23922    /**
23923     * Get the zoom level of the map.
23924     *
23925     * @param obj The map object.
23926     * @return The current zoom level.
23927     *
23928     * This returns the current zoom level of the map object.
23929     *
23930     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
23931     * (which is the default), the zoom level may be changed at any time by the
23932     * map object itself to account for map size and map viewport size.
23933     *
23934     * @see elm_map_zoom_set() for details.
23935     *
23936     * @ingroup Map
23937     */
23938    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23939
23940    /**
23941     * Set the zoom mode used by the map object.
23942     *
23943     * @param obj The map object.
23944     * @param mode The zoom mode of the map, being it one of
23945     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
23946     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
23947     *
23948     * This sets the zoom mode to manual or one of the automatic levels.
23949     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
23950     * elm_map_zoom_set() and will stay at that level until changed by code
23951     * or until zoom mode is changed. This is the default mode.
23952     *
23953     * The Automatic modes will allow the map object to automatically
23954     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
23955     * adjust zoom so the map fits inside the scroll frame with no pixels
23956     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
23957     * ensure no pixels within the frame are left unfilled. Do not forget that
23958     * the valid sizes are 2^zoom, consequently the map may be smaller than
23959     * the scroller view.
23960     *
23961     * @see elm_map_zoom_set()
23962     *
23963     * @ingroup Map
23964     */
23965    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
23966
23967    /**
23968     * Get the zoom mode used by the map object.
23969     *
23970     * @param obj The map object.
23971     * @return The zoom mode of the map, being it one of
23972     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
23973     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
23974     *
23975     * This function returns the current zoom mode used by the map object.
23976     *
23977     * @see elm_map_zoom_mode_set() for more details.
23978     *
23979     * @ingroup Map
23980     */
23981    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23982
23983    /**
23984     * Get the current coordinates of the map.
23985     *
23986     * @param obj The map object.
23987     * @param lon Pointer where to store longitude.
23988     * @param lat Pointer where to store latitude.
23989     *
23990     * This gets the current center coordinates of the map object. It can be
23991     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
23992     *
23993     * @see elm_map_geo_region_bring_in()
23994     * @see elm_map_geo_region_show()
23995     *
23996     * @ingroup Map
23997     */
23998    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
23999
24000    /**
24001     * Animatedly bring in given coordinates to the center of the map.
24002     *
24003     * @param obj The map object.
24004     * @param lon Longitude to center at.
24005     * @param lat Latitude to center at.
24006     *
24007     * This causes map to jump to the given @p lat and @p lon coordinates
24008     * and show it (by scrolling) in the center of the viewport, if it is not
24009     * already centered. This will use animation to do so and take a period
24010     * of time to complete.
24011     *
24012     * @see elm_map_geo_region_show() for a function to avoid animation.
24013     * @see elm_map_geo_region_get()
24014     *
24015     * @ingroup Map
24016     */
24017    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
24018
24019    /**
24020     * Show the given coordinates at the center of the map, @b immediately.
24021     *
24022     * @param obj The map object.
24023     * @param lon Longitude to center at.
24024     * @param lat Latitude to center at.
24025     *
24026     * This causes map to @b redraw its viewport's contents to the
24027     * region contining the given @p lat and @p lon, that will be moved to the
24028     * center of the map.
24029     *
24030     * @see elm_map_geo_region_bring_in() for a function to move with animation.
24031     * @see elm_map_geo_region_get()
24032     *
24033     * @ingroup Map
24034     */
24035    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
24036
24037    /**
24038     * Pause or unpause the map.
24039     *
24040     * @param obj The map object.
24041     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
24042     * to unpause it.
24043     *
24044     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
24045     * for map.
24046     *
24047     * The default is off.
24048     *
24049     * This will stop zooming using animation, changing zoom levels will
24050     * change instantly. This will stop any existing animations that are running.
24051     *
24052     * @see elm_map_paused_get()
24053     *
24054     * @ingroup Map
24055     */
24056    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
24057
24058    /**
24059     * Get a value whether map is paused or not.
24060     *
24061     * @param obj The map object.
24062     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
24063     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24064     *
24065     * This gets the current paused state for the map object.
24066     *
24067     * @see elm_map_paused_set() for details.
24068     *
24069     * @ingroup Map
24070     */
24071    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24072
24073    /**
24074     * Set to show markers during zoom level changes or not.
24075     *
24076     * @param obj The map object.
24077     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
24078     * to show them.
24079     *
24080     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
24081     * for map.
24082     *
24083     * The default is off.
24084     *
24085     * This will stop zooming using animation, changing zoom levels will
24086     * change instantly. This will stop any existing animations that are running.
24087     *
24088     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
24089     * for the markers.
24090     *
24091     * The default  is off.
24092     *
24093     * Enabling it will force the map to stop displaying the markers during
24094     * zoom level changes. Set to on if you have a large number of markers.
24095     *
24096     * @see elm_map_paused_markers_get()
24097     *
24098     * @ingroup Map
24099     */
24100    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
24101
24102    /**
24103     * Get a value whether markers will be displayed on zoom level changes or not
24104     *
24105     * @param obj The map object.
24106     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
24107     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
24108     *
24109     * This gets the current markers paused state for the map object.
24110     *
24111     * @see elm_map_paused_markers_set() for details.
24112     *
24113     * @ingroup Map
24114     */
24115    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24116
24117    /**
24118     * Get the information of downloading status.
24119     *
24120     * @param obj The map object.
24121     * @param try_num Pointer where to store number of tiles being downloaded.
24122     * @param finish_num Pointer where to store number of tiles successfully
24123     * downloaded.
24124     *
24125     * This gets the current downloading status for the map object, the number
24126     * of tiles being downloaded and the number of tiles already downloaded.
24127     *
24128     * @ingroup Map
24129     */
24130    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
24131
24132    /**
24133     * Convert a pixel coordinate (x,y) into a geographic coordinate
24134     * (longitude, latitude).
24135     *
24136     * @param obj The map object.
24137     * @param x the coordinate.
24138     * @param y the coordinate.
24139     * @param size the size in pixels of the map.
24140     * The map is a square and generally his size is : pow(2.0, zoom)*256.
24141     * @param lon Pointer where to store the longitude that correspond to x.
24142     * @param lat Pointer where to store the latitude that correspond to y.
24143     *
24144     * @note Origin pixel point is the top left corner of the viewport.
24145     * Map zoom and size are taken on account.
24146     *
24147     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
24148     *
24149     * @ingroup Map
24150     */
24151    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);
24152
24153    /**
24154     * Convert a geographic coordinate (longitude, latitude) into a pixel
24155     * coordinate (x, y).
24156     *
24157     * @param obj The map object.
24158     * @param lon the longitude.
24159     * @param lat the latitude.
24160     * @param size the size in pixels of the map. The map is a square
24161     * and generally his size is : pow(2.0, zoom)*256.
24162     * @param x Pointer where to store the horizontal pixel coordinate that
24163     * correspond to the longitude.
24164     * @param y Pointer where to store the vertical pixel coordinate that
24165     * correspond to the latitude.
24166     *
24167     * @note Origin pixel point is the top left corner of the viewport.
24168     * Map zoom and size are taken on account.
24169     *
24170     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
24171     *
24172     * @ingroup Map
24173     */
24174    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);
24175
24176    /**
24177     * Convert a geographic coordinate (longitude, latitude) into a name
24178     * (address).
24179     *
24180     * @param obj The map object.
24181     * @param lon the longitude.
24182     * @param lat the latitude.
24183     * @return name A #Elm_Map_Name handle for this coordinate.
24184     *
24185     * To get the string for this address, elm_map_name_address_get()
24186     * should be used.
24187     *
24188     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
24189     *
24190     * @ingroup Map
24191     */
24192    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
24193
24194    /**
24195     * Convert a name (address) into a geographic coordinate
24196     * (longitude, latitude).
24197     *
24198     * @param obj The map object.
24199     * @param name The address.
24200     * @return name A #Elm_Map_Name handle for this address.
24201     *
24202     * To get the longitude and latitude, elm_map_name_region_get()
24203     * should be used.
24204     *
24205     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
24206     *
24207     * @ingroup Map
24208     */
24209    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
24210
24211    /**
24212     * Convert a pixel coordinate into a rotated pixel coordinate.
24213     *
24214     * @param obj The map object.
24215     * @param x horizontal coordinate of the point to rotate.
24216     * @param y vertical coordinate of the point to rotate.
24217     * @param cx rotation's center horizontal position.
24218     * @param cy rotation's center vertical position.
24219     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
24220     * @param xx Pointer where to store rotated x.
24221     * @param yy Pointer where to store rotated y.
24222     *
24223     * @ingroup Map
24224     */
24225    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);
24226
24227    /**
24228     * Add a new marker to the map object.
24229     *
24230     * @param obj The map object.
24231     * @param lon The longitude of the marker.
24232     * @param lat The latitude of the marker.
24233     * @param clas The class, to use when marker @b isn't grouped to others.
24234     * @param clas_group The class group, to use when marker is grouped to others
24235     * @param data The data passed to the callbacks.
24236     *
24237     * @return The created marker or @c NULL upon failure.
24238     *
24239     * A marker will be created and shown in a specific point of the map, defined
24240     * by @p lon and @p lat.
24241     *
24242     * It will be displayed using style defined by @p class when this marker
24243     * is displayed alone (not grouped). A new class can be created with
24244     * elm_map_marker_class_new().
24245     *
24246     * If the marker is grouped to other markers, it will be displayed with
24247     * style defined by @p class_group. Markers with the same group are grouped
24248     * if they are close. A new group class can be created with
24249     * elm_map_marker_group_class_new().
24250     *
24251     * Markers created with this method can be deleted with
24252     * elm_map_marker_remove().
24253     *
24254     * A marker can have associated content to be displayed by a bubble,
24255     * when a user click over it, as well as an icon. These objects will
24256     * be fetch using class' callback functions.
24257     *
24258     * @see elm_map_marker_class_new()
24259     * @see elm_map_marker_group_class_new()
24260     * @see elm_map_marker_remove()
24261     *
24262     * @ingroup Map
24263     */
24264    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);
24265
24266    /**
24267     * Set the maximum numbers of markers' content to be displayed in a group.
24268     *
24269     * @param obj The map object.
24270     * @param max The maximum numbers of items displayed in a bubble.
24271     *
24272     * A bubble will be displayed when the user clicks over the group,
24273     * and will place the content of markers that belong to this group
24274     * inside it.
24275     *
24276     * A group can have a long list of markers, consequently the creation
24277     * of the content of the bubble can be very slow.
24278     *
24279     * In order to avoid this, a maximum number of items is displayed
24280     * in a bubble.
24281     *
24282     * By default this number is 30.
24283     *
24284     * Marker with the same group class are grouped if they are close.
24285     *
24286     * @see elm_map_marker_add()
24287     *
24288     * @ingroup Map
24289     */
24290    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
24291
24292    /**
24293     * Remove a marker from the map.
24294     *
24295     * @param marker The marker to remove.
24296     *
24297     * @see elm_map_marker_add()
24298     *
24299     * @ingroup Map
24300     */
24301    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24302
24303    /**
24304     * Get the current coordinates of the marker.
24305     *
24306     * @param marker marker.
24307     * @param lat Pointer where to store the marker's latitude.
24308     * @param lon Pointer where to store the marker's longitude.
24309     *
24310     * These values are set when adding markers, with function
24311     * elm_map_marker_add().
24312     *
24313     * @see elm_map_marker_add()
24314     *
24315     * @ingroup Map
24316     */
24317    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
24318
24319    /**
24320     * Animatedly bring in given marker to the center of the map.
24321     *
24322     * @param marker The marker to center at.
24323     *
24324     * This causes map to jump to the given @p marker's coordinates
24325     * and show it (by scrolling) in the center of the viewport, if it is not
24326     * already centered. This will use animation to do so and take a period
24327     * of time to complete.
24328     *
24329     * @see elm_map_marker_show() for a function to avoid animation.
24330     * @see elm_map_marker_region_get()
24331     *
24332     * @ingroup Map
24333     */
24334    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24335
24336    /**
24337     * Show the given marker at the center of the map, @b immediately.
24338     *
24339     * @param marker The marker to center at.
24340     *
24341     * This causes map to @b redraw its viewport's contents to the
24342     * region contining the given @p marker's coordinates, that will be
24343     * moved to the center of the map.
24344     *
24345     * @see elm_map_marker_bring_in() for a function to move with animation.
24346     * @see elm_map_markers_list_show() if more than one marker need to be
24347     * displayed.
24348     * @see elm_map_marker_region_get()
24349     *
24350     * @ingroup Map
24351     */
24352    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24353
24354    /**
24355     * Move and zoom the map to display a list of markers.
24356     *
24357     * @param markers A list of #Elm_Map_Marker handles.
24358     *
24359     * The map will be centered on the center point of the markers in the list.
24360     * Then the map will be zoomed in order to fit the markers using the maximum
24361     * zoom which allows display of all the markers.
24362     *
24363     * @warning All the markers should belong to the same map object.
24364     *
24365     * @see elm_map_marker_show() to show a single marker.
24366     * @see elm_map_marker_bring_in()
24367     *
24368     * @ingroup Map
24369     */
24370    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
24371
24372    /**
24373     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
24374     *
24375     * @param marker The marker wich content should be returned.
24376     * @return Return the evas object if it exists, else @c NULL.
24377     *
24378     * To set callback function #ElmMapMarkerGetFunc for the marker class,
24379     * elm_map_marker_class_get_cb_set() should be used.
24380     *
24381     * This content is what will be inside the bubble that will be displayed
24382     * when an user clicks over the marker.
24383     *
24384     * This returns the actual Evas object used to be placed inside
24385     * the bubble. This may be @c NULL, as it may
24386     * not have been created or may have been deleted, at any time, by
24387     * the map. <b>Do not modify this object</b> (move, resize,
24388     * show, hide, etc.), as the map is controlling it. This
24389     * function is for querying, emitting custom signals or hooking
24390     * lower level callbacks for events on that object. Do not delete
24391     * this object under any circumstances.
24392     *
24393     * @ingroup Map
24394     */
24395    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24396
24397    /**
24398     * Update the marker
24399     *
24400     * @param marker The marker to be updated.
24401     *
24402     * If a content is set to this marker, it will call function to delete it,
24403     * #ElmMapMarkerDelFunc, and then will fetch the content again with
24404     * #ElmMapMarkerGetFunc.
24405     *
24406     * These functions are set for the marker class with
24407     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
24408     *
24409     * @ingroup Map
24410     */
24411    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24412
24413    /**
24414     * Close all the bubbles opened by the user.
24415     *
24416     * @param obj The map object.
24417     *
24418     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
24419     * when the user clicks on a marker.
24420     *
24421     * This functions is set for the marker class with
24422     * elm_map_marker_class_get_cb_set().
24423     *
24424     * @ingroup Map
24425     */
24426    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
24427
24428    /**
24429     * Create a new group class.
24430     *
24431     * @param obj The map object.
24432     * @return Returns the new group class.
24433     *
24434     * Each marker must be associated to a group class. Markers in the same
24435     * group are grouped if they are close.
24436     *
24437     * The group class defines the style of the marker when a marker is grouped
24438     * to others markers. When it is alone, another class will be used.
24439     *
24440     * A group class will need to be provided when creating a marker with
24441     * elm_map_marker_add().
24442     *
24443     * Some properties and functions can be set by class, as:
24444     * - style, with elm_map_group_class_style_set()
24445     * - data - to be associated to the group class. It can be set using
24446     *   elm_map_group_class_data_set().
24447     * - min zoom to display markers, set with
24448     *   elm_map_group_class_zoom_displayed_set().
24449     * - max zoom to group markers, set using
24450     *   elm_map_group_class_zoom_grouped_set().
24451     * - visibility - set if markers will be visible or not, set with
24452     *   elm_map_group_class_hide_set().
24453     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
24454     *   It can be set using elm_map_group_class_icon_cb_set().
24455     *
24456     * @see elm_map_marker_add()
24457     * @see elm_map_group_class_style_set()
24458     * @see elm_map_group_class_data_set()
24459     * @see elm_map_group_class_zoom_displayed_set()
24460     * @see elm_map_group_class_zoom_grouped_set()
24461     * @see elm_map_group_class_hide_set()
24462     * @see elm_map_group_class_icon_cb_set()
24463     *
24464     * @ingroup Map
24465     */
24466    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
24467
24468    /**
24469     * Set the marker's style of a group class.
24470     *
24471     * @param clas The group class.
24472     * @param style The style to be used by markers.
24473     *
24474     * Each marker must be associated to a group class, and will use the style
24475     * defined by such class when grouped to other markers.
24476     *
24477     * The following styles are provided by default theme:
24478     * @li @c radio - blue circle
24479     * @li @c radio2 - green circle
24480     * @li @c empty
24481     *
24482     * @see elm_map_group_class_new() for more details.
24483     * @see elm_map_marker_add()
24484     *
24485     * @ingroup Map
24486     */
24487    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
24488
24489    /**
24490     * Set the icon callback function of a group class.
24491     *
24492     * @param clas The group class.
24493     * @param icon_get The callback function that will return the icon.
24494     *
24495     * Each marker must be associated to a group class, and it can display a
24496     * custom icon. The function @p icon_get must return this icon.
24497     *
24498     * @see elm_map_group_class_new() for more details.
24499     * @see elm_map_marker_add()
24500     *
24501     * @ingroup Map
24502     */
24503    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
24504
24505    /**
24506     * Set the data associated to the group class.
24507     *
24508     * @param clas The group class.
24509     * @param data The new user data.
24510     *
24511     * This data will be passed for callback functions, like icon get callback,
24512     * that can be set with elm_map_group_class_icon_cb_set().
24513     *
24514     * If a data was previously set, the object will lose the pointer for it,
24515     * so if needs to be freed, you must do it yourself.
24516     *
24517     * @see elm_map_group_class_new() for more details.
24518     * @see elm_map_group_class_icon_cb_set()
24519     * @see elm_map_marker_add()
24520     *
24521     * @ingroup Map
24522     */
24523    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
24524
24525    /**
24526     * Set the minimum zoom from where the markers are displayed.
24527     *
24528     * @param clas The group class.
24529     * @param zoom The minimum zoom.
24530     *
24531     * Markers only will be displayed when the map is displayed at @p zoom
24532     * or bigger.
24533     *
24534     * @see elm_map_group_class_new() for more details.
24535     * @see elm_map_marker_add()
24536     *
24537     * @ingroup Map
24538     */
24539    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
24540
24541    /**
24542     * Set the zoom from where the markers are no more grouped.
24543     *
24544     * @param clas The group class.
24545     * @param zoom The maximum zoom.
24546     *
24547     * Markers only will be grouped when the map is displayed at
24548     * less than @p zoom.
24549     *
24550     * @see elm_map_group_class_new() for more details.
24551     * @see elm_map_marker_add()
24552     *
24553     * @ingroup Map
24554     */
24555    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
24556
24557    /**
24558     * Set if the markers associated to the group class @clas are hidden or not.
24559     *
24560     * @param clas The group class.
24561     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
24562     * to show them.
24563     *
24564     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
24565     * is to show them.
24566     *
24567     * @ingroup Map
24568     */
24569    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
24570
24571    /**
24572     * Create a new marker class.
24573     *
24574     * @param obj The map object.
24575     * @return Returns the new group class.
24576     *
24577     * Each marker must be associated to a class.
24578     *
24579     * The marker class defines the style of the marker when a marker is
24580     * displayed alone, i.e., not grouped to to others markers. When grouped
24581     * it will use group class style.
24582     *
24583     * A marker class will need to be provided when creating a marker with
24584     * elm_map_marker_add().
24585     *
24586     * Some properties and functions can be set by class, as:
24587     * - style, with elm_map_marker_class_style_set()
24588     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
24589     *   It can be set using elm_map_marker_class_icon_cb_set().
24590     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
24591     *   Set using elm_map_marker_class_get_cb_set().
24592     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
24593     *   Set using elm_map_marker_class_del_cb_set().
24594     *
24595     * @see elm_map_marker_add()
24596     * @see elm_map_marker_class_style_set()
24597     * @see elm_map_marker_class_icon_cb_set()
24598     * @see elm_map_marker_class_get_cb_set()
24599     * @see elm_map_marker_class_del_cb_set()
24600     *
24601     * @ingroup Map
24602     */
24603    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
24604
24605    /**
24606     * Set the marker's style of a marker class.
24607     *
24608     * @param clas The marker class.
24609     * @param style The style to be used by markers.
24610     *
24611     * Each marker must be associated to a marker class, and will use the style
24612     * defined by such class when alone, i.e., @b not grouped to other markers.
24613     *
24614     * The following styles are provided by default theme:
24615     * @li @c radio
24616     * @li @c radio2
24617     * @li @c empty
24618     *
24619     * @see elm_map_marker_class_new() for more details.
24620     * @see elm_map_marker_add()
24621     *
24622     * @ingroup Map
24623     */
24624    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
24625
24626    /**
24627     * Set the icon callback function of a marker class.
24628     *
24629     * @param clas The marker class.
24630     * @param icon_get The callback function that will return the icon.
24631     *
24632     * Each marker must be associated to a marker class, and it can display a
24633     * custom icon. The function @p icon_get must return this icon.
24634     *
24635     * @see elm_map_marker_class_new() for more details.
24636     * @see elm_map_marker_add()
24637     *
24638     * @ingroup Map
24639     */
24640    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
24641
24642    /**
24643     * Set the bubble content callback function of a marker class.
24644     *
24645     * @param clas The marker class.
24646     * @param get The callback function that will return the content.
24647     *
24648     * Each marker must be associated to a marker class, and it can display a
24649     * a content on a bubble that opens when the user click over the marker.
24650     * The function @p get must return this content object.
24651     *
24652     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
24653     * can be used.
24654     *
24655     * @see elm_map_marker_class_new() for more details.
24656     * @see elm_map_marker_class_del_cb_set()
24657     * @see elm_map_marker_add()
24658     *
24659     * @ingroup Map
24660     */
24661    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
24662
24663    /**
24664     * Set the callback function used to delete bubble content of a marker class.
24665     *
24666     * @param clas The marker class.
24667     * @param del The callback function that will delete the content.
24668     *
24669     * Each marker must be associated to a marker class, and it can display a
24670     * a content on a bubble that opens when the user click over the marker.
24671     * The function to return such content can be set with
24672     * elm_map_marker_class_get_cb_set().
24673     *
24674     * If this content must be freed, a callback function need to be
24675     * set for that task with this function.
24676     *
24677     * If this callback is defined it will have to delete (or not) the
24678     * object inside, but if the callback is not defined the object will be
24679     * destroyed with evas_object_del().
24680     *
24681     * @see elm_map_marker_class_new() for more details.
24682     * @see elm_map_marker_class_get_cb_set()
24683     * @see elm_map_marker_add()
24684     *
24685     * @ingroup Map
24686     */
24687    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
24688
24689    /**
24690     * Get the list of available sources.
24691     *
24692     * @param obj The map object.
24693     * @return The source names list.
24694     *
24695     * It will provide a list with all available sources, that can be set as
24696     * current source with elm_map_source_name_set(), or get with
24697     * elm_map_source_name_get().
24698     *
24699     * Available sources:
24700     * @li "Mapnik"
24701     * @li "Osmarender"
24702     * @li "CycleMap"
24703     * @li "Maplint"
24704     *
24705     * @see elm_map_source_name_set() for more details.
24706     * @see elm_map_source_name_get()
24707     *
24708     * @ingroup Map
24709     */
24710    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24711
24712    /**
24713     * Set the source of the map.
24714     *
24715     * @param obj The map object.
24716     * @param source The source to be used.
24717     *
24718     * Map widget retrieves images that composes the map from a web service.
24719     * This web service can be set with this method.
24720     *
24721     * A different service can return a different maps with different
24722     * information and it can use different zoom values.
24723     *
24724     * The @p source_name need to match one of the names provided by
24725     * elm_map_source_names_get().
24726     *
24727     * The current source can be get using elm_map_source_name_get().
24728     *
24729     * @see elm_map_source_names_get()
24730     * @see elm_map_source_name_get()
24731     *
24732     *
24733     * @ingroup Map
24734     */
24735    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
24736
24737    /**
24738     * Get the name of currently used source.
24739     *
24740     * @param obj The map object.
24741     * @return Returns the name of the source in use.
24742     *
24743     * @see elm_map_source_name_set() for more details.
24744     *
24745     * @ingroup Map
24746     */
24747    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24748
24749    /**
24750     * Set the source of the route service to be used by the map.
24751     *
24752     * @param obj The map object.
24753     * @param source The route service to be used, being it one of
24754     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
24755     * and #ELM_MAP_ROUTE_SOURCE_ORS.
24756     *
24757     * Each one has its own algorithm, so the route retrieved may
24758     * differ depending on the source route. Now, only the default is working.
24759     *
24760     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
24761     * http://www.yournavigation.org/.
24762     *
24763     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
24764     * assumptions. Its routing core is based on Contraction Hierarchies.
24765     *
24766     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
24767     *
24768     * @see elm_map_route_source_get().
24769     *
24770     * @ingroup Map
24771     */
24772    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
24773
24774    /**
24775     * Get the current route source.
24776     *
24777     * @param obj The map object.
24778     * @return The source of the route service used by the map.
24779     *
24780     * @see elm_map_route_source_set() for details.
24781     *
24782     * @ingroup Map
24783     */
24784    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24785
24786    /**
24787     * Set the minimum zoom of the source.
24788     *
24789     * @param obj The map object.
24790     * @param zoom New minimum zoom value to be used.
24791     *
24792     * By default, it's 0.
24793     *
24794     * @ingroup Map
24795     */
24796    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
24797
24798    /**
24799     * Get the minimum zoom of the source.
24800     *
24801     * @param obj The map object.
24802     * @return Returns the minimum zoom of the source.
24803     *
24804     * @see elm_map_source_zoom_min_set() for details.
24805     *
24806     * @ingroup Map
24807     */
24808    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24809
24810    /**
24811     * Set the maximum zoom of the source.
24812     *
24813     * @param obj The map object.
24814     * @param zoom New maximum zoom value to be used.
24815     *
24816     * By default, it's 18.
24817     *
24818     * @ingroup Map
24819     */
24820    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
24821
24822    /**
24823     * Get the maximum zoom of the source.
24824     *
24825     * @param obj The map object.
24826     * @return Returns the maximum zoom of the source.
24827     *
24828     * @see elm_map_source_zoom_min_set() for details.
24829     *
24830     * @ingroup Map
24831     */
24832    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24833
24834    /**
24835     * Set the user agent used by the map object to access routing services.
24836     *
24837     * @param obj The map object.
24838     * @param user_agent The user agent to be used by the map.
24839     *
24840     * User agent is a client application implementing a network protocol used
24841     * in communications within a clientā€“server distributed computing system
24842     *
24843     * The @p user_agent identification string will transmitted in a header
24844     * field @c User-Agent.
24845     *
24846     * @see elm_map_user_agent_get()
24847     *
24848     * @ingroup Map
24849     */
24850    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
24851
24852    /**
24853     * Get the user agent used by the map object.
24854     *
24855     * @param obj The map object.
24856     * @return The user agent identification string used by the map.
24857     *
24858     * @see elm_map_user_agent_set() for details.
24859     *
24860     * @ingroup Map
24861     */
24862    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24863
24864    /**
24865     * Add a new route to the map object.
24866     *
24867     * @param obj The map object.
24868     * @param type The type of transport to be considered when tracing a route.
24869     * @param method The routing method, what should be priorized.
24870     * @param flon The start longitude.
24871     * @param flat The start latitude.
24872     * @param tlon The destination longitude.
24873     * @param tlat The destination latitude.
24874     *
24875     * @return The created route or @c NULL upon failure.
24876     *
24877     * A route will be traced by point on coordinates (@p flat, @p flon)
24878     * to point on coordinates (@p tlat, @p tlon), using the route service
24879     * set with elm_map_route_source_set().
24880     *
24881     * It will take @p type on consideration to define the route,
24882     * depending if the user will be walking or driving, the route may vary.
24883     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
24884     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
24885     *
24886     * Another parameter is what the route should priorize, the minor distance
24887     * or the less time to be spend on the route. So @p method should be one
24888     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
24889     *
24890     * Routes created with this method can be deleted with
24891     * elm_map_route_remove(), colored with elm_map_route_color_set(),
24892     * and distance can be get with elm_map_route_distance_get().
24893     *
24894     * @see elm_map_route_remove()
24895     * @see elm_map_route_color_set()
24896     * @see elm_map_route_distance_get()
24897     * @see elm_map_route_source_set()
24898     *
24899     * @ingroup Map
24900     */
24901    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);
24902
24903    /**
24904     * Remove a route from the map.
24905     *
24906     * @param route The route to remove.
24907     *
24908     * @see elm_map_route_add()
24909     *
24910     * @ingroup Map
24911     */
24912    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24913
24914    /**
24915     * Set the route color.
24916     *
24917     * @param route The route object.
24918     * @param r Red channel value, from 0 to 255.
24919     * @param g Green channel value, from 0 to 255.
24920     * @param b Blue channel value, from 0 to 255.
24921     * @param a Alpha channel value, from 0 to 255.
24922     *
24923     * It uses an additive color model, so each color channel represents
24924     * how much of each primary colors must to be used. 0 represents
24925     * ausence of this color, so if all of the three are set to 0,
24926     * the color will be black.
24927     *
24928     * These component values should be integers in the range 0 to 255,
24929     * (single 8-bit byte).
24930     *
24931     * This sets the color used for the route. By default, it is set to
24932     * solid red (r = 255, g = 0, b = 0, a = 255).
24933     *
24934     * For alpha channel, 0 represents completely transparent, and 255, opaque.
24935     *
24936     * @see elm_map_route_color_get()
24937     *
24938     * @ingroup Map
24939     */
24940    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24941
24942    /**
24943     * Get the route color.
24944     *
24945     * @param route The route object.
24946     * @param r Pointer where to store the red channel value.
24947     * @param g Pointer where to store the green channel value.
24948     * @param b Pointer where to store the blue channel value.
24949     * @param a Pointer where to store the alpha channel value.
24950     *
24951     * @see elm_map_route_color_set() for details.
24952     *
24953     * @ingroup Map
24954     */
24955    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24956
24957    /**
24958     * Get the route distance in kilometers.
24959     *
24960     * @param route The route object.
24961     * @return The distance of route (unit : km).
24962     *
24963     * @ingroup Map
24964     */
24965    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24966
24967    /**
24968     * Get the information of route nodes.
24969     *
24970     * @param route The route object.
24971     * @return Returns a string with the nodes of route.
24972     *
24973     * @ingroup Map
24974     */
24975    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24976
24977    /**
24978     * Get the information of route waypoint.
24979     *
24980     * @param route the route object.
24981     * @return Returns a string with information about waypoint of route.
24982     *
24983     * @ingroup Map
24984     */
24985    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24986
24987    /**
24988     * Get the address of the name.
24989     *
24990     * @param name The name handle.
24991     * @return Returns the address string of @p name.
24992     *
24993     * This gets the coordinates of the @p name, created with one of the
24994     * conversion functions.
24995     *
24996     * @see elm_map_utils_convert_name_into_coord()
24997     * @see elm_map_utils_convert_coord_into_name()
24998     *
24999     * @ingroup Map
25000     */
25001    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
25002
25003    /**
25004     * Get the current coordinates of the name.
25005     *
25006     * @param name The name handle.
25007     * @param lat Pointer where to store the latitude.
25008     * @param lon Pointer where to store The longitude.
25009     *
25010     * This gets the coordinates of the @p name, created with one of the
25011     * conversion functions.
25012     *
25013     * @see elm_map_utils_convert_name_into_coord()
25014     * @see elm_map_utils_convert_coord_into_name()
25015     *
25016     * @ingroup Map
25017     */
25018    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
25019
25020    /**
25021     * Remove a name from the map.
25022     *
25023     * @param name The name to remove.
25024     *
25025     * Basically the struct handled by @p name will be freed, so convertions
25026     * between address and coordinates will be lost.
25027     *
25028     * @see elm_map_utils_convert_name_into_coord()
25029     * @see elm_map_utils_convert_coord_into_name()
25030     *
25031     * @ingroup Map
25032     */
25033    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
25034
25035    /**
25036     * Rotate the map.
25037     *
25038     * @param obj The map object.
25039     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
25040     * @param cx Rotation's center horizontal position.
25041     * @param cy Rotation's center vertical position.
25042     *
25043     * @see elm_map_rotate_get()
25044     *
25045     * @ingroup Map
25046     */
25047    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
25048
25049    /**
25050     * Get the rotate degree of the map
25051     *
25052     * @param obj The map object
25053     * @param degree Pointer where to store degrees from 0.0 to 360.0
25054     * to rotate arount Z axis.
25055     * @param cx Pointer where to store rotation's center horizontal position.
25056     * @param cy Pointer where to store rotation's center vertical position.
25057     *
25058     * @see elm_map_rotate_set() to set map rotation.
25059     *
25060     * @ingroup Map
25061     */
25062    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);
25063
25064    /**
25065     * Enable or disable mouse wheel to be used to zoom in / out the map.
25066     *
25067     * @param obj The map object.
25068     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
25069     * to enable it.
25070     *
25071     * Mouse wheel can be used for the user to zoom in or zoom out the map.
25072     *
25073     * It's disabled by default.
25074     *
25075     * @see elm_map_wheel_disabled_get()
25076     *
25077     * @ingroup Map
25078     */
25079    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
25080
25081    /**
25082     * Get a value whether mouse wheel is enabled or not.
25083     *
25084     * @param obj The map object.
25085     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
25086     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25087     *
25088     * Mouse wheel can be used for the user to zoom in or zoom out the map.
25089     *
25090     * @see elm_map_wheel_disabled_set() for details.
25091     *
25092     * @ingroup Map
25093     */
25094    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25095
25096 #ifdef ELM_EMAP
25097    /**
25098     * Add a track on the map
25099     *
25100     * @param obj The map object.
25101     * @param emap The emap route object.
25102     * @return The route object. This is an elm object of type Route.
25103     *
25104     * @see elm_route_add() for details.
25105     *
25106     * @ingroup Map
25107     */
25108    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
25109 #endif
25110
25111    /**
25112     * Remove a track from the map
25113     *
25114     * @param obj The map object.
25115     * @param route The track to remove.
25116     *
25117     * @ingroup Map
25118     */
25119    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
25120
25121    /**
25122     * @}
25123     */
25124
25125    /* Route */
25126    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
25127 #ifdef ELM_EMAP
25128    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
25129 #endif
25130    EAPI double elm_route_lon_min_get(Evas_Object *obj);
25131    EAPI double elm_route_lat_min_get(Evas_Object *obj);
25132    EAPI double elm_route_lon_max_get(Evas_Object *obj);
25133    EAPI double elm_route_lat_max_get(Evas_Object *obj);
25134
25135
25136    /**
25137     * @defgroup Panel Panel
25138     *
25139     * @image html img/widget/panel/preview-00.png
25140     * @image latex img/widget/panel/preview-00.eps
25141     *
25142     * @brief A panel is a type of animated container that contains subobjects.
25143     * It can be expanded or contracted by clicking the button on it's edge.
25144     *
25145     * Orientations are as follows:
25146     * @li ELM_PANEL_ORIENT_TOP
25147     * @li ELM_PANEL_ORIENT_LEFT
25148     * @li ELM_PANEL_ORIENT_RIGHT
25149     *
25150     * Default contents parts of the panel widget that you can use for are:
25151     * @li "default" - A content of the panel
25152     *
25153     * @ref tutorial_panel shows one way to use this widget.
25154     * @{
25155     */
25156    typedef enum _Elm_Panel_Orient
25157      {
25158         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
25159         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
25160         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
25161         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
25162      } Elm_Panel_Orient;
25163
25164    /**
25165     * @brief Adds a panel object
25166     *
25167     * @param parent The parent object
25168     *
25169     * @return The panel object, or NULL on failure
25170     */
25171    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25172
25173    /**
25174     * @brief Sets the orientation of the panel
25175     *
25176     * @param parent The parent object
25177     * @param orient The panel orientation. Can be one of the following:
25178     * @li ELM_PANEL_ORIENT_TOP
25179     * @li ELM_PANEL_ORIENT_LEFT
25180     * @li ELM_PANEL_ORIENT_RIGHT
25181     *
25182     * Sets from where the panel will (dis)appear.
25183     */
25184    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
25185
25186    /**
25187     * @brief Get the orientation of the panel.
25188     *
25189     * @param obj The panel object
25190     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
25191     */
25192    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25193
25194    /**
25195     * @brief Set the content of the panel.
25196     *
25197     * @param obj The panel object
25198     * @param content The panel content
25199     *
25200     * Once the content object is set, a previously set one will be deleted.
25201     * If you want to keep that old content object, use the
25202     * elm_panel_content_unset() function.
25203     *
25204     * @deprecated use elm_object_content_set() instead
25205     *
25206     */
25207    EINA_DEPRECATED EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25208
25209    /**
25210     * @brief Get the content of the panel.
25211     *
25212     * @param obj The panel object
25213     * @return The content that is being used
25214     *
25215     * Return the content object which is set for this widget.
25216     *
25217     * @see elm_panel_content_set()
25218     *
25219     * @deprecated use elm_object_content_get() instead
25220     *
25221     */
25222    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25223
25224    /**
25225     * @brief Unset the content of the panel.
25226     *
25227     * @param obj The panel object
25228     * @return The content that was being used
25229     *
25230     * Unparent and return the content object which was set for this widget.
25231     *
25232     * @see elm_panel_content_set()
25233     *
25234     * @deprecated use elm_object_content_unset() instead
25235     *
25236     */
25237    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25238
25239    /**
25240     * @brief Set the state of the panel.
25241     *
25242     * @param obj The panel object
25243     * @param hidden If true, the panel will run the animation to contract
25244     */
25245    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
25246
25247    /**
25248     * @brief Get the state of the panel.
25249     *
25250     * @param obj The panel object
25251     * @param hidden If true, the panel is in the "hide" state
25252     */
25253    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25254
25255    /**
25256     * @brief Toggle the hidden state of the panel from code
25257     *
25258     * @param obj The panel object
25259     */
25260    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
25261
25262    /**
25263     * @}
25264     */
25265
25266    /**
25267     * @defgroup Panes Panes
25268     * @ingroup Elementary
25269     *
25270     * @image html img/widget/panes/preview-00.png
25271     * @image latex img/widget/panes/preview-00.eps width=\textwidth
25272     *
25273     * @image html img/panes.png
25274     * @image latex img/panes.eps width=\textwidth
25275     *
25276     * The panes adds a dragable bar between two contents. When dragged
25277     * this bar will resize contents size.
25278     *
25279     * Panes can be displayed vertically or horizontally, and contents
25280     * size proportion can be customized (homogeneous by default).
25281     *
25282     * Smart callbacks one can listen to:
25283     * - "press" - The panes has been pressed (button wasn't released yet).
25284     * - "unpressed" - The panes was released after being pressed.
25285     * - "clicked" - The panes has been clicked>
25286     * - "clicked,double" - The panes has been double clicked
25287     *
25288     * Available styles for it:
25289     * - @c "default"
25290     *
25291     * Default contents parts of the panes widget that you can use for are:
25292     * @li "left" - A leftside content of the panes
25293     * @li "right" - A rightside content of the panes
25294     *
25295     * If panes is displayed vertically, left content will be displayed at
25296     * top.
25297     *
25298     * Here is an example on its usage:
25299     * @li @ref panes_example
25300     */
25301
25302    /**
25303     * @addtogroup Panes
25304     * @{
25305     */
25306
25307    /**
25308     * Add a new panes widget to the given parent Elementary
25309     * (container) object.
25310     *
25311     * @param parent The parent object.
25312     * @return a new panes widget handle or @c NULL, on errors.
25313     *
25314     * This function inserts a new panes widget on the canvas.
25315     *
25316     * @ingroup Panes
25317     */
25318    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25319
25320    /**
25321     * Set the left content of the panes widget.
25322     *
25323     * @param obj The panes object.
25324     * @param content The new left content object.
25325     *
25326     * Once the content object is set, a previously set one will be deleted.
25327     * If you want to keep that old content object, use the
25328     * elm_panes_content_left_unset() function.
25329     *
25330     * If panes is displayed vertically, left content will be displayed at
25331     * top.
25332     *
25333     * @see elm_panes_content_left_get()
25334     * @see elm_panes_content_right_set() to set content on the other side.
25335     *
25336     * @deprecated use elm_object_part_content_set() instead
25337     *
25338     * @ingroup Panes
25339     */
25340    EINA_DEPRECATED EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25341
25342    /**
25343     * Set the right content of the panes widget.
25344     *
25345     * @param obj The panes object.
25346     * @param content The new right content object.
25347     *
25348     * Once the content object is set, a previously set one will be deleted.
25349     * If you want to keep that old content object, use the
25350     * elm_panes_content_right_unset() function.
25351     *
25352     * If panes is displayed vertically, left content will be displayed at
25353     * bottom.
25354     *
25355     * @see elm_panes_content_right_get()
25356     * @see elm_panes_content_left_set() to set content on the other side.
25357     *
25358     * @deprecated use elm_object_part_content_set() instead
25359     *
25360     * @ingroup Panes
25361     */
25362    EINA_DEPRECATED EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25363
25364    /**
25365     * Get the left content of the panes.
25366     *
25367     * @param obj The panes object.
25368     * @return The left content object that is being used.
25369     *
25370     * Return the left content object which is set for this widget.
25371     *
25372     * @see elm_panes_content_left_set() for details.
25373     *
25374     * @deprecated use elm_object_part_content_get() instead
25375     *
25376     * @ingroup Panes
25377     */
25378    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25379
25380    /**
25381     * Get the right content of the panes.
25382     *
25383     * @param obj The panes object
25384     * @return The right content object that is being used
25385     *
25386     * Return the right content object which is set for this widget.
25387     *
25388     * @see elm_panes_content_right_set() for details.
25389     *
25390     * @deprecated use elm_object_part_content_get() instead
25391     *
25392     * @ingroup Panes
25393     */
25394    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25395
25396    /**
25397     * Unset the left content used for the panes.
25398     *
25399     * @param obj The panes object.
25400     * @return The left content object that was being used.
25401     *
25402     * Unparent and return the left content object which was set for this widget.
25403     *
25404     * @see elm_panes_content_left_set() for details.
25405     * @see elm_panes_content_left_get().
25406     *
25407     * @deprecated use elm_object_part_content_unset() instead
25408     *
25409     * @ingroup Panes
25410     */
25411    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25412
25413    /**
25414     * Unset the right content used for the panes.
25415     *
25416     * @param obj The panes object.
25417     * @return The right content object that was being used.
25418     *
25419     * Unparent and return the right content object which was set for this
25420     * widget.
25421     *
25422     * @see elm_panes_content_right_set() for details.
25423     * @see elm_panes_content_right_get().
25424     *
25425     * @deprecated use elm_object_part_content_unset() instead
25426     *
25427     * @ingroup Panes
25428     */
25429    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25430
25431    /**
25432     * Get the size proportion of panes widget's left side.
25433     *
25434     * @param obj The panes object.
25435     * @return float value between 0.0 and 1.0 representing size proportion
25436     * of left side.
25437     *
25438     * @see elm_panes_content_left_size_set() for more details.
25439     *
25440     * @ingroup Panes
25441     */
25442    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25443
25444    /**
25445     * Set the size proportion of panes widget's left side.
25446     *
25447     * @param obj The panes object.
25448     * @param size Value between 0.0 and 1.0 representing size proportion
25449     * of left side.
25450     *
25451     * By default it's homogeneous, i.e., both sides have the same size.
25452     *
25453     * If something different is required, it can be set with this function.
25454     * For example, if the left content should be displayed over
25455     * 75% of the panes size, @p size should be passed as @c 0.75.
25456     * This way, right content will be resized to 25% of panes size.
25457     *
25458     * If displayed vertically, left content is displayed at top, and
25459     * right content at bottom.
25460     *
25461     * @note This proportion will change when user drags the panes bar.
25462     *
25463     * @see elm_panes_content_left_size_get()
25464     *
25465     * @ingroup Panes
25466     */
25467    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
25468
25469   /**
25470    * Set the orientation of a given panes widget.
25471    *
25472    * @param obj The panes object.
25473    * @param horizontal Use @c EINA_TRUE to make @p obj to be
25474    * @b horizontal, @c EINA_FALSE to make it @b vertical.
25475    *
25476    * Use this function to change how your panes is to be
25477    * disposed: vertically or horizontally.
25478    *
25479    * By default it's displayed horizontally.
25480    *
25481    * @see elm_panes_horizontal_get()
25482    *
25483    * @ingroup Panes
25484    */
25485    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
25486
25487    /**
25488     * Retrieve the orientation of a given panes widget.
25489     *
25490     * @param obj The panes object.
25491     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
25492     * @c EINA_FALSE if it's @b vertical (and on errors).
25493     *
25494     * @see elm_panes_horizontal_set() for more details.
25495     *
25496     * @ingroup Panes
25497     */
25498    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25499    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
25500    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25501
25502    /**
25503     * @}
25504     */
25505
25506    /**
25507     * @defgroup Flip Flip
25508     *
25509     * @image html img/widget/flip/preview-00.png
25510     * @image latex img/widget/flip/preview-00.eps
25511     *
25512     * This widget holds 2 content objects(Evas_Object): one on the front and one
25513     * on the back. It allows you to flip from front to back and vice-versa using
25514     * various animations.
25515     *
25516     * If either the front or back contents are not set the flip will treat that
25517     * as transparent. So if you wore to set the front content but not the back,
25518     * and then call elm_flip_go() you would see whatever is below the flip.
25519     *
25520     * For a list of supported animations see elm_flip_go().
25521     *
25522     * Signals that you can add callbacks for are:
25523     * "animate,begin" - when a flip animation was started
25524     * "animate,done" - when a flip animation is finished
25525     *
25526     * @ref tutorial_flip show how to use most of the API.
25527     *
25528     * @{
25529     */
25530    typedef enum _Elm_Flip_Mode
25531      {
25532         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
25533         ELM_FLIP_ROTATE_X_CENTER_AXIS,
25534         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
25535         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
25536         ELM_FLIP_CUBE_LEFT,
25537         ELM_FLIP_CUBE_RIGHT,
25538         ELM_FLIP_CUBE_UP,
25539         ELM_FLIP_CUBE_DOWN,
25540         ELM_FLIP_PAGE_LEFT,
25541         ELM_FLIP_PAGE_RIGHT,
25542         ELM_FLIP_PAGE_UP,
25543         ELM_FLIP_PAGE_DOWN
25544      } Elm_Flip_Mode;
25545    typedef enum _Elm_Flip_Interaction
25546      {
25547         ELM_FLIP_INTERACTION_NONE,
25548         ELM_FLIP_INTERACTION_ROTATE,
25549         ELM_FLIP_INTERACTION_CUBE,
25550         ELM_FLIP_INTERACTION_PAGE
25551      } Elm_Flip_Interaction;
25552    typedef enum _Elm_Flip_Direction
25553      {
25554         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
25555         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
25556         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
25557         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
25558      } Elm_Flip_Direction;
25559
25560    /**
25561     * @brief Add a new flip to the parent
25562     *
25563     * @param parent The parent object
25564     * @return The new object or NULL if it cannot be created
25565     */
25566    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25567
25568    /**
25569     * @brief Set the front content of the flip widget.
25570     *
25571     * @param obj The flip object
25572     * @param content The new front content object
25573     *
25574     * Once the content object is set, a previously set one will be deleted.
25575     * If you want to keep that old content object, use the
25576     * elm_flip_content_front_unset() function.
25577     */
25578    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25579
25580    /**
25581     * @brief Set the back content of the flip widget.
25582     *
25583     * @param obj The flip object
25584     * @param content The new back content object
25585     *
25586     * Once the content object is set, a previously set one will be deleted.
25587     * If you want to keep that old content object, use the
25588     * elm_flip_content_back_unset() function.
25589     */
25590    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25591
25592    /**
25593     * @brief Get the front content used for the flip
25594     *
25595     * @param obj The flip object
25596     * @return The front content object that is being used
25597     *
25598     * Return the front content object which is set for this widget.
25599     */
25600    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25601
25602    /**
25603     * @brief Get the back content used for the flip
25604     *
25605     * @param obj The flip object
25606     * @return The back content object that is being used
25607     *
25608     * Return the back content object which is set for this widget.
25609     */
25610    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25611
25612    /**
25613     * @brief Unset the front content used for the flip
25614     *
25615     * @param obj The flip object
25616     * @return The front content object that was being used
25617     *
25618     * Unparent and return the front content object which was set for this widget.
25619     */
25620    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25621
25622    /**
25623     * @brief Unset the back content used for the flip
25624     *
25625     * @param obj The flip object
25626     * @return The back content object that was being used
25627     *
25628     * Unparent and return the back content object which was set for this widget.
25629     */
25630    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25631
25632    /**
25633     * @brief Get flip front visibility state
25634     *
25635     * @param obj The flip objct
25636     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
25637     * showing.
25638     */
25639    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25640
25641    /**
25642     * @brief Set flip perspective
25643     *
25644     * @param obj The flip object
25645     * @param foc The coordinate to set the focus on
25646     * @param x The X coordinate
25647     * @param y The Y coordinate
25648     *
25649     * @warning This function currently does nothing.
25650     */
25651    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
25652
25653    /**
25654     * @brief Runs the flip animation
25655     *
25656     * @param obj The flip object
25657     * @param mode The mode type
25658     *
25659     * Flips the front and back contents using the @p mode animation. This
25660     * efectively hides the currently visible content and shows the hidden one.
25661     *
25662     * There a number of possible animations to use for the flipping:
25663     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
25664     * around a horizontal axis in the middle of its height, the other content
25665     * is shown as the other side of the flip.
25666     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
25667     * around a vertical axis in the middle of its width, the other content is
25668     * shown as the other side of the flip.
25669     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
25670     * around a diagonal axis in the middle of its width, the other content is
25671     * shown as the other side of the flip.
25672     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
25673     * around a diagonal axis in the middle of its height, the other content is
25674     * shown as the other side of the flip.
25675     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
25676     * as if the flip was a cube, the other content is show as the right face of
25677     * the cube.
25678     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
25679     * right as if the flip was a cube, the other content is show as the left
25680     * face of the cube.
25681     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
25682     * flip was a cube, the other content is show as the bottom face of the cube.
25683     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
25684     * the flip was a cube, the other content is show as the upper face of the
25685     * cube.
25686     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
25687     * if the flip was a book, the other content is shown as the page below that.
25688     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
25689     * as if the flip was a book, the other content is shown as the page below
25690     * that.
25691     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
25692     * flip was a book, the other content is shown as the page below that.
25693     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
25694     * flip was a book, the other content is shown as the page below that.
25695     *
25696     * @image html elm_flip.png
25697     * @image latex elm_flip.eps width=\textwidth
25698     */
25699    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
25700
25701    /**
25702     * @brief Set the interactive flip mode
25703     *
25704     * @param obj The flip object
25705     * @param mode The interactive flip mode to use
25706     *
25707     * This sets if the flip should be interactive (allow user to click and
25708     * drag a side of the flip to reveal the back page and cause it to flip).
25709     * By default a flip is not interactive. You may also need to set which
25710     * sides of the flip are "active" for flipping and how much space they use
25711     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
25712     * and elm_flip_interacton_direction_hitsize_set()
25713     *
25714     * The four avilable mode of interaction are:
25715     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
25716     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
25717     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
25718     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
25719     *
25720     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
25721     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
25722     * happen, those can only be acheived with elm_flip_go();
25723     */
25724    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
25725
25726    /**
25727     * @brief Get the interactive flip mode
25728     *
25729     * @param obj The flip object
25730     * @return The interactive flip mode
25731     *
25732     * Returns the interactive flip mode set by elm_flip_interaction_set()
25733     */
25734    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
25735
25736    /**
25737     * @brief Set which directions of the flip respond to interactive flip
25738     *
25739     * @param obj The flip object
25740     * @param dir The direction to change
25741     * @param enabled If that direction is enabled or not
25742     *
25743     * By default all directions are disabled, so you may want to enable the
25744     * desired directions for flipping if you need interactive flipping. You must
25745     * call this function once for each direction that should be enabled.
25746     *
25747     * @see elm_flip_interaction_set()
25748     */
25749    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
25750
25751    /**
25752     * @brief Get the enabled state of that flip direction
25753     *
25754     * @param obj The flip object
25755     * @param dir The direction to check
25756     * @return If that direction is enabled or not
25757     *
25758     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
25759     *
25760     * @see elm_flip_interaction_set()
25761     */
25762    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
25763
25764    /**
25765     * @brief Set the amount of the flip that is sensitive to interactive flip
25766     *
25767     * @param obj The flip object
25768     * @param dir The direction to modify
25769     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
25770     *
25771     * Set the amount of the flip that is sensitive to interactive flip, with 0
25772     * representing no area in the flip and 1 representing the entire flip. There
25773     * is however a consideration to be made in that the area will never be
25774     * smaller than the finger size set(as set in your Elementary configuration).
25775     *
25776     * @see elm_flip_interaction_set()
25777     */
25778    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
25779
25780    /**
25781     * @brief Get the amount of the flip that is sensitive to interactive flip
25782     *
25783     * @param obj The flip object
25784     * @param dir The direction to check
25785     * @return The size set for that direction
25786     *
25787     * Returns the amount os sensitive area set by
25788     * elm_flip_interacton_direction_hitsize_set().
25789     */
25790    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
25791
25792    /**
25793     * @}
25794     */
25795
25796    /* scrolledentry */
25797    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25798    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
25799    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25800    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
25801    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25802    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
25803    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25804    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
25805    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25806    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25807    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
25808    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
25809    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
25810    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25811    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
25812    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
25813    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25814    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25815    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
25816    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
25817    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25818    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25819    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25820    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25821    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
25822    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
25823    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25824    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25825    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25826    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25827    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25828    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
25829    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
25830    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
25831    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25832    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);
25833    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
25834    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25835    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);
25836    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25837    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);
25838    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
25839    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25840    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25841    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
25842    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
25843    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25844    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25845    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
25846    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);
25847    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);
25848    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);
25849    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);
25850    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);
25851    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);
25852    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
25853    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
25854    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
25855    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
25856    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25857    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
25858    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
25859
25860    /**
25861     * @defgroup Conformant Conformant
25862     * @ingroup Elementary
25863     *
25864     * @image html img/widget/conformant/preview-00.png
25865     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
25866     *
25867     * @image html img/conformant.png
25868     * @image latex img/conformant.eps width=\textwidth
25869     *
25870     * The aim is to provide a widget that can be used in elementary apps to
25871     * account for space taken up by the indicator, virtual keypad & softkey
25872     * windows when running the illume2 module of E17.
25873     *
25874     * So conformant content will be sized and positioned considering the
25875     * space required for such stuff, and when they popup, as a keyboard
25876     * shows when an entry is selected, conformant content won't change.
25877     *
25878     * Available styles for it:
25879     * - @c "default"
25880     *
25881     * Default contents parts of the conformant widget that you can use for are:
25882     * @li "default" - A content of the conformant
25883     *
25884     * See how to use this widget in this example:
25885     * @ref conformant_example
25886     */
25887
25888    /**
25889     * @addtogroup Conformant
25890     * @{
25891     */
25892
25893    /**
25894     * Add a new conformant widget to the given parent Elementary
25895     * (container) object.
25896     *
25897     * @param parent The parent object.
25898     * @return A new conformant widget handle or @c NULL, on errors.
25899     *
25900     * This function inserts a new conformant widget on the canvas.
25901     *
25902     * @ingroup Conformant
25903     */
25904    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25905
25906    /**
25907     * Set the content of the conformant widget.
25908     *
25909     * @param obj The conformant object.
25910     * @param content The content to be displayed by the conformant.
25911     *
25912     * Content will be sized and positioned considering the space required
25913     * to display a virtual keyboard. So it won't fill all the conformant
25914     * size. This way is possible to be sure that content won't resize
25915     * or be re-positioned after the keyboard is displayed.
25916     *
25917     * Once the content object is set, a previously set one will be deleted.
25918     * If you want to keep that old content object, use the
25919     * elm_object_content_unset() function.
25920     *
25921     * @see elm_object_content_unset()
25922     * @see elm_object_content_get()
25923     *
25924     * @deprecated use elm_object_content_set() instead
25925     *
25926     * @ingroup Conformant
25927     */
25928    EINA_DEPRECATED EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25929
25930    /**
25931     * Get the content of the conformant widget.
25932     *
25933     * @param obj The conformant object.
25934     * @return The content that is being used.
25935     *
25936     * Return the content object which is set for this widget.
25937     * It won't be unparent from conformant. For that, use
25938     * elm_object_content_unset().
25939     *
25940     * @see elm_object_content_set().
25941     * @see elm_object_content_unset()
25942     *
25943     * @deprecated use elm_object_content_get() instead
25944     *
25945     * @ingroup Conformant
25946     */
25947    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25948
25949    /**
25950     * Unset the content of the conformant widget.
25951     *
25952     * @param obj The conformant object.
25953     * @return The content that was being used.
25954     *
25955     * Unparent and return the content object which was set for this widget.
25956     *
25957     * @see elm_object_content_set().
25958     *
25959     * @deprecated use elm_object_content_unset() instead
25960     *
25961     * @ingroup Conformant
25962     */
25963    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25964
25965    /**
25966     * Returns the Evas_Object that represents the content area.
25967     *
25968     * @param obj The conformant object.
25969     * @return The content area of the widget.
25970     *
25971     * @ingroup Conformant
25972     */
25973    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25974
25975    /**
25976     * @}
25977     */
25978
25979    /**
25980     * @defgroup Mapbuf Mapbuf
25981     * @ingroup Elementary
25982     *
25983     * @image html img/widget/mapbuf/preview-00.png
25984     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
25985     *
25986     * This holds one content object and uses an Evas Map of transformation
25987     * points to be later used with this content. So the content will be
25988     * moved, resized, etc as a single image. So it will improve performance
25989     * when you have a complex interafce, with a lot of elements, and will
25990     * need to resize or move it frequently (the content object and its
25991     * children).
25992     *
25993     * Default contents parts of the mapbuf widget that you can use for are:
25994     * @li "default" - A content of the mapbuf
25995     *
25996     * To enable map, elm_mapbuf_enabled_set() should be used.
25997     *
25998     * See how to use this widget in this example:
25999     * @ref mapbuf_example
26000     */
26001
26002    /**
26003     * @addtogroup Mapbuf
26004     * @{
26005     */
26006
26007    /**
26008     * Add a new mapbuf widget to the given parent Elementary
26009     * (container) object.
26010     *
26011     * @param parent The parent object.
26012     * @return A new mapbuf widget handle or @c NULL, on errors.
26013     *
26014     * This function inserts a new mapbuf widget on the canvas.
26015     *
26016     * @ingroup Mapbuf
26017     */
26018    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26019
26020    /**
26021     * Set the content of the mapbuf.
26022     *
26023     * @param obj The mapbuf object.
26024     * @param content The content that will be filled in this mapbuf object.
26025     *
26026     * Once the content object is set, a previously set one will be deleted.
26027     * If you want to keep that old content object, use the
26028     * elm_mapbuf_content_unset() function.
26029     *
26030     * To enable map, elm_mapbuf_enabled_set() should be used.
26031     *
26032     * @deprecated use elm_object_content_set() instead
26033     *
26034     * @ingroup Mapbuf
26035     */
26036    EINA_DEPRECATED EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
26037
26038    /**
26039     * Get the content of the mapbuf.
26040     *
26041     * @param obj The mapbuf object.
26042     * @return The content that is being used.
26043     *
26044     * Return the content object which is set for this widget.
26045     *
26046     * @see elm_mapbuf_content_set() for details.
26047     *
26048     * @deprecated use elm_object_content_get() instead
26049     *
26050     * @ingroup Mapbuf
26051     */
26052    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26053
26054    /**
26055     * Unset the content of the mapbuf.
26056     *
26057     * @param obj The mapbuf object.
26058     * @return The content that was being used.
26059     *
26060     * Unparent and return the content object which was set for this widget.
26061     *
26062     * @see elm_mapbuf_content_set() for details.
26063     *
26064     * @deprecated use elm_object_content_unset() instead
26065     *
26066     * @ingroup Mapbuf
26067     */
26068    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26069
26070    /**
26071     * Enable or disable the map.
26072     *
26073     * @param obj The mapbuf object.
26074     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
26075     *
26076     * This enables the map that is set or disables it. On enable, the object
26077     * geometry will be saved, and the new geometry will change (position and
26078     * size) to reflect the map geometry set.
26079     *
26080     * Also, when enabled, alpha and smooth states will be used, so if the
26081     * content isn't solid, alpha should be enabled, for example, otherwise
26082     * a black retangle will fill the content.
26083     *
26084     * When disabled, the stored map will be freed and geometry prior to
26085     * enabling the map will be restored.
26086     *
26087     * It's disabled by default.
26088     *
26089     * @see elm_mapbuf_alpha_set()
26090     * @see elm_mapbuf_smooth_set()
26091     *
26092     * @ingroup Mapbuf
26093     */
26094    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26095
26096    /**
26097     * Get a value whether map is enabled or not.
26098     *
26099     * @param obj The mapbuf object.
26100     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
26101     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26102     *
26103     * @see elm_mapbuf_enabled_set() for details.
26104     *
26105     * @ingroup Mapbuf
26106     */
26107    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26108
26109    /**
26110     * Enable or disable smooth map rendering.
26111     *
26112     * @param obj The mapbuf object.
26113     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
26114     * to disable it.
26115     *
26116     * This sets smoothing for map rendering. If the object is a type that has
26117     * its own smoothing settings, then both the smooth settings for this object
26118     * and the map must be turned off.
26119     *
26120     * By default smooth maps are enabled.
26121     *
26122     * @ingroup Mapbuf
26123     */
26124    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
26125
26126    /**
26127     * Get a value whether smooth map rendering is enabled or not.
26128     *
26129     * @param obj The mapbuf object.
26130     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
26131     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26132     *
26133     * @see elm_mapbuf_smooth_set() for details.
26134     *
26135     * @ingroup Mapbuf
26136     */
26137    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26138
26139    /**
26140     * Set or unset alpha flag for map rendering.
26141     *
26142     * @param obj The mapbuf object.
26143     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
26144     * to disable it.
26145     *
26146     * This sets alpha flag for map rendering. If the object is a type that has
26147     * its own alpha settings, then this will take precedence. Only image objects
26148     * have this currently. It stops alpha blending of the map area, and is
26149     * useful if you know the object and/or all sub-objects is 100% solid.
26150     *
26151     * Alpha is enabled by default.
26152     *
26153     * @ingroup Mapbuf
26154     */
26155    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
26156
26157    /**
26158     * Get a value whether alpha blending is enabled or not.
26159     *
26160     * @param obj The mapbuf object.
26161     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
26162     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26163     *
26164     * @see elm_mapbuf_alpha_set() for details.
26165     *
26166     * @ingroup Mapbuf
26167     */
26168    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26169
26170    /**
26171     * @}
26172     */
26173
26174    /**
26175     * @defgroup Flipselector Flip Selector
26176     *
26177     * @image html img/widget/flipselector/preview-00.png
26178     * @image latex img/widget/flipselector/preview-00.eps
26179     *
26180     * A flip selector is a widget to show a set of @b text items, one
26181     * at a time, with the same sheet switching style as the @ref Clock
26182     * "clock" widget, when one changes the current displaying sheet
26183     * (thus, the "flip" in the name).
26184     *
26185     * User clicks to flip sheets which are @b held for some time will
26186     * make the flip selector to flip continuosly and automatically for
26187     * the user. The interval between flips will keep growing in time,
26188     * so that it helps the user to reach an item which is distant from
26189     * the current selection.
26190     *
26191     * Smart callbacks one can register to:
26192     * - @c "selected" - when the widget's selected text item is changed
26193     * - @c "overflowed" - when the widget's current selection is changed
26194     *   from the first item in its list to the last
26195     * - @c "underflowed" - when the widget's current selection is changed
26196     *   from the last item in its list to the first
26197     *
26198     * Available styles for it:
26199     * - @c "default"
26200     *
26201          * To set/get the label of the flipselector item, you can use
26202          * elm_object_item_text_set/get APIs.
26203          * Once the text is set, a previously set one will be deleted.
26204          *
26205     * Here is an example on its usage:
26206     * @li @ref flipselector_example
26207     */
26208
26209    /**
26210     * @addtogroup Flipselector
26211     * @{
26212     */
26213
26214    /**
26215     * Add a new flip selector widget to the given parent Elementary
26216     * (container) widget
26217     *
26218     * @param parent The parent object
26219     * @return a new flip selector widget handle or @c NULL, on errors
26220     *
26221     * This function inserts a new flip selector widget on the canvas.
26222     *
26223     * @ingroup Flipselector
26224     */
26225    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26226
26227    /**
26228     * Programmatically select the next item of a flip selector widget
26229     *
26230     * @param obj The flipselector object
26231     *
26232     * @note The selection will be animated. Also, if it reaches the
26233     * end of its list of member items, it will continue with the first
26234     * one onwards.
26235     *
26236     * @ingroup Flipselector
26237     */
26238    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
26239
26240    /**
26241     * Programmatically select the previous item of a flip selector
26242     * widget
26243     *
26244     * @param obj The flipselector object
26245     *
26246     * @note The selection will be animated.  Also, if it reaches the
26247     * beginning of its list of member items, it will continue with the
26248     * last one backwards.
26249     *
26250     * @ingroup Flipselector
26251     */
26252    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
26253
26254    /**
26255     * Append a (text) item to a flip selector widget
26256     *
26257     * @param obj The flipselector object
26258     * @param label The (text) label of the new item
26259     * @param func Convenience callback function to take place when
26260     * item is selected
26261     * @param data Data passed to @p func, above
26262     * @return A handle to the item added or @c NULL, on errors
26263     *
26264     * The widget's list of labels to show will be appended with the
26265     * given value. If the user wishes so, a callback function pointer
26266     * can be passed, which will get called when this same item is
26267     * selected.
26268     *
26269     * @note The current selection @b won't be modified by appending an
26270     * element to the list.
26271     *
26272     * @note The maximum length of the text label is going to be
26273     * determined <b>by the widget's theme</b>. Strings larger than
26274     * that value are going to be @b truncated.
26275     *
26276     * @ingroup Flipselector
26277     */
26278    EAPI Elm_Object_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
26279
26280    /**
26281     * Prepend a (text) item to a flip selector widget
26282     *
26283     * @param obj The flipselector object
26284     * @param label The (text) label of the new item
26285     * @param func Convenience callback function to take place when
26286     * item is selected
26287     * @param data Data passed to @p func, above
26288     * @return A handle to the item added or @c NULL, on errors
26289     *
26290     * The widget's list of labels to show will be prepended with the
26291     * given value. If the user wishes so, a callback function pointer
26292     * can be passed, which will get called when this same item is
26293     * selected.
26294     *
26295     * @note The current selection @b won't be modified by prepending
26296     * an element to the list.
26297     *
26298     * @note The maximum length of the text label is going to be
26299     * determined <b>by the widget's theme</b>. Strings larger than
26300     * that value are going to be @b truncated.
26301     *
26302     * @ingroup Flipselector
26303     */
26304    EAPI Elm_Object_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
26305
26306    /**
26307     * Get the internal list of items in a given flip selector widget.
26308     *
26309     * @param obj The flipselector object
26310     * @return The list of items (#Elm_Object_Item as data) or
26311     * @c NULL on errors.
26312     *
26313     * This list is @b not to be modified in any way and must not be
26314     * freed. Use the list members with functions like
26315     * elm_object_item_text_set(),
26316     * elm_object_item_text_get(),
26317     * elm_flipselector_item_del(),
26318     * elm_flipselector_item_selected_get(),
26319     * elm_flipselector_item_selected_set().
26320     *
26321     * @warning This list is only valid until @p obj object's internal
26322     * items list is changed. It should be fetched again with another
26323     * call to this function when changes happen.
26324     *
26325     * @ingroup Flipselector
26326     */
26327    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26328
26329    /**
26330     * Get the first item in the given flip selector widget's list of
26331     * items.
26332     *
26333     * @param obj The flipselector object
26334     * @return The first item or @c NULL, if it has no items (and on
26335     * errors)
26336     *
26337     * @see elm_flipselector_item_append()
26338     * @see elm_flipselector_last_item_get()
26339     *
26340     * @ingroup Flipselector
26341     */
26342    EAPI Elm_Object_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26343
26344    /**
26345     * Get the last item in the given flip selector widget's list of
26346     * items.
26347     *
26348     * @param obj The flipselector object
26349     * @return The last item or @c NULL, if it has no items (and on
26350     * errors)
26351     *
26352     * @see elm_flipselector_item_prepend()
26353     * @see elm_flipselector_first_item_get()
26354     *
26355     * @ingroup Flipselector
26356     */
26357    EAPI Elm_Object_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26358
26359    /**
26360     * Get the currently selected item in a flip selector widget.
26361     *
26362     * @param obj The flipselector object
26363     * @return The selected item or @c NULL, if the widget has no items
26364     * (and on erros)
26365     *
26366     * @ingroup Flipselector
26367     */
26368    EAPI Elm_Object_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26369
26370    /**
26371     * Set whether a given flip selector widget's item should be the
26372     * currently selected one.
26373     *
26374     * @param it The flip selector item
26375     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
26376     *
26377     * This sets whether @p item is or not the selected (thus, under
26378     * display) one. If @p item is different than one under display,
26379     * the latter will be unselected. If the @p item is set to be
26380     * unselected, on the other hand, the @b first item in the widget's
26381     * internal members list will be the new selected one.
26382     *
26383     * @see elm_flipselector_item_selected_get()
26384     *
26385     * @ingroup Flipselector
26386     */
26387    EAPI void                       elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
26388
26389    /**
26390     * Get whether a given flip selector widget's item is the currently
26391     * selected one.
26392     *
26393     * @param it The flip selector item
26394     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
26395     * (or on errors).
26396     *
26397     * @see elm_flipselector_item_selected_set()
26398     *
26399     * @ingroup Flipselector
26400     */
26401    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26402
26403    /**
26404     * Delete a given item from a flip selector widget.
26405     *
26406     * @param it The item to delete
26407     *
26408     * @ingroup Flipselector
26409     */
26410    EAPI void                       elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26411
26412    /**
26413     * Get the label of a given flip selector widget's item.
26414     *
26415     * @param it The item to get label from
26416     * @return The text label of @p item or @c NULL, on errors
26417     *
26418     * @see elm_object_item_text_set()
26419     *
26420     * @deprecated see elm_object_item_text_get() instead
26421     * @ingroup Flipselector
26422     */
26423    EINA_DEPRECATED EAPI const char                *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26424
26425    /**
26426     * Set the label of a given flip selector widget's item.
26427     *
26428     * @param it The item to set label on
26429     * @param label The text label string, in UTF-8 encoding
26430     *
26431     * @see elm_object_item_text_get()
26432     *
26433          * @deprecated see elm_object_item_text_set() instead
26434     * @ingroup Flipselector
26435     */
26436    EINA_DEPRECATED EAPI void                       elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26437
26438    /**
26439     * Gets the item before @p item in a flip selector widget's
26440     * internal list of items.
26441     *
26442     * @param it The item to fetch previous from
26443     * @return The item before the @p item, in its parent's list. If
26444     *         there is no previous item for @p item or there's an
26445     *         error, @c NULL is returned.
26446     *
26447     * @see elm_flipselector_item_next_get()
26448     *
26449     * @ingroup Flipselector
26450     */
26451    EAPI Elm_Object_Item     *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26452
26453    /**
26454     * Gets the item after @p item in a flip selector widget's
26455     * internal list of items.
26456     *
26457     * @param it The item to fetch next from
26458     * @return The item after the @p item, in its parent's list. If
26459     *         there is no next item for @p item or there's an
26460     *         error, @c NULL is returned.
26461     *
26462     * @see elm_flipselector_item_next_get()
26463     *
26464     * @ingroup Flipselector
26465     */
26466    EAPI Elm_Object_Item     *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26467
26468    /**
26469     * Set the interval on time updates for an user mouse button hold
26470     * on a flip selector widget.
26471     *
26472     * @param obj The flip selector object
26473     * @param interval The (first) interval value in seconds
26474     *
26475     * This interval value is @b decreased while the user holds the
26476     * mouse pointer either flipping up or flipping doww a given flip
26477     * selector.
26478     *
26479     * This helps the user to get to a given item distant from the
26480     * current one easier/faster, as it will start to flip quicker and
26481     * quicker on mouse button holds.
26482     *
26483     * The calculation for the next flip interval value, starting from
26484     * the one set with this call, is the previous interval divided by
26485     * 1.05, so it decreases a little bit.
26486     *
26487     * The default starting interval value for automatic flips is
26488     * @b 0.85 seconds.
26489     *
26490     * @see elm_flipselector_interval_get()
26491     *
26492     * @ingroup Flipselector
26493     */
26494    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
26495
26496    /**
26497     * Get the interval on time updates for an user mouse button hold
26498     * on a flip selector widget.
26499     *
26500     * @param obj The flip selector object
26501     * @return The (first) interval value, in seconds, set on it
26502     *
26503     * @see elm_flipselector_interval_set() for more details
26504     *
26505     * @ingroup Flipselector
26506     */
26507    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26508    /**
26509     * @}
26510     */
26511
26512    /**
26513     * @addtogroup Calendar
26514     * @{
26515     */
26516
26517    /**
26518     * @enum _Elm_Calendar_Mark_Repeat
26519     * @typedef Elm_Calendar_Mark_Repeat
26520     *
26521     * Event periodicity, used to define if a mark should be repeated
26522     * @b beyond event's day. It's set when a mark is added.
26523     *
26524     * So, for a mark added to 13th May with periodicity set to WEEKLY,
26525     * there will be marks every week after this date. Marks will be displayed
26526     * at 13th, 20th, 27th, 3rd June ...
26527     *
26528     * Values don't work as bitmask, only one can be choosen.
26529     *
26530     * @see elm_calendar_mark_add()
26531     *
26532     * @ingroup Calendar
26533     */
26534    typedef enum _Elm_Calendar_Mark_Repeat
26535      {
26536         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
26537         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
26538         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
26539         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*/
26540         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. */
26541      } Elm_Calendar_Mark_Repeat;
26542
26543    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(). */
26544
26545    /**
26546     * Add a new calendar widget to the given parent Elementary
26547     * (container) object.
26548     *
26549     * @param parent The parent object.
26550     * @return a new calendar widget handle or @c NULL, on errors.
26551     *
26552     * This function inserts a new calendar widget on the canvas.
26553     *
26554     * @ref calendar_example_01
26555     *
26556     * @ingroup Calendar
26557     */
26558    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26559
26560    /**
26561     * Get weekdays names displayed by the calendar.
26562     *
26563     * @param obj The calendar object.
26564     * @return Array of seven strings to be used as weekday names.
26565     *
26566     * By default, weekdays abbreviations get from system are displayed:
26567     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
26568     * The first string is related to Sunday, the second to Monday...
26569     *
26570     * @see elm_calendar_weekdays_name_set()
26571     *
26572     * @ref calendar_example_05
26573     *
26574     * @ingroup Calendar
26575     */
26576    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26577
26578    /**
26579     * Set weekdays names to be displayed by the calendar.
26580     *
26581     * @param obj The calendar object.
26582     * @param weekdays Array of seven strings to be used as weekday names.
26583     * @warning It must have 7 elements, or it will access invalid memory.
26584     * @warning The strings must be NULL terminated ('@\0').
26585     *
26586     * By default, weekdays abbreviations get from system are displayed:
26587     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
26588     *
26589     * The first string should be related to Sunday, the second to Monday...
26590     *
26591     * The usage should be like this:
26592     * @code
26593     *   const char *weekdays[] =
26594     *   {
26595     *      "Sunday", "Monday", "Tuesday", "Wednesday",
26596     *      "Thursday", "Friday", "Saturday"
26597     *   };
26598     *   elm_calendar_weekdays_names_set(calendar, weekdays);
26599     * @endcode
26600     *
26601     * @see elm_calendar_weekdays_name_get()
26602     *
26603     * @ref calendar_example_02
26604     *
26605     * @ingroup Calendar
26606     */
26607    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
26608
26609    /**
26610     * Set the minimum and maximum values for the year
26611     *
26612     * @param obj The calendar object
26613     * @param min The minimum year, greater than 1901;
26614     * @param max The maximum year;
26615     *
26616     * Maximum must be greater than minimum, except if you don't wan't to set
26617     * maximum year.
26618     * Default values are 1902 and -1.
26619     *
26620     * If the maximum year is a negative value, it will be limited depending
26621     * on the platform architecture (year 2037 for 32 bits);
26622     *
26623     * @see elm_calendar_min_max_year_get()
26624     *
26625     * @ref calendar_example_03
26626     *
26627     * @ingroup Calendar
26628     */
26629    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
26630
26631    /**
26632     * Get the minimum and maximum values for the year
26633     *
26634     * @param obj The calendar object.
26635     * @param min The minimum year.
26636     * @param max The maximum year.
26637     *
26638     * Default values are 1902 and -1.
26639     *
26640     * @see elm_calendar_min_max_year_get() for more details.
26641     *
26642     * @ref calendar_example_05
26643     *
26644     * @ingroup Calendar
26645     */
26646    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
26647
26648    /**
26649     * Enable or disable day selection
26650     *
26651     * @param obj The calendar object.
26652     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
26653     * disable it.
26654     *
26655     * Enabled by default. If disabled, the user still can select months,
26656     * but not days. Selected days are highlighted on calendar.
26657     * It should be used if you won't need such selection for the widget usage.
26658     *
26659     * When a day is selected, or month is changed, smart callbacks for
26660     * signal "changed" will be called.
26661     *
26662     * @see elm_calendar_day_selection_enable_get()
26663     *
26664     * @ref calendar_example_04
26665     *
26666     * @ingroup Calendar
26667     */
26668    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26669
26670    /**
26671     * Get a value whether day selection is enabled or not.
26672     *
26673     * @see elm_calendar_day_selection_enable_set() for details.
26674     *
26675     * @param obj The calendar object.
26676     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
26677     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
26678     *
26679     * @ref calendar_example_05
26680     *
26681     * @ingroup Calendar
26682     */
26683    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26684
26685
26686    /**
26687     * Set selected date to be highlighted on calendar.
26688     *
26689     * @param obj The calendar object.
26690     * @param selected_time A @b tm struct to represent the selected date.
26691     *
26692     * Set the selected date, changing the displayed month if needed.
26693     * Selected date changes when the user goes to next/previous month or
26694     * select a day pressing over it on calendar.
26695     *
26696     * @see elm_calendar_selected_time_get()
26697     *
26698     * @ref calendar_example_04
26699     *
26700     * @ingroup Calendar
26701     */
26702    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
26703
26704    /**
26705     * Get selected date.
26706     *
26707     * @param obj The calendar object
26708     * @param selected_time A @b tm struct to point to selected date
26709     * @return EINA_FALSE means an error ocurred and returned time shouldn't
26710     * be considered.
26711     *
26712     * Get date selected by the user or set by function
26713     * elm_calendar_selected_time_set().
26714     * Selected date changes when the user goes to next/previous month or
26715     * select a day pressing over it on calendar.
26716     *
26717     * @see elm_calendar_selected_time_get()
26718     *
26719     * @ref calendar_example_05
26720     *
26721     * @ingroup Calendar
26722     */
26723    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
26724
26725    /**
26726     * Set a function to format the string that will be used to display
26727     * month and year;
26728     *
26729     * @param obj The calendar object
26730     * @param format_function Function to set the month-year string given
26731     * the selected date
26732     *
26733     * By default it uses strftime with "%B %Y" format string.
26734     * It should allocate the memory that will be used by the string,
26735     * that will be freed by the widget after usage.
26736     * A pointer to the string and a pointer to the time struct will be provided.
26737     *
26738     * Example:
26739     * @code
26740     * static char *
26741     * _format_month_year(struct tm *selected_time)
26742     * {
26743     *    char buf[32];
26744     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
26745     *    return strdup(buf);
26746     * }
26747     *
26748     * elm_calendar_format_function_set(calendar, _format_month_year);
26749     * @endcode
26750     *
26751     * @ref calendar_example_02
26752     *
26753     * @ingroup Calendar
26754     */
26755    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
26756
26757    /**
26758     * Add a new mark to the calendar
26759     *
26760     * @param obj The calendar object
26761     * @param mark_type A string used to define the type of mark. It will be
26762     * emitted to the theme, that should display a related modification on these
26763     * days representation.
26764     * @param mark_time A time struct to represent the date of inclusion of the
26765     * mark. For marks that repeats it will just be displayed after the inclusion
26766     * date in the calendar.
26767     * @param repeat Repeat the event following this periodicity. Can be a unique
26768     * mark (that don't repeat), daily, weekly, monthly or annually.
26769     * @return The created mark or @p NULL upon failure.
26770     *
26771     * Add a mark that will be drawn in the calendar respecting the insertion
26772     * time and periodicity. It will emit the type as signal to the widget theme.
26773     * Default theme supports "holiday" and "checked", but it can be extended.
26774     *
26775     * It won't immediately update the calendar, drawing the marks.
26776     * For this, call elm_calendar_marks_draw(). However, when user selects
26777     * next or previous month calendar forces marks drawn.
26778     *
26779     * Marks created with this method can be deleted with
26780     * elm_calendar_mark_del().
26781     *
26782     * Example
26783     * @code
26784     * struct tm selected_time;
26785     * time_t current_time;
26786     *
26787     * current_time = time(NULL) + 5 * 84600;
26788     * localtime_r(&current_time, &selected_time);
26789     * elm_calendar_mark_add(cal, "holiday", selected_time,
26790     *     ELM_CALENDAR_ANNUALLY);
26791     *
26792     * current_time = time(NULL) + 1 * 84600;
26793     * localtime_r(&current_time, &selected_time);
26794     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
26795     *
26796     * elm_calendar_marks_draw(cal);
26797     * @endcode
26798     *
26799     * @see elm_calendar_marks_draw()
26800     * @see elm_calendar_mark_del()
26801     *
26802     * @ref calendar_example_06
26803     *
26804     * @ingroup Calendar
26805     */
26806    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);
26807
26808    /**
26809     * Delete mark from the calendar.
26810     *
26811     * @param mark The mark to be deleted.
26812     *
26813     * If deleting all calendar marks is required, elm_calendar_marks_clear()
26814     * should be used instead of getting marks list and deleting each one.
26815     *
26816     * @see elm_calendar_mark_add()
26817     *
26818     * @ref calendar_example_06
26819     *
26820     * @ingroup Calendar
26821     */
26822    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
26823
26824    /**
26825     * Remove all calendar's marks
26826     *
26827     * @param obj The calendar object.
26828     *
26829     * @see elm_calendar_mark_add()
26830     * @see elm_calendar_mark_del()
26831     *
26832     * @ingroup Calendar
26833     */
26834    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26835
26836    /**
26837     * Get a list of all the calendar marks.
26838     *
26839     * @param obj The calendar object.
26840     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
26841     *
26842     * @see elm_calendar_mark_add()
26843     * @see elm_calendar_mark_del()
26844     * @see elm_calendar_marks_clear()
26845     *
26846     * @ingroup Calendar
26847     */
26848    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26849
26850    /**
26851     * Draw calendar marks.
26852     *
26853     * @param obj The calendar object.
26854     *
26855     * Should be used after adding, removing or clearing marks.
26856     * It will go through the entire marks list updating the calendar.
26857     * If lots of marks will be added, add all the marks and then call
26858     * this function.
26859     *
26860     * When the month is changed, i.e. user selects next or previous month,
26861     * marks will be drawed.
26862     *
26863     * @see elm_calendar_mark_add()
26864     * @see elm_calendar_mark_del()
26865     * @see elm_calendar_marks_clear()
26866     *
26867     * @ref calendar_example_06
26868     *
26869     * @ingroup Calendar
26870     */
26871    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
26872
26873    /**
26874     * Set a day text color to the same that represents Saturdays.
26875     *
26876     * @param obj The calendar object.
26877     * @param pos The text position. Position is the cell counter, from left
26878     * to right, up to down. It starts on 0 and ends on 41.
26879     *
26880     * @deprecated use elm_calendar_mark_add() instead like:
26881     *
26882     * @code
26883     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
26884     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
26885     * @endcode
26886     *
26887     * @see elm_calendar_mark_add()
26888     *
26889     * @ingroup Calendar
26890     */
26891    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26892
26893    /**
26894     * Set a day text color to the same that represents Sundays.
26895     *
26896     * @param obj The calendar object.
26897     * @param pos The text position. Position is the cell counter, from left
26898     * to right, up to down. It starts on 0 and ends on 41.
26899
26900     * @deprecated use elm_calendar_mark_add() instead like:
26901     *
26902     * @code
26903     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
26904     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
26905     * @endcode
26906     *
26907     * @see elm_calendar_mark_add()
26908     *
26909     * @ingroup Calendar
26910     */
26911    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26912
26913    /**
26914     * Set a day text color to the same that represents Weekdays.
26915     *
26916     * @param obj The calendar object
26917     * @param pos The text position. Position is the cell counter, from left
26918     * to right, up to down. It starts on 0 and ends on 41.
26919     *
26920     * @deprecated use elm_calendar_mark_add() instead like:
26921     *
26922     * @code
26923     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
26924     *
26925     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
26926     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26927     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
26928     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26929     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
26930     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26931     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
26932     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26933     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
26934     * @endcode
26935     *
26936     * @see elm_calendar_mark_add()
26937     *
26938     * @ingroup Calendar
26939     */
26940    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26941
26942    /**
26943     * Set the interval on time updates for an user mouse button hold
26944     * on calendar widgets' month selection.
26945     *
26946     * @param obj The calendar object
26947     * @param interval The (first) interval value in seconds
26948     *
26949     * This interval value is @b decreased while the user holds the
26950     * mouse pointer either selecting next or previous month.
26951     *
26952     * This helps the user to get to a given month distant from the
26953     * current one easier/faster, as it will start to change quicker and
26954     * quicker on mouse button holds.
26955     *
26956     * The calculation for the next change interval value, starting from
26957     * the one set with this call, is the previous interval divided by
26958     * 1.05, so it decreases a little bit.
26959     *
26960     * The default starting interval value for automatic changes is
26961     * @b 0.85 seconds.
26962     *
26963     * @see elm_calendar_interval_get()
26964     *
26965     * @ingroup Calendar
26966     */
26967    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
26968
26969    /**
26970     * Get the interval on time updates for an user mouse button hold
26971     * on calendar widgets' month selection.
26972     *
26973     * @param obj The calendar object
26974     * @return The (first) interval value, in seconds, set on it
26975     *
26976     * @see elm_calendar_interval_set() for more details
26977     *
26978     * @ingroup Calendar
26979     */
26980    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26981
26982    /**
26983     * @}
26984     */
26985
26986    /**
26987     * @defgroup Diskselector Diskselector
26988     * @ingroup Elementary
26989     *
26990     * @image html img/widget/diskselector/preview-00.png
26991     * @image latex img/widget/diskselector/preview-00.eps
26992     *
26993     * A diskselector is a kind of list widget. It scrolls horizontally,
26994     * and can contain label and icon objects. Three items are displayed
26995     * with the selected one in the middle.
26996     *
26997     * It can act like a circular list with round mode and labels can be
26998     * reduced for a defined length for side items.
26999     *
27000     * Smart callbacks one can listen to:
27001     * - "selected" - when item is selected, i.e. scroller stops.
27002     *
27003     * Available styles for it:
27004     * - @c "default"
27005     *
27006     * List of examples:
27007     * @li @ref diskselector_example_01
27008     * @li @ref diskselector_example_02
27009     */
27010
27011    /**
27012     * @addtogroup Diskselector
27013     * @{
27014     */
27015
27016    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(). */
27017
27018    /**
27019     * Add a new diskselector widget to the given parent Elementary
27020     * (container) object.
27021     *
27022     * @param parent The parent object.
27023     * @return a new diskselector widget handle or @c NULL, on errors.
27024     *
27025     * This function inserts a new diskselector widget on the canvas.
27026     *
27027     * @ingroup Diskselector
27028     */
27029    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27030
27031    /**
27032     * Enable or disable round mode.
27033     *
27034     * @param obj The diskselector object.
27035     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
27036     * disable it.
27037     *
27038     * Disabled by default. If round mode is enabled the items list will
27039     * work like a circle list, so when the user reaches the last item,
27040     * the first one will popup.
27041     *
27042     * @see elm_diskselector_round_get()
27043     *
27044     * @ingroup Diskselector
27045     */
27046    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
27047
27048    /**
27049     * Get a value whether round mode is enabled or not.
27050     *
27051     * @see elm_diskselector_round_set() for details.
27052     *
27053     * @param obj The diskselector object.
27054     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
27055     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
27056     *
27057     * @ingroup Diskselector
27058     */
27059    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27060
27061    /**
27062     * Get the side labels max length.
27063     *
27064     * @deprecated use elm_diskselector_side_label_length_get() instead:
27065     *
27066     * @param obj The diskselector object.
27067     * @return The max length defined for side labels, or 0 if not a valid
27068     * diskselector.
27069     *
27070     * @ingroup Diskselector
27071     */
27072    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27073
27074    /**
27075     * Set the side labels max length.
27076     *
27077     * @deprecated use elm_diskselector_side_label_length_set() instead:
27078     *
27079     * @param obj The diskselector object.
27080     * @param len The max length defined for side labels.
27081     *
27082     * @ingroup Diskselector
27083     */
27084    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
27085
27086    /**
27087     * Get the side labels max length.
27088     *
27089     * @see elm_diskselector_side_label_length_set() for details.
27090     *
27091     * @param obj The diskselector object.
27092     * @return The max length defined for side labels, or 0 if not a valid
27093     * diskselector.
27094     *
27095     * @ingroup Diskselector
27096     */
27097    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27098
27099    /**
27100     * Set the side labels max length.
27101     *
27102     * @param obj The diskselector object.
27103     * @param len The max length defined for side labels.
27104     *
27105     * Length is the number of characters of items' label that will be
27106     * visible when it's set on side positions. It will just crop
27107     * the string after defined size. E.g.:
27108     *
27109     * An item with label "January" would be displayed on side position as
27110     * "Jan" if max length is set to 3, or "Janu", if this property
27111     * is set to 4.
27112     *
27113     * When it's selected, the entire label will be displayed, except for
27114     * width restrictions. In this case label will be cropped and "..."
27115     * will be concatenated.
27116     *
27117     * Default side label max length is 3.
27118     *
27119     * This property will be applyed over all items, included before or
27120     * later this function call.
27121     *
27122     * @ingroup Diskselector
27123     */
27124    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
27125
27126    /**
27127     * Set the number of items to be displayed.
27128     *
27129     * @param obj The diskselector object.
27130     * @param num The number of items the diskselector will display.
27131     *
27132     * Default value is 3, and also it's the minimun. If @p num is less
27133     * than 3, it will be set to 3.
27134     *
27135     * Also, it can be set on theme, using data item @c display_item_num
27136     * on group "elm/diskselector/item/X", where X is style set.
27137     * E.g.:
27138     *
27139     * group { name: "elm/diskselector/item/X";
27140     * data {
27141     *     item: "display_item_num" "5";
27142     *     }
27143     *
27144     * @ingroup Diskselector
27145     */
27146    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
27147
27148    /**
27149     * Get the number of items in the diskselector object.
27150     *
27151     * @param obj The diskselector object.
27152     *
27153     * @ingroup Diskselector
27154     */
27155    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27156
27157    /**
27158     * Set bouncing behaviour when the scrolled content reaches an edge.
27159     *
27160     * Tell the internal scroller object whether it should bounce or not
27161     * when it reaches the respective edges for each axis.
27162     *
27163     * @param obj The diskselector object.
27164     * @param h_bounce Whether to bounce or not in the horizontal axis.
27165     * @param v_bounce Whether to bounce or not in the vertical axis.
27166     *
27167     * @see elm_scroller_bounce_set()
27168     *
27169     * @ingroup Diskselector
27170     */
27171    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
27172
27173    /**
27174     * Get the bouncing behaviour of the internal scroller.
27175     *
27176     * Get whether the internal scroller should bounce when the edge of each
27177     * axis is reached scrolling.
27178     *
27179     * @param obj The diskselector object.
27180     * @param h_bounce Pointer where to store the bounce state of the horizontal
27181     * axis.
27182     * @param v_bounce Pointer where to store the bounce state of the vertical
27183     * axis.
27184     *
27185     * @see elm_scroller_bounce_get()
27186     * @see elm_diskselector_bounce_set()
27187     *
27188     * @ingroup Diskselector
27189     */
27190    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
27191
27192    /**
27193     * Get the scrollbar policy.
27194     *
27195     * @see elm_diskselector_scroller_policy_get() for details.
27196     *
27197     * @param obj The diskselector object.
27198     * @param policy_h Pointer where to store horizontal scrollbar policy.
27199     * @param policy_v Pointer where to store vertical scrollbar policy.
27200     *
27201     * @ingroup Diskselector
27202     */
27203    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);
27204
27205    /**
27206     * Set the scrollbar policy.
27207     *
27208     * @param obj The diskselector object.
27209     * @param policy_h Horizontal scrollbar policy.
27210     * @param policy_v Vertical scrollbar policy.
27211     *
27212     * This sets the scrollbar visibility policy for the given scroller.
27213     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
27214     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
27215     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
27216     * This applies respectively for the horizontal and vertical scrollbars.
27217     *
27218     * The both are disabled by default, i.e., are set to
27219     * #ELM_SCROLLER_POLICY_OFF.
27220     *
27221     * @ingroup Diskselector
27222     */
27223    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
27224
27225    /**
27226     * Remove all diskselector's items.
27227     *
27228     * @param obj The diskselector object.
27229     *
27230     * @see elm_diskselector_item_del()
27231     * @see elm_diskselector_item_append()
27232     *
27233     * @ingroup Diskselector
27234     */
27235    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
27236
27237    /**
27238     * Get a list of all the diskselector items.
27239     *
27240     * @param obj The diskselector object.
27241     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
27242     * or @c NULL on failure.
27243     *
27244     * @see elm_diskselector_item_append()
27245     * @see elm_diskselector_item_del()
27246     * @see elm_diskselector_clear()
27247     *
27248     * @ingroup Diskselector
27249     */
27250    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27251
27252    /**
27253     * Appends a new item to the diskselector object.
27254     *
27255     * @param obj The diskselector object.
27256     * @param label The label of the diskselector item.
27257     * @param icon The icon object to use at left side of the item. An
27258     * icon can be any Evas object, but usually it is an icon created
27259     * with elm_icon_add().
27260     * @param func The function to call when the item is selected.
27261     * @param data The data to associate with the item for related callbacks.
27262     *
27263     * @return The created item or @c NULL upon failure.
27264     *
27265     * A new item will be created and appended to the diskselector, i.e., will
27266     * be set as last item. Also, if there is no selected item, it will
27267     * be selected. This will always happens for the first appended item.
27268     *
27269     * If no icon is set, label will be centered on item position, otherwise
27270     * the icon will be placed at left of the label, that will be shifted
27271     * to the right.
27272     *
27273     * Items created with this method can be deleted with
27274     * elm_diskselector_item_del().
27275     *
27276     * Associated @p data can be properly freed when item is deleted if a
27277     * callback function is set with elm_diskselector_item_del_cb_set().
27278     *
27279     * If a function is passed as argument, it will be called everytime this item
27280     * is selected, i.e., the user stops the diskselector with this
27281     * item on center position. If such function isn't needed, just passing
27282     * @c NULL as @p func is enough. The same should be done for @p data.
27283     *
27284     * Simple example (with no function callback or data associated):
27285     * @code
27286     * disk = elm_diskselector_add(win);
27287     * ic = elm_icon_add(win);
27288     * elm_icon_file_set(ic, "path/to/image", NULL);
27289     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27290     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
27291     * @endcode
27292     *
27293     * @see elm_diskselector_item_del()
27294     * @see elm_diskselector_item_del_cb_set()
27295     * @see elm_diskselector_clear()
27296     * @see elm_icon_add()
27297     *
27298     * @ingroup Diskselector
27299     */
27300    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);
27301
27302
27303    /**
27304     * Delete them item from the diskselector.
27305     *
27306     * @param it The item of diskselector to be deleted.
27307     *
27308     * If deleting all diskselector items is required, elm_diskselector_clear()
27309     * should be used instead of getting items list and deleting each one.
27310     *
27311     * @see elm_diskselector_clear()
27312     * @see elm_diskselector_item_append()
27313     * @see elm_diskselector_item_del_cb_set()
27314     *
27315     * @ingroup Diskselector
27316     */
27317    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27318
27319    /**
27320     * Set the function called when a diskselector item is freed.
27321     *
27322     * @param it The item to set the callback on
27323     * @param func The function called
27324     *
27325     * If there is a @p func, then it will be called prior item's memory release.
27326     * That will be called with the following arguments:
27327     * @li item's data;
27328     * @li item's Evas object;
27329     * @li item itself;
27330     *
27331     * This way, a data associated to a diskselector item could be properly
27332     * freed.
27333     *
27334     * @ingroup Diskselector
27335     */
27336    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
27337
27338    /**
27339     * Get the data associated to the item.
27340     *
27341     * @param it The diskselector item
27342     * @return The data associated to @p it
27343     *
27344     * The return value is a pointer to data associated to @p item when it was
27345     * created, with function elm_diskselector_item_append(). If no data
27346     * was passed as argument, it will return @c NULL.
27347     *
27348     * @see elm_diskselector_item_append()
27349     *
27350     * @ingroup Diskselector
27351     */
27352    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27353
27354    /**
27355     * Set the icon associated to the item.
27356     *
27357     * @param it The diskselector item
27358     * @param icon The icon object to associate with @p it
27359     *
27360     * The icon object to use at left side of the item. An
27361     * icon can be any Evas object, but usually it is an icon created
27362     * with elm_icon_add().
27363     *
27364     * Once the icon object is set, a previously set one will be deleted.
27365     * @warning Setting the same icon for two items will cause the icon to
27366     * dissapear from the first item.
27367     *
27368     * If an icon was passed as argument on item creation, with function
27369     * elm_diskselector_item_append(), it will be already
27370     * associated to the item.
27371     *
27372     * @see elm_diskselector_item_append()
27373     * @see elm_diskselector_item_icon_get()
27374     *
27375     * @ingroup Diskselector
27376     */
27377    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
27378
27379    /**
27380     * Get the icon associated to the item.
27381     *
27382     * @param it The diskselector item
27383     * @return The icon associated to @p it
27384     *
27385     * The return value is a pointer to the icon associated to @p item when it was
27386     * created, with function elm_diskselector_item_append(), or later
27387     * with function elm_diskselector_item_icon_set. If no icon
27388     * was passed as argument, it will return @c NULL.
27389     *
27390     * @see elm_diskselector_item_append()
27391     * @see elm_diskselector_item_icon_set()
27392     *
27393     * @ingroup Diskselector
27394     */
27395    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27396
27397    /**
27398     * Set the label of item.
27399     *
27400     * @param it The item of diskselector.
27401     * @param label The label of item.
27402     *
27403     * The label to be displayed by the item.
27404     *
27405     * If no icon is set, label will be centered on item position, otherwise
27406     * the icon will be placed at left of the label, that will be shifted
27407     * to the right.
27408     *
27409     * An item with label "January" would be displayed on side position as
27410     * "Jan" if max length is set to 3 with function
27411     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
27412     * is set to 4.
27413     *
27414     * When this @p item is selected, the entire label will be displayed,
27415     * except for width restrictions.
27416     * In this case label will be cropped and "..." will be concatenated,
27417     * but only for display purposes. It will keep the entire string, so
27418     * if diskselector is resized the remaining characters will be displayed.
27419     *
27420     * If a label was passed as argument on item creation, with function
27421     * elm_diskselector_item_append(), it will be already
27422     * displayed by the item.
27423     *
27424     * @see elm_diskselector_side_label_lenght_set()
27425     * @see elm_diskselector_item_label_get()
27426     * @see elm_diskselector_item_append()
27427     *
27428     * @ingroup Diskselector
27429     */
27430    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
27431
27432    /**
27433     * Get the label of item.
27434     *
27435     * @param it The item of diskselector.
27436     * @return The label of item.
27437     *
27438     * The return value is a pointer to the label associated to @p item when it was
27439     * created, with function elm_diskselector_item_append(), or later
27440     * with function elm_diskselector_item_label_set. If no label
27441     * was passed as argument, it will return @c NULL.
27442     *
27443     * @see elm_diskselector_item_label_set() for more details.
27444     * @see elm_diskselector_item_append()
27445     *
27446     * @ingroup Diskselector
27447     */
27448    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27449
27450    /**
27451     * Get the selected item.
27452     *
27453     * @param obj The diskselector object.
27454     * @return The selected diskselector item.
27455     *
27456     * The selected item can be unselected with function
27457     * elm_diskselector_item_selected_set(), and the first item of
27458     * diskselector will be selected.
27459     *
27460     * The selected item always will be centered on diskselector, with
27461     * full label displayed, i.e., max lenght set to side labels won't
27462     * apply on the selected item. More details on
27463     * elm_diskselector_side_label_length_set().
27464     *
27465     * @ingroup Diskselector
27466     */
27467    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27468
27469    /**
27470     * Set the selected state of an item.
27471     *
27472     * @param it The diskselector item
27473     * @param selected The selected state
27474     *
27475     * This sets the selected state of the given item @p it.
27476     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27477     *
27478     * If a new item is selected the previosly selected will be unselected.
27479     * Previoulsy selected item can be get with function
27480     * elm_diskselector_selected_item_get().
27481     *
27482     * If the item @p it is unselected, the first item of diskselector will
27483     * be selected.
27484     *
27485     * Selected items will be visible on center position of diskselector.
27486     * So if it was on another position before selected, or was invisible,
27487     * diskselector will animate items until the selected item reaches center
27488     * position.
27489     *
27490     * @see elm_diskselector_item_selected_get()
27491     * @see elm_diskselector_selected_item_get()
27492     *
27493     * @ingroup Diskselector
27494     */
27495    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
27496
27497    /*
27498     * Get whether the @p item is selected or not.
27499     *
27500     * @param it The diskselector item.
27501     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
27502     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
27503     *
27504     * @see elm_diskselector_selected_item_set() for details.
27505     * @see elm_diskselector_item_selected_get()
27506     *
27507     * @ingroup Diskselector
27508     */
27509    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27510
27511    /**
27512     * Get the first item of the diskselector.
27513     *
27514     * @param obj The diskselector object.
27515     * @return The first item, or @c NULL if none.
27516     *
27517     * The list of items follows append order. So it will return the first
27518     * item appended to the widget that wasn't deleted.
27519     *
27520     * @see elm_diskselector_item_append()
27521     * @see elm_diskselector_items_get()
27522     *
27523     * @ingroup Diskselector
27524     */
27525    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27526
27527    /**
27528     * Get the last item of the diskselector.
27529     *
27530     * @param obj The diskselector object.
27531     * @return The last item, or @c NULL if none.
27532     *
27533     * The list of items follows append order. So it will return last first
27534     * item appended to the widget that wasn't deleted.
27535     *
27536     * @see elm_diskselector_item_append()
27537     * @see elm_diskselector_items_get()
27538     *
27539     * @ingroup Diskselector
27540     */
27541    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27542
27543    /**
27544     * Get the item before @p item in diskselector.
27545     *
27546     * @param it The diskselector item.
27547     * @return The item before @p item, or @c NULL if none or on failure.
27548     *
27549     * The list of items follows append order. So it will return item appended
27550     * just before @p item and that wasn't deleted.
27551     *
27552     * If it is the first item, @c NULL will be returned.
27553     * First item can be get by elm_diskselector_first_item_get().
27554     *
27555     * @see elm_diskselector_item_append()
27556     * @see elm_diskselector_items_get()
27557     *
27558     * @ingroup Diskselector
27559     */
27560    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27561
27562    /**
27563     * Get the item after @p item in diskselector.
27564     *
27565     * @param it The diskselector item.
27566     * @return The item after @p item, or @c NULL if none or on failure.
27567     *
27568     * The list of items follows append order. So it will return item appended
27569     * just after @p item and that wasn't deleted.
27570     *
27571     * If it is the last item, @c NULL will be returned.
27572     * Last item can be get by elm_diskselector_last_item_get().
27573     *
27574     * @see elm_diskselector_item_append()
27575     * @see elm_diskselector_items_get()
27576     *
27577     * @ingroup Diskselector
27578     */
27579    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27580
27581    /**
27582     * Set the text to be shown in the diskselector item.
27583     *
27584     * @param item Target item
27585     * @param text The text to set in the content
27586     *
27587     * Setup the text as tooltip to object. The item can have only one tooltip,
27588     * so any previous tooltip data is removed.
27589     *
27590     * @see elm_object_tooltip_text_set() for more details.
27591     *
27592     * @ingroup Diskselector
27593     */
27594    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
27595
27596    /**
27597     * Set the content to be shown in the tooltip item.
27598     *
27599     * Setup the tooltip to item. The item can have only one tooltip,
27600     * so any previous tooltip data is removed. @p func(with @p data) will
27601     * be called every time that need show the tooltip and it should
27602     * return a valid Evas_Object. This object is then managed fully by
27603     * tooltip system and is deleted when the tooltip is gone.
27604     *
27605     * @param item the diskselector item being attached a tooltip.
27606     * @param func the function used to create the tooltip contents.
27607     * @param data what to provide to @a func as callback data/context.
27608     * @param del_cb called when data is not needed anymore, either when
27609     *        another callback replaces @p func, the tooltip is unset with
27610     *        elm_diskselector_item_tooltip_unset() or the owner @a item
27611     *        dies. This callback receives as the first parameter the
27612     *        given @a data, and @c event_info is the item.
27613     *
27614     * @see elm_object_tooltip_content_cb_set() for more details.
27615     *
27616     * @ingroup Diskselector
27617     */
27618    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);
27619
27620    /**
27621     * Unset tooltip from item.
27622     *
27623     * @param item diskselector item to remove previously set tooltip.
27624     *
27625     * Remove tooltip from item. The callback provided as del_cb to
27626     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
27627     * it is not used anymore.
27628     *
27629     * @see elm_object_tooltip_unset() for more details.
27630     * @see elm_diskselector_item_tooltip_content_cb_set()
27631     *
27632     * @ingroup Diskselector
27633     */
27634    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27635
27636    /**
27637     * Sets a different style for this item tooltip.
27638     *
27639     * @note before you set a style you should define a tooltip with
27640     *       elm_diskselector_item_tooltip_content_cb_set() or
27641     *       elm_diskselector_item_tooltip_text_set()
27642     *
27643     * @param item diskselector item with tooltip already set.
27644     * @param style the theme style to use (default, transparent, ...)
27645     *
27646     * @see elm_object_tooltip_style_set() for more details.
27647     *
27648     * @ingroup Diskselector
27649     */
27650    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
27651
27652    /**
27653     * Get the style for this item tooltip.
27654     *
27655     * @param item diskselector item with tooltip already set.
27656     * @return style the theme style in use, defaults to "default". If the
27657     *         object does not have a tooltip set, then NULL is returned.
27658     *
27659     * @see elm_object_tooltip_style_get() for more details.
27660     * @see elm_diskselector_item_tooltip_style_set()
27661     *
27662     * @ingroup Diskselector
27663     */
27664    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27665
27666    /**
27667     * Set the cursor to be shown when mouse is over the diskselector item
27668     *
27669     * @param item Target item
27670     * @param cursor the cursor name to be used.
27671     *
27672     * @see elm_object_cursor_set() for more details.
27673     *
27674     * @ingroup Diskselector
27675     */
27676    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
27677
27678    /**
27679     * Get the cursor to be shown when mouse is over the diskselector item
27680     *
27681     * @param item diskselector item with cursor already set.
27682     * @return the cursor name.
27683     *
27684     * @see elm_object_cursor_get() for more details.
27685     * @see elm_diskselector_cursor_set()
27686     *
27687     * @ingroup Diskselector
27688     */
27689    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27690
27691    /**
27692     * Unset the cursor to be shown when mouse is over the diskselector item
27693     *
27694     * @param item Target item
27695     *
27696     * @see elm_object_cursor_unset() for more details.
27697     * @see elm_diskselector_cursor_set()
27698     *
27699     * @ingroup Diskselector
27700     */
27701    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27702
27703    /**
27704     * Sets a different style for this item cursor.
27705     *
27706     * @note before you set a style you should define a cursor with
27707     *       elm_diskselector_item_cursor_set()
27708     *
27709     * @param item diskselector item with cursor already set.
27710     * @param style the theme style to use (default, transparent, ...)
27711     *
27712     * @see elm_object_cursor_style_set() for more details.
27713     *
27714     * @ingroup Diskselector
27715     */
27716    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
27717
27718    /**
27719     * Get the style for this item cursor.
27720     *
27721     * @param item diskselector item with cursor already set.
27722     * @return style the theme style in use, defaults to "default". If the
27723     *         object does not have a cursor set, then @c NULL is returned.
27724     *
27725     * @see elm_object_cursor_style_get() for more details.
27726     * @see elm_diskselector_item_cursor_style_set()
27727     *
27728     * @ingroup Diskselector
27729     */
27730    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27731
27732
27733    /**
27734     * Set if the cursor set should be searched on the theme or should use
27735     * the provided by the engine, only.
27736     *
27737     * @note before you set if should look on theme you should define a cursor
27738     * with elm_diskselector_item_cursor_set().
27739     * By default it will only look for cursors provided by the engine.
27740     *
27741     * @param item widget item with cursor already set.
27742     * @param engine_only boolean to define if cursors set with
27743     * elm_diskselector_item_cursor_set() should be searched only
27744     * between cursors provided by the engine or searched on widget's
27745     * theme as well.
27746     *
27747     * @see elm_object_cursor_engine_only_set() for more details.
27748     *
27749     * @ingroup Diskselector
27750     */
27751    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
27752
27753    /**
27754     * Get the cursor engine only usage for this item cursor.
27755     *
27756     * @param item widget item with cursor already set.
27757     * @return engine_only boolean to define it cursors should be looked only
27758     * between the provided by the engine or searched on widget's theme as well.
27759     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
27760     *
27761     * @see elm_object_cursor_engine_only_get() for more details.
27762     * @see elm_diskselector_item_cursor_engine_only_set()
27763     *
27764     * @ingroup Diskselector
27765     */
27766    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27767
27768    /**
27769     * @}
27770     */
27771
27772    /**
27773     * @defgroup Colorselector Colorselector
27774     *
27775     * @{
27776     *
27777     * @image html img/widget/colorselector/preview-00.png
27778     * @image latex img/widget/colorselector/preview-00.eps
27779     *
27780     * @brief Widget for user to select a color.
27781     *
27782     * Signals that you can add callbacks for are:
27783     * "changed" - When the color value changes(event_info is NULL).
27784     *
27785     * See @ref tutorial_colorselector.
27786     */
27787    /**
27788     * @brief Add a new colorselector to the parent
27789     *
27790     * @param parent The parent object
27791     * @return The new object or NULL if it cannot be created
27792     *
27793     * @ingroup Colorselector
27794     */
27795    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27796    /**
27797     * Set a color for the colorselector
27798     *
27799     * @param obj   Colorselector object
27800     * @param r     r-value of color
27801     * @param g     g-value of color
27802     * @param b     b-value of color
27803     * @param a     a-value of color
27804     *
27805     * @ingroup Colorselector
27806     */
27807    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
27808    /**
27809     * Get a color from the colorselector
27810     *
27811     * @param obj   Colorselector object
27812     * @param r     integer pointer for r-value of color
27813     * @param g     integer pointer for g-value of color
27814     * @param b     integer pointer for b-value of color
27815     * @param a     integer pointer for a-value of color
27816     *
27817     * @ingroup Colorselector
27818     */
27819    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
27820    /**
27821     * @}
27822     */
27823
27824    /**
27825     * @defgroup Ctxpopup Ctxpopup
27826     *
27827     * @image html img/widget/ctxpopup/preview-00.png
27828     * @image latex img/widget/ctxpopup/preview-00.eps
27829     *
27830     * @brief Context popup widet.
27831     *
27832     * A ctxpopup is a widget that, when shown, pops up a list of items.
27833     * It automatically chooses an area inside its parent object's view
27834     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
27835     * optimally fit into it. In the default theme, it will also point an
27836     * arrow to it's top left position at the time one shows it. Ctxpopup
27837     * items have a label and/or an icon. It is intended for a small
27838     * number of items (hence the use of list, not genlist).
27839     *
27840     * @note Ctxpopup is a especialization of @ref Hover.
27841     *
27842     * Signals that you can add callbacks for are:
27843     * "dismissed" - the ctxpopup was dismissed
27844     *
27845     * Default contents parts of the ctxpopup widget that you can use for are:
27846     * @li "default" - A content of the ctxpopup
27847     *
27848     * Default contents parts of the ctxpopup items that you can use for are:
27849     * @li "icon" - An icon in the title area
27850     *
27851     * Default text parts of the ctxpopup items that you can use for are:
27852     * @li "default" - Title label in the title area
27853     *
27854     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
27855     * @{
27856     */
27857
27858    /**
27859     * @addtogroup Ctxpopup
27860     * @{
27861     */
27862
27863    typedef enum _Elm_Ctxpopup_Direction
27864      {
27865         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
27866                                           area */
27867         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
27868                                            the clicked area */
27869         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
27870                                           the clicked area */
27871         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
27872                                         area */
27873         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
27874      } Elm_Ctxpopup_Direction;
27875
27876    /**
27877     * @brief Add a new Ctxpopup object to the parent.
27878     *
27879     * @param parent Parent object
27880     * @return New object or @c NULL, if it cannot be created
27881     *
27882     * @ingroup Ctxpopup
27883     */
27884    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27885
27886    /**
27887     * @brief Set the Ctxpopup's parent
27888     *
27889     * @param obj The ctxpopup object
27890     * @param area The parent to use
27891     *
27892     * Set the parent object.
27893     *
27894     * @note elm_ctxpopup_add() will automatically call this function
27895     * with its @c parent argument.
27896     *
27897     * @see elm_ctxpopup_add()
27898     * @see elm_hover_parent_set()
27899     *
27900     * @ingroup Ctxpopup
27901     */
27902    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
27903
27904    /**
27905     * @brief Get the Ctxpopup's parent
27906     *
27907     * @param obj The ctxpopup object
27908     *
27909     * @see elm_ctxpopup_hover_parent_set() for more information
27910     *
27911     * @ingroup Ctxpopup
27912     */
27913    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27914
27915    /**
27916     * @brief Clear all items in the given ctxpopup object.
27917     *
27918     * @param obj Ctxpopup object
27919     *
27920     * @ingroup Ctxpopup
27921     */
27922    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
27923
27924    /**
27925     * @brief Change the ctxpopup's orientation to horizontal or vertical.
27926     *
27927     * @param obj Ctxpopup object
27928     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
27929     *
27930     * @ingroup Ctxpopup
27931     */
27932    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
27933
27934    /**
27935     * @brief Get the value of current ctxpopup object's orientation.
27936     *
27937     * @param obj Ctxpopup object
27938     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
27939     *
27940     * @see elm_ctxpopup_horizontal_set()
27941     *
27942     * @ingroup Ctxpopup
27943     */
27944    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27945
27946    /**
27947     * @brief Add a new item to a ctxpopup object.
27948     *
27949     * @param obj Ctxpopup object
27950     * @param icon Icon to be set on new item
27951     * @param label The Label of the new item
27952     * @param func Convenience function called when item selected
27953     * @param data Data passed to @p func
27954     * @return A handle to the item added or @c NULL, on errors
27955     *
27956     * @warning Ctxpopup can't hold both an item list and a content at the same
27957     * time. When an item is added, any previous content will be removed.
27958     *
27959     * @see elm_ctxpopup_content_set()
27960     *
27961     * @ingroup Ctxpopup
27962     */
27963    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);
27964
27965    /**
27966     * @brief Delete the given item in a ctxpopup object.
27967     *
27968     * @param it Ctxpopup item to be deleted
27969     *
27970     * @see elm_ctxpopup_item_append()
27971     *
27972     * @ingroup Ctxpopup
27973     */
27974    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27975
27976    /**
27977     * @brief Set the ctxpopup item's state as disabled or enabled.
27978     *
27979     * @param it Ctxpopup item to be enabled/disabled
27980     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
27981     *
27982     * When disabled the item is greyed out to indicate it's state.
27983     * @deprecated use elm_object_item_disabled_set() instead
27984     *
27985     * @ingroup Ctxpopup
27986     */
27987    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
27988
27989    /**
27990     * @brief Get the ctxpopup item's disabled/enabled state.
27991     *
27992     * @param it Ctxpopup item to be enabled/disabled
27993     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
27994     *
27995     * @see elm_ctxpopup_item_disabled_set()
27996     * @deprecated use elm_object_item_disabled_get() instead
27997     *
27998     * @ingroup Ctxpopup
27999     */
28000    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28001
28002    /**
28003     * @brief Get the icon object for the given ctxpopup item.
28004     *
28005     * @param it Ctxpopup item
28006     * @return icon object or @c NULL, if the item does not have icon or an error
28007     * occurred
28008     *
28009     * @see elm_ctxpopup_item_append()
28010     * @see elm_ctxpopup_item_icon_set()
28011     *
28012     * @deprecated use elm_object_item_part_content_get() instead
28013     *
28014     * @ingroup Ctxpopup
28015     */
28016    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28017
28018    /**
28019     * @brief Sets the side icon associated with the ctxpopup item
28020     *
28021     * @param it Ctxpopup item
28022     * @param icon Icon object to be set
28023     *
28024     * Once the icon object is set, a previously set one will be deleted.
28025     * @warning Setting the same icon for two items will cause the icon to
28026     * dissapear from the first item.
28027     *
28028     * @see elm_ctxpopup_item_append()
28029     *
28030     * @deprecated use elm_object_item_part_content_set() instead
28031     *
28032     * @ingroup Ctxpopup
28033     */
28034    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28035
28036    /**
28037     * @brief Get the label for the given ctxpopup item.
28038     *
28039     * @param it Ctxpopup item
28040     * @return label string or @c NULL, if the item does not have label or an
28041     * error occured
28042     *
28043     * @see elm_ctxpopup_item_append()
28044     * @see elm_ctxpopup_item_label_set()
28045     *
28046     * @deprecated use elm_object_item_text_get() instead
28047     *
28048     * @ingroup Ctxpopup
28049     */
28050    EINA_DEPRECATED EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28051
28052    /**
28053     * @brief (Re)set the label on the given ctxpopup item.
28054     *
28055     * @param it Ctxpopup item
28056     * @param label String to set as label
28057     *
28058     * @deprecated use elm_object_item_text_set() instead
28059     *
28060     * @ingroup Ctxpopup
28061     */
28062    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
28063
28064    /**
28065     * @brief Set an elm widget as the content of the ctxpopup.
28066     *
28067     * @param obj Ctxpopup object
28068     * @param content Content to be swallowed
28069     *
28070     * If the content object is already set, a previous one will bedeleted. If
28071     * you want to keep that old content object, use the
28072     * elm_ctxpopup_content_unset() function.
28073     *
28074     * @warning Ctxpopup can't hold both a item list and a content at the same
28075     * time. When a content is set, any previous items will be removed.
28076     *
28077     * @deprecated use elm_object_content_set() instead
28078     *
28079     * @ingroup Ctxpopup
28080     */
28081    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
28082
28083    /**
28084     * @brief Unset the ctxpopup content
28085     *
28086     * @param obj Ctxpopup object
28087     * @return The content that was being used
28088     *
28089     * Unparent and return the content object which was set for this widget.
28090     *
28091     * @deprecated use elm_object_content_unset()
28092     *
28093     * @see elm_ctxpopup_content_set()
28094     *
28095     * @deprecated use elm_object_content_unset() instead
28096     *
28097     * @ingroup Ctxpopup
28098     */
28099    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
28100
28101    /**
28102     * @brief Set the direction priority of a ctxpopup.
28103     *
28104     * @param obj Ctxpopup object
28105     * @param first 1st priority of direction
28106     * @param second 2nd priority of direction
28107     * @param third 3th priority of direction
28108     * @param fourth 4th priority of direction
28109     *
28110     * This functions gives a chance to user to set the priority of ctxpopup
28111     * showing direction. This doesn't guarantee the ctxpopup will appear in the
28112     * requested direction.
28113     *
28114     * @see Elm_Ctxpopup_Direction
28115     *
28116     * @ingroup Ctxpopup
28117     */
28118    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);
28119
28120    /**
28121     * @brief Get the direction priority of a ctxpopup.
28122     *
28123     * @param obj Ctxpopup object
28124     * @param first 1st priority of direction to be returned
28125     * @param second 2nd priority of direction to be returned
28126     * @param third 3th priority of direction to be returned
28127     * @param fourth 4th priority of direction to be returned
28128     *
28129     * @see elm_ctxpopup_direction_priority_set() for more information.
28130     *
28131     * @ingroup Ctxpopup
28132     */
28133    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);
28134
28135    /**
28136     * @brief Get the current direction of a ctxpopup.
28137     *
28138     * @param obj Ctxpopup object
28139     * @return current direction of a ctxpopup
28140     *
28141     * @warning Once the ctxpopup showed up, the direction would be determined
28142     *
28143     * @ingroup Ctxpopup
28144     */
28145    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28146
28147    /**
28148     * @}
28149     */
28150
28151    /* transit */
28152    /**
28153     *
28154     * @defgroup Transit Transit
28155     * @ingroup Elementary
28156     *
28157     * Transit is designed to apply various animated transition effects to @c
28158     * Evas_Object, such like translation, rotation, etc. For using these
28159     * effects, create an @ref Elm_Transit and add the desired transition effects.
28160     *
28161     * Once the effects are added into transit, they will be automatically
28162     * managed (their callback will be called until the duration is ended, and
28163     * they will be deleted on completion).
28164     *
28165     * Example:
28166     * @code
28167     * Elm_Transit *trans = elm_transit_add();
28168     * elm_transit_object_add(trans, obj);
28169     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
28170     * elm_transit_duration_set(transit, 1);
28171     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
28172     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
28173     * elm_transit_repeat_times_set(transit, 3);
28174     * @endcode
28175     *
28176     * Some transition effects are used to change the properties of objects. They
28177     * are:
28178     * @li @ref elm_transit_effect_translation_add
28179     * @li @ref elm_transit_effect_color_add
28180     * @li @ref elm_transit_effect_rotation_add
28181     * @li @ref elm_transit_effect_wipe_add
28182     * @li @ref elm_transit_effect_zoom_add
28183     * @li @ref elm_transit_effect_resizing_add
28184     *
28185     * Other transition effects are used to make one object disappear and another
28186     * object appear on its old place. These effects are:
28187     *
28188     * @li @ref elm_transit_effect_flip_add
28189     * @li @ref elm_transit_effect_resizable_flip_add
28190     * @li @ref elm_transit_effect_fade_add
28191     * @li @ref elm_transit_effect_blend_add
28192     *
28193     * It's also possible to make a transition chain with @ref
28194     * elm_transit_chain_transit_add.
28195     *
28196     * @warning We strongly recommend to use elm_transit just when edje can not do
28197     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
28198     * animations can be manipulated inside the theme.
28199     *
28200     * List of examples:
28201     * @li @ref transit_example_01_explained
28202     * @li @ref transit_example_02_explained
28203     * @li @ref transit_example_03_c
28204     * @li @ref transit_example_04_c
28205     *
28206     * @{
28207     */
28208
28209    /**
28210     * @enum Elm_Transit_Tween_Mode
28211     *
28212     * The type of acceleration used in the transition.
28213     */
28214    typedef enum
28215      {
28216         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
28217         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
28218                                              over time, then decrease again
28219                                              and stop slowly */
28220         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
28221                                              speed over time */
28222         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
28223                                             over time */
28224      } Elm_Transit_Tween_Mode;
28225
28226    /**
28227     * @enum Elm_Transit_Effect_Flip_Axis
28228     *
28229     * The axis where flip effect should be applied.
28230     */
28231    typedef enum
28232      {
28233         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
28234         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
28235      } Elm_Transit_Effect_Flip_Axis;
28236
28237    /**
28238     * @enum Elm_Transit_Effect_Wipe_Dir
28239     *
28240     * The direction where the wipe effect should occur.
28241     */
28242    typedef enum
28243      {
28244         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
28245         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
28246         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
28247         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
28248      } Elm_Transit_Effect_Wipe_Dir;
28249
28250    /** @enum Elm_Transit_Effect_Wipe_Type
28251     *
28252     * Whether the wipe effect should show or hide the object.
28253     */
28254    typedef enum
28255      {
28256         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
28257                                              animation */
28258         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
28259                                             animation */
28260      } Elm_Transit_Effect_Wipe_Type;
28261
28262    /**
28263     * @typedef Elm_Transit
28264     *
28265     * The Transit created with elm_transit_add(). This type has the information
28266     * about the objects which the transition will be applied, and the
28267     * transition effects that will be used. It also contains info about
28268     * duration, number of repetitions, auto-reverse, etc.
28269     */
28270    typedef struct _Elm_Transit Elm_Transit;
28271    typedef void Elm_Transit_Effect;
28272
28273    /**
28274     * @typedef Elm_Transit_Effect_Transition_Cb
28275     *
28276     * Transition callback called for this effect on each transition iteration.
28277     */
28278    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
28279
28280    /**
28281     * Elm_Transit_Effect_End_Cb
28282     *
28283     * Transition callback called for this effect when the transition is over.
28284     */
28285    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
28286
28287    /**
28288     * Elm_Transit_Del_Cb
28289     *
28290     * A callback called when the transit is deleted.
28291     */
28292    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
28293
28294    /**
28295     * Add new transit.
28296     *
28297     * @note Is not necessary to delete the transit object, it will be deleted at
28298     * the end of its operation.
28299     * @note The transit will start playing when the program enter in the main loop, is not
28300     * necessary to give a start to the transit.
28301     *
28302     * @return The transit object.
28303     *
28304     * @ingroup Transit
28305     */
28306    EAPI Elm_Transit                *elm_transit_add(void);
28307
28308    /**
28309     * Stops the animation and delete the @p transit object.
28310     *
28311     * Call this function if you wants to stop the animation before the duration
28312     * time. Make sure the @p transit object is still alive with
28313     * elm_transit_del_cb_set() function.
28314     * All added effects will be deleted, calling its repective data_free_cb
28315     * functions. The function setted by elm_transit_del_cb_set() will be called.
28316     *
28317     * @see elm_transit_del_cb_set()
28318     *
28319     * @param transit The transit object to be deleted.
28320     *
28321     * @ingroup Transit
28322     * @warning Just call this function if you are sure the transit is alive.
28323     */
28324    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
28325
28326    /**
28327     * Add a new effect to the transit.
28328     *
28329     * @note The cb function and the data are the key to the effect. If you try to
28330     * add an already added effect, nothing is done.
28331     * @note After the first addition of an effect in @p transit, if its
28332     * effect list become empty again, the @p transit will be killed by
28333     * elm_transit_del(transit) function.
28334     *
28335     * Exemple:
28336     * @code
28337     * Elm_Transit *transit = elm_transit_add();
28338     * elm_transit_effect_add(transit,
28339     *                        elm_transit_effect_blend_op,
28340     *                        elm_transit_effect_blend_context_new(),
28341     *                        elm_transit_effect_blend_context_free);
28342     * @endcode
28343     *
28344     * @param transit The transit object.
28345     * @param transition_cb The operation function. It is called when the
28346     * animation begins, it is the function that actually performs the animation.
28347     * It is called with the @p data, @p transit and the time progression of the
28348     * animation (a double value between 0.0 and 1.0).
28349     * @param effect The context data of the effect.
28350     * @param end_cb The function to free the context data, it will be called
28351     * at the end of the effect, it must finalize the animation and free the
28352     * @p data.
28353     *
28354     * @ingroup Transit
28355     * @warning The transit free the context data at the and of the transition with
28356     * the data_free_cb function, do not use the context data in another transit.
28357     */
28358    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);
28359
28360    /**
28361     * Delete an added effect.
28362     *
28363     * This function will remove the effect from the @p transit, calling the
28364     * data_free_cb to free the @p data.
28365     *
28366     * @see elm_transit_effect_add()
28367     *
28368     * @note If the effect is not found, nothing is done.
28369     * @note If the effect list become empty, this function will call
28370     * elm_transit_del(transit), that is, it will kill the @p transit.
28371     *
28372     * @param transit The transit object.
28373     * @param transition_cb The operation function.
28374     * @param effect The context data of the effect.
28375     *
28376     * @ingroup Transit
28377     */
28378    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);
28379
28380    /**
28381     * Add new object to apply the effects.
28382     *
28383     * @note After the first addition of an object in @p transit, if its
28384     * object list become empty again, the @p transit will be killed by
28385     * elm_transit_del(transit) function.
28386     * @note If the @p obj belongs to another transit, the @p obj will be
28387     * removed from it and it will only belong to the @p transit. If the old
28388     * transit stays without objects, it will die.
28389     * @note When you add an object into the @p transit, its state from
28390     * evas_object_pass_events_get(obj) is saved, and it is applied when the
28391     * transit ends, if you change this state whith evas_object_pass_events_set()
28392     * after add the object, this state will change again when @p transit stops to
28393     * run.
28394     *
28395     * @param transit The transit object.
28396     * @param obj Object to be animated.
28397     *
28398     * @ingroup Transit
28399     * @warning It is not allowed to add a new object after transit begins to go.
28400     */
28401    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
28402
28403    /**
28404     * Removes an added object from the transit.
28405     *
28406     * @note If the @p obj is not in the @p transit, nothing is done.
28407     * @note If the list become empty, this function will call
28408     * elm_transit_del(transit), that is, it will kill the @p transit.
28409     *
28410     * @param transit The transit object.
28411     * @param obj Object to be removed from @p transit.
28412     *
28413     * @ingroup Transit
28414     * @warning It is not allowed to remove objects after transit begins to go.
28415     */
28416    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
28417
28418    /**
28419     * Get the objects of the transit.
28420     *
28421     * @param transit The transit object.
28422     * @return a Eina_List with the objects from the transit.
28423     *
28424     * @ingroup Transit
28425     */
28426    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28427
28428    /**
28429     * Enable/disable keeping up the objects states.
28430     * If it is not kept, the objects states will be reset when transition ends.
28431     *
28432     * @note @p transit can not be NULL.
28433     * @note One state includes geometry, color, map data.
28434     *
28435     * @param transit The transit object.
28436     * @param state_keep Keeping or Non Keeping.
28437     *
28438     * @ingroup Transit
28439     */
28440    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
28441
28442    /**
28443     * Get a value whether the objects states will be reset or not.
28444     *
28445     * @note @p transit can not be NULL
28446     *
28447     * @see elm_transit_objects_final_state_keep_set()
28448     *
28449     * @param transit The transit object.
28450     * @return EINA_TRUE means the states of the objects will be reset.
28451     * If @p transit is NULL, EINA_FALSE is returned
28452     *
28453     * @ingroup Transit
28454     */
28455    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28456
28457    /**
28458     * Set the event enabled when transit is operating.
28459     *
28460     * If @p enabled is EINA_TRUE, the objects of the transit will receives
28461     * events from mouse and keyboard during the animation.
28462     * @note When you add an object with elm_transit_object_add(), its state from
28463     * evas_object_pass_events_get(obj) is saved, and it is applied when the
28464     * transit ends, if you change this state with evas_object_pass_events_set()
28465     * after adding the object, this state will change again when @p transit stops
28466     * to run.
28467     *
28468     * @param transit The transit object.
28469     * @param enabled Events are received when enabled is @c EINA_TRUE, and
28470     * ignored otherwise.
28471     *
28472     * @ingroup Transit
28473     */
28474    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
28475
28476    /**
28477     * Get the value of event enabled status.
28478     *
28479     * @see elm_transit_event_enabled_set()
28480     *
28481     * @param transit The Transit object
28482     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
28483     * EINA_FALSE is returned
28484     *
28485     * @ingroup Transit
28486     */
28487    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28488
28489    /**
28490     * Set the user-callback function when the transit is deleted.
28491     *
28492     * @note Using this function twice will overwrite the first function setted.
28493     * @note the @p transit object will be deleted after call @p cb function.
28494     *
28495     * @param transit The transit object.
28496     * @param cb Callback function pointer. This function will be called before
28497     * the deletion of the transit.
28498     * @param data Callback funtion user data. It is the @p op parameter.
28499     *
28500     * @ingroup Transit
28501     */
28502    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
28503
28504    /**
28505     * Set reverse effect automatically.
28506     *
28507     * If auto reverse is setted, after running the effects with the progress
28508     * parameter from 0 to 1, it will call the effecs again with the progress
28509     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
28510     * where the duration was setted with the function elm_transit_add and
28511     * the repeat with the function elm_transit_repeat_times_set().
28512     *
28513     * @param transit The transit object.
28514     * @param reverse EINA_TRUE means the auto_reverse is on.
28515     *
28516     * @ingroup Transit
28517     */
28518    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
28519
28520    /**
28521     * Get if the auto reverse is on.
28522     *
28523     * @see elm_transit_auto_reverse_set()
28524     *
28525     * @param transit The transit object.
28526     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
28527     * EINA_FALSE is returned
28528     *
28529     * @ingroup Transit
28530     */
28531    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28532
28533    /**
28534     * Set the transit repeat count. Effect will be repeated by repeat count.
28535     *
28536     * This function sets the number of repetition the transit will run after
28537     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
28538     * If the @p repeat is a negative number, it will repeat infinite times.
28539     *
28540     * @note If this function is called during the transit execution, the transit
28541     * will run @p repeat times, ignoring the times it already performed.
28542     *
28543     * @param transit The transit object
28544     * @param repeat Repeat count
28545     *
28546     * @ingroup Transit
28547     */
28548    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
28549
28550    /**
28551     * Get the transit repeat count.
28552     *
28553     * @see elm_transit_repeat_times_set()
28554     *
28555     * @param transit The Transit object.
28556     * @return The repeat count. If @p transit is NULL
28557     * 0 is returned
28558     *
28559     * @ingroup Transit
28560     */
28561    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28562
28563    /**
28564     * Set the transit animation acceleration type.
28565     *
28566     * This function sets the tween mode of the transit that can be:
28567     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
28568     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
28569     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
28570     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
28571     *
28572     * @param transit The transit object.
28573     * @param tween_mode The tween type.
28574     *
28575     * @ingroup Transit
28576     */
28577    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
28578
28579    /**
28580     * Get the transit animation acceleration type.
28581     *
28582     * @note @p transit can not be NULL
28583     *
28584     * @param transit The transit object.
28585     * @return The tween type. If @p transit is NULL
28586     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
28587     *
28588     * @ingroup Transit
28589     */
28590    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28591
28592    /**
28593     * Set the transit animation time
28594     *
28595     * @note @p transit can not be NULL
28596     *
28597     * @param transit The transit object.
28598     * @param duration The animation time.
28599     *
28600     * @ingroup Transit
28601     */
28602    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
28603
28604    /**
28605     * Get the transit animation time
28606     *
28607     * @note @p transit can not be NULL
28608     *
28609     * @param transit The transit object.
28610     *
28611     * @return The transit animation time.
28612     *
28613     * @ingroup Transit
28614     */
28615    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28616
28617    /**
28618     * Starts the transition.
28619     * Once this API is called, the transit begins to measure the time.
28620     *
28621     * @note @p transit can not be NULL
28622     *
28623     * @param transit The transit object.
28624     *
28625     * @ingroup Transit
28626     */
28627    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
28628
28629    /**
28630     * Pause/Resume the transition.
28631     *
28632     * If you call elm_transit_go again, the transit will be started from the
28633     * beginning, and will be unpaused.
28634     *
28635     * @note @p transit can not be NULL
28636     *
28637     * @param transit The transit object.
28638     * @param paused Whether the transition should be paused or not.
28639     *
28640     * @ingroup Transit
28641     */
28642    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
28643
28644    /**
28645     * Get the value of paused status.
28646     *
28647     * @see elm_transit_paused_set()
28648     *
28649     * @note @p transit can not be NULL
28650     *
28651     * @param transit The transit object.
28652     * @return EINA_TRUE means transition is paused. If @p transit is NULL
28653     * EINA_FALSE is returned
28654     *
28655     * @ingroup Transit
28656     */
28657    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28658
28659    /**
28660     * Get the time progression of the animation (a double value between 0.0 and 1.0).
28661     *
28662     * The value returned is a fraction (current time / total time). It
28663     * represents the progression position relative to the total.
28664     *
28665     * @note @p transit can not be NULL
28666     *
28667     * @param transit The transit object.
28668     *
28669     * @return The time progression value. If @p transit is NULL
28670     * 0 is returned
28671     *
28672     * @ingroup Transit
28673     */
28674    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28675
28676    /**
28677     * Makes the chain relationship between two transits.
28678     *
28679     * @note @p transit can not be NULL. Transit would have multiple chain transits.
28680     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
28681     *
28682     * @param transit The transit object.
28683     * @param chain_transit The chain transit object. This transit will be operated
28684     *        after transit is done.
28685     *
28686     * This function adds @p chain_transit transition to a chain after the @p
28687     * transit, and will be started as soon as @p transit ends. See @ref
28688     * transit_example_02_explained for a full example.
28689     *
28690     * @ingroup Transit
28691     */
28692    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
28693
28694    /**
28695     * Cut off the chain relationship between two transits.
28696     *
28697     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
28698     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
28699     *
28700     * @param transit The transit object.
28701     * @param chain_transit The chain transit object.
28702     *
28703     * This function remove the @p chain_transit transition from the @p transit.
28704     *
28705     * @ingroup Transit
28706     */
28707    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
28708
28709    /**
28710     * Get the current chain transit list.
28711     *
28712     * @note @p transit can not be NULL.
28713     *
28714     * @param transit The transit object.
28715     * @return chain transit list.
28716     *
28717     * @ingroup Transit
28718     */
28719    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
28720
28721    /**
28722     * Add the Resizing Effect to Elm_Transit.
28723     *
28724     * @note This API is one of the facades. It creates resizing effect context
28725     * and add it's required APIs to elm_transit_effect_add.
28726     *
28727     * @see elm_transit_effect_add()
28728     *
28729     * @param transit Transit object.
28730     * @param from_w Object width size when effect begins.
28731     * @param from_h Object height size when effect begins.
28732     * @param to_w Object width size when effect ends.
28733     * @param to_h Object height size when effect ends.
28734     * @return Resizing effect context data.
28735     *
28736     * @ingroup Transit
28737     */
28738    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);
28739
28740    /**
28741     * Add the Translation Effect to Elm_Transit.
28742     *
28743     * @note This API is one of the facades. It creates translation effect context
28744     * and add it's required APIs to elm_transit_effect_add.
28745     *
28746     * @see elm_transit_effect_add()
28747     *
28748     * @param transit Transit object.
28749     * @param from_dx X Position variation when effect begins.
28750     * @param from_dy Y Position variation when effect begins.
28751     * @param to_dx X Position variation when effect ends.
28752     * @param to_dy Y Position variation when effect ends.
28753     * @return Translation effect context data.
28754     *
28755     * @ingroup Transit
28756     * @warning It is highly recommended just create a transit with this effect when
28757     * the window that the objects of the transit belongs has already been created.
28758     * This is because this effect needs the geometry information about the objects,
28759     * and if the window was not created yet, it can get a wrong information.
28760     */
28761    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);
28762
28763    /**
28764     * Add the Zoom Effect to Elm_Transit.
28765     *
28766     * @note This API is one of the facades. It creates zoom effect context
28767     * and add it's required APIs to elm_transit_effect_add.
28768     *
28769     * @see elm_transit_effect_add()
28770     *
28771     * @param transit Transit object.
28772     * @param from_rate Scale rate when effect begins (1 is current rate).
28773     * @param to_rate Scale rate when effect ends.
28774     * @return Zoom effect context data.
28775     *
28776     * @ingroup Transit
28777     * @warning It is highly recommended just create a transit with this effect when
28778     * the window that the objects of the transit belongs has already been created.
28779     * This is because this effect needs the geometry information about the objects,
28780     * and if the window was not created yet, it can get a wrong information.
28781     */
28782    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
28783
28784    /**
28785     * Add the Flip Effect to Elm_Transit.
28786     *
28787     * @note This API is one of the facades. It creates flip effect context
28788     * and add it's required APIs to elm_transit_effect_add.
28789     * @note This effect is applied to each pair of objects in the order they are listed
28790     * in the transit list of objects. The first object in the pair will be the
28791     * "front" object and the second will be the "back" object.
28792     *
28793     * @see elm_transit_effect_add()
28794     *
28795     * @param transit Transit object.
28796     * @param axis Flipping Axis(X or Y).
28797     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
28798     * @return Flip effect context data.
28799     *
28800     * @ingroup Transit
28801     * @warning It is highly recommended just create a transit with this effect when
28802     * the window that the objects of the transit belongs has already been created.
28803     * This is because this effect needs the geometry information about the objects,
28804     * and if the window was not created yet, it can get a wrong information.
28805     */
28806    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
28807
28808    /**
28809     * Add the Resizable Flip Effect to Elm_Transit.
28810     *
28811     * @note This API is one of the facades. It creates resizable flip effect context
28812     * and add it's required APIs to elm_transit_effect_add.
28813     * @note This effect is applied to each pair of objects in the order they are listed
28814     * in the transit list of objects. The first object in the pair will be the
28815     * "front" object and the second will be the "back" object.
28816     *
28817     * @see elm_transit_effect_add()
28818     *
28819     * @param transit Transit object.
28820     * @param axis Flipping Axis(X or Y).
28821     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
28822     * @return Resizable flip effect context data.
28823     *
28824     * @ingroup Transit
28825     * @warning It is highly recommended just create a transit with this effect when
28826     * the window that the objects of the transit belongs has already been created.
28827     * This is because this effect needs the geometry information about the objects,
28828     * and if the window was not created yet, it can get a wrong information.
28829     */
28830    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
28831
28832    /**
28833     * Add the Wipe Effect to Elm_Transit.
28834     *
28835     * @note This API is one of the facades. It creates wipe effect context
28836     * and add it's required APIs to elm_transit_effect_add.
28837     *
28838     * @see elm_transit_effect_add()
28839     *
28840     * @param transit Transit object.
28841     * @param type Wipe type. Hide or show.
28842     * @param dir Wipe Direction.
28843     * @return Wipe effect context data.
28844     *
28845     * @ingroup Transit
28846     * @warning It is highly recommended just create a transit with this effect when
28847     * the window that the objects of the transit belongs has already been created.
28848     * This is because this effect needs the geometry information about the objects,
28849     * and if the window was not created yet, it can get a wrong information.
28850     */
28851    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
28852
28853    /**
28854     * Add the Color Effect to Elm_Transit.
28855     *
28856     * @note This API is one of the facades. It creates color effect context
28857     * and add it's required APIs to elm_transit_effect_add.
28858     *
28859     * @see elm_transit_effect_add()
28860     *
28861     * @param transit        Transit object.
28862     * @param  from_r        RGB R when effect begins.
28863     * @param  from_g        RGB G when effect begins.
28864     * @param  from_b        RGB B when effect begins.
28865     * @param  from_a        RGB A when effect begins.
28866     * @param  to_r          RGB R when effect ends.
28867     * @param  to_g          RGB G when effect ends.
28868     * @param  to_b          RGB B when effect ends.
28869     * @param  to_a          RGB A when effect ends.
28870     * @return               Color effect context data.
28871     *
28872     * @ingroup Transit
28873     */
28874    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);
28875
28876    /**
28877     * Add the Fade Effect to Elm_Transit.
28878     *
28879     * @note This API is one of the facades. It creates fade effect context
28880     * and add it's required APIs to elm_transit_effect_add.
28881     * @note This effect is applied to each pair of objects in the order they are listed
28882     * in the transit list of objects. The first object in the pair will be the
28883     * "before" object and the second will be the "after" object.
28884     *
28885     * @see elm_transit_effect_add()
28886     *
28887     * @param transit Transit object.
28888     * @return Fade effect context data.
28889     *
28890     * @ingroup Transit
28891     * @warning It is highly recommended just create a transit with this effect when
28892     * the window that the objects of the transit belongs has already been created.
28893     * This is because this effect needs the color information about the objects,
28894     * and if the window was not created yet, it can get a wrong information.
28895     */
28896    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
28897
28898    /**
28899     * Add the Blend Effect to Elm_Transit.
28900     *
28901     * @note This API is one of the facades. It creates blend effect context
28902     * and add it's required APIs to elm_transit_effect_add.
28903     * @note This effect is applied to each pair of objects in the order they are listed
28904     * in the transit list of objects. The first object in the pair will be the
28905     * "before" object and the second will be the "after" object.
28906     *
28907     * @see elm_transit_effect_add()
28908     *
28909     * @param transit Transit object.
28910     * @return Blend effect context data.
28911     *
28912     * @ingroup Transit
28913     * @warning It is highly recommended just create a transit with this effect when
28914     * the window that the objects of the transit belongs has already been created.
28915     * This is because this effect needs the color information about the objects,
28916     * and if the window was not created yet, it can get a wrong information.
28917     */
28918    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
28919
28920    /**
28921     * Add the Rotation Effect to Elm_Transit.
28922     *
28923     * @note This API is one of the facades. It creates rotation effect context
28924     * and add it's required APIs to elm_transit_effect_add.
28925     *
28926     * @see elm_transit_effect_add()
28927     *
28928     * @param transit Transit object.
28929     * @param from_degree Degree when effect begins.
28930     * @param to_degree Degree when effect is ends.
28931     * @return Rotation effect context data.
28932     *
28933     * @ingroup Transit
28934     * @warning It is highly recommended just create a transit with this effect when
28935     * the window that the objects of the transit belongs has already been created.
28936     * This is because this effect needs the geometry information about the objects,
28937     * and if the window was not created yet, it can get a wrong information.
28938     */
28939    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
28940
28941    /**
28942     * Add the ImageAnimation Effect to Elm_Transit.
28943     *
28944     * @note This API is one of the facades. It creates image animation effect context
28945     * and add it's required APIs to elm_transit_effect_add.
28946     * The @p images parameter is a list images paths. This list and
28947     * its contents will be deleted at the end of the effect by
28948     * elm_transit_effect_image_animation_context_free() function.
28949     *
28950     * Example:
28951     * @code
28952     * char buf[PATH_MAX];
28953     * Eina_List *images = NULL;
28954     * Elm_Transit *transi = elm_transit_add();
28955     *
28956     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
28957     * images = eina_list_append(images, eina_stringshare_add(buf));
28958     *
28959     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
28960     * images = eina_list_append(images, eina_stringshare_add(buf));
28961     * elm_transit_effect_image_animation_add(transi, images);
28962     *
28963     * @endcode
28964     *
28965     * @see elm_transit_effect_add()
28966     *
28967     * @param transit Transit object.
28968     * @param images Eina_List of images file paths. This list and
28969     * its contents will be deleted at the end of the effect by
28970     * elm_transit_effect_image_animation_context_free() function.
28971     * @return Image Animation effect context data.
28972     *
28973     * @ingroup Transit
28974     */
28975    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
28976    /**
28977     * @}
28978     */
28979
28980    typedef struct _Elm_Store                      Elm_Store;
28981    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
28982    typedef struct _Elm_Store_Item                 Elm_Store_Item;
28983    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
28984    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
28985    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
28986    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
28987    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
28988    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
28989    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
28990    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
28991
28992    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
28993    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
28994    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
28995    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
28996
28997    typedef enum
28998      {
28999         ELM_STORE_ITEM_MAPPING_NONE = 0,
29000         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
29001         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
29002         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
29003         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
29004         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
29005         // can add more here as needed by common apps
29006         ELM_STORE_ITEM_MAPPING_LAST
29007      } Elm_Store_Item_Mapping_Type;
29008
29009    struct _Elm_Store_Item_Mapping_Icon
29010      {
29011         // FIXME: allow edje file icons
29012         int                   w, h;
29013         Elm_Icon_Lookup_Order lookup_order;
29014         Eina_Bool             standard_name : 1;
29015         Eina_Bool             no_scale : 1;
29016         Eina_Bool             smooth : 1;
29017         Eina_Bool             scale_up : 1;
29018         Eina_Bool             scale_down : 1;
29019      };
29020
29021    struct _Elm_Store_Item_Mapping_Empty
29022      {
29023         Eina_Bool             dummy;
29024      };
29025
29026    struct _Elm_Store_Item_Mapping_Photo
29027      {
29028         int                   size;
29029      };
29030
29031    struct _Elm_Store_Item_Mapping_Custom
29032      {
29033         Elm_Store_Item_Mapping_Cb func;
29034      };
29035
29036    struct _Elm_Store_Item_Mapping
29037      {
29038         Elm_Store_Item_Mapping_Type     type;
29039         const char                     *part;
29040         int                             offset;
29041         union
29042           {
29043              Elm_Store_Item_Mapping_Empty  empty;
29044              Elm_Store_Item_Mapping_Icon   icon;
29045              Elm_Store_Item_Mapping_Photo  photo;
29046              Elm_Store_Item_Mapping_Custom custom;
29047              // add more types here
29048           } details;
29049      };
29050
29051    struct _Elm_Store_Item_Info
29052      {
29053         Elm_Genlist_Item_Class       *item_class;
29054         const Elm_Store_Item_Mapping *mapping;
29055         void                         *data;
29056         char                         *sort_id;
29057      };
29058
29059    struct _Elm_Store_Item_Info_Filesystem
29060      {
29061         Elm_Store_Item_Info  base;
29062         char                *path;
29063      };
29064
29065 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
29066 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
29067
29068    EAPI void                    elm_store_free(Elm_Store *st);
29069
29070    EAPI Elm_Store              *elm_store_filesystem_new(void);
29071    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
29072    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29073    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29074
29075    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
29076
29077    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
29078    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29079    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
29080    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
29081    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
29082    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29083
29084    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
29085    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
29086    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29087    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
29088    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29089    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29090    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29091
29092    /**
29093     * @defgroup SegmentControl SegmentControl
29094     * @ingroup Elementary
29095     *
29096     * @image html img/widget/segment_control/preview-00.png
29097     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
29098     *
29099     * @image html img/segment_control.png
29100     * @image latex img/segment_control.eps width=\textwidth
29101     *
29102     * Segment control widget is a horizontal control made of multiple segment
29103     * items, each segment item functioning similar to discrete two state button.
29104     * A segment control groups the items together and provides compact
29105     * single button with multiple equal size segments.
29106     *
29107     * Segment item size is determined by base widget
29108     * size and the number of items added.
29109     * Only one segment item can be at selected state. A segment item can display
29110     * combination of Text and any Evas_Object like Images or other widget.
29111     *
29112     * Smart callbacks one can listen to:
29113     * - "changed" - When the user clicks on a segment item which is not
29114     *   previously selected and get selected. The event_info parameter is the
29115     *   segment item pointer.
29116     *
29117     * Available styles for it:
29118     * - @c "default"
29119     *
29120     * Here is an example on its usage:
29121     * @li @ref segment_control_example
29122     */
29123
29124    /**
29125     * @addtogroup SegmentControl
29126     * @{
29127     */
29128
29129    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
29130
29131    /**
29132     * Add a new segment control widget to the given parent Elementary
29133     * (container) object.
29134     *
29135     * @param parent The parent object.
29136     * @return a new segment control widget handle or @c NULL, on errors.
29137     *
29138     * This function inserts a new segment control widget on the canvas.
29139     *
29140     * @ingroup SegmentControl
29141     */
29142    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29143
29144    /**
29145     * Append a new item to the segment control object.
29146     *
29147     * @param obj The segment control object.
29148     * @param icon The icon object to use for the left side of the item. An
29149     * icon can be any Evas object, but usually it is an icon created
29150     * with elm_icon_add().
29151     * @param label The label of the item.
29152     *        Note that, NULL is different from empty string "".
29153     * @return The created item or @c NULL upon failure.
29154     *
29155     * A new item will be created and appended to the segment control, i.e., will
29156     * be set as @b last item.
29157     *
29158     * If it should be inserted at another position,
29159     * elm_segment_control_item_insert_at() should be used instead.
29160     *
29161     * Items created with this function can be deleted with function
29162     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
29163     *
29164     * @note @p label set to @c NULL is different from empty string "".
29165     * If an item
29166     * only has icon, it will be displayed bigger and centered. If it has
29167     * icon and label, even that an empty string, icon will be smaller and
29168     * positioned at left.
29169     *
29170     * Simple example:
29171     * @code
29172     * sc = elm_segment_control_add(win);
29173     * ic = elm_icon_add(win);
29174     * elm_icon_file_set(ic, "path/to/image", NULL);
29175     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
29176     * elm_segment_control_item_add(sc, ic, "label");
29177     * evas_object_show(sc);
29178     * @endcode
29179     *
29180     * @see elm_segment_control_item_insert_at()
29181     * @see elm_segment_control_item_del()
29182     *
29183     * @ingroup SegmentControl
29184     */
29185    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
29186
29187    /**
29188     * Insert a new item to the segment control object at specified position.
29189     *
29190     * @param obj The segment control object.
29191     * @param icon The icon object to use for the left side of the item. An
29192     * icon can be any Evas object, but usually it is an icon created
29193     * with elm_icon_add().
29194     * @param label The label of the item.
29195     * @param index Item position. Value should be between 0 and items count.
29196     * @return The created item or @c NULL upon failure.
29197
29198     * Index values must be between @c 0, when item will be prepended to
29199     * segment control, and items count, that can be get with
29200     * elm_segment_control_item_count_get(), case when item will be appended
29201     * to segment control, just like elm_segment_control_item_add().
29202     *
29203     * Items created with this function can be deleted with function
29204     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
29205     *
29206     * @note @p label set to @c NULL is different from empty string "".
29207     * If an item
29208     * only has icon, it will be displayed bigger and centered. If it has
29209     * icon and label, even that an empty string, icon will be smaller and
29210     * positioned at left.
29211     *
29212     * @see elm_segment_control_item_add()
29213     * @see elm_segment_control_item_count_get()
29214     * @see elm_segment_control_item_del()
29215     *
29216     * @ingroup SegmentControl
29217     */
29218    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);
29219
29220    /**
29221     * Remove a segment control item from its parent, deleting it.
29222     *
29223     * @param it The item to be removed.
29224     *
29225     * Items can be added with elm_segment_control_item_add() or
29226     * elm_segment_control_item_insert_at().
29227     *
29228     * @ingroup SegmentControl
29229     */
29230    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
29231
29232    /**
29233     * Remove a segment control item at given index from its parent,
29234     * deleting it.
29235     *
29236     * @param obj The segment control object.
29237     * @param index The position of the segment control item to be deleted.
29238     *
29239     * Items can be added with elm_segment_control_item_add() or
29240     * elm_segment_control_item_insert_at().
29241     *
29242     * @ingroup SegmentControl
29243     */
29244    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29245
29246    /**
29247     * Get the Segment items count from segment control.
29248     *
29249     * @param obj The segment control object.
29250     * @return Segment items count.
29251     *
29252     * It will just return the number of items added to segment control @p obj.
29253     *
29254     * @ingroup SegmentControl
29255     */
29256    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29257
29258    /**
29259     * Get the item placed at specified index.
29260     *
29261     * @param obj The segment control object.
29262     * @param index The index of the segment item.
29263     * @return The segment control item or @c NULL on failure.
29264     *
29265     * Index is the position of an item in segment control widget. Its
29266     * range is from @c 0 to <tt> count - 1 </tt>.
29267     * Count is the number of items, that can be get with
29268     * elm_segment_control_item_count_get().
29269     *
29270     * @ingroup SegmentControl
29271     */
29272    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29273
29274    /**
29275     * Get the label of item.
29276     *
29277     * @param obj The segment control object.
29278     * @param index The index of the segment item.
29279     * @return The label of the item at @p index.
29280     *
29281     * The return value is a pointer to the label associated to the item when
29282     * it was created, with function elm_segment_control_item_add(), or later
29283     * with function elm_segment_control_item_label_set. If no label
29284     * was passed as argument, it will return @c NULL.
29285     *
29286     * @see elm_segment_control_item_label_set() for more details.
29287     * @see elm_segment_control_item_add()
29288     *
29289     * @ingroup SegmentControl
29290     */
29291    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29292
29293    /**
29294     * Set the label of item.
29295     *
29296     * @param it The item of segment control.
29297     * @param text The label of item.
29298     *
29299     * The label to be displayed by the item.
29300     * Label will be at right of the icon (if set).
29301     *
29302     * If a label was passed as argument on item creation, with function
29303     * elm_control_segment_item_add(), it will be already
29304     * displayed by the item.
29305     *
29306     * @see elm_segment_control_item_label_get()
29307     * @see elm_segment_control_item_add()
29308     *
29309     * @ingroup SegmentControl
29310     */
29311    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
29312
29313    /**
29314     * Get the icon associated to the item.
29315     *
29316     * @param obj The segment control object.
29317     * @param index The index of the segment item.
29318     * @return The left side icon associated to the item at @p index.
29319     *
29320     * The return value is a pointer to the icon associated to the item when
29321     * it was created, with function elm_segment_control_item_add(), or later
29322     * with function elm_segment_control_item_icon_set(). If no icon
29323     * was passed as argument, it will return @c NULL.
29324     *
29325     * @see elm_segment_control_item_add()
29326     * @see elm_segment_control_item_icon_set()
29327     *
29328     * @ingroup SegmentControl
29329     */
29330    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29331
29332    /**
29333     * Set the icon associated to the item.
29334     *
29335     * @param it The segment control item.
29336     * @param icon The icon object to associate with @p it.
29337     *
29338     * The icon object to use at left side of the item. An
29339     * icon can be any Evas object, but usually it is an icon created
29340     * with elm_icon_add().
29341     *
29342     * Once the icon object is set, a previously set one will be deleted.
29343     * @warning Setting the same icon for two items will cause the icon to
29344     * dissapear from the first item.
29345     *
29346     * If an icon was passed as argument on item creation, with function
29347     * elm_segment_control_item_add(), it will be already
29348     * associated to the item.
29349     *
29350     * @see elm_segment_control_item_add()
29351     * @see elm_segment_control_item_icon_get()
29352     *
29353     * @ingroup SegmentControl
29354     */
29355    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
29356
29357    /**
29358     * Get the index of an item.
29359     *
29360     * @param it The segment control item.
29361     * @return The position of item in segment control widget.
29362     *
29363     * Index is the position of an item in segment control widget. Its
29364     * range is from @c 0 to <tt> count - 1 </tt>.
29365     * Count is the number of items, that can be get with
29366     * elm_segment_control_item_count_get().
29367     *
29368     * @ingroup SegmentControl
29369     */
29370    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
29371
29372    /**
29373     * Get the base object of the item.
29374     *
29375     * @param it The segment control item.
29376     * @return The base object associated with @p it.
29377     *
29378     * Base object is the @c Evas_Object that represents that item.
29379     *
29380     * @ingroup SegmentControl
29381     */
29382    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
29383
29384    /**
29385     * Get the selected item.
29386     *
29387     * @param obj The segment control object.
29388     * @return The selected item or @c NULL if none of segment items is
29389     * selected.
29390     *
29391     * The selected item can be unselected with function
29392     * elm_segment_control_item_selected_set().
29393     *
29394     * The selected item always will be highlighted on segment control.
29395     *
29396     * @ingroup SegmentControl
29397     */
29398    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29399
29400    /**
29401     * Set the selected state of an item.
29402     *
29403     * @param it The segment control item
29404     * @param select The selected state
29405     *
29406     * This sets the selected state of the given item @p it.
29407     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
29408     *
29409     * If a new item is selected the previosly selected will be unselected.
29410     * Previoulsy selected item can be get with function
29411     * elm_segment_control_item_selected_get().
29412     *
29413     * The selected item always will be highlighted on segment control.
29414     *
29415     * @see elm_segment_control_item_selected_get()
29416     *
29417     * @ingroup SegmentControl
29418     */
29419    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
29420
29421    /**
29422     * @}
29423     */
29424
29425    /**
29426     * @defgroup Grid Grid
29427     *
29428     * The grid is a grid layout widget that lays out a series of children as a
29429     * fixed "grid" of widgets using a given percentage of the grid width and
29430     * height each using the child object.
29431     *
29432     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
29433     * widgets size itself. The default is 100 x 100, so that means the
29434     * position and sizes of children will effectively be percentages (0 to 100)
29435     * of the width or height of the grid widget
29436     *
29437     * @{
29438     */
29439
29440    /**
29441     * Add a new grid to the parent
29442     *
29443     * @param parent The parent object
29444     * @return The new object or NULL if it cannot be created
29445     *
29446     * @ingroup Grid
29447     */
29448    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
29449
29450    /**
29451     * Set the virtual size of the grid
29452     *
29453     * @param obj The grid object
29454     * @param w The virtual width of the grid
29455     * @param h The virtual height of the grid
29456     *
29457     * @ingroup Grid
29458     */
29459    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
29460
29461    /**
29462     * Get the virtual size of the grid
29463     *
29464     * @param obj The grid object
29465     * @param w Pointer to integer to store the virtual width of the grid
29466     * @param h Pointer to integer to store the virtual height of the grid
29467     *
29468     * @ingroup Grid
29469     */
29470    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
29471
29472    /**
29473     * Pack child at given position and size
29474     *
29475     * @param obj The grid object
29476     * @param subobj The child to pack
29477     * @param x The virtual x coord at which to pack it
29478     * @param y The virtual y coord at which to pack it
29479     * @param w The virtual width at which to pack it
29480     * @param h The virtual height at which to pack it
29481     *
29482     * @ingroup Grid
29483     */
29484    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
29485
29486    /**
29487     * Unpack a child from a grid object
29488     *
29489     * @param obj The grid object
29490     * @param subobj The child to unpack
29491     *
29492     * @ingroup Grid
29493     */
29494    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
29495
29496    /**
29497     * Faster way to remove all child objects from a grid object.
29498     *
29499     * @param obj The grid object
29500     * @param clear If true, it will delete just removed children
29501     *
29502     * @ingroup Grid
29503     */
29504    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
29505
29506    /**
29507     * Set packing of an existing child at to position and size
29508     *
29509     * @param subobj The child to set packing of
29510     * @param x The virtual x coord at which to pack it
29511     * @param y The virtual y coord at which to pack it
29512     * @param w The virtual width at which to pack it
29513     * @param h The virtual height at which to pack it
29514     *
29515     * @ingroup Grid
29516     */
29517    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
29518
29519    /**
29520     * get packing of a child
29521     *
29522     * @param subobj The child to query
29523     * @param x Pointer to integer to store the virtual x coord
29524     * @param y Pointer to integer to store the virtual y coord
29525     * @param w Pointer to integer to store the virtual width
29526     * @param h Pointer to integer to store the virtual height
29527     *
29528     * @ingroup Grid
29529     */
29530    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
29531
29532    /**
29533     * @}
29534     */
29535
29536    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
29537    EINA_DEPRECATED EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
29538    EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
29539    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
29540    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
29541    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
29542
29543    /**
29544     * @defgroup Video Video
29545     *
29546     * @addtogroup Video
29547     * @{
29548     *
29549     * Elementary comes with two object that help design application that need
29550     * to display video. The main one, Elm_Video, display a video by using Emotion.
29551     * It does embedded the video inside an Edje object, so you can do some
29552     * animation depending on the video state change. It does also implement a
29553     * ressource management policy to remove this burden from the application writer.
29554     *
29555     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
29556     * It take care of updating its content according to Emotion event and provide a
29557     * way to theme itself. It also does automatically raise the priority of the
29558     * linked Elm_Video so it will use the video decoder if available. It also does
29559     * activate the remember function on the linked Elm_Video object.
29560     *
29561     * Signals that you can add callback for are :
29562     *
29563     * "forward,clicked" - the user clicked the forward button.
29564     * "info,clicked" - the user clicked the info button.
29565     * "next,clicked" - the user clicked the next button.
29566     * "pause,clicked" - the user clicked the pause button.
29567     * "play,clicked" - the user clicked the play button.
29568     * "prev,clicked" - the user clicked the prev button.
29569     * "rewind,clicked" - the user clicked the rewind button.
29570     * "stop,clicked" - the user clicked the stop button.
29571     *
29572     * Default contents parts of the player widget that you can use for are:
29573     * @li "video" - A video of the player
29574     *
29575     */
29576
29577    /**
29578     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
29579     *
29580     * @param parent The parent object
29581     * @return a new player widget handle or @c NULL, on errors.
29582     *
29583     * This function inserts a new player widget on the canvas.
29584     *
29585     * @see elm_object_part_content_set()
29586     *
29587     * @ingroup Video
29588     */
29589    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
29590
29591    /**
29592     * @brief Link a Elm_Payer with an Elm_Video object.
29593     *
29594     * @param player the Elm_Player object.
29595     * @param video The Elm_Video object.
29596     *
29597     * This mean that action on the player widget will affect the
29598     * video object and the state of the video will be reflected in
29599     * the player itself.
29600     *
29601     * @see elm_player_add()
29602     * @see elm_video_add()
29603     * @deprecated use elm_object_part_content_set() instead
29604     *
29605     * @ingroup Video
29606     */
29607    EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
29608
29609    /**
29610     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
29611     *
29612     * @param parent The parent object
29613     * @return a new video widget handle or @c NULL, on errors.
29614     *
29615     * This function inserts a new video widget on the canvas.
29616     *
29617     * @seeelm_video_file_set()
29618     * @see elm_video_uri_set()
29619     *
29620     * @ingroup Video
29621     */
29622    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
29623
29624    /**
29625     * @brief Define the file that will be the video source.
29626     *
29627     * @param video The video object to define the file for.
29628     * @param filename The file to target.
29629     *
29630     * This function will explicitly define a filename as a source
29631     * for the video of the Elm_Video object.
29632     *
29633     * @see elm_video_uri_set()
29634     * @see elm_video_add()
29635     * @see elm_player_add()
29636     *
29637     * @ingroup Video
29638     */
29639    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
29640
29641    /**
29642     * @brief Define the uri that will be the video source.
29643     *
29644     * @param video The video object to define the file for.
29645     * @param uri The uri to target.
29646     *
29647     * This function will define an uri as a source for the video of the
29648     * Elm_Video object. URI could be remote source of video, like http:// or local source
29649     * like for example WebCam who are most of the time v4l2:// (but that depend and
29650     * you should use Emotion API to request and list the available Webcam on your system).
29651     *
29652     * @see elm_video_file_set()
29653     * @see elm_video_add()
29654     * @see elm_player_add()
29655     *
29656     * @ingroup Video
29657     */
29658    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
29659
29660    /**
29661     * @brief Get the underlying Emotion object.
29662     *
29663     * @param video The video object to proceed the request on.
29664     * @return the underlying Emotion object.
29665     *
29666     * @ingroup Video
29667     */
29668    EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
29669
29670    /**
29671     * @brief Start to play the video
29672     *
29673     * @param video The video object to proceed the request on.
29674     *
29675     * Start to play the video and cancel all suspend state.
29676     *
29677     * @ingroup Video
29678     */
29679    EAPI void elm_video_play(Evas_Object *video);
29680
29681    /**
29682     * @brief Pause the video
29683     *
29684     * @param video The video object to proceed the request on.
29685     *
29686     * Pause the video and start a timer to trigger suspend mode.
29687     *
29688     * @ingroup Video
29689     */
29690    EAPI void elm_video_pause(Evas_Object *video);
29691
29692    /**
29693     * @brief Stop the video
29694     *
29695     * @param video The video object to proceed the request on.
29696     *
29697     * Stop the video and put the emotion in deep sleep mode.
29698     *
29699     * @ingroup Video
29700     */
29701    EAPI void elm_video_stop(Evas_Object *video);
29702
29703    /**
29704     * @brief Is the video actually playing.
29705     *
29706     * @param video The video object to proceed the request on.
29707     * @return EINA_TRUE if the video is actually playing.
29708     *
29709     * You should consider watching event on the object instead of polling
29710     * the object state.
29711     *
29712     * @ingroup Video
29713     */
29714    EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
29715
29716    /**
29717     * @brief Is it possible to seek inside the video.
29718     *
29719     * @param video The video object to proceed the request on.
29720     * @return EINA_TRUE if is possible to seek inside the video.
29721     *
29722     * @ingroup Video
29723     */
29724    EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
29725
29726    /**
29727     * @brief Is the audio muted.
29728     *
29729     * @param video The video object to proceed the request on.
29730     * @return EINA_TRUE if the audio is muted.
29731     *
29732     * @ingroup Video
29733     */
29734    EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
29735
29736    /**
29737     * @brief Change the mute state of the Elm_Video object.
29738     *
29739     * @param video The video object to proceed the request on.
29740     * @param mute The new mute state.
29741     *
29742     * @ingroup Video
29743     */
29744    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
29745
29746    /**
29747     * @brief Get the audio level of the current video.
29748     *
29749     * @param video The video object to proceed the request on.
29750     * @return the current audio level.
29751     *
29752     * @ingroup Video
29753     */
29754    EAPI double elm_video_audio_level_get(const Evas_Object *video);
29755
29756    /**
29757     * @brief Set the audio level of anElm_Video object.
29758     *
29759     * @param video The video object to proceed the request on.
29760     * @param volume The new audio volume.
29761     *
29762     * @ingroup Video
29763     */
29764    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
29765
29766    EAPI double elm_video_play_position_get(const Evas_Object *video);
29767    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
29768    EAPI double elm_video_play_length_get(const Evas_Object *video);
29769    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
29770    EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
29771    EAPI const char *elm_video_title_get(const Evas_Object *video);
29772    /**
29773     * @}
29774     */
29775
29776    /**
29777     * @defgroup Naviframe Naviframe
29778     * @ingroup Elementary
29779     *
29780     * @brief Naviframe is a kind of view manager for the applications.
29781     *
29782     * Naviframe provides functions to switch different pages with stack
29783     * mechanism. It means if one page(item) needs to be changed to the new one,
29784     * then naviframe would push the new page to it's internal stack. Of course,
29785     * it can be back to the previous page by popping the top page. Naviframe
29786     * provides some transition effect while the pages are switching (same as
29787     * pager).
29788     *
29789     * Since each item could keep the different styles, users could keep the
29790     * same look & feel for the pages or different styles for the items in it's
29791     * application.
29792     *
29793     * Signals that you can add callback for are:
29794     * @li "transition,finished" - When the transition is finished in changing
29795     *     the item
29796     * @li "title,clicked" - User clicked title area
29797     *
29798     * Default contents parts of the naviframe items that you can use for are:
29799     * @li "default" - A main content of the page
29800     * @li "icon" - An icon in the title area
29801     * @li "prev_btn" - A button to go to the previous page
29802     * @li "next_btn" - A button to go to the next page
29803     *
29804     * Default text parts of the naviframe items that you can use for are:
29805     * @li "default" - Title label in the title area
29806     * @li "subtitle" - Sub-title label in the title area
29807     *
29808     * Supported elm_object common APIs.
29809     * @li elm_object_signal_emit
29810     *
29811     * Supported elm_object_item common APIs.
29812     * @li elm_object_item_text_set
29813     * @li elm_object_item_part_text_set
29814     * @li elm_object_item_text_get
29815     * @li elm_object_item_part_text_get
29816     * @li elm_object_item_content_set
29817     * @li elm_object_item_part_content_set
29818     * @li elm_object_item_content_get
29819     * @li elm_object_item_part_content_get
29820     * @li elm_object_item_content_unset
29821     * @li elm_object_item_part_content_unset
29822     * @li elm_object_item_signal_emit
29823     *
29824     * @ref tutorial_naviframe gives a good overview of the usage of the API.
29825     */
29826
29827    /**
29828     * @addtogroup Naviframe
29829     * @{
29830     */
29831
29832    /**
29833     * @brief Add a new Naviframe object to the parent.
29834     *
29835     * @param parent Parent object
29836     * @return New object or @c NULL, if it cannot be created
29837     *
29838     * @ingroup Naviframe
29839     */
29840    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29841
29842    /**
29843     * @brief Push a new item to the top of the naviframe stack (and show it).
29844     *
29845     * @param obj The naviframe object
29846     * @param title_label The label in the title area. The name of the title
29847     *        label part is "elm.text.title"
29848     * @param prev_btn The button to go to the previous item. If it is NULL,
29849     *        then naviframe will create a back button automatically. The name of
29850     *        the prev_btn part is "elm.swallow.prev_btn"
29851     * @param next_btn The button to go to the next item. Or It could be just an
29852     *        extra function button. The name of the next_btn part is
29853     *        "elm.swallow.next_btn"
29854     * @param content The main content object. The name of content part is
29855     *        "elm.swallow.content"
29856     * @param item_style The current item style name. @c NULL would be default.
29857     * @return The created item or @c NULL upon failure.
29858     *
29859     * The item pushed becomes one page of the naviframe, this item will be
29860     * deleted when it is popped.
29861     *
29862     * @see also elm_naviframe_item_style_set()
29863     * @see also elm_naviframe_item_insert_before()
29864     * @see also elm_naviframe_item_insert_after()
29865     *
29866     * The following styles are available for this item:
29867     * @li @c "default"
29868     *
29869     * @ingroup Naviframe
29870     */
29871    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);
29872
29873    /**
29874     * @brief Insert a new item into the naviframe before item @p before.
29875     *
29876     * @param before The naviframe item to insert before.
29877     * @param title_label The label in the title area. The name of the title
29878     *        label part is "elm.text.title"
29879     * @param prev_btn The button to go to the previous item. If it is NULL,
29880     *        then naviframe will create a back button automatically. The name of
29881     *        the prev_btn part is "elm.swallow.prev_btn"
29882     * @param next_btn The button to go to the next item. Or It could be just an
29883     *        extra function button. The name of the next_btn part is
29884     *        "elm.swallow.next_btn"
29885     * @param content The main content object. The name of content part is
29886     *        "elm.swallow.content"
29887     * @param item_style The current item style name. @c NULL would be default.
29888     * @return The created item or @c NULL upon failure.
29889     *
29890     * The item is inserted into the naviframe straight away without any
29891     * transition operations. This item will be deleted when it is popped.
29892     *
29893     * @see also elm_naviframe_item_style_set()
29894     * @see also elm_naviframe_item_push()
29895     * @see also elm_naviframe_item_insert_after()
29896     *
29897     * The following styles are available for this item:
29898     * @li @c "default"
29899     *
29900     * @ingroup Naviframe
29901     */
29902    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);
29903
29904    /**
29905     * @brief Insert a new item into the naviframe after item @p after.
29906     *
29907     * @param after The naviframe item to insert after.
29908     * @param title_label The label in the title area. The name of the title
29909     *        label part is "elm.text.title"
29910     * @param prev_btn The button to go to the previous item. If it is NULL,
29911     *        then naviframe will create a back button automatically. The name of
29912     *        the prev_btn part is "elm.swallow.prev_btn"
29913     * @param next_btn The button to go to the next item. Or It could be just an
29914     *        extra function button. The name of the next_btn part is
29915     *        "elm.swallow.next_btn"
29916     * @param content The main content object. The name of content part is
29917     *        "elm.swallow.content"
29918     * @param item_style The current item style name. @c NULL would be default.
29919     * @return The created item or @c NULL upon failure.
29920     *
29921     * The item is inserted into the naviframe straight away without any
29922     * transition operations. This item will be deleted when it is popped.
29923     *
29924     * @see also elm_naviframe_item_style_set()
29925     * @see also elm_naviframe_item_push()
29926     * @see also elm_naviframe_item_insert_before()
29927     *
29928     * The following styles are available for this item:
29929     * @li @c "default"
29930     *
29931     * @ingroup Naviframe
29932     */
29933    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);
29934
29935    /**
29936     * @brief Pop an item that is on top of the stack
29937     *
29938     * @param obj The naviframe object
29939     * @return @c NULL or the content object(if the
29940     *         elm_naviframe_content_preserve_on_pop_get is true).
29941     *
29942     * This pops an item that is on the top(visible) of the naviframe, makes it
29943     * disappear, then deletes the item. The item that was underneath it on the
29944     * stack will become visible.
29945     *
29946     * @see also elm_naviframe_content_preserve_on_pop_get()
29947     *
29948     * @ingroup Naviframe
29949     */
29950    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
29951
29952    /**
29953     * @brief Pop the items between the top and the above one on the given item.
29954     *
29955     * @param it The naviframe item
29956     *
29957     * @ingroup Naviframe
29958     */
29959    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29960
29961    /**
29962     * Promote an item already in the naviframe stack to the top of the stack
29963     *
29964     * @param it The naviframe item
29965     *
29966     * This will take the indicated item and promote it to the top of the stack
29967     * as if it had been pushed there. The item must already be inside the
29968     * naviframe stack to work.
29969     *
29970     */
29971    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29972
29973    /**
29974     * @brief Delete the given item instantly.
29975     *
29976     * @param it The naviframe item
29977     *
29978     * This just deletes the given item from the naviframe item list instantly.
29979     * So this would not emit any signals for view transitions but just change
29980     * the current view if the given item is a top one.
29981     *
29982     * @ingroup Naviframe
29983     */
29984    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29985
29986    /**
29987     * @brief preserve the content objects when items are popped.
29988     *
29989     * @param obj The naviframe object
29990     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
29991     *
29992     * @see also elm_naviframe_content_preserve_on_pop_get()
29993     *
29994     * @ingroup Naviframe
29995     */
29996    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
29997
29998    /**
29999     * @brief Get a value whether preserve mode is enabled or not.
30000     *
30001     * @param obj The naviframe object
30002     * @return If @c EINA_TRUE, preserve mode is enabled
30003     *
30004     * @see also elm_naviframe_content_preserve_on_pop_set()
30005     *
30006     * @ingroup Naviframe
30007     */
30008    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30009
30010    /**
30011     * @brief Get a top item on the naviframe stack
30012     *
30013     * @param obj The naviframe object
30014     * @return The top item on the naviframe stack or @c NULL, if the stack is
30015     *         empty
30016     *
30017     * @ingroup Naviframe
30018     */
30019    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30020
30021    /**
30022     * @brief Get a bottom item on the naviframe stack
30023     *
30024     * @param obj The naviframe object
30025     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
30026     *         empty
30027     *
30028     * @ingroup Naviframe
30029     */
30030    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30031
30032    /**
30033     * @brief Set an item style
30034     *
30035     * @param obj The naviframe item
30036     * @param item_style The current item style name. @c NULL would be default
30037     *
30038     * The following styles are available for this item:
30039     * @li @c "default"
30040     *
30041     * @see also elm_naviframe_item_style_get()
30042     *
30043     * @ingroup Naviframe
30044     */
30045    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
30046
30047    /**
30048     * @brief Get an item style
30049     *
30050     * @param obj The naviframe item
30051     * @return The current item style name
30052     *
30053     * @see also elm_naviframe_item_style_set()
30054     *
30055     * @ingroup Naviframe
30056     */
30057    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
30058
30059    /**
30060     * @brief Show/Hide the title area
30061     *
30062     * @param it The naviframe item
30063     * @param visible If @c EINA_TRUE, title area will be visible, hidden
30064     *        otherwise
30065     *
30066     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
30067     *
30068     * @see also elm_naviframe_item_title_visible_get()
30069     *
30070     * @ingroup Naviframe
30071     */
30072    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
30073
30074    /**
30075     * @brief Get a value whether title area is visible or not.
30076     *
30077     * @param it The naviframe item
30078     * @return If @c EINA_TRUE, title area is visible
30079     *
30080     * @see also elm_naviframe_item_title_visible_set()
30081     *
30082     * @ingroup Naviframe
30083     */
30084    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
30085
30086    /**
30087     * @brief Set creating prev button automatically or not
30088     *
30089     * @param obj The naviframe object
30090     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
30091     *        be created internally when you pass the @c NULL to the prev_btn
30092     *        parameter in elm_naviframe_item_push
30093     *
30094     * @see also elm_naviframe_item_push()
30095     *
30096     * @ingroup Naviframe
30097     */
30098    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
30099
30100    /**
30101     * @brief Get a value whether prev button(back button) will be auto pushed or
30102     *        not.
30103     *
30104     * @param obj The naviframe object
30105     * @return If @c EINA_TRUE, prev button will be auto pushed.
30106     *
30107     * @see also elm_naviframe_item_push()
30108     *           elm_naviframe_prev_btn_auto_pushed_set()
30109     *
30110     * @ingroup Naviframe
30111     */
30112    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30113
30114    /**
30115     * @brief Get a list of all the naviframe items.
30116     *
30117     * @param obj The naviframe object
30118     * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
30119     * or @c NULL on failure.
30120     *
30121     * @ingroup Naviframe
30122     */
30123    EAPI Eina_Inlist        *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30124
30125    /**
30126     * @brief Set the event enabled when pushing/popping items
30127     *
30128     * If @c enabled is EINA_TRUE, the contents of the naviframe item will
30129     * receives events from mouse and keyboard during view changing such as
30130     * item push/pop.
30131     *
30132     * @param obj The naviframe object
30133     * @param enabled Events are received when enabled is @c EINA_TRUE, and
30134     * ignored otherwise.
30135     *
30136     * @warning Events will be blocked by calling evas_object_freeze_events_set()
30137     * internally. So don't call the API whiling pushing/popping items.
30138     *
30139     * @see elm_naviframe_event_enabled_get()
30140     * @see evas_object_freeze_events_set()
30141     *
30142     * @ingroup Naviframe
30143     */
30144    EAPI void                elm_naviframe_event_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
30145
30146    /**
30147     * @brief Get the value of event enabled status.
30148     *
30149     * @param obj The naviframe object
30150     * @return EINA_TRUE, when event is enabled
30151     *
30152     * @see elm_naviframe_event_enabled_set()
30153     *
30154     * @ingroup Naviframe
30155     */
30156    EAPI Eina_Bool           elm_naviframe_event_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30157
30158    /**
30159     * @}
30160     */
30161
30162    /**
30163     * @defgroup Multibuttonentry Multibuttonentry
30164     *
30165     * A Multibuttonentry is a widget to allow a user enter text and manage it as a number of buttons
30166     * Each text button is inserted by pressing the "return" key. If there is no space in the current row,
30167     * a new button is added to the next row. When a text button is pressed, it will become focused.
30168     * Backspace removes the focus.
30169     * When the Multibuttonentry loses focus items longer than 1 lines are shrunk to one line.
30170     *
30171     * Smart callbacks one can register:
30172     * - @c "item,selected" - when item is selected. May be called on backspace key.
30173     * - @c "item,added" - when a new multibuttonentry item is added.
30174     * - @c "item,deleted" - when a multibuttonentry item is deleted.
30175     * - @c "item,clicked" - selected item of multibuttonentry is clicked.
30176     * - @c "clicked" - when multibuttonentry is clicked.
30177     * - @c "focused" - when multibuttonentry is focused.
30178     * - @c "unfocused" - when multibuttonentry is unfocused.
30179     * - @c "expanded" - when multibuttonentry is expanded.
30180     * - @c "shrank" - when multibuttonentry is shrank.
30181     * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed.
30182     *
30183     * Here is an example on its usage:
30184     * @li @ref multibuttonentry_example
30185     */
30186
30187    /**
30188     * @addtogroup Multibuttonentry
30189     * @{
30190     */
30191
30192    typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
30193    typedef Eina_Bool (*Elm_Multibuttonentry_Item_Filter_callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
30194
30195    /**
30196     * @brief Add a new multibuttonentry to the parent
30197     *
30198     * @param parent The parent object
30199     * @return The new object or NULL if it cannot be created
30200     *
30201     */
30202    EAPI Evas_Object               *elm_multibuttonentry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
30203
30204    /**
30205     * Get the label
30206     *
30207     * @param obj The multibuttonentry object
30208     * @return The label, or NULL if none
30209     *
30210     */
30211    EAPI const char                *elm_multibuttonentry_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30212
30213    /**
30214     * Set the label
30215     *
30216     * @param obj The multibuttonentry object
30217     * @param label The text label string
30218     *
30219     */
30220    EAPI void                       elm_multibuttonentry_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
30221
30222    /**
30223     * Get the entry of the multibuttonentry object
30224     *
30225     * @param obj The multibuttonentry object
30226     * @return The entry object, or NULL if none
30227     *
30228     */
30229    EAPI Evas_Object               *elm_multibuttonentry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30230
30231    /**
30232     * Get the guide text
30233     *
30234     * @param obj The multibuttonentry object
30235     * @return The guide text, or NULL if none
30236     *
30237     */
30238    EAPI const char *               elm_multibuttonentry_guide_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30239
30240    /**
30241     * Set the guide text
30242     *
30243     * @param obj The multibuttonentry object
30244     * @param label The guide text string
30245     *
30246     */
30247    EAPI void                       elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext) EINA_ARG_NONNULL(1);
30248
30249    /**
30250     * Get the value of shrink_mode state.
30251     *
30252     * @param obj The multibuttonentry object
30253     * @param the value of shrink mode state.
30254     *
30255     */
30256    EAPI int                        elm_multibuttonentry_shrink_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30257
30258    /**
30259     * Set/Unset the multibuttonentry to shrink mode state of single line
30260     *
30261     * @param obj The multibuttonentry object
30262     * @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.
30263     *
30264     */
30265    EAPI void                       elm_multibuttonentry_shrink_mode_set(Evas_Object *obj, int shrink) EINA_ARG_NONNULL(1);
30266
30267    /**
30268     * Prepend a new item to the multibuttonentry
30269     *
30270     * @param obj The multibuttonentry object
30271     * @param label The label of new item
30272     * @param data The ponter to the data to be attached
30273     * @return A handle to the item added or NULL if not possible
30274     *
30275     */
30276    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prepend(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
30277
30278    /**
30279     * Append a new item to the multibuttonentry
30280     *
30281     * @param obj The multibuttonentry object
30282     * @param label The label of new item
30283     * @param data The ponter to the data to be attached
30284     * @return A handle to the item added or NULL if not possible
30285     *
30286     */
30287    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_append(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
30288
30289    /**
30290     * Add a new item to the multibuttonentry before the indicated object
30291     *
30292     * reference.
30293     * @param obj The multibuttonentry object
30294     * @param before The item before which to add it
30295     * @param label The label of new item
30296     * @param data The ponter to the data to be attached
30297     * @return A handle to the item added or NULL if not possible
30298     *
30299     */
30300    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);
30301
30302    /**
30303     * Add a new item to the multibuttonentry after the indicated object
30304     *
30305     * @param obj The multibuttonentry object
30306     * @param after The item after which to add it
30307     * @param label The label of new item
30308     * @param data The ponter to the data to be attached
30309     * @return A handle to the item added or NULL if not possible
30310     *
30311     */
30312    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);
30313
30314    /**
30315     * Get a list of items in the multibuttonentry
30316     *
30317     * @param obj The multibuttonentry object
30318     * @return The list of items, or NULL if none
30319     *
30320     */
30321    EAPI const Eina_List           *elm_multibuttonentry_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30322
30323    /**
30324     * Get the first item in the multibuttonentry
30325     *
30326     * @param obj The multibuttonentry object
30327     * @return The first item, or NULL if none
30328     *
30329     */
30330    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30331
30332    /**
30333     * Get the last item in the multibuttonentry
30334     *
30335     * @param obj The multibuttonentry object
30336     * @return The last item, or NULL if none
30337     *
30338     */
30339    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30340
30341    /**
30342     * Get the selected item in the multibuttonentry
30343     *
30344     * @param obj The multibuttonentry object
30345     * @return The selected item, or NULL if none
30346     *
30347     */
30348    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30349
30350    /**
30351     * Set the selected state of an item
30352     *
30353     * @param item The item
30354     * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
30355     *
30356     */
30357    EAPI void                       elm_multibuttonentry_item_select(Elm_Multibuttonentry_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
30358
30359    /**
30360     * unselect all items.
30361     *
30362     * @param obj The multibuttonentry object
30363     *
30364     */
30365    EAPI void                       elm_multibuttonentry_item_unselect_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
30366
30367    /**
30368     * Delete a given item
30369     *
30370     * @param item The item
30371     *
30372     */
30373    EAPI void                       elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30374
30375    /**
30376     * Remove all items in the multibuttonentry.
30377     *
30378     * @param obj The multibuttonentry object
30379     *
30380     */
30381    EAPI void                       elm_multibuttonentry_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
30382
30383    /**
30384     * Get the label of a given item
30385     *
30386     * @param item The item
30387     * @return The label of a given item, or NULL if none
30388     *
30389     */
30390    EAPI const char                *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30391
30392    /**
30393     * Set the label of a given item
30394     *
30395     * @param item The item
30396     * @param label The text label string
30397     *
30398     */
30399    EAPI void                       elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str) EINA_ARG_NONNULL(1);
30400
30401    /**
30402     * Get the previous item in the multibuttonentry
30403     *
30404     * @param item The item
30405     * @return The item before the item @p item
30406     *
30407     */
30408    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30409
30410    /**
30411     * Get the next item in the multibuttonentry
30412     *
30413     * @param item The item
30414     * @return The item after the item @p item
30415     *
30416     */
30417    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30418
30419    /**
30420     * Append a item filter function for text inserted in the Multibuttonentry
30421     *
30422     * Append the given callback to the list. This functions will be called
30423     * whenever any text is inserted into the Multibuttonentry, with the text to be inserted
30424     * as a parameter. The callback function is free to alter the text in any way
30425     * it wants, but it must remember to free the given pointer and update it.
30426     * If the new text is to be discarded, the function can free it and set it text
30427     * parameter to NULL. This will also prevent any following filters from being
30428     * called.
30429     *
30430     * @param obj The multibuttonentryentry object
30431     * @param func The function to use as item filter
30432     * @param data User data to pass to @p func
30433     *
30434     */
30435    EAPI void elm_multibuttonentry_item_filter_append(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
30436
30437    /**
30438     * Prepend a filter function for text inserted in the Multibuttentry
30439     *
30440     * Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
30441     * for more information
30442     *
30443     * @param obj The multibuttonentry object
30444     * @param func The function to use as text filter
30445     * @param data User data to pass to @p func
30446     *
30447     */
30448    EAPI void elm_multibuttonentry_item_filter_prepend(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
30449
30450    /**
30451     * Remove a filter from the list
30452     *
30453     * Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
30454     * for more information.
30455     *
30456     * @param obj The multibuttonentry object
30457     * @param func The filter function to remove
30458     * @param data The user data passed when adding the function
30459     *
30460     */
30461    EAPI void elm_multibuttonentry_item_filter_remove(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
30462
30463    /**
30464     * @}
30465     */
30466
30467    /**
30468     * @addtogroup CopyPaste
30469     * @{
30470     */
30471
30472    typedef struct _Elm_Selection_Data Elm_Selection_Data;
30473    typedef Eina_Bool (*Elm_Drop_Cb) (void *d, Evas_Object *o, Elm_Selection_Data *data);
30474
30475    typedef enum _Elm_Sel_Type
30476    {
30477       ELM_SEL_TYPE_PRIMARY,
30478       ELM_SEL_TYPE_SECONDARY,
30479       ELM_SEL_TYPE_CLIPBOARD,
30480       ELM_SEL_TYPE_XDND,
30481
30482       ELM_SEL_TYPE_MAX,
30483    } Elm_Sel_Type;
30484
30485    typedef enum _Elm_Sel_Format
30486    {
30487       /** Targets: for matching every atom requesting */
30488       ELM_SEL_FORMAT_TARGETS  = -1,
30489       /** they come from outside of elm */
30490       ELM_SEL_FORMAT_NONE     = 0x0,
30491       /** Plain unformated text: Used for things that don't want rich markup */
30492       ELM_SEL_FORMAT_TEXT     = 0x01,
30493       /** Edje textblock markup, including inline images */
30494       ELM_SEL_FORMAT_MARKUP   = 0x02,
30495       /** Images */
30496       ELM_SEL_FORMAT_IMAGE    = 0x04,
30497       /** Vcards */
30498       ELM_SEL_FORMAT_VCARD    = 0x08,
30499       /** Raw HTMLish things for widgets that want that stuff (hello webkit!) */
30500       ELM_SEL_FORMAT_HTML     = 0x10,
30501
30502       ELM_SEL_FORMAT_MAX
30503    } Elm_Sel_Format;
30504
30505    struct _Elm_Selection_Data
30506    {
30507       int                   x, y;
30508       Elm_Sel_Format   format;
30509       void                 *data;
30510       size_t                len;
30511    };
30512
30513    /**
30514     * @brief Set a data of a widget to copy and paste.
30515     *
30516     * Append the given callback to the list. This functions will be called
30517     * called.
30518     *
30519     * @param selection selection type for copying and pasting
30520     * @param widget The source widget pointer
30521     * @param format Type of selection format
30522     * @param buf The pointer of data source
30523     * @return If EINA_TRUE, setting data is success.
30524     *
30525     * @ingroup CopyPaste
30526     *
30527     */
30528
30529    EAPI Eina_Bool            elm_cnp_selection_set(Elm_Sel_Type selection, Evas_Object *widget, Elm_Sel_Format format, const void *buf, size_t buflen);
30530
30531    /**
30532     * @brief Retrive the data from the widget which is set for copying and pasting.
30533     *
30534     * Getting the data from the widget which is set for copying and pasting.
30535     * Mainly the widget is elm_entry. If then @p datacb and @p udata are
30536     * can be NULL. If not, @p datacb and @p udata are used for retriving data.
30537     *
30538     * @see also elm_cnp_selection_set()
30539     *
30540     * @param selection selection type for copying and pasting
30541     * @param widget The source widget pointer
30542     * @param datacb The user data callback if the target widget isn't elm_entry
30543     * @param udata The user data pointer for @p datacb
30544     * @return If EINA_TRUE, getting data is success.
30545     *
30546     * @ingroup CopyPaste
30547     *
30548     */
30549
30550    EAPI Eina_Bool            elm_cnp_selection_get(Elm_Sel_Type selection, Elm_Sel_Format format, Evas_Object *widget, Elm_Drop_Cb datacb, void *udata);
30551
30552    /**
30553     * @brief Clear the data in the widget which is set for copying and pasting.
30554     *
30555     * Clear the data in the widget. Normally this function isn't need to call.
30556     *
30557     * @see also elm_cnp_selection_set()
30558     *
30559     * @param selection selection type for copying and pasting
30560     * @param widget The source widget pointer
30561     * @return If EINA_TRUE, clearing data is success.
30562     *
30563     * @ingroup CopyPaste
30564     *
30565     */
30566
30567    EAPI Eina_Bool            elm_cnp_selection_clear(Elm_Sel_Type selection, Evas_Object *widget);
30568
30569    /**
30570     * @}
30571     */
30572
30573 #ifdef __cplusplus
30574 }
30575 #endif
30576
30577 #endif